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

representation for "Render View" like views in ParaView. More...

#include <vtkSMPVRepresentationProxy.h>

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

Public Types

typedef vtkSMRepresentationProxy Superclass
 
- Public Types inherited from vtkSMRepresentationProxy
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)
 
virtual bool GetUsingScalarColoring ()
 Returns true if scalar coloring is enabled. More...
 
virtual bool SetScalarColoring (const char *arrayname, int attribute_type)
 Enable/disable scalar coloring using the specified array. More...
 
virtual bool SetScalarColoring (const char *arrayname, int attribute_type, int component)
 Enable/disable scalar coloring using the specified array. More...
 
virtual bool RescaleTransferFunctionToDataRange (bool extend=false, bool force=true)
 Rescales the color transfer function and opacity transfer function using the current data range. More...
 
virtual bool RescaleTransferFunctionToDataRange (const char *arrayname, int attribute_type, bool extend=false, bool force=true)
 Rescales the color transfer function and opacity transfer function using the current data range for the chosen data-array. More...
 
virtual bool RescaleTransferFunctionToDataRangeOverTime ()
 Rescales the color transfer function and opacity transfer function using the current data range over time. More...
 
virtual bool RescaleTransferFunctionToDataRangeOverTime (const char *arrayname, int attribute_type)
 Rescales the color transfer function and opacity transfer function using the current data range over time for the chosen data-array. More...
 
virtual bool SetRepresentationType (const char *type)
 Overridden to ensure when picking representation types that require scalar colors, scalar coloring it setup properly. More...
 
virtual bool RescaleTransferFunctionToVisibleRange (vtkSMProxy *view)
 Rescales the color transfer function and the opacity transfer function using the current data range, limited to the currernt visible elements. More...
 
virtual bool RescaleTransferFunctionToVisibleRange (vtkSMProxy *view, const char *arrayname, int attribute_type)
 Rescales the color transfer function and the opacity transfer function using the current data range, limited to the currernt visible elements. More...
 
- Public Member Functions inherited from vtkSMRepresentationProxy
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void MarkDirty (vtkSMProxy *modifiedProxy)
 Calls MarkDirty() and invokes ModifiedEvent. More...
 
virtual vtkPVDataInformationGetRepresentedDataInformation ()
 Returns information about the data that is finally rendered by this representation. More...
 
virtual vtkPVProminentValuesInformationGetProminentValuesInformation (vtkStdString name, int fieldAssoc, int numComponents, double uncertaintyAllowed=1e-6, double fraction=1e-3)
 Returns information about a specific array component's prominent values (or NULL). More...
 
virtual void UpdatePipeline ()
 Calls Update() on all sources. More...
 
virtual void UpdatePipeline (double time)
 Calls Update() on all sources with the given time request. More...
 
virtual void PostUpdateData ()
 Overridden to reset this->MarkedModified flag. More...
 
virtual void ViewUpdated (vtkSMProxy *view)
 Called after the view updates. More...
 
virtual vtkTypeUInt32 GetGlobalID ()
 Overridden to reserve additional IDs for use by internal composite representation. More...
 
- Public Member Functions inherited from vtkSMSourceProxy
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void UpdatePipelineInformation ()
 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...
 
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 configuraton xml. More...
 
vtkSMDocumentationGetOutputPortDocumentation (const char *portname)
 It is possible to provide some documentation for each output port in the configuraton 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...
 
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 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...
 
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...
 
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...
 
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 vtkSMPVRepresentationProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMPVRepresentationProxySafeDownCast (vtkObject *o)
 
static bool GetUsingScalarColoring (vtkSMProxy *proxy)
 Safely call GetUsingScalarColoring() after casting the proxy to appropriate type. More...
 
static bool SetScalarColoring (vtkSMProxy *proxy, const char *arrayname, int attribute_type)
 Safely call SetScalarColoring() after casting the proxy to the appropriate type. More...
 
