ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMViewProxy Class Reference

Superclass for all view proxies. More...

#include <vtkSMViewProxy.h>

Inheritance diagram for vtkSMViewProxy:
Inheritance graph
[legend]
Collaboration diagram for vtkSMViewProxy:
Collaboration graph
[legend]

Public Types

typedef vtkSMProxy Superclass
 
- Public Types inherited from vtkSMProxy
enum  ResetPropertiesMode { DEFAULT = 0, ONLY_XML = 1, ONLY_DOMAIN = 2 }
 
enum  { COPY_PROXY_PROPERTY_VALUES_BY_REFERENCE = 0, COPY_PROXY_PROPERTY_VALUES_BY_CLONING }
 Flags used for the proxyPropertyCopyFlag argument to the Copy method. More...
 
typedef vtkSMRemoteObject Superclass
 
- Public Types inherited from vtkSMRemoteObject
typedef vtkSMSessionObject Superclass
 
- Public Types inherited from vtkSMSessionObject
typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void StillRender ()
 Renders the view using full resolution. More...
 
virtual void InteractiveRender ()
 Renders the view using lower resolution is possible. More...
 
virtual void Update ()
 Called vtkPVView::Update on the server-side. More...
 
virtual bool CanDisplayData (vtkSMSourceProxy *producer, int outputPort)
 Returns true if the view can display the data produced by the producer's port. More...
 
virtual vtkSMRepresentationProxyCreateDefaultRepresentation (vtkSMProxy *, int)
 Create a default representation for the given source proxy. More...
 
virtual const char * GetRepresentationType (vtkSMSourceProxy *producer, int outputPort)
 Returns the xml name of the representation proxy to create to show the data produced in this view, if any. More...
 
virtual vtkSMRepresentationProxyFindRepresentation (vtkSMSourceProxy *producer, int outputPort)
 Finds the representation proxy showing the data produced by the provided producer, if any. More...
 
vtkImageData * CaptureWindow (int magnification)
 Captures a image from this view. More...
 
vtkView * GetClientSideView ()
 Returns the client-side vtkView, if any. More...
 
int WriteImage (const char *filename, const char *writerName, int magnification=1)
 Saves a screenshot of the view to disk. More...
 
virtual bool HasDirtyRepresentation ()
 Return true any internal representation is dirty. More...
 
virtual vtkRenderWindow * GetRenderWindow ()
 Return the vtkRenderWindow used by this view, if any. More...
 
virtual vtkRenderWindowInteractor * GetInteractor ()
 Returns the interactor. More...
 
virtual void SetupInteractor (vtkRenderWindowInteractor *iren)
 A client process need to set the interactor to enable interactivity. More...
 
virtual bool MakeRenderWindowInteractor (bool quiet=false)
 Creates a default render window interactor for the vtkRenderWindow and sets it up on the local process if the local process supports interaction. More...
 
virtual void SetEnable (bool)
 Enable/Disable a view. More...
 
virtual bool GetEnable ()
 Enable/Disable a view. More...
 
virtual void EnableOn ()
 Enable/Disable a view. More...
 
virtual void EnableOff ()
 Enable/Disable a view. More...
 
virtual bool GetNeedsUpdate ()
 Returns true if the subsequent call to Update() will result in an actual update. More...
 
- Public Member Functions inherited from vtkSMProxy
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetAnnotation (const char *key, const char *value)
 
const char * GetAnnotation (const char *key)
 Retreive an annotation with a given key. More...
 
void RemoveAnnotation (const char *key)
 Remove a given annotation based on its key to the proxy. More...
 
void RemoveAllAnnotations ()
 Remove all proxy annotations. More...
 
bool HasAnnotation (const char *key)
 Return true if a given annotation exists. More...
 
int GetNumberOfAnnotations ()
 Return the number of available annotations. More...
 
const char * GetAnnotationKeyAt (int index)
 Return the nth key of the available annotations. More...
 
