representation for "Render View" like views in ParaView. More...
#include <vtkSMPVRepresentationProxy.h>
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) override |
bool | SetRepresentationType (const char *type) override |
Overridden to ensure when picking representation types that require scalar colors, scalar coloring it setup properly. More... | |
bool | GetVolumeIndependentRanges () |
True if ranges have to be computed independently on component 0 for the color and 1 for the opacity on the Volume representation. More... | |
void | ViewUpdated (vtkSMProxy *view) override |
Called after the view updates. More... | |
void | SetLastLUTProxy (vtkSMProxy *proxy) |
Set/get last LUT proxy. More... | |
void | SetLastLookupTable (vtkSMProxy *proxy) |
Set/get last LUT proxy. More... | |
vtkSMProxy * | GetLastLUTProxy () |
Set/get last LUT proxy. More... | |
vtkSMProxy * | GetLastLookupTable () |
Set/get last LUT proxy. More... | |
void | SetLastBlockLookupTable (const std::string &blockSelector, vtkSMProxy *proxy) |
Set/get last LUT proxy. More... | |
void | SetLastBlocksLookupTable (const std::vector< std::string > &blockSelectors, vtkSMProxy *proxy) |
Set/get last LUT proxy. More... | |
vtkSMProxy * | GetLastBlockLookupTable (const std::string &blockSelector) |
Set/get last LUT proxy. More... | |
std::vector< vtkSMProxy * > | GetLastBlocksLookupTables (const std::vector< std::string > &blockSelectors) |
Set/get last LUT proxy. More... | |
virtual bool | GetUsingScalarColoring () |
Returns true if scalar coloring is enabled. More... | |
virtual bool | GetBlockUsingScalarColoring (const std::string &blockSelector) |
Returns true if scalar coloring is enabled. More... | |
virtual std::vector< vtkTypeBool > | GetBlocksUsingScalarColoring (const std::vector< std::string > &blockSelectors) |
Returns true if scalar coloring is enabled. More... | |
virtual bool | GetAnyBlockUsingScalarColoring () |
Returns true if scalar coloring is enabled. More... | |
vtkSMProxy * | GetLUTProxy (vtkSMProxy *view) |
Returns the lut proxy of this representation in the given view. More... | |
vtkSMProxy * | GetLookupTable (vtkSMProxy *view) |
Returns the lut proxy of this representation in the given view. More... | |
vtkSMProxy * | GetBlockLookupTable (vtkSMProxy *view, const std::string &blockSelector) |
Returns the lut proxy of this representation in the given view. More... | |
std::vector< vtkSMProxy * > | GetBlocksLookupTables (vtkSMProxy *view, const std::vector< std::string > &blockSelectors) |
Returns the lut proxy of this representation in the given view. More... | |
bool | UpdateScalarBarRange (vtkSMProxy *view, bool deleteRange) |
Updates the ranges shown in the scalar bar. More... | |
std::vector< vtkTypeBool > | UpdateBlocksScalarBarRange (vtkSMProxy *view, bool deleteRange) |
Updates the ranges shown in the scalar bar. More... | |
virtual bool | SetScalarColoring (const char *arrayName, int attributeType) |
Enable/disable scalar coloring using the specified array. More... | |
virtual bool | SetBlockScalarColoring (const std::string &blockSelector, const char *arrayName, int attributeType) |
Enable/disable scalar coloring using the specified array. More... | |
virtual std::vector< vtkTypeBool > | SetBlocksScalarColoring (const std::vector< std::string > &blockSelectors, const char *arrayName, int attributeType) |
Enable/disable scalar coloring using the specified array. More... | |
virtual bool | SetScalarColoring (const char *arrayName, int attributeType, int component) |
Enable/disable scalar coloring using the specified array. More... | |
virtual bool | SetBlockScalarColoring (const std::string &blockSelector, const char *arrayName, int attributeType, int component) |
Enable/disable scalar coloring using the specified array. More... | |
virtual std::vector< vtkTypeBool > | SetBlocksScalarColoring (const std::vector< std::string > &blockSelectors, const char *arrayName, int attributeType, 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 | RescaleBlockTransferFunctionToDataRange (const std::string &blockSelector, bool extend=false, bool force=true) |
Rescales the color transfer function and opacity transfer function using the current data range. More... | |
virtual std::vector< vtkTypeBool > | RescaleBlocksTransferFunctionToDataRange (const std::vector< std::string > &blockSelectors, 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 attributeType, 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 | RescaleBlockTransferFunctionToDataRange (const std::string &blockSelector, const char *arrayName, int attributeType, 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 std::vector< vtkTypeBool > | RescaleBlocksTransferFunctionToDataRange (const std::vector< std::string > &blockSelectors, const char *arrayName, int attributeType, 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 | RescaleBlockTransferFunctionToDataRangeOverTime (const std::string &blockSelector) |
Rescales the color transfer function and opacity transfer function using the current data range over time. More... | |
virtual std::vector< vtkTypeBool > | RescaleBlocksTransferFunctionToDataRangeOverTime (const std::vector< std::string > &blockSelectors) |
Rescales the color transfer function and opacity transfer function using the current data range over time. More... | |
virtual bool | RescaleTransferFunctionToDataRangeOverTime (const char *arrayName, int attributeType) |
Rescales the color transfer function and opacity transfer function using the current data range over time for the chosen data-array. More... | |
virtual bool | RescaleBlockTransferFunctionToDataRangeOverTime (const std::string &blockSelector, const char *arrayName, int attributeType) |
Rescales the color transfer function and opacity transfer function using the current data range over time for the chosen data-array. More... | |
virtual std::vector< vtkTypeBool > | RescaleBlocksTransferFunctionToDataRangeOverTime (const std::vector< std::string > &blockSelectors, const char *arrayName, int attributeType) |
Rescales the color transfer function and opacity transfer function using the current data range over time for the chosen data-array. 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 attributeType) |
Rescales the color transfer function and the opacity transfer function using the current data range, limited to the currernt visible elements. More... | |
virtual bool | SetScalarBarVisibility (vtkSMProxy *view, bool visible) |
Set the scalar bar visibility. More... | |
virtual bool | SetBlockScalarBarVisibility (vtkSMProxy *view, const std::string &blockSelector, bool visible) |
Set the scalar bar visibility. More... | |
virtual std::vector< vtkTypeBool > | SetBlocksScalarBarVisibility (vtkSMProxy *view, const std::vector< std::string > &blockSelectors, bool visible) |
Set the scalar bar visibility. 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... | |
virtual bool | HideBlocksScalarBarIfNotNeeded (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 | IsScalarBarVisible (vtkSMProxy *view) |
Check scalar bar visibility. More... | |
virtual bool | IsBlockScalarBarVisible (vtkSMProxy *view, const std::string &blockSelector) |
Check scalar bar visibility. More... | |
virtual std::vector< vtkTypeBool > | IsBlocksScalarBarVisible (vtkSMProxy *view, const std::vector< std::string > &blockSelectors) |
Check scalar bar visibility. More... | |
virtual vtkPVArrayInformation * | GetArrayInformationForColorArray (bool checkRepresentedData=true) |
Returns the array information for the data array used for scalar coloring, from input data. More... | |
virtual vtkPVArrayInformation * | GetBlockArrayInformationForColorArray (const std::string &blockSelector) |
Returns the array information for the data array used for scalar coloring, from input data. More... | |
virtual std::vector< vtkPVArrayInformation * > | GetBlocksArrayInformationForColorArray (const std::vector< std::string > &blockSelectors) |
Returns the array information for the data array used for scalar coloring, from input data. More... | |
virtual vtkPVProminentValuesInformation * | GetProminentValuesInformationForColorArray (double uncertaintyAllowed=1e-6, double fraction=1e-3, bool force=false) |
Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any. More... | |
virtual vtkPVProminentValuesInformation * | GetBlockProminentValuesInformationForColorArray (const std::string &blockSelector, double uncertaintyAllowed=1e-6, double fraction=1e-3, bool force=false) |
Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any. More... | |
virtual std::vector< vtkPVProminentValuesInformation * > | GetBlocksProminentValuesInformationForColorArray (const std::vector< std::string > &blockSelectors, double uncertaintyAllowed=1e-6, double fraction=1e-3, bool force=false) |
Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any. More... | |
int | GetEstimatedNumberOfAnnotationsOnScalarBar (vtkSMProxy *view) |
Get an estimated number of annotation shown on this representation scalar bar. More... | |
int | GetBlockEstimatedNumberOfAnnotationsOnScalarBar (vtkSMProxy *view, const std::string &blockSelector) |
Get an estimated number of annotation shown on this representation scalar bar. More... | |
std::vector< int > | GetBlocksEstimatedNumberOfAnnotationsOnScalarBars (vtkSMProxy *view, const std::vector< std::string > &blockSelectors) |
Get an estimated number of annotation shown on this representation scalar bar. More... | |
int | IsScalarBarStickyVisible (vtkSMProxy *view) |
Checks if the scalar bar of this representation in view is sticky visible, i.e. More... | |
int | IsBlockScalarBarStickyVisible (vtkSMProxy *view, const std::string &blockSelector) |
Checks if the scalar bar of this representation in view is sticky visible, i.e. More... | |
std::vector< int > | IsBlocksScalarBarStickyVisible (vtkSMProxy *view, const std::vector< std::string > &blockSelectors) |
Checks if the scalar bar of this representation in view is sticky visible, i.e. More... | |
std::pair< int, std::string > | GetBlockColorArray (const std::string &blockSelector) |
Set/Get the block color array name. More... | |
std::vector< std::pair< int, std::string > > | GetBlocksColorArrays (const std::vector< std::string > &blockSelectors) |
Set/Get the block color array name. More... | |
int | GetBlockColorArrayAssociation (const std::string &blockSelector) |
Set/Get the block color array name. More... | |
std::string | GetBlockColorArrayName (const std::string &blockSelector) |
Set/Get the block color array name. More... | |
void | SetBlockUseSeparateColorMap (const std::string &blockSelector, bool use) |
Set/Get if we should use a separate color map for this block. More... | |
void | SetBlocksUseSeparateColorMap (const std::vector< std::string > &blockSelectors, bool use) |
Set/Get if we should use a separate color map for this block. More... | |
bool | GetBlockUseSeparateColorMap (const std::string &blockSelector) |
Set/Get if we should use a separate color map for this block. More... | |
std::vector< vtkTypeBool > | GetBlocksUseSeparateColorMaps (const std::vector< std::string > &blockSelectors) |
Set/Get if we should use a separate color map for this block. More... | |
Public Member Functions inherited from vtkSMRepresentationProxy | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
virtual vtkPVDataInformation * | GetRepresentedDataInformation () |
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... | |
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 vtkPVProminentValuesInformation * | GetProminentValuesInformation (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 vtkPVProminentValuesInformation * | 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) |
Returns information about a specific array component's prominent values (or nullptr). More... | |
const char * | GetRepresentationType () |
Set the representation type. 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... | |
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 vtkSMOutputPort * | GetOutputPort (unsigned int idx) |
Return an output port. More... | |
virtual vtkSMOutputPort * | GetOutputPort (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... | |
vtkPVDataInformation * | GetSubsetDataInformation (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... | |
vtkSMSourceProxy * | GetSelectionOutput (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... | |
vtkSMDocumentation * | GetOutputPortDocumentation (unsigned int index) |
It is possible to provide some documentation for each output port in the configuration xml. More... | |
vtkSMDocumentation * | GetOutputPortDocumentation (const char *portname) |
It is possible to provide some documentation for each output port in the configuration xml. More... | |
vtkPVDataInformation * | GetDataInformation () |
DataInformation is used by the source proxy to obtain information on the output(s) from the server. More... | |
vtkPVDataInformation * | GetDataInformation (unsigned int outputIdx) |
DataInformation is used by the source proxy to obtain information on the output(s) from the server. More... | |
vtkPVDataInformation * | GetSubsetDataInformation (unsigned int outputIdx, const char *selector, const char *assemblyName=nullptr) |
For composite datasets, GetDataInformation returns summary data information for all blocks combined. More... | |
vtkPVDataInformation * | GetRankDataInformation (int rank) |
Get rank-specific data information. More... | |
vtkPVDataInformation * | GetRankDataInformation (unsigned int outputIdx, int rank) |
Get rank-specific data information. More... | |
vtkSMSourceProxy * | GetSelectionInput (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 vtkSMProperty * | GetProperty (const char *name) |
Return the property with the given name. More... | |
virtual vtkSMProperty * | GetProperty (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 vtkSMPropertyIterator * | NewPropertyIterator () |
Returns a new (initialized) iterator of the properties. More... | |
unsigned int | GetNumberOfConsumers () |
Returns the number of consumers. More... | |
vtkSMProxy * | GetConsumerProxy (unsigned int idx) |
Returns the consumer of given index. More... | |
vtkSMProperty * | GetConsumerProperty (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... | |
vtkSMProxy * | GetProducerProxy (unsigned int idx) |
Returns a proxy this proxy depends on, given index. More... | |
vtkSMProperty * | GetProducerProperty (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... | |
bool | IsDeprecated () |
Returns true if the proxy has a deprecation tag. 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 vtkPVXMLElement * | SaveXMLState (vtkPVXMLElement *root) |
Saves the state of the proxy. More... | |
virtual vtkPVXMLElement * | SaveXMLState (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... | |
vtkSMProxy * | GetParentProxy () |
If this instance is a sub-proxy, this method will return the proxy of which this instance is an immediate sub-proxy. More... | |
vtkSMProxy * | GetTrueParentProxy () |
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 vtkSMMessage * | GetFullState () 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... | |
vtkSMPropertyGroup * | GetPropertyGroup (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 () |
virtual std::vector< std::string > | GetPropertiesWithDifferentValues (vtkSMProxy *otherProxy) |
Return the property names that have values different from the otherProxy argument. 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 vtkSMDocumentation * | GetDocumentation () |
Returns the documentation for this proxy. More... | |
virtual vtkPVXMLElement * | GetHints () |
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 vtkSMSessionProxyManager * | GetSessionProxyManager () |
Return the corresponding ProxyManager if any. More... | |
virtual vtkSMSession * | GetSession () |
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) |
vtkCommand * | GetCommand (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) |
vtkCommand * | GetCommand (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 vtkSMPVRepresentationProxy * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMPVRepresentationProxy * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkSMRepresentationProxy | |
static vtkSMRepresentationProxy * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMRepresentationProxy * | SafeDownCast (vtkObject *o) |
static bool | SetRepresentationType (vtkSMProxy *repr, const char *type) |
Set the representation type. More... | |
static const char * | GetRepresentationType (vtkSMProxy *repr) |
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... | |
Static Public Member Functions inherited from vtkSMSourceProxy | |
static vtkSMSourceProxy * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMSourceProxy * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkSMProxy | |
static vtkSMProxy * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMProxy * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkSMRemoteObject | |
static int | IsTypeOf (const char *type) |
static vtkSMRemoteObject * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkSMSessionObject | |
static vtkSMSessionObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMSessionObject * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkSMObject | |
static vtkSMObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMObject * | SafeDownCast (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 vtkObject * | New () |
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 vtkObjectBase * | New () |
static vtkObjectBase * | New () |
Protected Member Functions | |
vtkSMPVRepresentationProxy () | |
~vtkSMPVRepresentationProxy () override | |
void | CreateVTKObjects () override |
Overridden to ensure that the RepresentationTypesInfo and Representations's domain are up-to-date. More... | |
void | OnPropertyUpdated (vtkObject *, unsigned long, void *calldata) |
void | SetPropertyModifiedFlag (const char *name, int flag) override |
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) override |
Overridden to process "RepresentationType" elements. More... | |
Protected Member Functions inherited from vtkSMRepresentationProxy | |
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 *) |
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... | |
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... | |
vtkSMProxy * | GetSubProxy (const char *name) |
Returns a sub-proxy. More... | |
vtkSMProxy * | GetSubProxy (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... | |
bool | LoadPluginIfEnsured () |
If a proxy need to ensure a plugin is loaded, make sure it is. 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... | |
vtkSMPropertyGroup * | NewPropertyGroup (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 | SetEnsurePluginLoaded (vtkPVXMLElement *ensurePluginLoaded) |
Set the "EnsurePluginLoaded" XML element that is used in LoadPluginIfEnsured. More... | |
void | SetXMLElement (vtkPVXMLElement *element) |
vtkSMProxy (const vtkSMProxy &)=delete | |
void | operator= (const vtkSMProxy &)=delete |
virtual const vtkClientServerStream & | GetLastResult () |
Get the last result. More... | |
virtual const vtkClientServerStream & | GetLastResult (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... | |
vtkSMProperty * | NewProperty (const char *name) |
Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More... | |
vtkSMProperty * | NewProperty (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 &) |
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 redirecting to vtkSMColorMapEditorHelper for controlling transfer functions, scalar coloring, etc.
Definition at line 35 of file vtkSMPVRepresentationProxy.h.
Definition at line 39 of file vtkSMPVRepresentationProxy.h.
|
protected |
|
overrideprotected |
|
static |
|
virtual |
Reimplemented from vtkSMRepresentationProxy.
Reimplemented in vtkSMPVMoleculeRepresentationProxy.
Reimplemented from vtkSMRepresentationProxy.
Reimplemented in vtkSMPVMoleculeRepresentationProxy.
|
static |
|
overridevirtual |
Reimplemented from vtkSMSourceProxy.
|
inline |
Set/get last LUT proxy.
Used as a memory of what was the last LUT proxy linked to this representation.
Definition at line 48 of file vtkSMPVRepresentationProxy.h.
void vtkSMPVRepresentationProxy::SetLastLookupTable | ( | vtkSMProxy * | proxy | ) |
Set/get last LUT proxy.
Used as a memory of what was the last LUT proxy linked to this representation.
|
inline |
Set/get last LUT proxy.
Used as a memory of what was the last LUT proxy linked to this representation.
Definition at line 51 of file vtkSMPVRepresentationProxy.h.
vtkSMProxy* vtkSMPVRepresentationProxy::GetLastLookupTable | ( | ) |
Set/get last LUT proxy.
Used as a memory of what was the last LUT proxy linked to this representation.
|
inline |
Set/get last LUT proxy.
Used as a memory of what was the last LUT proxy linked to this representation.
Definition at line 53 of file vtkSMPVRepresentationProxy.h.
void vtkSMPVRepresentationProxy::SetLastBlocksLookupTable | ( | const std::vector< std::string > & | blockSelectors, |
vtkSMProxy * | proxy | ||
) |
Set/get last LUT proxy.
Used as a memory of what was the last LUT proxy linked to this representation.
|
inline |
Set/get last LUT proxy.
Used as a memory of what was the last LUT proxy linked to this representation.
Definition at line 58 of file vtkSMPVRepresentationProxy.h.
std::vector<vtkSMProxy*> vtkSMPVRepresentationProxy::GetLastBlocksLookupTables | ( | const std::vector< std::string > & | blockSelectors | ) |
Set/get last LUT proxy.
Used as a memory of what was the last LUT proxy linked to this representation.
|
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.
|
inlinevirtual |
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.
Definition at line 73 of file vtkSMPVRepresentationProxy.h.
|
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.
|
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.
|
inline |
Returns the lut proxy of this representation in the given view.
This method will return nullptr
if no lut proxy exists in this view.
Definition at line 88 of file vtkSMPVRepresentationProxy.h.
vtkSMProxy* vtkSMPVRepresentationProxy::GetLookupTable | ( | vtkSMProxy * | view | ) |
Returns the lut proxy of this representation in the given view.
This method will return nullptr
if no lut proxy exists in this view.
|
inline |
Returns the lut proxy of this representation in the given view.
This method will return nullptr
if no lut proxy exists in this view.
Definition at line 90 of file vtkSMPVRepresentationProxy.h.
std::vector<vtkSMProxy*> vtkSMPVRepresentationProxy::GetBlocksLookupTables | ( | vtkSMProxy * | view, |
const std::vector< std::string > & | blockSelectors | ||
) |
Returns the lut proxy of this representation in the given view.
This method will return nullptr
if no lut proxy exists in this view.
bool vtkSMPVRepresentationProxy::UpdateScalarBarRange | ( | vtkSMProxy * | view, |
bool | deleteRange | ||
) |
Updates the ranges shown in the scalar bar.
If deleteRange is true, then the range stored for current representation proxy is deleted. This should be done when the scalar bar gets separated or becomes not visible. If deleteRange is false, then the range stored for current representation proxy is updated with the new range value.
std::vector<vtkTypeBool> vtkSMPVRepresentationProxy::UpdateBlocksScalarBarRange | ( | vtkSMProxy * | view, |
bool | deleteRange | ||
) |
Updates the ranges shown in the scalar bar.
If deleteRange is true, then the range stored for current representation proxy is deleted. This should be done when the scalar bar gets separated or becomes not visible. If deleteRange is false, then the range stored for current representation proxy is updated with the new range value.
|
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 nullptr, then scalar coloring is turned off. attributeType
must be one of vtkDataObject::AttributeTypes.
|
inlinevirtual |
Enable/disable scalar coloring using the specified array.
This will set up a color and opacity transfer functions using vtkSMTransferFunctionProxy instance. If arrayName is nullptr, then scalar coloring is turned off. attributeType
must be one of vtkDataObject::AttributeTypes.
Definition at line 118 of file vtkSMPVRepresentationProxy.h.
|
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 nullptr, then scalar coloring is turned off. attributeType
must be one of vtkDataObject::AttributeTypes.
|
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 nullptr, then scalar coloring is turned off. if component name is -1, then the magnitude of the array is used. If component name is >=0, then the corresponding component is used.
|
inlinevirtual |
Enable/disable scalar coloring using the specified array.
This will set up a color and opacity transfer functions using vtkSMTransferFunctionProxy instance. If arrayName is nullptr, then scalar coloring is turned off. if component name is -1, then the magnitude of the array is used. If component name is >=0, then the corresponding component is used.
Definition at line 136 of file vtkSMPVRepresentationProxy.h.
|
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 nullptr, then scalar coloring is turned off. if component name is -1, then the magnitude of the array is used. If component name is >=0, then the corresponding component is used.
|
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.
blockSelector the block selector. extend Extend existing range instead of clamping to the new range (default: false). force Update transfer function even if the range is locked (default: true).
|
inlinevirtual |
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.
blockSelector the block selector. extend Extend existing range instead of clamping to the new range (default: false). force Update transfer function even if the range is locked (default: true).
Definition at line 163 of file vtkSMPVRepresentationProxy.h.
|
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.
blockSelector the block selector. extend Extend existing range instead of clamping to the new range (default: false). force Update transfer function even if the range is locked (default: 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. 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.
blockSelector the block selector. arrayName the name of the array. attributeType must be one of vtkDataObject::AttributeTypes. extend Extend existing range instead of clamping to the new range (default: false). force Update transfer function even if the range is locked (default: true).
|
inlinevirtual |
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. 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.
blockSelector the block selector. arrayName the name of the array. attributeType must be one of vtkDataObject::AttributeTypes. extend Extend existing range instead of clamping to the new range (default: false). force Update transfer function even if the range is locked (default: true).
Definition at line 192 of file vtkSMPVRepresentationProxy.h.
|
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. 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.
blockSelector the block selector. arrayName the name of the array. attributeType must be one of vtkDataObject::AttributeTypes. extend Extend existing range instead of clamping to the new range (default: false). force Update transfer function even if the range is locked (default: true).
|
virtual |
Rescales the color transfer function and opacity transfer function using the current data range over time.
Returns true if rescale was successful.
|
inlinevirtual |
Rescales the color transfer function and opacity transfer function using the current data range over time.
Returns true if rescale was successful.
Definition at line 211 of file vtkSMPVRepresentationProxy.h.
|
virtual |
Rescales the color transfer function and opacity transfer function using the current data range over time.
Returns true if rescale was successful.
|
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,
|
inlinevirtual |
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,
Definition at line 227 of file vtkSMPVRepresentationProxy.h.
|
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,
|
virtual |
Rescales the color transfer function and the opacity transfer function using the current data range, limited to the currernt visible elements.
|
virtual |
Rescales the color transfer function and the opacity transfer function using the current data range, limited to the currernt visible elements.
|
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.
|
inlinevirtual |
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 255 of file vtkSMPVRepresentationProxy.h.
|
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.
|
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.
|
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.
|
virtual |
Check scalar bar visibility.
Return true if the scalar bar for this representation and view is visible, return false otherwise.
|
inlinevirtual |
Check scalar bar visibility.
Return true if the scalar bar for this representation and view is visible, return false otherwise.
Definition at line 282 of file vtkSMPVRepresentationProxy.h.
|
virtual |
Check scalar bar visibility.
Return true if the scalar bar for this representation and view is visible, return false otherwise.
|
virtual |
Returns the array information for the data array used for scalar coloring, from input data.
If checkRepresentedData is true, it will also check in the represented data. Default is true. If none is found, returns nullptr.
|
inlinevirtual |
Returns the array information for the data array used for scalar coloring, from input data.
If checkRepresentedData is true, it will also check in the represented data. Default is true. If none is found, returns nullptr.
Definition at line 297 of file vtkSMPVRepresentationProxy.h.
|
virtual |
Returns the array information for the data array used for scalar coloring, from input data.
If checkRepresentedData is true, it will also check in the represented data. Default is true. If none is found, returns nullptr.
|
virtual |
Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any.
Otherwise returns nullptr.
|
inlinevirtual |
Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any.
Otherwise returns nullptr.
Definition at line 313 of file vtkSMPVRepresentationProxy.h.
|
virtual |
Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any.
Otherwise returns nullptr.
int vtkSMPVRepresentationProxy::GetEstimatedNumberOfAnnotationsOnScalarBar | ( | vtkSMProxy * | view | ) |
Get an estimated number of annotation shown on this representation scalar bar.
|
inline |
Get an estimated number of annotation shown on this representation scalar bar.
Definition at line 332 of file vtkSMPVRepresentationProxy.h.
std::vector<int> vtkSMPVRepresentationProxy::GetBlocksEstimatedNumberOfAnnotationsOnScalarBars | ( | vtkSMProxy * | view, |
const std::vector< std::string > & | blockSelectors | ||
) |
Get an estimated number of annotation shown on this representation scalar bar.
|
overridevirtual |
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.
bool vtkSMPVRepresentationProxy::GetVolumeIndependentRanges | ( | ) |
True if ranges have to be computed independently on component 0 for the color and 1 for the opacity on the Volume representation.
int vtkSMPVRepresentationProxy::IsScalarBarStickyVisible | ( | vtkSMProxy * | view | ) |
Checks if the scalar bar of this representation in view is sticky visible, i.e.
should be visible whenever this representation is also visible. It returns 1 if the scalar bar is sticky visible, 0 other wise. If any problem is encountered, for example if view == nullptr, or if the scalar bar representation is not instanciated / found, it returns -1.
|
inline |
Checks if the scalar bar of this representation in view is sticky visible, i.e.
should be visible whenever this representation is also visible. It returns 1 if the scalar bar is sticky visible, 0 other wise. If any problem is encountered, for example if view == nullptr, or if the scalar bar representation is not instanciated / found, it returns -1.
Definition at line 365 of file vtkSMPVRepresentationProxy.h.
std::vector<int> vtkSMPVRepresentationProxy::IsBlocksScalarBarStickyVisible | ( | vtkSMProxy * | view, |
const std::vector< std::string > & | blockSelectors | ||
) |
Checks if the scalar bar of this representation in view is sticky visible, i.e.
should be visible whenever this representation is also visible. It returns 1 if the scalar bar is sticky visible, 0 other wise. If any problem is encountered, for example if view == nullptr, or if the scalar bar representation is not instanciated / found, it returns -1.
|
overridevirtual |
Called after the view updates.
Reimplemented from vtkSMRepresentationProxy.
|
inline |
Set/Get the block color array name.
Definition at line 382 of file vtkSMPVRepresentationProxy.h.
std::vector<std::pair<int, std::string> > vtkSMPVRepresentationProxy::GetBlocksColorArrays | ( | const std::vector< std::string > & | blockSelectors | ) |
Set/Get the block color array name.
|
inline |
Set/Get the block color array name.
Definition at line 388 of file vtkSMPVRepresentationProxy.h.
|
inline |
Set/Get the block color array name.
Definition at line 392 of file vtkSMPVRepresentationProxy.h.
|
inline |
Set/Get if we should use a separate color map for this block.
Definition at line 402 of file vtkSMPVRepresentationProxy.h.
void vtkSMPVRepresentationProxy::SetBlocksUseSeparateColorMap | ( | const std::vector< std::string > & | blockSelectors, |
bool | use | ||
) |
Set/Get if we should use a separate color map for this block.
|
inline |
Set/Get if we should use a separate color map for this block.
Definition at line 407 of file vtkSMPVRepresentationProxy.h.
std::vector<vtkTypeBool> vtkSMPVRepresentationProxy::GetBlocksUseSeparateColorMaps | ( | const std::vector< std::string > & | blockSelectors | ) |
Set/Get if we should use a separate color map for this block.
|
overrideprotectedvirtual |
Overridden to ensure that the RepresentationTypesInfo and Representations's domain are up-to-date.
Reimplemented from vtkSMSourceProxy.
|
protected |
|
overrideprotectedvirtual |
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.
|
overrideprotectedvirtual |
Overridden to process "RepresentationType" elements.
Reimplemented from vtkSMSourceProxy.
|
protected |
Used as a memory of what was the last LUT proxy linked to this representation.
This is used in UpdateScalarBarRange
to update the scalar bar range when turning off the coloring for this representation.
Definition at line 446 of file vtkSMPVRepresentationProxy.h.
|
protected |
Definition at line 447 of file vtkSMPVRepresentationProxy.h.