static bool SetScalarColoring (vtkSMProxy *proxy, const char *arrayname, int attribute_type, int component)
 Safely call SetScalarColoring() after casting the proxy to the appropriate type, component version. More...
 
static bool RescaleTransferFunctionToDataRange (vtkSMProxy *proxy, bool extend=false, bool force=true)
 Safely call RescaleTransferFunctionToDataRange() after casting the proxy to appropriate type. More...
 
static bool RescaleTransferFunctionToDataRange (vtkSMProxy *proxy, const char *arrayname, int attribute_type, bool extend=false, bool force=true)
 Safely call RescaleTransferFunctionToDataRange() after casting the proxy to appropriate type. More...
 
static bool RescaleTransferFunctionToDataRangeOverTime (vtkSMProxy *proxy)
 Safely call RescaleTransferFunctionToDataRangeOverTime() after casting the proxy to appropriate type. More...
 
static bool RescaleTransferFunctionToDataRangeOverTime (vtkSMProxy *proxy, const char *arrayname, int attribute_type)
 Safely call RescaleTransferFunctionToDataRangeOverTime() after casting the proxy to appropriate type. More...
 
static bool RescaleTransferFunctionToVisibleRange (vtkSMProxy *proxy, vtkSMProxy *view)
 Safely call RescaleTransferFunctionToVisibleRange() after casting the proxy to the appropriate type. More...
 
static bool RescaleTransferFunctionToVisibleRange (vtkSMProxy *proxy, vtkSMProxy *view, const char *arrayname, int attribute_type)
 Safely call RescaleTransferFunctionToVisibleRange() after casting the proxy to the appropriate type. More...
 
- Static Public Member Functions inherited from vtkSMRepresentationProxy
static vtkSMRepresentationProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMRepresentationProxySafeDownCast (vtkObject *o)
 
static bool SetRepresentationType (vtkSMProxy *repr, const char *type)
 Set the representation type. More...
 
- 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)
 

Protected Member Functions

 vtkSMPVRepresentationProxy ()
 
 ~vtkSMPVRepresentationProxy ()
 
virtual bool RescaleTransferFunctionToDataRange (vtkPVArrayInformation *info, bool extend=false, bool force=true)
 Rescales transfer function ranges using the array information provided. More...
 
virtual void CreateVTKObjects ()
 Overridden to ensure that the RepresentationTypesInfo and Representations's domain are up-to-date. More...
 
void OnPropertyUpdated (vtkObject *, unsigned long, void *calldata)
 
virtual void SetPropertyModifiedFlag (const char *name, int flag)
 Overridden to ensure that whenever "Input" property changes, we update the "Input" properties for all internal representations (including setting up of the link to the extract-selection representation). More...
 
int ReadXMLAttributes (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element)
 Overridden to process "RepresentationType" elements. More...
 
virtual bool SetScalarColoringInternal (const char *arrayname, int attribute_type, bool useComponent, int component)
 Internal method to set scalar coloring, do not use directly. More...
 
- Protected Member Functions inherited from vtkSMRepresentationProxy
 vtkSMRepresentationProxy ()
 
 ~vtkSMRepresentationProxy ()
 
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 OnVTKRepresentationUpdated ()
 
virtual void UpdatePipelineInternal (double time, bool doTime)
 
virtual void InvalidateDataInformation ()
 Mark the data information as invalid. More...
 
virtual int LoadXMLState (vtkPVXMLElement *element, vtkSMProxyLocator *locator)
 Overridden to restore this->Servers flag state. More...
 
- Protected Member Functions inherited from vtkSMSourceProxy
 vtkSMSourceProxy ()
 
 ~vtkSMSourceProxy ()
 
virtual void SetExecutiveName (const char *)
 
void CreateOutputPortsInternal (vtkSMProxy *op)
 Internal method which creates the output port proxies using the proxy specified. 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 ()
 
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...
 
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...
 
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 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 ()
 
static bool SetScalarBarVisibility (vtkSMProxy *proxy, vtkSMProxy *view, bool visibile)
 Set the scalar bar visibility. More...
 