virtual void SetLocation (vtkTypeUInt32)
 Get/Set the location where the underlying VTK-objects are created. More...
 
virtual vtkSMPropertyGetProperty (const char *name)
 Return the property with the given name. More...
 
virtual vtkSMPropertyGetProperty (const char *name, int selfOnly)
 Return a property of the given name from self or one of the sub-proxies. More...
 
const char * GetPropertyName (vtkSMProperty *prop)
 Given a property pointer, returns the name that was used to add it to the proxy. More...
 
virtual void UpdateVTKObjects ()
 Update the VTK object on the server by pushing the values of all modifed properties (un-modified properties are ignored). More...
 
virtual void RecreateVTKObjects ()
 Recreate the VTK object for this proxy. More...
 
void InvokeCommand (const char *name)
 Convenience method equivalent to UpdateProperty(name, 1). More...
 
virtual vtkSMPropertyIteratorNewPropertyIterator ()
 Returns a new (initialized) iterator of the properties. More...
 
unsigned int GetNumberOfConsumers ()
 Returns the number of consumers. More...
 
vtkSMProxyGetConsumerProxy (unsigned int idx)
 Returns the consumer of given index. More...
 
vtkSMPropertyGetConsumerProperty (unsigned int idx)
 Returns the corresponding property of the consumer of given index. More...
 
unsigned int GetNumberOfProducers ()
 Returns the number of proxies this proxy depends on (uses or is connected to through the pipeline). More...
 
vtkSMProxyGetProducerProxy (unsigned int idx)
 Returns a proxy this proxy depends on, given index. More...
 
vtkSMPropertyGetProducerProperty (unsigned int idx)
 Returns the property holding a producer proxy given an index. More...
 
virtual void UpdatePropertyInformation ()
 Updates all property informations by calling UpdateInformation() and populating the values. More...
 
virtual void UpdatePropertyInformation (vtkSMProperty *prop)
 Similar to UpdatePropertyInformation() but updates only the given property. More...
 
virtual void MarkAllPropertiesAsModified ()
 Marks all properties as modified. More...
 
virtual void ResetPropertiesToXMLDefaults ()
 Use this method to set all properties on this proxy to their default values. More...
 
virtual void ResetPropertiesToDomainDefaults ()
 Use this method to set all properties on this proxy to their default domains. More...
 
virtual void ResetPropertiesToDefault (ResetPropertiesMode mode=DEFAULT)
 Use this method to set all properties on this proxy to their default domain or values. More...
 
virtual void MarkModified (vtkSMProxy *modifiedProxy)
 Calls MarkDirty() and invokes ModifiedEvent. More...
 
void InitializeAndCopyFromProxy (vtkSMProxy *source)
 Given a source proxy, makes this proxy point to the same server-side object (with a new id). More...
 
virtual void MarkDirty (vtkSMProxy *modifiedProxy)
 Dirty means this algorithm will execute during next update. More...
 
vtkObjectBase * GetClientSideObject ()
 Returns the client side object associated with the VTKObjectID (if any). More...
 
virtual vtkPVXMLElementSaveXMLState (vtkPVXMLElement *root)
 Saves the state of the proxy. More...
 
virtual vtkPVXMLElementSaveXMLState (vtkPVXMLElement *root, vtkSMPropertyIterator *iter)
 The iterator is use to filter the property available on the given proxy. More...
 
virtual int LoadXMLState (vtkPVXMLElement *element, vtkSMProxyLocator *locator)
 Loads the proxy state from the XML element. More...
 
void UpdateSelfAndAllInputs ()
 This method call UpdateVTKObjects on the current pipeline by starting at the sources. More...
 
bool GetIsSubProxy ()
 A proxy instance can be a sub-proxy for some other proxy. More...
 
vtkSMProxyGetParentProxy ()
 If this instance is a sub-proxy, this method will return the proxy of which this instance is an immediate sub-proxy. More...
 
