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

vtkSMTransferFunctionProxy is the proxy used for "PVLookupTable", "ColorTransferFunction" and "PiecewiseFunction". More...

#include <vtkSMTransferFunctionProxy.h>

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

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual bool RescaleTransferFunction (const double range[2], bool extend=false)
 Rescale the "RGBPoints" for the transfer function to match the new range. More...
 
virtual bool RescaleTransferFunction (double rangeMin, double rangeMax, bool extend=false)
 
virtual bool InvertTransferFunction ()
 Invert the transfer function. More...
 
virtual bool MapControlPointsToLogSpace (bool inverse=false)
 Remaps control points by normalizing in linear-space and then interpolating in log-space. More...
 
virtual bool MapControlPointsToLinearSpace ()
 
virtual bool ApplyPreset (const char *presetname, bool rescale=true)
 
virtual bool SaveColorMap (vtkPVXMLElement *xml)
 Save to ColorMap XML. More...
 
virtual bool IsScalarBarVisible (vtkSMProxy *view)
 Return true if the representation corresponding to the transfer function for the view is showing a Scalar-Bar (Color Legend). More...
 
virtual vtkSMProxyFindScalarBarRepresentation (vtkSMProxy *view)
 Find and return the Scalar-Bar (Color Legend) representation corresponding to the transfer function for the view, if any. More...
 
virtual bool ComputeAvailableAnnotations (bool extend=false)
 
virtual bool ApplyColorMap (const char *text)
 Load a ColorMap XML. More...
 
virtual bool ApplyColorMap (vtkPVXMLElement *xml)
 Load a ColorMap XML. More...
 
- Public Member Functions inherited from vtkSMProxy
void SetAnnotation (const char *key, const char *value)
 
const char * GetAnnotation (const char *key)
 Retrieve an annotation with a given key. More...
 
void RemoveAnnotation (const char *key)
 Remove a given annotation based on its key to the proxy. More...
 
void RemoveAllAnnotations ()
 Remove all proxy annotations. More...
 
bool HasAnnotation (const char *key)
 Return true if a given annotation exists. More...
 
int GetNumberOfAnnotations ()
 Return the number of available annotations. More...
 
const char * GetAnnotationKeyAt (int index)
 Return the nth key of the available annotations. More...
 
void SetLocation (vtkTypeUInt32) override
 Get/Set the location where the underlying VTK-objects are created. More...
 
virtual vtkSMPropertyGetProperty (const char *name)
 Return the property with the given name. More...
 
virtual vtkSMPropertyGetProperty (const char *name, int selfOnly)
 Return a property of the given name from self or one of the sub-proxies. More...
 
const char * GetPropertyName (vtkSMProperty *prop)
 Given a property pointer, returns the name that was used to add it to the proxy. More...
 
virtual void UpdateVTKObjects ()
 Update the VTK object on the server by pushing the values of all modified properties (un-modified properties are ignored). More...
 
virtual void RecreateVTKObjects ()
 Recreate the VTK object for this proxy. More...
 
void InvokeCommand (const char *name)
 Convenience method equivalent to UpdateProperty(name, 1). More...
 
virtual vtkSMPropertyIteratorNewPropertyIterator ()
 Returns a new (initialized) iterator of the properties. More...
 
unsigned int GetNumberOfConsumers ()
 Returns the number of consumers. More...
 
vtkSMProxyGetConsumerProxy (unsigned int idx)
 Returns the consumer of given index. More...
 
vtkSMPropertyGetConsumerProperty (unsigned int idx)
 Returns the corresponding property of the consumer of given index. More...
 
unsigned int GetNumberOfProducers ()
 Returns the number of proxies this proxy depends on (uses or is connected to through the pipeline). More...
 
vtkSMProxyGetProducerProxy (unsigned int idx)
 Returns a proxy this proxy depends on, given index. More...
 
vtkSMPropertyGetProducerProperty (unsigned int idx)
 Returns the property holding a producer proxy given an index. More...
 
virtual void UpdatePropertyInformation ()
 Updates all property information by calling UpdateInformation() and populating the values. More...
 
virtual void UpdatePropertyInformation (vtkSMProperty *prop)
 Similar to UpdatePropertyInformation() but updates only the given property. More...
 
virtual void MarkAllPropertiesAsModified ()
 Marks all properties as modified. More...
 
virtual void ResetPropertiesToXMLDefaults ()
 Use this method to set all properties on this proxy to their default values. More...
 
virtual void ResetPropertiesToDomainDefaults ()
 Use this method to set all properties on this proxy to their default domains. More...
 
virtual void ResetPropertiesToDefault (ResetPropertiesMode mode=DEFAULT)
 Use this method to set all properties on this proxy to their default domain or values. More...
 
virtual void MarkModified (vtkSMProxy *modifiedProxy)
 Calls MarkDirty() and invokes ModifiedEvent. More...
 
void InitializeAndCopyFromProxy (vtkSMProxy *source)
 Given a source proxy, makes this proxy point to the same server-side object (with a new id). More...
 
