Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSMComparativeViewProxy Class Reference

view for comparative visualization/ film-strips. More...

#include <vtkSMComparativeViewProxy.h>

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

Public Types

typedef vtkSMViewProxy Superclass
 
- Public Types inherited from vtkSMViewProxy
enum  { PrepareContextForRendering = vtkCommand::UserEvent + 1 }
 
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) override
 
void Update () override
 Updates the data pipelines for all visible representations. More...
 
void GetViews (vtkCollection *collection)
 Get all the internal views. More...
 
vtkSMViewProxyGetRootView ()
 Returns the root view proxy. More...
 
void MarkDirty (vtkSMProxy *modifiedProxy) override
 Dirty means this algorithm will execute during next update. More...
 
const char * GetRepresentationType (vtkSMSourceProxy *producer, int outputPort) override
 Overridden to forward the call to the internal root view proxy. More...
 
vtkRenderWindowGetRenderWindow () override
 Returns the render-window used by the root view, if any. More...
 
vtkRenderWindowInteractorGetInteractor () override
 Returns the interactor. More...
 
void SetupInteractor (vtkRenderWindowInteractor *iren) override
 To avoid misuse of this method for comparative views, this method will raise an error. More...
 
bool MakeRenderWindowInteractor (bool quiet=false) override
 Overridden to call MakeRenderWindowInteractor() on each of the internal views. More...
 
- Public Member Functions inherited from vtkSMViewProxy
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void StillRender ()
 Renders the view using full resolution. More...
 
virtual void InteractiveRender ()
 Renders the view using lower resolution is possible. 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 vtkSMRepresentationProxyFindRepresentation (vtkSMSourceProxy *producer, int outputPort)
 Finds the representation proxy showing the data produced by the provided producer, if any. More...
 
vtkViewGetClientSideView ()
 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...
 
int WriteImage (const char *filename, const char *writerName, int magnificationX, int magnificationY)
 
virtual bool HasDirtyRepresentation ()
 Return true any internal representation is dirty. 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...
 
vtkImageDataCaptureWindow (int magnification)
 Captures a image from this view. More...
 
vtkImageDataCaptureWindow (int magnificationX, int magnificationY)
 Captures a image from this view. More...
 
virtual bool GetNeedsUpdate ()
 Returns true if the subsequent call to Update() will result in an actual update. More...
 
virtual bool HideOtherRepresentationsIfNeeded (vtkSMProxy *repr)
 Method used to hide other representations if the view has a <ShowOneRepresentationAtATime/> hint. More...
 
virtual void RepresentationVisibilityChanged (vtkSMProxy *repr, bool new_visibility)
 Certain views maintain properties (or other state) that should be updated when visibility of representations is changed e.g. More...
 
- Public Member Functions inherited from vtkSMProxy
void SetAnnotation (const char *key, const char *value)
 
const char * GetAnnotation (const char *key)
 Retrieve 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...
 
void SetLocation (vtkTypeUInt32) override
 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 modified 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 information 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...
 
vtkObjectBaseGetClientSideObject ()
 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...
 
void EnableLocalPushOnly () override
 Allow to switch off any push of state change to the server for that particular object. More...
 
void DisableLocalPushOnly () override
 Enable the given remote object to communicate its state normally to the server location. More...
 
const vtkSMMessageGetFullState () override
 This method return the full object state that can be used to create that object from scratch. More...
 
void LoadState (const vtkSMMessage *msg, vtkSMProxyLocator *locator) override
 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...
 
const char * GetLogNameOrDefault ()
 A helper that makes up an default name if none is provided. 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 ()
 Returns 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...
 
void PrototypeOn () override
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
void PrototypeOff () override
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
void SetPrototype (bool undo) override
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
void SetLogName (const char *name)
 Log name is a name for this proxy that will be used when logging status messages. More...
 
virtual char * GetLogName ()
 Log name is a name for this proxy that will be used when logging status messages. More...
 
- Public Member Functions inherited from vtkSMRemoteObject
void SetSession (vtkSMSession *) override
 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
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 vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSMComparativeViewProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMComparativeViewProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMViewProxy
static vtkSMViewProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMViewProxySafeDownCast (vtkObject *o)
 
static vtkSMViewProxyFindView (vtkSMProxy *repr, const char *reggroup="views")
 Helper method to locate a view to which the representation has been added. More...
 
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 bool HideOtherRepresentationsIfNeeded (vtkSMViewProxy *self, vtkSMProxy *repr)
 Method used to hide other representations if the view has a <ShowOneRepresentationAtATime/> hint. More...
 
static void RepresentationVisibilityChanged (vtkSMViewProxy *self, vtkSMProxy *repr, bool new_visibility)
 Certain views maintain properties (or other state) that should be updated when visibility of representations is changed e.g. 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)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMComparativeViewProxy ()
 
 ~vtkSMComparativeViewProxy () override
 
vtkImageDataCaptureWindowInternal (int magX, int magY) override
 Overridden to do the capturing of images from each of the internal views and then stitching them together. More...
 
void InvokeConfigureEvent ()
 
void CreateVTKObjects () override
 Given a class name (by setting VTKClassName) and server ids (by setting ServerIDs), this methods instantiates the objects on the server(s) More...
 
- Protected Member Functions inherited from vtkSMViewProxy
 vtkSMViewProxy ()
 
 ~vtkSMViewProxy () override
 
virtual void RenderForImageCapture ()
 This method is called whenever the view wants to render to during image capture. More...
 
virtual vtkTypeUInt32 PreRender (bool vtkNotUsed(interactive))
 This method is called before executing code that could cause a render on the underlying vtkPVView. More...
 
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...
 
void CreateVTKObjects () override
 Called at the end of CreateVTKObjects(). More...
 