vtkSMProxyGetTrueParentProxy ()
 Call GetParentProxy() recursively till a proxy that is not a subproxy of any other proxy is found. More...
 
virtual void EnableLocalPushOnly ()
 Allow to switch off any push of state change to the server for that particular object. More...
 
virtual void DisableLocalPushOnly ()
 Enable the given remote object to communicate its state normaly to the server location. More...
 
virtual const vtkSMMessageGetFullState ()
 This method return the full object state that can be used to create that object from scratch. More...
 
virtual void LoadState (const vtkSMMessage *msg, vtkSMProxyLocator *locator)
 This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set. More...
 
vtkSMPropertyGroupGetPropertyGroup (size_t index) const
 Returns the property group at index for the proxy. More...
 
size_t GetNumberOfPropertyGroups () const
 Returns the number of property groups that the proxy contains. More...
 
bool UpdateProperty (const char *name)
 Update the value of one property (pushed to the server) if it is modified. More...
 
bool UpdateProperty (const char *name, int force)
 Update the value of one property (pushed to the server) if it is modified. More...
 
virtual char * GetVTKClassName ()
 Returns the type of object managed by the proxy. More...
 
virtual void SetVTKClassName (const char *)
 the type of object created by the proxy. More...
 
virtual char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual char * GetXMLGroup ()
 Assigned by the XML parser. More...
 
virtual char * GetXMLLabel ()
 Assigned by the XML parser. More...
 
void Copy (vtkSMProxy *src)
 Copies values of all the properties and sub-proxies from src. More...
 
void Copy (vtkSMProxy *src, const char *exceptionClass)
 Copies values of all the properties and sub-proxies from src. More...
 
virtual void Copy (vtkSMProxy *src, const char *exceptionClass, int proxyPropertyCopyFlag)
 Copies values of all the properties and sub-proxies from src. More...
 
virtual vtkSMDocumentationGetDocumentation ()
 Returns the documentation for this proxy. More...
 
virtual vtkPVXMLElementGetHints ()
 The server manager configuration XML may define <Hints> element for a proxy. More...
 
virtual int GetObjectsCreated ()
 Retuns if the VTK objects for this proxy have been created. More...
 
bool GatherInformation (vtkPVInformation *information)
 Gathers information about this proxy. More...
 
bool GatherInformation (vtkPVInformation *information, vtkTypeUInt32 location)
 Gathers information about this proxy. More...
 
virtual void PrototypeOn ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
virtual void PrototypeOff ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
virtual void SetPrototype (bool undo)
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
- Public Member Functions inherited from vtkSMRemoteObject
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetSession (vtkSMSession *)
 Override the SetSession so if the object already have an ID we automatically register it to the associated session. More...
 
bool HasGlobalID ()
 Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it. More...
 
virtual bool IsLocalPushOnly ()
 Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast. More...
 
virtual vtkTypeUInt32 GetLocation ()
 Get/Set the location where the underlying VTK-objects are created. More...
 
virtual vtkTypeUInt32 GetGlobalID ()
 Get the global unique id for this object. More...
 
const char * GetGlobalIDAsString ()
 Get the global unique id for this object. More...
 
bool IsPrototype ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
- Public Member Functions inherited from vtkSMSessionObject
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMViewProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMViewProxySafeDownCast (vtkObject *o)
 
static void SetTransparentBackground (bool val)
 Sets whether screenshots have a transparent background. More...
 
static bool GetTransparentBackground ()
 Sets whether screenshots have a transparent background. More...
 
- Static Public Member Functions inherited from vtkSMProxy
static vtkSMProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMRemoteObject
static int IsTypeOf (const char *type)
 
static vtkSMRemoteObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMViewProxy ()
 
 ~vtkSMViewProxy ()
 
virtual vtkImageData * CaptureWindowInternal (int vtkNotUsed(magnification))
 Subclasses should override this method to do the actual image capture. More...
 
