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

Proxy for a representations. More...

#include <vtkSMRepresentationProxy.h>

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

Public Types

typedef vtkSMSourceProxy Superclass
 
- Public Types inherited from vtkSMSourceProxy
enum  ProcessSupportType { SINGLE_PROCESS, MULTIPLE_PROCESSES, BOTH }
 
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
 
virtual vtkPVDataInformationGetRepresentedDataInformation ()
 Returns information about the data that is finally rendered by this representation. More...
 
void UpdatePipeline () override
 Calls Update() on all sources. More...
 
void UpdatePipeline (double time) override
 Calls Update() on all sources with the given time request. More...
 
void PostUpdateData (bool) override
 Overridden to reset this->MarkedModified flag. More...
 
virtual void ViewUpdated (vtkSMProxy *view)
 Called after the view updates. More...
 
vtkTypeUInt32 GetGlobalID () override
 Overridden to reserve additional IDs for use by internal composite representation. More...
 
void MarkDirty (vtkSMProxy *modifiedProxy) override
 Marks the selection proxies dirty as well as chain to superclass. More...
 
virtual vtkPVProminentValuesInformationGetProminentValuesInformation (std::string name, int fieldAssoc, int numComponents, double uncertaintyAllowed=1e-6, double fraction=1e-3, bool force=false)
 Returns information about a specific array component's prominent values (or nullptr). More...
 
virtual vtkPVProminentValuesInformationGetBlockProminentValuesInformation (std::string blockSelector, std::string assemblyName, std::string name, int fieldAssoc, int numComponents, double uncertaintyAllowed=1e-6, double fraction=1e-3, bool force=false)
 Returns information about a specific array component's prominent values (or nullptr). More...
 
- Public Member Functions inherited from vtkSMSourceProxy
void UpdatePipelineInformation () override
 Calls UpdateInformation() on all sources. More...
 
virtual unsigned int GetNumberOfOutputPorts ()
 Return the number of output ports. More...
 
virtual vtkSMOutputPortGetOutputPort (unsigned int idx)
 Return an output port. More...
 
virtual vtkSMOutputPortGetOutputPort (const char *portname)
 Return an output port, given the name for the port. More...
 
virtual unsigned int GetOutputPortIndex (const char *portname)
 Returns the port index, given the name of an output port. More...
 
virtual const char * GetOutputPortName (unsigned int index)
 Returns the output port name given its index. More...
 
virtual void CreateOutputPorts ()
 Creates the output port proxies for this filter. More...
 
vtkPVDataInformationGetSubsetDataInformation (unsigned int outputIdx, unsigned int compositeIndex)
 A GetSubsetDataInformation overload that uses composite index. More...
 
virtual void CreateSelectionProxies ()
 Creates extract selection proxies for each output port if not already created. More...
 
void SetSelectionInput (unsigned int portIndex, vtkSMSourceProxy *input, unsigned int outputPort)
 Set/Get the selection input. More...
 
void CleanSelectionInputs (unsigned int portIndex)
 Clean all selection inputs for the given port. More...
 
vtkSMSourceProxyGetSelectionOutput (unsigned int portIndex)
 Returns the source proxy which provides the selected data from the given output port. More...
 
unsigned int GetNumberOfAlgorithmOutputPorts ()
 Returns the number of output ports provided by the algorithm. More...
 
virtual unsigned int GetNumberOfAlgorithmRequiredInputPorts ()
 Returns the number of non-optional input ports required by the algorithm. More...
 
virtual int GetOutputPortsCreated ()
 Returns if the output port proxies have been created. More...
 
vtkSMDocumentationGetOutputPortDocumentation (unsigned int index)
 It is possible to provide some documentation for each output port in the configuration xml. More...
 
vtkSMDocumentationGetOutputPortDocumentation (const char *portname)
 It is possible to provide some documentation for each output port in the configuration xml. More...
 
vtkPVDataInformationGetDataInformation ()
 DataInformation is used by the source proxy to obtain information on the output(s) from the server. More...
 
vtkPVDataInformationGetDataInformation (unsigned int outputIdx)
 DataInformation is used by the source proxy to obtain information on the output(s) from the server. More...
 
vtkPVDataInformationGetSubsetDataInformation (unsigned int outputIdx, const char *selector, const char *assemblyName=nullptr)
 For composite datasets, GetDataInformation returns summary data information for all blocks combined. More...
 