int ReadXMLAttributes (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element) override
 Read attributes from an XML element. More...
 
bool GetLocalProcessSupportsInteraction ()
 Convenience method to call vtkPVView::SafeDownCast(this->GetClientSideObject())->GetLocalProcessSupportsInteraction();. More...
 
virtual vtkSMDataDeliveryManagerProxyGetDeliveryManager ()
 Provides access to the delivery manager proxy, if any. More...
 
virtual void SetDefaultRepresentationName (const char *)
 
- Protected Member Functions inherited from vtkSMProxy
 vtkSMProxy ()
 
 ~vtkSMProxy () override
 
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 MarkDirtyFromProducer on all consumers. More...
 
virtual void MarkDirtyFromProducer (vtkSMProxy *modifiedProxy, vtkSMProxy *producer, vtkSMProperty *property)
 MarkConsumersAsDirty calls this method on each consumer, instead of directly calling MarkDirty on the consumer. More...
 
void MarkInputsAsDirty ()
 This method is called by vtkSMRepresentationProxy whenever the time request for the pipeline may have potentially changed. 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 (bool using_cache)
 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 AppendPropertyGroup (vtkSMPropertyGroup *group)
 Adds a property groups. 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...
 
void RebuildStateForProperties ()
 vtkSMProxy tracks state of properties on this proxy in an internal State object. More...
 
virtual void SetLogNameInternal (const char *name, bool propagate_to_subproxies, bool propagate_to_proxylistdomains)
 Internal method used by SetLogName 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 &)=delete
 
void operator= (const vtkSMProxy &)=delete
 
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...
 
 ~vtkSMRemoteObject () override
 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 () override
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMViewProxy
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
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

view for comparative visualization/ film-strips.

vtkSMComparativeViewProxy is the view used to generate/view comparative visualizations/film-strips. vtkSMComparativeViewProxy works together with vtkPVComparativeView – the vtk-object for which this represents the proxy. vtkPVComparativeView is a client-side VTK object which literally uses the view and representation proxies to simulate the comparative view. Refer to vtkPVComparativeView for details.

Definition at line 36 of file vtkSMComparativeViewProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkSMComparativeViewProxy.h.

Constructor & Destructor Documentation

◆ vtkSMComparativeViewProxy()

vtkSMComparativeViewProxy::vtkSMComparativeViewProxy ( )
protected

◆ ~vtkSMComparativeViewProxy()

vtkSMComparativeViewProxy::~vtkSMComparativeViewProxy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMComparativeViewProxy* vtkSMComparativeViewProxy::New ( )
static

◆ GetClassName()

virtual const char* vtkSMComparativeViewProxy::GetClassName ( )
virtual

Reimplemented from vtkSMViewProxy.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMViewProxy.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMComparativeViewProxy::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSMProxy.

◆ Update()

void vtkSMComparativeViewProxy::Update ( )
overridevirtual

Updates the data pipelines for all visible representations.

Reimplemented from vtkSMViewProxy.

◆ GetViews()

void vtkSMComparativeViewProxy::GetViews ( vtkCollection collection)

Get all the internal views.

The views should only be used to be laid out by the GUI. It's not recommended to directly change the properties of the views.

◆ GetRootView()

vtkSMViewProxy* vtkSMComparativeViewProxy::GetRootView ( )

Returns the root view proxy.

◆ MarkDirty()

void vtkSMComparativeViewProxy::MarkDirty ( vtkSMProxy modifiedProxy)
overridevirtual

Dirty means this algorithm will execute during next update.

This all marks all consumers as dirty.

Reimplemented from vtkSMProxy.

◆ GetRepresentationType()

const char* vtkSMComparativeViewProxy::GetRepresentationType ( vtkSMSourceProxy producer,
int  outputPort 
)
overridevirtual

Overridden to forward the call to the internal root view proxy.

Reimplemented from vtkSMViewProxy.

◆ GetRenderWindow()

vtkRenderWindow* vtkSMComparativeViewProxy::GetRenderWindow ( )
inlineoverridevirtual

Returns the render-window used by the root view, if any.

Reimplemented from vtkSMViewProxy.

Definition at line 74 of file vtkSMComparativeViewProxy.h.

◆ GetInteractor()

vtkRenderWindowInteractor* vtkSMComparativeViewProxy::GetInteractor ( )
inlineoverridevirtual

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 from vtkSMViewProxy.

Definition at line 78 of file vtkSMComparativeViewProxy.h.

◆ SetupInteractor()

void vtkSMComparativeViewProxy::SetupInteractor ( vtkRenderWindowInteractor iren)
overridevirtual

To avoid misuse of this method for comparative views, this method will raise an error.

Client code should set up interactor for each of the internal views explicitly.

Reimplemented from vtkSMViewProxy.

◆ MakeRenderWindowInteractor()

bool vtkSMComparativeViewProxy::MakeRenderWindowInteractor ( bool  quiet = false)
overridevirtual

Overridden to call MakeRenderWindowInteractor() on each of the internal views.

Reimplemented from vtkSMViewProxy.

◆ CaptureWindowInternal()

vtkImageData* vtkSMComparativeViewProxy::CaptureWindowInternal ( int  magX,
int  magY 
)
overrideprotectedvirtual

Overridden to do the capturing of images from each of the internal views and then stitching them together.

Reimplemented from vtkSMViewProxy.

◆ InvokeConfigureEvent()

void vtkSMComparativeViewProxy::InvokeConfigureEvent ( )
protected

◆ CreateVTKObjects()

void vtkSMComparativeViewProxy::CreateVTKObjects ( )
overrideprotectedvirtual

Given a class name (by setting VTKClassName) and server ids (by setting ServerIDs), this methods instantiates the objects on the server(s)

Reimplemented from vtkSMProxy.


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