virtual bool SetScalarBarVisibility (vtkSMProxy *view, bool visibile)
 Set the scalar bar visibility. More...
 
static bool HideScalarBarIfNotNeeded (vtkSMProxy *repr, vtkSMProxy *view)
 While SetScalarBarVisibility can be used to hide a scalar bar, it will always simply hide the scalar bar even if its being used by some other representation. More...
 
virtual bool HideScalarBarIfNotNeeded (vtkSMProxy *view)
 While SetScalarBarVisibility can be used to hide a scalar bar, it will always simply hide the scalar bar even if its being used by some other representation. More...
 
static bool IsScalarBarVisible (vtkSMProxy *repr, vtkSMProxy *view)
 Check scalar bar visibility. More...
 
virtual bool IsScalarBarVisible (vtkSMProxy *view)
 Check scalar bar visibility. More...
 
static vtkPVArrayInformationGetArrayInformationForColorArray (vtkSMProxy *proxy)
 Returns the array information for the data array used for scalar coloring, if any. More...
 
virtual vtkPVArrayInformationGetArrayInformationForColorArray ()
 Returns the array information for the data array used for scalar coloring, if any. More...
 
static vtkPVProminentValuesInformationGetProminentValuesInformationForColorArray (vtkSMProxy *proxy, double uncertaintyAllowed=1e-6, double fraction=1e-3)
 Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any. More...
 
virtual vtkPVProminentValuesInformationGetProminentValuesInformationForColorArray (double uncertaintyAllowed=1e-6, double fraction=1e-3)
 Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any. 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
 

Detailed Description

representation for "Render View" like views in ParaView.

vtkSMPVRepresentationProxy combines surface representation and volume representation proxies typically used for displaying data. This class also takes over the selection obligations for all the internal representations, i.e. is disables showing of selection in all the internal representations, and manages it. This avoids duplicate execution of extract selection filter for each of the internal representations.

vtkSMPVRepresentationProxy is used for pretty much all of the data-representations (i.e. representations showing input data) in the render views. It provides helper functions for controlling transfer functions, scalar coloring, etc.

Definition at line 41 of file vtkSMPVRepresentationProxy.h.

Member Typedef Documentation

§ Superclass

Definition at line 46 of file vtkSMPVRepresentationProxy.h.

Constructor & Destructor Documentation

§ vtkSMPVRepresentationProxy()

vtkSMPVRepresentationProxy::vtkSMPVRepresentationProxy ( )
protected

§ ~vtkSMPVRepresentationProxy()

vtkSMPVRepresentationProxy::~vtkSMPVRepresentationProxy ( )
protected

Member Function Documentation

§ New()

static vtkSMPVRepresentationProxy* vtkSMPVRepresentationProxy::New ( )
static

§ GetClassName()

virtual const char* vtkSMPVRepresentationProxy::GetClassName ( )
virtual

Reimplemented from vtkSMRepresentationProxy.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMRepresentationProxy.

§ SafeDownCast()

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

§ PrintSelf()

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

§ GetUsingScalarColoring() [1/2]

virtual bool vtkSMPVRepresentationProxy::GetUsingScalarColoring ( )
virtual

Returns true if scalar coloring is enabled.

This checks whether a property named "ColorArrayName" exists and has a non-empty string. This does not check for the validity of the array.

§ GetUsingScalarColoring() [2/2]

static bool vtkSMPVRepresentationProxy::GetUsingScalarColoring ( vtkSMProxy proxy)
inlinestatic

Safely call GetUsingScalarColoring() after casting the proxy to appropriate type.

Definition at line 61 of file vtkSMPVRepresentationProxy.h.

§ SetScalarColoring() [1/4]

virtual bool vtkSMPVRepresentationProxy::SetScalarColoring ( const char *  arrayname,
int  attribute_type 
)
virtual

Enable/disable scalar coloring using the specified array.