virtual void MarkDirty (vtkSMProxy *modifiedProxy)
 Dirty means this algorithm will execute during next update. More...
 
vtkObjectBaseGetClientSideObject ()
 Returns the client side object associated with the VTKObjectID (if any). More...
 
virtual vtkPVXMLElementSaveXMLState (vtkPVXMLElement *root)
 Saves the state of the proxy. More...
 
virtual vtkPVXMLElementSaveXMLState (vtkPVXMLElement *root, vtkSMPropertyIterator *iter)
 The iterator is use to filter the property available on the given proxy. More...
 
virtual int LoadXMLState (vtkPVXMLElement *element, vtkSMProxyLocator *locator)
 Loads the proxy state from the XML element. More...
 
void UpdateSelfAndAllInputs ()
 This method call UpdateVTKObjects on the current pipeline by starting at the sources. More...
 
bool GetIsSubProxy ()
 A proxy instance can be a sub-proxy for some other proxy. More...
 
vtkSMProxyGetParentProxy ()
 If this instance is a sub-proxy, this method will return the proxy of which this instance is an immediate sub-proxy. More...
 
vtkSMProxyGetTrueParentProxy ()
 Call GetParentProxy() recursively till a proxy that is not a subproxy of any other proxy is found. More...
 
void EnableLocalPushOnly () override
 Allow to switch off any push of state change to the server for that particular object. More...
 
void DisableLocalPushOnly () override
 Enable the given remote object to communicate its state normally to the server location. More...
 
const vtkSMMessageGetFullState () override
 This method return the full object state that can be used to create that object from scratch. More...
 
void LoadState (const vtkSMMessage *msg, vtkSMProxyLocator *locator) override
 This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set. More...
 
vtkSMPropertyGroupGetPropertyGroup (size_t index) const
 Returns the property group at index for the proxy. More...
 
size_t GetNumberOfPropertyGroups () const
 Returns the number of property groups that the proxy contains. More...
 
const char * GetLogNameOrDefault ()
 A helper that makes up an default name if none is provided. More...
 
bool GetPropertiesModified ()
 
bool UpdateProperty (const char *name)
 Update the value of one property (pushed to the server) if it is modified. More...
 
bool UpdateProperty (const char *name, int force)
 Update the value of one property (pushed to the server) if it is modified. More...
 
virtual char * GetVTKClassName ()
 Returns the type of object managed by the proxy. More...
 
virtual void SetVTKClassName (const char *)
 the type of object created by the proxy. More...
 
virtual char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual char * GetXMLGroup ()
 Assigned by the XML parser. More...
 
virtual char * GetXMLLabel ()
 Assigned by the XML parser. More...
 
void Copy (vtkSMProxy *src)
 Copies values of all the properties and sub-proxies from src. More...
 
void Copy (vtkSMProxy *src, const char *exceptionClass)
 Copies values of all the properties and sub-proxies from src. More...
 
virtual void Copy (vtkSMProxy *src, const char *exceptionClass, int proxyPropertyCopyFlag)
 Copies values of all the properties and sub-proxies from src. More...
 
virtual vtkSMDocumentationGetDocumentation ()
 Returns the documentation for this proxy. More...
 
virtual vtkPVXMLElementGetHints ()
 The server manager configuration XML may define <Hints/> element for a proxy. More...
 
virtual int GetObjectsCreated ()
 Returns if the VTK objects for this proxy have been created. More...
 
bool GatherInformation (vtkPVInformation *information)
 Gathers information about this proxy. More...
 
bool GatherInformation (vtkPVInformation *information, vtkTypeUInt32 location)
 Gathers information about this proxy. More...
 
void PrototypeOn () override
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
void PrototypeOff () override
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
void SetPrototype (bool undo) override
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
void SetLogName (const char *name)
 Log name is a name for this proxy that will be used when logging status messages. More...
 
virtual char * GetLogName ()
 Log name is a name for this proxy that will be used when logging status messages. More...
 
- Public Member Functions inherited from vtkSMRemoteObject
void SetSession (vtkSMSession *) override
 Override the SetSession so if the object already have an ID we automatically register it to the associated session. More...
 
bool HasGlobalID ()
 Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it. More...
 
virtual bool IsLocalPushOnly ()
 Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast. More...
 
virtual vtkTypeUInt32 GetLocation ()
 Get/Set the location where the underlying VTK-objects are created. More...
 
virtual vtkTypeUInt32 GetGlobalID ()
 Get the global unique id for this object. More...
 
const char * GetGlobalIDAsString ()
 Get the global unique id for this object. More...
 
bool IsPrototype ()
 Allow user to set the remote object to be discard for Undo/Redo action. More...
 
- Public Member Functions inherited from vtkSMSessionObject
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSMTransferFunctionProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMTransferFunctionProxySafeDownCast (vtkObject *o)
 
static bool InvertTransferFunction (vtkSMProxy *)
 Safely call InvertTransferFunction() after casting the proxy to the appropriate type. More...
 