vtkPVDataInformationGetRankDataInformation (int rank)
 Get rank-specific data information. More...
 
vtkPVDataInformationGetRankDataInformation (unsigned int outputIdx, int rank)
 Get rank-specific data information. More...
 
vtkSMSourceProxyGetSelectionInput (unsigned int portIndex)
 API to query selection input set using SetSelectionInput. More...
 
unsigned int GetSelectionInputPort (unsigned int portIndex)
 API to query selection input set using SetSelectionInput. More...
 
virtual int GetProcessSupport ()
 This returns information about whether the VTK algorithm supports multiple processes or not. More...
 
virtual bool GetMPIRequired ()
 This returns information about whether the VTK algorithm explicitly needs MPI to be initialized. 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...
 
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 GetPropertiesModified ()
 
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...
 
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 vtkSMRepresentationProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMRepresentationProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSourceProxy
static vtkSMSourceProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSourceProxySafeDownCast (vtkObject *o)
 
- 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 std::string CreatePrettyLabel (const std::string &name)
 Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...
 
- 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

 vtkSMRepresentationProxy ()
 
 ~vtkSMRepresentationProxy () override
 
void MarkDirtyFromProducer (vtkSMProxy *modifiedProxy, vtkSMProxy *producer, vtkSMProperty *property) override
 When the representation is being marked dirty due to a producer i.e. More...
 
void AddConsumer (vtkSMProperty *property, vtkSMProxy *proxy) override
 Called by a proxy property, this adds the property,proxy pair to the list of consumers. More...
 
void RemoveConsumer (vtkSMProperty *property, vtkSMProxy *proxy) override
 Remove the property,proxy pair from the list of consumers. More...
 
void RemoveAllConsumers () override
 Remove all consumers. More...
 
void CreateVTKObjects () override
 Call superclass' and then assigns a new executive (vtkCompositeDataPipeline) More...
 
void OnVTKRepresentationUpdated ()
 
void OnVTKRepresentationUpdateSkipped ()
 
void OnVTKRepresentationUpdateTimeChanged ()
 
virtual void UpdatePipelineInternal (double time, bool doTime)
 
void InvalidateDataInformation () override
 Mark the data information as invalid. More...
 
int LoadXMLState (vtkPVXMLElement *element, vtkSMProxyLocator *locator) override
 Overridden to restore this->Servers flag state. More...
 
- Protected Member Functions inherited from vtkSMSourceProxy
 vtkSMSourceProxy ()
 
 ~vtkSMSourceProxy () override
 
virtual void SetExecutiveName (const char *)
 
int ReadXMLAttributes (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element) override
 Read attributes from an XML element. More...
 
void SetLogNameInternal (const char *name, bool propagate_to_subproxies, bool propagate_to_proxylistdomains) override
 Overridden to pass the logname to the internal ExtractSelection proxies. More...
 
void SetOutputPort (unsigned int index, const char *name, vtkSMOutputPort *port, vtkSMDocumentation *doc)
 Method to set an output port at the given index. More...
 
void RemoveAllOutputPorts ()
 Method to set an output port at the given index. More...
 
void SetExtractSelectionProxy (unsigned int index, vtkSMSourceProxy *proxy)
 Method to set an output port at the given index. More...
 
void RemoveAllExtractSelectionProxies ()
 Method to set an output port at the given index. More...
 
- 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...
 
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...
 
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...
 
void PostUpdateDataSelfOnly (bool using_cache)
 This is called by PostUpdateData to only update state for this proxy without iterative over producers. More...
 
bool WarnIfDeprecated ()
 If a proxy is deprecated, prints a warning. 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=nullptr)
 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...
 
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 &)
 

Friends

class vtkPVComparativeViewNS::vtkCloningVectorOfRepresentations
 
static bool SetRepresentationType (vtkSMProxy *repr, const char *type)
 Set the representation type. More...
 
static const char * GetRepresentationType (vtkSMProxy *repr)
 Set the representation type. More...
 
virtual bool SetRepresentationType (const char *type)
 Set the representation type. More...
 
const char * GetRepresentationType ()
 Set the representation type. More...
 
static bool IsVolumeRendering (vtkSMProxy *repr)
 Convenient method to check if this representation is currently rendering volumes, using 2D Transfer function. More...
 