This will set up a color and opacity transfer functions using vtkSMTransferFunctionProxy instance. If arrayname is NULL, then scalar coloring is turned off. attribute_type must be one of vtkDataObject::AttributeTypes.

§ SetScalarColoring() [2/4]

virtual bool vtkSMPVRepresentationProxy::SetScalarColoring ( const char *  arrayname,
int  attribute_type,
int  component 
)
virtual

Enable/disable scalar coloring using the specified array.

This will set up a color and opacity transfer functions using vtkSMTransferFunctionProxy instance. If arrayname is NULL, then scalar coloring is turned off. attribute_type must be one of vtkDataObject::AttributeTypes.

Parameters
componentenables choosing a component to color with, -1 will change to Magnitude, >=0 will change to corresponding component.

§ SetScalarColoring() [3/4]

static bool vtkSMPVRepresentationProxy::SetScalarColoring ( vtkSMProxy proxy,
const char *  arrayname,
int  attribute_type 
)
inlinestatic

Safely call SetScalarColoring() after casting the proxy to the appropriate type.

Definition at line 91 of file vtkSMPVRepresentationProxy.h.

§ SetScalarColoring() [4/4]

static bool vtkSMPVRepresentationProxy::SetScalarColoring ( vtkSMProxy proxy,
const char *  arrayname,
int  attribute_type,
int  component 
)
inlinestatic

Safely call SetScalarColoring() after casting the proxy to the appropriate type, component version.

Definition at line 103 of file vtkSMPVRepresentationProxy.h.

§ RescaleTransferFunctionToDataRange() [1/5]

virtual bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToDataRange ( bool  extend = false,
bool  force = true 
)
virtual

Rescales the color transfer function and opacity transfer function using the current data range.

Returns true if rescale was successful. If extend is true (false by default), the transfer function range will only be extended as needed to fit the data range. If force is false (true by default), then the transfer function range is not changed if locked.

Parameters
[in]extendExtend existing range instead of clamping to the new range (default: false).
[in]forceUpdate transfer function even if the range is locked (default: true).

§ RescaleTransferFunctionToDataRange() [2/5]

virtual bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToDataRange ( const char *  arrayname,
int  attribute_type,
bool  extend = false,
bool  force = true 
)
virtual

Rescales the color transfer function and opacity transfer function using the current data range for the chosen data-array.

Returns true if rescale was successful. field_association must be one of vtkDataObject::AttributeTypes. If extend is true (false by default), the transfer function range will only be extended as needed to fit the data range. If force is false (true by default), then the transfer function range is not changed if locked.

Parameters
[in]extendExtend existing range instead of clamping to the new range (default: false).
[in]forceUpdate transfer function even if the range is locked (default: true).

§ RescaleTransferFunctionToDataRange() [3/5]

static bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToDataRange ( vtkSMProxy proxy,
bool  extend = false,
bool  force = true 
)
inlinestatic

Safely call RescaleTransferFunctionToDataRange() after casting the proxy to appropriate type.

Definition at line 147 of file vtkSMPVRepresentationProxy.h.

§ RescaleTransferFunctionToDataRange() [4/5]

static bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToDataRange ( vtkSMProxy proxy,
const char *  arrayname,
int  attribute_type,
bool  extend = false,
bool  force = true 
)
inlinestatic

Safely call RescaleTransferFunctionToDataRange() after casting the proxy to appropriate type.

Definition at line 160 of file vtkSMPVRepresentationProxy.h.

§ RescaleTransferFunctionToDataRangeOverTime() [1/4]

virtual bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToDataRangeOverTime ( )
virtual

Rescales the color transfer function and opacity transfer function using the current data range over time.

Returns true if rescale was successful.

§ RescaleTransferFunctionToDataRangeOverTime() [2/4]

virtual bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToDataRangeOverTime ( const char *  arrayname,
int  attribute_type 
)
virtual

Rescales the color transfer function and opacity transfer function using the current data range over time for the chosen data-array.