static bool MapControlPointsToLinearSpace (vtkSMProxy *proxy)
 Safely call MapControlPointsToLinearSpace() after casting the proxy to the appropriate type. More...
 
static bool ApplyPreset (vtkSMProxy *proxy, const char *presetname, bool rescale=true)
 
static bool ComputeAvailableAnnotations (vtkSMProxy *proxy, bool extend=false)
 
static bool ConvertLegacyColorMapsToJSON (const char *inxmlfile, const char *outjsonfile)
 Converts legacy xml file to json. More...
 
static bool ExportTransferFunction (vtkSMTransferFunctionProxy *colorTransferFunction, vtkSMTransferFunctionProxy *opacityTransferFunction, const char *tfname, const char *filename)
 Export a transfer function to a json file. More...
 
static bool RescaleTransferFunction (vtkSMProxy *proxy, double rangeMin, double rangeMax, bool extend=false)
 Safely call RescaleTransferFunction() after casting the proxy to appropriate type. More...
 
static bool RescaleTransferFunction (vtkSMProxy *proxy, const double range[2], bool extend=false)
 Safely call RescaleTransferFunction() after casting the proxy to appropriate type. More...
 
static bool MapControlPointsToLogSpace (vtkSMProxy *proxy, bool inverse=false)
 Safely call MapControlPointsToLogSpace() after casting the proxy to the appropriate type. More...
 
static bool ApplyColorMap (vtkSMProxy *proxy, const char *text)
 Safely call ApplyColorMap(..) after casting the proxy to the appropriate type. More...
 
static bool ApplyColorMap (vtkSMProxy *proxy, vtkPVXMLElement *xml)
 Safely call ApplyColorMap(..) after casting the proxy to the appropriate type. More...
 
static bool SaveColorMap (vtkSMProxy *proxy, vtkPVXMLElement *xml)
 Safely call ApplyColorMap(..) after casting the proxy to the appropriate type. More...
 
static bool IsScalarBarVisible (vtkSMProxy *proxy, vtkSMProxy *view)
 Safely call IsScalarBarVisible(..) after casting the proxy to the appropriate type. More...
 
static vtkSMProxyFindScalarBarRepresentation (vtkSMProxy *proxy, vtkSMProxy *view)
 Safely call FindScalarBarRepresentation(..) after casting the proxy to the appropriate type. More...
 
static Json::Value ConvertLegacyColorMapXMLToJSON (vtkPVXMLElement *xml)
 Method to convert legacy color map preset XML to JSON. More...
 
static Json::Value ConvertLegacyColorMapXMLToJSON (const char *xmlcontents)
 Method to convert legacy color map preset XML to JSON. More...
 
static Json::Value ConvertMultipleLegacyColorMapXMLToJSON (vtkPVXMLElement *xml)
 Method to convert legacy "ColorMaps" preset XML to JSON. More...
 
static Json::Value ConvertMultipleLegacyColorMapXMLToJSON (const char *xmlcontents)
 Method to convert legacy "ColorMaps" preset XML to JSON. More...
 
- Static Public Member Functions inherited from vtkSMProxy
static vtkSMProxyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMProxySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMRemoteObject
static int IsTypeOf (const char *type)
 
static vtkSMRemoteObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMTransferFunctionProxy ()=default
 
 ~vtkSMTransferFunctionProxy () override=default
 
void RestoreFromSiteSettingsOrXML (const char *arrayName)
 Attempt to reset transfer function to site settings. 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...
 
virtual void MarkDirtyFromProducer (vtkSMProxy *modifiedProxy, vtkSMProxy *producer, vtkSMProperty *property)
 MarkConsumersAsDirty calls this method on each consumer, instead of directly calling MarkDirty on the consumer. More...
 
void MarkInputsAsDirty ()
 This method is called by vtkSMRepresentationProxy whenever the time request for the pipeline may have potentially changed. More...
 
virtual void CreateVTKObjects ()
 Given a class name (by setting VTKClassName) and server ids (by setting ServerIDs), this methods instantiates the objects on the server(s) More...
 
void RemoveAllObservers ()
 Cleanup code. More...
 
virtual void SetPropertyModifiedFlag (const char *name, int flag)
 Note on property modified flags: The modified flag of each property associated with a proxy is stored in the proxy object instead of in the property itself. More...
 
void AddSubProxy (const char *name, vtkSMProxy *proxy, int overrideOK=0)
 Add a sub-proxy. More...
 
void RemoveSubProxy (const char *name)
 Remove a sub-proxy. More...
 
vtkSMProxyGetSubProxy (const char *name)
 Returns a sub-proxy. More...
 
vtkSMProxyGetSubProxy (unsigned int index)
 Returns a sub-proxy. More...
 
const char * GetSubProxyName (unsigned int index)
 Returns the name used to store sub-proxy. More...
 
const char * GetSubProxyName (vtkSMProxy *)
 Returns the name used to store sub-proxy. More...
 
unsigned int GetNumberOfSubProxies ()
 Returns the number of sub-proxies. More...
 