static bool GetUsing2DTransferFunction (vtkSMProxy *repr)
 Convenient method to check if this representation is currently rendering volumes, using 2D Transfer function. More...
 
bool IsVolumeRendering ()
 Convenient method to check if this representation is currently rendering volumes, using 2D Transfer function. More...
 
bool GetUsing2DTransferFunction ()
 Convenient method to check if this representation is currently rendering volumes, using 2D Transfer function. More...
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMSourceProxy
int OutputPortsCreated
 
int ProcessSupport
 
bool MPIRequired
 
char * ExecutiveName
 
bool DisableSelectionProxies
 
bool SelectionProxiesCreated
 
- 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

Proxy for a representations.

vtkSMRepresentationProxy is a vtkSMSourceProxy subclass that is designed to be used either directly or as a superclass for "data" representations i.e. representation that have an input (as against proxies for annotations such as 3D widgets).

Special handling of `MarkDirty`

vtkSMProxy::MarkDirty is a mechanism that ParaView uses to know on the client side (i.e. in the server-manager layer) when a pipeline on the server side is "dirty" or has potential to execute on an update causing things like data information to be invalidated. Simply speaking, when a property on a vtkSMProxy is modified and pushed (using vtkSMProxy::UpdateVTKObjects or vtkSMProxy::UpdateProperty), it calls this->MarkDirty(this). vtkSMProxy::MarkDirty invokes vtkSMProxy::MarkConsumersAsDirty which results in any consumers of this dirtied proxy also getting the notification. Consumers (and conversely producers) are setup via ProxyProperty and InputProperty connections. For standard data processing pipelines, this mechanism works quite well. Consider a filter proxy, say Clip, which has an input set via a InputProperty and a implicit function set via a ProxyProperty. If either the input or the implicit function is modified, it is reasonable to expect the Clip filter to re-execute on an UpdatePipeline call. Whether the call will truly cause the VTK pipeline (server side) to execute is not that important. The pipeline may not re-execute and that's not a big deal.

Things get a little complicated for representations, however. Data representations don't necessary have valid input connections on all processes where their VTK objects are present (note, representations create VTK objects on all process while data input is only available on the data server nodes). As a result representations have to be explicitly told to re-execute following upstream changes since they cannot rely on their VTK-level upstream. Re-executing a representation means regenerating the geometry or data artifacts for rendering, redelivering them to the rendering nodes, etc. It can also mean cleaning up any caches the representation built for flip-book animation support. In other words, re-executing a representation is non-trivial task. Thus, we want do it only when absolutely needed.

The explicit pipeline update is often referred to as "update suppression" and handled by vtkPVDataRepresentation and vtkPVDataRepresentationPipeline. In short, calling Update on vtkPVDataRepresentation has no effect unless vtkPVDataRepresentation::MarkModified was explicitly called at some point since the last Update.

To explicitly call vtkPVDataRepresentation::MarkModified for only those cases where the representation must be re-executed, we follow the following strategy.

Definition at line 78 of file vtkSMRepresentationProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 82 of file vtkSMRepresentationProxy.h.

Constructor & Destructor Documentation

◆ vtkSMRepresentationProxy()

vtkSMRepresentationProxy::vtkSMRepresentationProxy ( )
protected

◆ ~vtkSMRepresentationProxy()

vtkSMRepresentationProxy::~vtkSMRepresentationProxy ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMRepresentationProxy* vtkSMRepresentationProxy::New ( )
static

◆ GetClassName()

virtual const char* vtkSMRepresentationProxy::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkSMSourceProxy.

Reimplemented in vtkSMSpreadSheetRepresentationProxy.

◆ GetRepresentedDataInformation()

virtual vtkPVDataInformation* vtkSMRepresentationProxy::GetRepresentedDataInformation ( )
virtual

Returns information about the data that is finally rendered by this representation.

◆ GetProminentValuesInformation()

virtual vtkPVProminentValuesInformation* vtkSMRepresentationProxy::GetProminentValuesInformation ( std::string  name,
int  fieldAssoc,
int  numComponents,
double  uncertaintyAllowed = 1e-6,
double  fraction = 1e-3,
bool  force = false 
)
virtual

Returns information about a specific array component's prominent values (or nullptr).