Returns true if rescale was successful. field_association must be one of vtkDataObject::AttributeTypes,

§ RescaleTransferFunctionToDataRangeOverTime() [3/4]

static bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToDataRangeOverTime ( vtkSMProxy proxy)
inlinestatic

Safely call RescaleTransferFunctionToDataRangeOverTime() after casting the proxy to appropriate type.

Definition at line 189 of file vtkSMPVRepresentationProxy.h.

§ RescaleTransferFunctionToDataRangeOverTime() [4/4]

static bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToDataRangeOverTime ( vtkSMProxy proxy,
const char *  arrayname,
int  attribute_type 
)
inlinestatic

Safely call RescaleTransferFunctionToDataRangeOverTime() after casting the proxy to appropriate type.

Definition at line 201 of file vtkSMPVRepresentationProxy.h.

§ RescaleTransferFunctionToVisibleRange() [1/4]

virtual bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToVisibleRange ( vtkSMProxy view)
virtual

Rescales the color transfer function and the opacity transfer function using the current data range, limited to the currernt visible elements.

§ RescaleTransferFunctionToVisibleRange() [2/4]

virtual bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToVisibleRange ( vtkSMProxy view,
const char *  arrayname,
int  attribute_type 
)
virtual

Rescales the color transfer function and the opacity transfer function using the current data range, limited to the currernt visible elements.

§ RescaleTransferFunctionToVisibleRange() [3/4]

static bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToVisibleRange ( vtkSMProxy proxy,
vtkSMProxy view 
)
inlinestatic

Safely call RescaleTransferFunctionToVisibleRange() after casting the proxy to the appropriate type.

Definition at line 225 of file vtkSMPVRepresentationProxy.h.

§ RescaleTransferFunctionToVisibleRange() [4/4]

static bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToVisibleRange ( vtkSMProxy proxy,
vtkSMProxy view,
const char *  arrayname,
int  attribute_type 
)
inlinestatic

Safely call RescaleTransferFunctionToVisibleRange() after casting the proxy to the appropriate type.

Definition at line 230 of file vtkSMPVRepresentationProxy.h.

§ SetScalarBarVisibility() [1/2]

virtual bool vtkSMPVRepresentationProxy::SetScalarBarVisibility ( vtkSMProxy view,
bool  visibile 
)
virtual

Set the scalar bar visibility.

This will create a new scalar bar as needed. Scalar bar is only shown if scalar coloring is indeed being used.

§ SetScalarBarVisibility() [2/2]

static bool vtkSMPVRepresentationProxy::SetScalarBarVisibility ( vtkSMProxy proxy,
vtkSMProxy view,
bool  visibile 
)
inlinestatic

Set the scalar bar visibility.

This will create a new scalar bar as needed. Scalar bar is only shown if scalar coloring is indeed being used.

Definition at line 245 of file vtkSMPVRepresentationProxy.h.

§ HideScalarBarIfNotNeeded() [1/2]

virtual bool vtkSMPVRepresentationProxy::HideScalarBarIfNotNeeded ( vtkSMProxy view)
virtual

While SetScalarBarVisibility can be used to hide a scalar bar, it will always simply hide the scalar bar even if its being used by some other representation.

Use this method instead to only hide the scalar/color bar if no other visible representation in the view is mapping data using the scalar bar.

§ HideScalarBarIfNotNeeded() [2/2]

static bool vtkSMPVRepresentationProxy::HideScalarBarIfNotNeeded ( vtkSMProxy repr,
vtkSMProxy view 
)
inlinestatic

While SetScalarBarVisibility can be used to hide a scalar bar, it will always simply hide the scalar bar even if its being used by some other representation.

Use this method instead to only hide the scalar/color bar if no other visible representation in the view is mapping data using the scalar bar.

Definition at line 261 of file vtkSMPVRepresentationProxy.h.

§ IsScalarBarVisible() [1/2]