virtual void AddConsumer (vtkSMProperty *property, vtkSMProxy *proxy)
 Called by a proxy property, this adds the property,proxy pair to the list of consumers. More...
 
virtual void RemoveConsumer (vtkSMProperty *property, vtkSMProxy *proxy)
 Remove the property,proxy pair from the list of consumers. More...
 
virtual void RemoveAllConsumers ()
 Remove all consumers. More...
 
void AddProducer (vtkSMProperty *property, vtkSMProxy *proxy)
 Called by an proxy/input property to add property, proxy pair to the list of producers. More...
 
void RemoveProducer (vtkSMProperty *property, vtkSMProxy *proxy)
 Remove the property,proxy pair from the list of producers. More...
 
virtual void PostUpdateData (bool using_cache)
 This method is called after the algorithm(s) (if any) associated with this proxy execute. More...
 
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...
 
virtual void UpdatePipelineInformation ()
 This method simply iterates over subproxies and calls UpdatePipelineInformation() on them. More...
 
void LinkProperty (vtkSMProperty *inputProperty, vtkSMProperty *outputProperty)
 Links properties such that when inputProperty's checked or unchecked values are changed, the outputProperty's corresponding values are also changed. More...
 
vtkSMPropertyGroupNewPropertyGroup (vtkPVXMLElement *propElement)
 Parses the XML to create a new property group. More...
 
void AppendPropertyGroup (vtkSMPropertyGroup *group)
 Adds a property groups. More...
 
void ExposeSubProxyProperty (const char *subproxy_name, const char *property_name, const char *exposed_name, int overrideOK=0)
 Expose a subproxy property from the base proxy. More...
 
virtual void ExecuteSubProxyEvent (vtkSMProxy *o, unsigned long event, void *data)
 Handle events fired by subproxies. More...
 
virtual int CreateSubProxiesAndProperties (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element)
 
virtual void UpdatePropertyInformationInternal (vtkSMProperty *prop=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...
 
virtual void SetLogNameInternal (const char *name, bool propagate_to_subproxies, bool propagate_to_proxylistdomains)
 Internal method used by SetLogName More...
 
bool ArePropertiesModified ()
 Indicates if any properties are modified. More...
 
void SetHints (vtkPVXMLElement *hints)
 
void SetDeprecated (vtkPVXMLElement *deprecated)
 
void SetXMLElement (vtkPVXMLElement *element)
 
 vtkSMProxy (const vtkSMProxy &)=delete
 
void operator= (const vtkSMProxy &)=delete
 
virtual const vtkClientServerStreamGetLastResult ()
 Get the last result. More...
 
virtual const vtkClientServerStreamGetLastResult (vtkTypeUInt32 location)
 Get the last result. More...
 
virtual void SetXMLName (const char *)
 Assigned by the XML parser. More...
 
virtual void SetXMLGroup (const char *)
 Assigned by the XML parser. More...
 
virtual void SetXMLLabel (const char *)
 Assigned by the XML parser. More...
 
virtual void SetXMLSubProxyName (const char *)
 Assigned by the XML parser. More...
 
vtkSMPropertyNewProperty (const char *name)
 Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...
 
vtkSMPropertyNewProperty (const char *name, vtkPVXMLElement *propElement)
 Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...
 
virtual int ReadXMLAttributes (vtkSMSessionProxyManager *pm, vtkPVXMLElement *element)
 Read attributes from an 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 &)
 

Protected Attributes

double LastRange [2] = { 0, 1 }
 
vtkSmartPointer< vtkTableHistogramTableCache
 
- Protected Attributes inherited from vtkSMProxy
bool NeedsUpdate
 
char * VTKClassName
 
char * XMLGroup
 
char * XMLName
 
char * XMLLabel
 
char * XMLSubProxyName
 
int ObjectsCreated
 
int DoNotUpdateImmediately
 
int DoNotModifyProperty
 
int InUpdateVTKObjects
 Avoids calls to UpdateVTKObjects in UpdateVTKObjects. More...
 
bool PropertiesModified
 Flag used to help speed up UpdateVTKObjects and ArePropertiesModified calls. More...
 
vtkPVXMLElementXMLElement
 
vtkSMDocumentationDocumentation
 
vtkPVXMLElementHints
 
vtkPVXMLElementDeprecated
 
vtkSMMessageState
 
int InMarkModified
 
vtkWeakPointer< vtkSMProxyParentProxy
 
vtkSMProxyInternalsInternals
 
vtkSMProxyObserverSubProxyObserver
 
char * SIClassName
 SIClassName identifies the classname for the helper on the server side. More...
 
- Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32 GlobalID
 
vtkTypeUInt32 Location
 
bool Prototype
 
bool ClientOnlyLocationFlag
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
static bool RescaleTransferFunctionToDataRange (vtkSMProxy *proxy, bool extend=false)
 Locates all representations that are currently using this transfer function and then rescales the transfer function scalar range to exactly match the combined valid scalar ranges obtained from them all. More...
 