virtual vtkTypeUInt32 PreRender (bool vtkNotUsed(interactive))
 
virtual void PostRender (bool vtkNotUsed(interactive))
 
virtual bool IsContextReadyForRendering ()
 Subclasses should override this method and return false if the rendering context is not ready for rendering at this moment. More...
 
virtual void CreateVTKObjects ()
 Called at the end of CreateVTKObjects(). More...
 
virtual int ReadXMLAttributes (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element)
 Read attributes from an XML element. More...
 
bool GetLocalProcessSupportsInteraction ()
 Convenience method to call vtkPVView::SafeDownCast(this->GetClientSideObject())->GetLocalProcessSupportsInteraction();. More...
 
virtual void SetDefaultRepresentationName (const char *)
 
- Protected Member Functions inherited from vtkSMProxy
 vtkSMProxy ()
 
 ~vtkSMProxy ()
 
void ExecuteStream (const vtkClientServerStream &msg, bool ignore_errors=false, vtkTypeUInt32 location=0)
 Invoke that takes a vtkClientServerStream as the argument. More...
 
virtual void UpdateAndPushAnnotationState ()
 
virtual void AddProperty (const char *name, vtkSMProperty *prop)
 Add a property with the given key (name). More...
 
virtual void MarkConsumersAsDirty (vtkSMProxy *modifiedProxy)
 Calls MarkDirty() on all consumers. More...
 
void RemoveAllObservers ()
 Cleanup code. More...
 
virtual void SetPropertyModifiedFlag (const char *name, int flag)
 Note on property modified flags: The modified flag of each property associated with a proxy is stored in the proxy object instead of in the property itself. More...
 
void AddSubProxy (const char *name, vtkSMProxy *proxy, int overrideOK=0)
 Add a sub-proxy. More...
 
void RemoveSubProxy (const char *name)
 Remove a sub-proxy. More...
 
vtkSMProxyGetSubProxy (const char *name)
 Returns a sub-proxy. More...
 
vtkSMProxyGetSubProxy (unsigned int index)
 Returns a sub-proxy. More...
 
const char * GetSubProxyName (unsigned int index)
 Returns the name used to store sub-proxy. More...
 
const char * GetSubProxyName (vtkSMProxy *)
 Returns the name used to store sub-proxy. More...
 
unsigned int GetNumberOfSubProxies ()
 Returns the number of sub-proxies. More...
 
virtual void AddConsumer (vtkSMProperty *property, vtkSMProxy *proxy)
 Called by a proxy property, this adds the property,proxy pair to the list of consumers. More...
 
virtual void RemoveConsumer (vtkSMProperty *property, vtkSMProxy *proxy)
 Remove the property,proxy pair from the list of consumers. More...
 
virtual void RemoveAllConsumers ()
 Remove all consumers. More...
 
void AddProducer (vtkSMProperty *property, vtkSMProxy *proxy)
 Called by an proxy/input property to add property, proxy pair to the list of producers. More...
 
void RemoveProducer (vtkSMProperty *property, vtkSMProxy *proxy)
 Remove the property,proxy pair from the list of producers. More...
 
virtual void PostUpdateData ()
 This method is called after the algorithm(s) (if any) associated with this proxy execute. More...
 
bool WarnIfDeprecated ()
 If a proxy is deprecated, prints a warning. More...
 
virtual void UpdatePipelineInformation ()
 This method simply iterates over subproxies and calls UpdatePipelineInformation() on them. More...
 
void LinkProperty (vtkSMProperty *inputProperty, vtkSMProperty *outputProperty)
 Links properties such that when inputProperty's checked or unchecked values are changed, the outputProperty's corresponding values are also changed. More...
 
vtkSMPropertyGroupNewPropertyGroup (vtkPVXMLElement *propElement)
 Parses the XML to create a new property group. More...
 