virtual bool vtkSMPVRepresentationProxy::IsScalarBarVisible ( vtkSMProxy view)
virtual

Check scalar bar visibility.

Return true if the scalar bar for this representation and view is visible, return false otherwise.

§ IsScalarBarVisible() [2/2]

static bool vtkSMPVRepresentationProxy::IsScalarBarVisible ( vtkSMProxy repr,
vtkSMProxy view 
)
inlinestatic

Check scalar bar visibility.

Return true if the scalar bar for this representation and view is visible, return false otherwise.

Definition at line 274 of file vtkSMPVRepresentationProxy.h.

§ GetArrayInformationForColorArray() [1/2]

virtual vtkPVArrayInformation* vtkSMPVRepresentationProxy::GetArrayInformationForColorArray ( )
virtual

Returns the array information for the data array used for scalar coloring, if any.

Otherwise returns NULL.

§ GetArrayInformationForColorArray() [2/2]

static vtkPVArrayInformation* vtkSMPVRepresentationProxy::GetArrayInformationForColorArray ( vtkSMProxy proxy)
inlinestatic

Returns the array information for the data array used for scalar coloring, if any.

Otherwise returns NULL.

Definition at line 287 of file vtkSMPVRepresentationProxy.h.

§ GetProminentValuesInformationForColorArray() [1/2]

virtual vtkPVProminentValuesInformation* vtkSMPVRepresentationProxy::GetProminentValuesInformationForColorArray ( double  uncertaintyAllowed = 1e-6,
double  fraction = 1e-3 
)
virtual

Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any.

Otherwise returns NULL.

§ GetProminentValuesInformationForColorArray() [2/2]

static vtkPVProminentValuesInformation* vtkSMPVRepresentationProxy::GetProminentValuesInformationForColorArray ( vtkSMProxy proxy,
double  uncertaintyAllowed = 1e-6,
double  fraction = 1e-3 
)
inlinestatic

Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any.

Otherwise returns NULL.

Definition at line 301 of file vtkSMPVRepresentationProxy.h.

§ SetRepresentationType()

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

Overridden to ensure when picking representation types that require scalar colors, scalar coloring it setup properly.

Currently this is hard-coded for Volume and Slice representation types.

Reimplemented from vtkSMRepresentationProxy.

§ RescaleTransferFunctionToDataRange() [5/5]

virtual bool vtkSMPVRepresentationProxy::RescaleTransferFunctionToDataRange ( vtkPVArrayInformation info,
bool  extend = false,
bool  force = true 
)
protectedvirtual

Rescales transfer function ranges using the array information provided.

§ CreateVTKObjects()

virtual void vtkSMPVRepresentationProxy::CreateVTKObjects ( )
protectedvirtual

Overridden to ensure that the RepresentationTypesInfo and Representations's domain are up-to-date.

Reimplemented from vtkSMRepresentationProxy.

§ OnPropertyUpdated()

void vtkSMPVRepresentationProxy::OnPropertyUpdated ( vtkObject *  ,
unsigned  long,
void *  calldata 
)
protected

§ SetPropertyModifiedFlag()

virtual void vtkSMPVRepresentationProxy::SetPropertyModifiedFlag ( const char *  name,
int  flag 
)
protectedvirtual

Overridden to ensure that whenever "Input" property changes, we update the "Input" properties for all internal representations (including setting up of the link to the extract-selection representation).

Reimplemented from vtkSMProxy.

§ ReadXMLAttributes()

int vtkSMPVRepresentationProxy::ReadXMLAttributes ( vtkSMSessionProxyManager pm,
vtkPVXMLElement element 
)
protectedvirtual

Overridden to process "RepresentationType" elements.

Reimplemented from vtkSMSourceProxy.

§ SetScalarColoringInternal()

virtual bool vtkSMPVRepresentationProxy::SetScalarColoringInternal ( const char *  arrayname,
int  attribute_type,
bool  useComponent,
int  component 
)
protectedvirtual

Internal method to set scalar coloring, do not use directly.


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