virtual bool RescaleTransferFunctionToDataRange (bool extend=false)
 Locates all representations that are currently using this transfer function and then rescales the transfer function scalar range to exactly match the combined valid scalar ranges obtained from them all. More...
 
static bool ApplyPreset (vtkSMProxy *proxy, const Json::Value &value, bool rescale=true)
 Apply a preset. More...
 
virtual bool ApplyPreset (const Json::Value &value, bool rescale=true)
 Apply a preset. More...
 
static Json::Value GetStateAsPreset (vtkSMProxy *proxy)
 Saves the transfer function state as a preset. More...
 
virtual Json::Value GetStateAsPreset ()
 Saves the transfer function state as a preset. More...
 
static bool UpdateScalarBarsComponentTitle (vtkSMProxy *proxy, vtkPVArrayInformation *arrayInfo)
 Update component titles for all scalar bars connected to this transfer function proxy. More...
 
virtual bool UpdateScalarBarsComponentTitle (vtkPVArrayInformation *arrayInfo)
 Update component titles for all scalar bars connected to this transfer function proxy. More...
 
static bool ComputeDataRange (vtkSMProxy *proxy, double range[2])
 Helper method used by RescaleTransferFunctionToDataRange() to compute range from all visible representations using the transfer function. More...
 
virtual bool ComputeDataRange (double range[2])
 Helper method used by RescaleTransferFunctionToDataRange() to compute range from all visible representations using the transfer function. More...
 
static vtkTableComputeDataHistogramTable (vtkSMProxy *proxy, int numberOfBins)
 Helper method used to compute a histogram with provided number of bins based on the data from all the visible representations using the transfer function. More...
 
virtual vtkTableComputeDataHistogramTable (int numberOfBins)
 Helper method used to compute a histogram with provided number of bins based on the data from all the visible representations using the transfer function. More...
 
static vtkTableGetHistogramTableCache (vtkSMProxy *proxy)
 Helper method used to recover the last histogram computed by ComputeDataHistogram Returns the histogram as a vtkTable if available, nullptr otherwise. More...
 
virtual vtkTableGetHistogramTableCache ()
 Helper method used to recover the last histogram computed by ComputeDataHistogram Returns the histogram as a vtkTable if available, nullptr otherwise. More...
 
static void ResetPropertiesToDefaults (vtkSMProxy *proxy, const char *arrayName, bool preserve_range=false)
 Helper method to reset a transfer function proxy to its defaults. More...
 
virtual void ResetPropertiesToDefaults (const char *arrayName, bool preserve_range)
 Helper method to reset a transfer function proxy to its defaults. More...
 
static bool GetRange (vtkSMProxy *proxy, double range[2])
 Returns current transfer function data range. More...
 
virtual bool GetRange (double range[2])
 Returns current transfer function data range. More...
 

Detailed Description

vtkSMTransferFunctionProxy is the proxy used for "PVLookupTable", "ColorTransferFunction" and "PiecewiseFunction".

It provides utility API to update lookup-table ranges, invert transfer function, etc. that can be used from C++ as well as Python layers.

Definition at line 37 of file vtkSMTransferFunctionProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkSMTransferFunctionProxy.h.

Constructor & Destructor Documentation

◆ vtkSMTransferFunctionProxy()

vtkSMTransferFunctionProxy::vtkSMTransferFunctionProxy ( )
protecteddefault

◆ ~vtkSMTransferFunctionProxy()

vtkSMTransferFunctionProxy::~vtkSMTransferFunctionProxy ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkSMTransferFunctionProxy* vtkSMTransferFunctionProxy::New ( )
static

◆ GetClassName()

virtual const char* vtkSMTransferFunctionProxy::GetClassName ( )
virtual

Reimplemented from vtkSMProxy.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMProxy.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkSMProxy.

◆ RescaleTransferFunction() [1/4]

virtual bool vtkSMTransferFunctionProxy::RescaleTransferFunction ( const double  range[2],
bool  extend = false 
)
inlinevirtual

Rescale the "RGBPoints" for the transfer function to match the new 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.

Definition at line 50 of file vtkSMTransferFunctionProxy.h.

◆ RescaleTransferFunction() [2/4]

virtual bool vtkSMTransferFunctionProxy::RescaleTransferFunction ( double  rangeMin,
double  rangeMax,
bool  extend = false 
)
virtual

◆ RescaleTransferFunction() [3/4]

static bool vtkSMTransferFunctionProxy::RescaleTransferFunction ( vtkSMProxy proxy,
double  rangeMin,
double  rangeMax,
bool  extend = false 
)
static

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

◆ RescaleTransferFunction() [4/4]

static bool vtkSMTransferFunctionProxy::RescaleTransferFunction ( vtkSMProxy proxy,
const double  range[2],
bool  extend = false 
)
inlinestatic

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

Definition at line 63 of file vtkSMTransferFunctionProxy.h.

◆ RescaleTransferFunctionToDataRange() [1/2]

virtual bool vtkSMTransferFunctionProxy::RescaleTransferFunctionToDataRange ( bool  extend = false)
virtual