The name, fieldAssoc, and numComponents arguments specify which arrays on the input dataset to examine. Because multiblock datasets may have multiple arrays of the same name on different blocks, and these arrays may not have the same storage type or number of components, this method requires you to specify the number of components per tuple the array(s) of interest must have. You may call GetRepresentedDataInformation() to obtain the number of components for any array.

See vtkAbstractArray::GetProminentComponentValues for more information about the uncertaintyAllowed and fraction arguments.

◆ GetBlockProminentValuesInformation()

virtual vtkPVProminentValuesInformation* vtkSMRepresentationProxy::GetBlockProminentValuesInformation ( std::string  blockSelector,
std::string  assemblyName,
std::string  name,
int  fieldAssoc,
int  numComponents,
double  uncertaintyAllowed = 1e-6,
double  fraction = 1e-3,
bool  force = false 
)
virtual

Returns information about a specific array component's prominent values (or nullptr).

The name, fieldAssoc, and numComponents arguments specify which arrays on the input dataset to examine. Because multiblock datasets may have multiple arrays of the same name on different blocks, and these arrays may not have the same storage type or number of components, this method requires you to specify the number of components per tuple the array(s) of interest must have. You may call GetRepresentedDataInformation() to obtain the number of components for any array.

See vtkAbstractArray::GetProminentComponentValues for more information about the uncertaintyAllowed and fraction arguments.

◆ UpdatePipeline() [1/2]

void vtkSMRepresentationProxy::UpdatePipeline ( )
overridevirtual

Calls Update() on all sources.

It also creates output ports if they are not already created.

Reimplemented from vtkSMSourceProxy.

◆ UpdatePipeline() [2/2]

void vtkSMRepresentationProxy::UpdatePipeline ( double  time)
overridevirtual

Calls Update() on all sources with the given time request.

It also creates output ports if they are not already created.

Reimplemented from vtkSMSourceProxy.

◆ PostUpdateData()

void vtkSMRepresentationProxy::PostUpdateData ( bool  )
overridevirtual

Overridden to reset this->MarkedModified flag.

Reimplemented from vtkSMSourceProxy.

◆ ViewUpdated()

virtual void vtkSMRepresentationProxy::ViewUpdated ( vtkSMProxy view)
virtual

Called after the view updates.

Reimplemented in vtkSMPVRepresentationProxy.

◆ GetGlobalID()

vtkTypeUInt32 vtkSMRepresentationProxy::GetGlobalID ( )
overridevirtual

Overridden to reserve additional IDs for use by internal composite representation.

Reimplemented from vtkSMSourceProxy.

◆ SetRepresentationType() [1/2]

virtual bool vtkSMRepresentationProxy::SetRepresentationType ( const char *  type)
virtual

Set the representation type.

Default implementation simply updates the "Representation" property, if present with the value provided. Subclasses can override this method to add custom logic to manage the representation state to support the change e.g. pick a scalar color array when switching to Volume or Slice representation, for example. Returns true, if the change was successful, otherwise returns false.

Reimplemented in vtkSMPVRepresentationProxy.

◆ SetRepresentationType() [2/2]

static bool vtkSMRepresentationProxy::SetRepresentationType ( vtkSMProxy repr,
const char *  type 
)
inlinestatic

Set the representation type.

Default implementation simply updates the "Representation" property, if present with the value provided. Subclasses can override this method to add custom logic to manage the representation state to support the change e.g. pick a scalar color array when switching to Volume or Slice representation, for example. Returns true, if the change was successful, otherwise returns false.

Definition at line 153 of file vtkSMRepresentationProxy.h.

◆ GetRepresentationType() [1/2]

const char* vtkSMRepresentationProxy::GetRepresentationType ( )

Set the representation type.

Default implementation simply updates the "Representation" property, if present with the value provided. Subclasses can override this method to add custom logic to manage the representation state to support the change e.g. pick a scalar color array when switching to Volume or Slice representation, for example. Returns true, if the change was successful, otherwise returns false.

◆ GetRepresentationType() [2/2]

static const char* vtkSMRepresentationProxy::GetRepresentationType ( vtkSMProxy repr)
inlinestatic

Set the representation type.

Default implementation simply updates the "Representation" property, if present with the value provided. Subclasses can override this method to add custom logic to manage the representation state to support the change e.g. pick a scalar color array when switching to Volume or Slice representation, for example. Returns true, if the change was successful, otherwise returns false.

Definition at line 159 of file vtkSMRepresentationProxy.h.