void ExposeSubProxyProperty (const char *subproxy_name, const char *property_name, const char *exposed_name, int overrideOK=0)
 Expose a subproxy property from the base proxy. More...
 
virtual void ExecuteSubProxyEvent (vtkSMProxy *o, unsigned long event, void *data)
 Handle events fired by subproxies. More...
 
virtual int CreateSubProxiesAndProperties (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element)
 
virtual void UpdatePropertyInformationInternal (vtkSMProperty *prop=NULL)
 Called to update the property information on the property. More...
 
bool ArePropertiesModified ()
 Indicates if any properties are modified. More...
 
void SetHints (vtkPVXMLElement *hints)
 
void SetDeprecated (vtkPVXMLElement *deprecated)
 
void SetXMLElement (vtkPVXMLElement *element)
 
 vtkSMProxy (const vtkSMProxy &) VTK_DELETE_FUNCTION
 
void operator= (const vtkSMProxy &) VTK_DELETE_FUNCTION
 
virtual const vtkClientServerStreamGetLastResult ()
 Get the last result. More...
 
virtual const vtkClientServerStreamGetLastResult (vtkTypeUInt32 location)
 Get the last result. More...
 
virtual void SetXMLName (const char *)
 Assigned by the XML parser. More...
 
virtual void SetXMLGroup (const char *)
 Assigned by the XML parser. More...
 
virtual void SetXMLLabel (const char *)
 Assigned by the XML parser. More...
 
virtual void SetXMLSubProxyName (const char *)
 Assigned by the XML parser. More...
 
vtkSMPropertyNewProperty (const char *name)
 Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...
 
vtkSMPropertyNewProperty (const char *name, vtkPVXMLElement *propElement)
 Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...
 
void SetupExposedProperties (const char *subproxy_name, vtkPVXMLElement *element)
 Read attributes from an XML element. More...
 
void SetupSharedProperties (vtkSMProxy *subproxy, vtkPVXMLElement *element)
 Read attributes from an XML element. More...
 
virtual void SetSIClassName (const char *)
 SIClassName identifies the classname for the helper on the server side. More...
 
virtual char * GetSIClassName ()
 SIClassName identifies the classname for the helper on the server side. More...
 
- Protected Member Functions inherited from vtkSMRemoteObject
 vtkSMRemoteObject ()
 Default constructor. More...
 
virtual ~vtkSMRemoteObject ()
 Destructor. More...
 
void PushState (vtkSMMessage *msg)
 Subclasses can call this method to send a message to its state object on the server processes specified. More...
 
bool PullState (vtkSMMessage *msg)
 Subclasses can call this method to pull the state from the state-object on the server processes specified. More...
 
void SetGlobalID (vtkTypeUInt32 guid)
 Set the GlobalUniqueId. More...
 
vtkTypeUInt32 GetFilteredLocation ()
 
- Protected Member Functions inherited from vtkSMSessionObject
 vtkSMSessionObject ()
 
 ~vtkSMSessionObject ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Protected Attributes

char * DefaultRepresentationName
 
bool Enable
 
- Protected Attributes inherited from vtkSMProxy
bool NeedsUpdate
 
char * VTKClassName
 
char * XMLGroup
 
char * XMLName
 
char * XMLLabel
 
char * XMLSubProxyName
 
int ObjectsCreated
 
int DoNotUpdateImmediately
 
int DoNotModifyProperty
 
int InUpdateVTKObjects
 Avoids calls to UpdateVTKObjects in UpdateVTKObjects. More...
 
bool PropertiesModified
 Flag used to help speed up UpdateVTKObjects and ArePropertiesModified calls. More...
 
vtkPVXMLElementXMLElement
 
vtkSMDocumentationDocumentation
 
vtkPVXMLElementHints
 
vtkPVXMLElementDeprecated
 
vtkSMMessageState
 
int InMarkModified
 
vtkWeakPointer< vtkSMProxyParentProxy
 
vtkSMProxyInternalsInternals
 