Locates all representations that are currently using this transfer function and then rescales the transfer function scalar range to exactly match the combined valid scalar ranges obtained from them all.

◆ RescaleTransferFunctionToDataRange() [2/2]

static bool vtkSMTransferFunctionProxy::RescaleTransferFunctionToDataRange ( vtkSMProxy proxy,
bool  extend = false 
)
inlinestatic

Locates all representations that are currently using this transfer function and then rescales the transfer function scalar range to exactly match the combined valid scalar ranges obtained from them all.

Definition at line 76 of file vtkSMTransferFunctionProxy.h.

◆ InvertTransferFunction() [1/2]

virtual bool vtkSMTransferFunctionProxy::InvertTransferFunction ( )
virtual

Invert the transfer function.

Returns true if successful.

◆ InvertTransferFunction() [2/2]

static bool vtkSMTransferFunctionProxy::InvertTransferFunction ( vtkSMProxy )
static

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

◆ MapControlPointsToLogSpace() [1/2]

virtual bool vtkSMTransferFunctionProxy::MapControlPointsToLogSpace ( bool  inverse = false)
virtual

Remaps control points by normalizing in linear-space and then interpolating in log-space.

This is useful when converting the transfer function from linear- to log-mode. If inverse is true, the operation is reversed i.e. the control points are normalized in log-space and interpolated in linear-space, useful when converting from log- to linear-mode.

◆ MapControlPointsToLinearSpace() [1/2]

virtual bool vtkSMTransferFunctionProxy::MapControlPointsToLinearSpace ( )
inlinevirtual

Definition at line 102 of file vtkSMTransferFunctionProxy.h.

◆ MapControlPointsToLogSpace() [2/2]

static bool vtkSMTransferFunctionProxy::MapControlPointsToLogSpace ( vtkSMProxy proxy,
bool  inverse = false 
)
inlinestatic

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

Definition at line 109 of file vtkSMTransferFunctionProxy.h.

◆ MapControlPointsToLinearSpace() [2/2]

static bool vtkSMTransferFunctionProxy::MapControlPointsToLinearSpace ( vtkSMProxy proxy)
inlinestatic

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

Definition at line 120 of file vtkSMTransferFunctionProxy.h.

◆ ApplyPreset() [1/4]

virtual bool vtkSMTransferFunctionProxy::ApplyPreset ( const Json::Value &  value,
bool  rescale = true 
)
virtual

Apply a preset.

If rescale is true (default), then apply loading the preset, the transfer function range will be preserved (if originally valid). If not valid, or rescale is false, then the range provided by the preset is used. When using indexed color maps, the rescale implies loading of annotations since the "range" for indexed color maps is described by the annotations.

◆ ApplyPreset() [2/4]

static bool vtkSMTransferFunctionProxy::ApplyPreset ( vtkSMProxy proxy,
const Json::Value &  value,
bool  rescale = true 
)
inlinestatic

Apply a preset.

If rescale is true (default), then apply loading the preset, the transfer function range will be preserved (if originally valid). If not valid, or rescale is false, then the range provided by the preset is used. When using indexed color maps, the rescale implies loading of annotations since the "range" for indexed color maps is described by the annotations.

Definition at line 135 of file vtkSMTransferFunctionProxy.h.

◆ ApplyPreset() [3/4]

virtual bool vtkSMTransferFunctionProxy::ApplyPreset ( const char *  presetname,
bool  rescale = true 
)
virtual

◆ ApplyPreset() [4/4]

static bool vtkSMTransferFunctionProxy::ApplyPreset ( vtkSMProxy proxy,
const char *  presetname,
bool  rescale = true 
)
inlinestatic

Definition at line 143 of file vtkSMTransferFunctionProxy.h.

◆ GetStateAsPreset() [1/2]

virtual Json::Value vtkSMTransferFunctionProxy::GetStateAsPreset ( )
virtual

Saves the transfer function state as a preset.

This is simply a subset of the state of the transfer function proxy.

◆ GetStateAsPreset() [2/2]

static Json::Value vtkSMTransferFunctionProxy::GetStateAsPreset ( vtkSMProxy proxy)
static

Saves the transfer function state as a preset.

This is simply a subset of the state of the transfer function proxy.

◆ ApplyColorMap() [1/4]

virtual bool vtkSMTransferFunctionProxy::ApplyColorMap ( const char *  text)
virtual

Load a ColorMap XML.

This will update a transfer function using the ColorMap XML. Currently, this is only supported for color transfer functions. Returns true on success.

◆ ApplyColorMap() [2/4]

virtual bool vtkSMTransferFunctionProxy::ApplyColorMap ( vtkPVXMLElement xml)
virtual

Load a ColorMap XML.

This will update a transfer function using the ColorMap XML. Currently, this is only supported for color transfer functions. Returns true on success.

◆ ApplyColorMap() [3/4]

static bool vtkSMTransferFunctionProxy::ApplyColorMap ( vtkSMProxy proxy,
const char *  text 
)
inlinestatic

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