◆ IsVolumeRendering() [1/2]

static bool vtkSMRepresentationProxy::IsVolumeRendering ( vtkSMProxy repr)
inlinestatic

Convenient method to check if this representation is currently rendering volumes, using 2D Transfer function.

Definition at line 171 of file vtkSMRepresentationProxy.h.

◆ IsVolumeRendering() [2/2]

bool vtkSMRepresentationProxy::IsVolumeRendering ( )

Convenient method to check if this representation is currently rendering volumes, using 2D Transfer function.

◆ GetUsing2DTransferFunction() [1/2]

static bool vtkSMRepresentationProxy::GetUsing2DTransferFunction ( vtkSMProxy repr)
inlinestatic

Convenient method to check if this representation is currently rendering volumes, using 2D Transfer function.

Definition at line 177 of file vtkSMRepresentationProxy.h.

◆ GetUsing2DTransferFunction() [2/2]

bool vtkSMRepresentationProxy::GetUsing2DTransferFunction ( )

Convenient method to check if this representation is currently rendering volumes, using 2D Transfer function.

◆ MarkDirty()

void vtkSMRepresentationProxy::MarkDirty ( vtkSMProxy modifiedProxy)
overridevirtual

Marks the selection proxies dirty as well as chain to superclass.

Reimplemented from vtkSMSourceProxy.

◆ MarkDirtyFromProducer()

void vtkSMRepresentationProxy::MarkDirtyFromProducer ( vtkSMProxy modifiedProxy,
vtkSMProxy producer,
vtkSMProperty property 
)
overrideprotectedvirtual

When the representation is being marked dirty due to a producer i.e.

a proxy-property input-property connection, we need to decide if the representation's data pipeline is indeed invalidated or is this simply a "rendering" change. We override this method to make that distinction.

Reimplemented from vtkSMProxy.

◆ AddConsumer()

void vtkSMRepresentationProxy::AddConsumer ( vtkSMProperty property,
vtkSMProxy proxy 
)
overrideprotectedvirtual

Called by a proxy property, this adds the property,proxy pair to the list of consumers.

Reimplemented from vtkSMProxy.

◆ RemoveConsumer()

void vtkSMRepresentationProxy::RemoveConsumer ( vtkSMProperty property,
vtkSMProxy proxy 
)
overrideprotectedvirtual

Remove the property,proxy pair from the list of consumers.

Reimplemented from vtkSMProxy.

◆ RemoveAllConsumers()

void vtkSMRepresentationProxy::RemoveAllConsumers ( )
overrideprotectedvirtual

Remove all consumers.

Reimplemented from vtkSMProxy.

◆ CreateVTKObjects()

void vtkSMRepresentationProxy::CreateVTKObjects ( )
overrideprotectedvirtual

Call superclass' and then assigns a new executive (vtkCompositeDataPipeline)

Reimplemented from vtkSMSourceProxy.

◆ OnVTKRepresentationUpdated()

void vtkSMRepresentationProxy::OnVTKRepresentationUpdated ( )
protected

◆ OnVTKRepresentationUpdateSkipped()

void vtkSMRepresentationProxy::OnVTKRepresentationUpdateSkipped ( )
protected

◆ OnVTKRepresentationUpdateTimeChanged()

void vtkSMRepresentationProxy::OnVTKRepresentationUpdateTimeChanged ( )
protected

◆ UpdatePipelineInternal()

virtual void vtkSMRepresentationProxy::UpdatePipelineInternal ( double  time,
bool  doTime 
)
protectedvirtual

◆ InvalidateDataInformation()

void vtkSMRepresentationProxy::InvalidateDataInformation ( )
overrideprotectedvirtual

Mark the data information as invalid.

Reimplemented from vtkSMSourceProxy.

◆ LoadXMLState()

int vtkSMRepresentationProxy::LoadXMLState ( vtkPVXMLElement element,
vtkSMProxyLocator locator 
)
overrideprotectedvirtual

Overridden to restore this->Servers flag state.

Reimplemented from vtkSMProxy.

Friends And Related Function Documentation

◆ vtkPVComparativeViewNS::vtkCloningVectorOfRepresentations

friend class vtkPVComparativeViewNS::vtkCloningVectorOfRepresentations
friend

Definition at line 243 of file vtkSMRepresentationProxy.h.


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