vtkSMProxyObserverSubProxyObserver
 
char * SIClassName
 SIClassName identifies the classname for the helper on the server side. More...
 
- Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32 GlobalID
 
vtkTypeUInt32 Location
 
bool Prototype
 
bool ClientOnlyLocationFlag
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 
static bool HideOtherRepresentationsIfNeeded (vtkSMViewProxy *self, vtkSMProxy *repr)
 Method used to hide other representations if the view has a <ShowOneRepresentationAtATime> hint. More...
 
virtual bool HideOtherRepresentationsIfNeeded (vtkSMProxy *repr)
 Method used to hide other representations if the view has a <ShowOneRepresentationAtATime> hint. More...
 

Detailed Description

Superclass for all view proxies.

vtkSMViewProxy is a superclass for all view proxies. A view proxy abstracts the logic to take one or more representation proxies and show then in some viewport such as vtkRenderWindow. This class may directly be used as the view proxy for views that do all the rendering work at the GUI level. The VTKObject corresponding to this class has to be a vtkView subclass.

Events:

Definition at line 46 of file vtkSMViewProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkSMViewProxy.h.

Constructor & Destructor Documentation

◆ vtkSMViewProxy()

vtkSMViewProxy::vtkSMViewProxy ( )
protected

◆ ~vtkSMViewProxy()

vtkSMViewProxy::~vtkSMViewProxy ( )
protected

Member Function Documentation

◆ New()

static vtkSMViewProxy* vtkSMViewProxy::New ( )
static

◆ GetClassName()

virtual const char* vtkSMViewProxy::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkSMViewProxy::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkSMViewProxy::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkSMViewProxy* vtkSMViewProxy::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkSMViewProxy::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ SetEnable()

virtual void vtkSMViewProxy::SetEnable ( bool  )
virtual

Enable/Disable a view.

◆ GetEnable()

virtual bool vtkSMViewProxy::GetEnable ( )
virtual

Enable/Disable a view.

◆ EnableOn()

virtual void vtkSMViewProxy::EnableOn ( )
virtual

Enable/Disable a view.

◆ EnableOff()

virtual void vtkSMViewProxy::EnableOff ( )
virtual

Enable/Disable a view.

◆ StillRender()

virtual void vtkSMViewProxy::StillRender ( )
virtual

Renders the view using full resolution.

◆ InteractiveRender()

virtual void vtkSMViewProxy::InteractiveRender ( )
virtual

Renders the view using lower resolution is possible.

◆ Update()

virtual void vtkSMViewProxy::Update ( )
virtual

Called vtkPVView::Update on the server-side.

Reimplemented in vtkSMRenderViewProxy, and vtkSMComparativeViewProxy.

◆ CanDisplayData()

virtual bool vtkSMViewProxy::CanDisplayData ( vtkSMSourceProxy producer,
int  outputPort 
)
virtual

Returns true if the view can display the data produced by the producer's port.

Internally calls GetRepresentationType() and returns true only if the type is valid a representation proxy of that type can be created.

Reimplemented in vtkSMContextViewProxy.

◆ CreateDefaultRepresentation()

virtual vtkSMRepresentationProxy* vtkSMViewProxy::CreateDefaultRepresentation ( vtkSMProxy ,
int   
)
virtual

Create a default representation for the given source proxy.

Returns a new proxy. In version 4.1 and earlier, subclasses overrode this method. Since 4.2, the preferred way is to simply override GetRepresentationType(). That ensures that CreateDefaultRepresentation() and CanDisplayData() both work as expected.

Reimplemented in vtkSMMultiSliceViewProxy, and vtkSMOrthographicSliceViewProxy.

◆ GetRepresentationType()

virtual const char* vtkSMViewProxy::GetRepresentationType ( vtkSMSourceProxy producer,
int  outputPort 
)
virtual

Returns the xml name of the representation proxy to create to show the data produced in this view, if any.