Definition at line 173 of file vtkSMTransferFunctionProxy.h.

◆ ApplyColorMap() [4/4]

static bool vtkSMTransferFunctionProxy::ApplyColorMap ( vtkSMProxy proxy,
vtkPVXMLElement xml 
)
inlinestatic

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

Definition at line 185 of file vtkSMTransferFunctionProxy.h.

◆ SaveColorMap() [1/2]

virtual bool vtkSMTransferFunctionProxy::SaveColorMap ( vtkPVXMLElement xml)
virtual

Save to ColorMap XML.

Currently, this is only supported for color transfer functions. Returns true on success.

◆ SaveColorMap() [2/2]

static bool vtkSMTransferFunctionProxy::SaveColorMap ( vtkSMProxy proxy,
vtkPVXMLElement xml 
)
inlinestatic

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

Definition at line 203 of file vtkSMTransferFunctionProxy.h.

◆ IsScalarBarVisible() [1/2]

virtual bool vtkSMTransferFunctionProxy::IsScalarBarVisible ( vtkSMProxy view)
virtual

Return true if the representation corresponding to the transfer function for the view is showing a Scalar-Bar (Color Legend).

Otherwise return false.

◆ IsScalarBarVisible() [2/2]

static bool vtkSMTransferFunctionProxy::IsScalarBarVisible ( vtkSMProxy proxy,
vtkSMProxy view 
)
inlinestatic

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

Definition at line 222 of file vtkSMTransferFunctionProxy.h.

◆ FindScalarBarRepresentation() [1/2]

virtual vtkSMProxy* vtkSMTransferFunctionProxy::FindScalarBarRepresentation ( vtkSMProxy view)
virtual

Find and return the Scalar-Bar (Color Legend) representation corresponding to the transfer function for the view, if any.

This returns the proxy if one exists, it won't create a new one.

◆ FindScalarBarRepresentation() [2/2]

static vtkSMProxy* vtkSMTransferFunctionProxy::FindScalarBarRepresentation ( vtkSMProxy proxy,
vtkSMProxy view 
)
inlinestatic

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

Definition at line 241 of file vtkSMTransferFunctionProxy.h.

◆ UpdateScalarBarsComponentTitle() [1/2]

virtual bool vtkSMTransferFunctionProxy::UpdateScalarBarsComponentTitle ( vtkPVArrayInformation arrayInfo)
virtual

Update component titles for all scalar bars connected to this transfer function proxy.

The arrayInfo is used to determine component names, if possible.

◆ UpdateScalarBarsComponentTitle() [2/2]

static bool vtkSMTransferFunctionProxy::UpdateScalarBarsComponentTitle ( vtkSMProxy proxy,
vtkPVArrayInformation arrayInfo 
)
inlinestatic

Update component titles for all scalar bars connected to this transfer function proxy.

The arrayInfo is used to determine component names, if possible.

Definition at line 255 of file vtkSMTransferFunctionProxy.h.

◆ ComputeDataRange() [1/2]

virtual bool vtkSMTransferFunctionProxy::ComputeDataRange ( double  range[2])
virtual

Helper method used by RescaleTransferFunctionToDataRange() to compute range from all visible representations using the transfer function.

Returns true if a valid range was determined.

◆ ComputeDataRange() [2/2]

static bool vtkSMTransferFunctionProxy::ComputeDataRange ( vtkSMProxy proxy,
double  range[2] 
)
inlinestatic

Helper method used by RescaleTransferFunctionToDataRange() to compute range from all visible representations using the transfer function.

Returns true if a valid range was determined.

Definition at line 269 of file vtkSMTransferFunctionProxy.h.

◆ ComputeDataHistogramTable() [1/2]

virtual vtkTable* vtkSMTransferFunctionProxy::ComputeDataHistogramTable ( int  numberOfBins)
virtual

Helper method used to compute a histogram with provided number of bins based on the data from all the visible representations using the transfer function.

If successful, returns the histogram as a vtkTable containing two columns of double, the first one being the indexes, the second one the number of values. If not, returns nullptr.

◆ ComputeDataHistogramTable() [2/2]

static vtkTable* vtkSMTransferFunctionProxy::ComputeDataHistogramTable ( vtkSMProxy proxy,
int  numberOfBins 
)
inlinestatic

Helper method used to compute a histogram with provided number of bins based on the data from all the visible representations using the transfer function.

If successful, returns the histogram as a vtkTable containing two columns of double, the first one being the indexes, the second one the number of values. If not, returns nullptr.

Definition at line 285 of file vtkSMTransferFunctionProxy.h.

◆ GetHistogramTableCache() [1/2]

virtual vtkTable* vtkSMTransferFunctionProxy::GetHistogramTableCache ( )
inlinevirtual

Helper method used to recover the last histogram computed by ComputeDataHistogram Returns the histogram as a vtkTable if available, nullptr otherwise.

Definition at line 297 of file vtkSMTransferFunctionProxy.h.

◆ GetHistogramTableCache() [2/2]

static vtkTable* vtkSMTransferFunctionProxy::GetHistogramTableCache ( vtkSMProxy proxy)
inlinestatic

Helper method used to recover the last histogram computed by ComputeDataHistogram Returns the histogram as a vtkTable if available, nullptr otherwise.

Definition at line 298 of file vtkSMTransferFunctionProxy.h.

◆ ComputeAvailableAnnotations() [1/2]

virtual bool vtkSMTransferFunctionProxy::ComputeAvailableAnnotations ( bool  extend = false)
virtual

◆ ComputeAvailableAnnotations() [2/2]

static bool vtkSMTransferFunctionProxy::ComputeAvailableAnnotations ( vtkSMProxy proxy,
bool  extend = false 
)
inlinestatic

Definition at line 308 of file vtkSMTransferFunctionProxy.h.

◆ ResetPropertiesToDefaults() [1/2]

virtual void vtkSMTransferFunctionProxy::ResetPropertiesToDefaults ( const char *  arrayName,
bool  preserve_range 
)
virtual

Helper method to reset a transfer function proxy to its defaults.

By passing in preserve_range, you can make this method preserve the current transfer function range.

◆ ResetPropertiesToDefaults() [2/2]

static void vtkSMTransferFunctionProxy::ResetPropertiesToDefaults ( vtkSMProxy proxy,
const char *  arrayName,
bool  preserve_range = false 
)
inlinestatic

Helper method to reset a transfer function proxy to its defaults.

By passing in preserve_range, you can make this method preserve the current transfer function range.

Definition at line 321 of file vtkSMTransferFunctionProxy.h.

◆ ConvertLegacyColorMapXMLToJSON() [1/2]

static Json::Value vtkSMTransferFunctionProxy::ConvertLegacyColorMapXMLToJSON ( vtkPVXMLElement xml)
static

Method to convert legacy color map preset XML to JSON.

Use this to convert a single ColorMap xml. To convert a collection of color maps, use ConvertMultipleLegacyColorMapXMLToJSON().

◆ ConvertLegacyColorMapXMLToJSON() [2/2]

static Json::Value vtkSMTransferFunctionProxy::ConvertLegacyColorMapXMLToJSON ( const char *  xmlcontents)
static

Method to convert legacy color map preset XML to JSON.

Use this to convert a single ColorMap xml. To convert a collection of color maps, use ConvertMultipleLegacyColorMapXMLToJSON().

◆ ConvertMultipleLegacyColorMapXMLToJSON() [1/2]

static Json::Value vtkSMTransferFunctionProxy::ConvertMultipleLegacyColorMapXMLToJSON ( vtkPVXMLElement xml)
static

Method to convert legacy "ColorMaps" preset XML to JSON.

This converts all colormaps in the XML.

◆ ConvertMultipleLegacyColorMapXMLToJSON() [2/2]

static Json::Value vtkSMTransferFunctionProxy::ConvertMultipleLegacyColorMapXMLToJSON ( const char *  xmlcontents)
static

Method to convert legacy "ColorMaps" preset XML to JSON.

This converts all colormaps in the XML.

◆ ConvertLegacyColorMapsToJSON()

static bool vtkSMTransferFunctionProxy::ConvertLegacyColorMapsToJSON ( const char *  inxmlfile,
const char *  outjsonfile 
)
static

Converts legacy xml file to json.

◆ GetRange() [1/2]

virtual bool vtkSMTransferFunctionProxy::GetRange ( double  range[2])
virtual

Returns current transfer function data range.

Returns false is a valid range could not be determined.

◆ GetRange() [2/2]

static bool vtkSMTransferFunctionProxy::GetRange ( vtkSMProxy proxy,
double  range[2] 
)
inlinestatic

Returns current transfer function data range.

Returns false is a valid range could not be determined.

Definition at line 363 of file vtkSMTransferFunctionProxy.h.

◆ ExportTransferFunction()

static bool vtkSMTransferFunctionProxy::ExportTransferFunction ( vtkSMTransferFunctionProxy colorTransferFunction,
vtkSMTransferFunctionProxy opacityTransferFunction,
const char *  tfname,
const char *  filename 
)
static

Export a transfer function to a json file.

opacityTransferFunction can be nullptr but colorTransferFunction must not be nullptr. The tfname will be the preset name upon importing the transfer function back into ParaView.

◆ RestoreFromSiteSettingsOrXML()

void vtkSMTransferFunctionProxy::RestoreFromSiteSettingsOrXML ( const char *  arrayName)
protected

Attempt to reset transfer function to site settings.

If site settings are not available, then the application XML defaults are used.

Member Data Documentation

◆ LastRange

double vtkSMTransferFunctionProxy::LastRange[2] = { 0, 1 }
protected

Definition at line 392 of file vtkSMTransferFunctionProxy.h.

◆ HistogramTableCache

vtkSmartPointer<vtkTable> vtkSMTransferFunctionProxy::HistogramTableCache
protected

Definition at line 397 of file vtkSMTransferFunctionProxy.h.


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