Default implementation checks if the producer has any "Hints" that define the representation to create in this view and if so, returns that. Or if this->DefaultRepresentationName is set and its Input property can accept the data produced, returns this->DefaultRepresentationName. Subclasses should override this method.

Reimplemented in vtkSMRenderViewProxy, vtkSMComparativeViewProxy, vtkSMMultiSliceViewProxy, and vtkSMOrthographicSliceViewProxy.

◆ FindRepresentation()

virtual vtkSMRepresentationProxy* vtkSMViewProxy::FindRepresentation ( vtkSMSourceProxy producer,
int  outputPort 
)
virtual

Finds the representation proxy showing the data produced by the provided producer, if any.

Note the representation may not necessarily be visible.

◆ CaptureWindow()

vtkImageData* vtkSMViewProxy::CaptureWindow ( int  magnification)

Captures a image from this view.

Default implementation returns NULL. Subclasses should override CaptureWindowInternal() to do the actual image capture.

◆ GetClientSideView()

vtkView* vtkSMViewProxy::GetClientSideView ( )

Returns the client-side vtkView, if any.

◆ WriteImage()

int vtkSMViewProxy::WriteImage ( const char *  filename,
const char *  writerName,
int  magnification = 1 
)

Saves a screenshot of the view to disk.

The writerName argument specifies the vtkImageWriter subclass to use.

◆ HasDirtyRepresentation()

virtual bool vtkSMViewProxy::HasDirtyRepresentation ( )
inlinevirtual

Return true any internal representation is dirty.

This can be usefull to know if the internal geometry has changed. DEPRECATED: Use GetNeedsUpdate() instead.

Definition at line 134 of file vtkSMViewProxy.h.

◆ GetNeedsUpdate()

virtual bool vtkSMViewProxy::GetNeedsUpdate ( )
virtual

Returns true if the subsequent call to Update() will result in an actual update.

If returned true, it means that the view thinks its rendering is obsolete and needs to be re-generated.

Reimplemented in vtkSMRenderViewProxy.

◆ GetRenderWindow()

virtual vtkRenderWindow* vtkSMViewProxy::GetRenderWindow ( )
inlinevirtual

Return the vtkRenderWindow used by this view, if any.

Note, views like vtkSMComparativeViewProxy can have more than 1 render window in play, in which case, using this method alone may yield incorrect results. Also, certain views don't use a vtkRenderWindow at all (e.g. Spreadsheet View), in which case, this method will return NULL. Default implementation returns NULL.

Reimplemented in vtkSMRenderViewProxy, vtkSMComparativeViewProxy, vtkSMContextViewProxy, and vtkSMPythonViewProxy.

Definition at line 153 of file vtkSMViewProxy.h.

◆ GetInteractor()

virtual vtkRenderWindowInteractor* vtkSMViewProxy::GetInteractor ( )
inlinevirtual

Returns the interactor.

Note, that views may not use vtkRenderWindow at all in which case they will not have any interactor and will return NULL. Default implementation returns NULL.

Reimplemented in vtkSMRenderViewProxy, vtkSMComparativeViewProxy, and vtkSMContextViewProxy.

Definition at line 160 of file vtkSMViewProxy.h.

◆ SetupInteractor()

virtual void vtkSMViewProxy::SetupInteractor ( vtkRenderWindowInteractor *  iren)
inlinevirtual

A client process need to set the interactor to enable interactivity.

Use this method to set the interactor and initialize it as needed by the RenderView. This include changing the interactor style as well as overriding VTK rendering to use the Proxy/ViewProxy API instead. Default implementation does nothing. Views that support interaction using vtkRenderWindowInteractor should override this method to set the interactor up.

Reimplemented in vtkSMRenderViewProxy, vtkSMComparativeViewProxy, and vtkSMContextViewProxy.

Definition at line 171 of file vtkSMViewProxy.h.

◆ MakeRenderWindowInteractor()

virtual bool vtkSMViewProxy::MakeRenderWindowInteractor ( bool  quiet = false)
virtual

Creates a default render window interactor for the vtkRenderWindow and sets it up on the local process if the local process supports interaction.

This should not be used when putting the render window in a QVTKWidget as that may cause issues. One should let the QVTKWidget create the interactor and then call SetupInteractor().

Reimplemented in vtkSMComparativeViewProxy, and vtkSMPythonViewProxy.

◆ SetTransparentBackground()

static void vtkSMViewProxy::SetTransparentBackground ( bool  val)
static

Sets whether screenshots have a transparent background.

◆ GetTransparentBackground()

static bool vtkSMViewProxy::GetTransparentBackground ( )
static

Sets whether screenshots have a transparent background.

◆ HideOtherRepresentationsIfNeeded() [1/2]

virtual bool vtkSMViewProxy::HideOtherRepresentationsIfNeeded ( vtkSMProxy repr)
virtual

Method used to hide other representations if the view has a <ShowOneRepresentationAtATime> hint.

This only affects other representations that have data inputs, not non-data representations. Returns true if any representations were hidden by this call, otherwise returns false.

◆ HideOtherRepresentationsIfNeeded() [2/2]

static bool vtkSMViewProxy::HideOtherRepresentationsIfNeeded ( vtkSMViewProxy self,
vtkSMProxy repr 
)
inlinestatic

Method used to hide other representations if the view has a <ShowOneRepresentationAtATime> hint.

This only affects other representations that have data inputs, not non-data representations. Returns true if any representations were hidden by this call, otherwise returns false.

Definition at line 200 of file vtkSMViewProxy.h.

◆ CaptureWindowInternal()

virtual vtkImageData* vtkSMViewProxy::CaptureWindowInternal ( int   vtkNotUsedmagnification)
inlineprotectedvirtual

Subclasses should override this method to do the actual image capture.

Definition at line 214 of file vtkSMViewProxy.h.

◆ PreRender()

virtual vtkTypeUInt32 vtkSMViewProxy::PreRender ( bool   vtkNotUsedinteractive)
inlineprotectedvirtual

Definition at line 216 of file vtkSMViewProxy.h.

◆ PostRender()

virtual void vtkSMViewProxy::PostRender ( bool   vtkNotUsedinteractive)
inlineprotectedvirtual

Definition at line 217 of file vtkSMViewProxy.h.

◆ IsContextReadyForRendering()

virtual bool vtkSMViewProxy::IsContextReadyForRendering ( )
protectedvirtual

Subclasses should override this method and return false if the rendering context is not ready for rendering at this moment.

This method is called in StillRender() and InteractiveRender() calls before the actual render to ensure that we don't attempt to render when the rendering context is not ready. Default implementation uses this->GetRenderWindow() and checks if that window is drawable.

◆ CreateVTKObjects()

virtual void vtkSMViewProxy::CreateVTKObjects ( )
protectedvirtual

◆ ReadXMLAttributes()

virtual int vtkSMViewProxy::ReadXMLAttributes ( vtkSMSessionProxyManager pm,
vtkPVXMLElement element 
)
protectedvirtual

Read attributes from an XML element.

Reimplemented from vtkSMProxy.

Reimplemented in vtkSMContextViewProxy.

◆ GetLocalProcessSupportsInteraction()

bool vtkSMViewProxy::GetLocalProcessSupportsInteraction ( )
protected

◆ SetDefaultRepresentationName()

virtual void vtkSMViewProxy::SetDefaultRepresentationName ( const char *  )
protectedvirtual

Member Data Documentation

◆ DefaultRepresentationName

char* vtkSMViewProxy::DefaultRepresentationName
protected

Definition at line 246 of file vtkSMViewProxy.h.

◆ Enable

bool vtkSMViewProxy::Enable
protected

Definition at line 249 of file vtkSMViewProxy.h.


The documentation for this class was generated from the following file: