vtkSMTransferFunction2DProxy is the proxy used for "TransferFunction2D". More...

#include <vtkSMTransferFunction2DProxy.h>

Inheritance diagram for vtkSMTransferFunction2DProxy:

Collaboration diagram for vtkSMTransferFunction2DProxy:

[legend]

Public Member Functions
virtual bool	RescaleTransferFunction (const double range[4], bool extend=false)
	Rescale the control boxes for the 2D transfer function to match the new range. More...

virtual bool	RescaleTransferFunction (double rangeXMin, double rangeXMax, double rangeYMin, double rangeYMax, bool extend=false)

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

virtual void	MarkDirty (vtkSMProxy *modifiedProxy)
	Dirty means this algorithm will execute during next update. 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...

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

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

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 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 vtkSMTransferFunction2DProxy *	New ()
	Instantiate the class. More...


static bool	RescaleTransferFunction (vtkSMProxy *proxy, double rangeXMin, double rangeXMax, double rangeYMin, double rangeYMax, bool extend=false)
	Safely call RescaleTransferFunction() after casting the proxy to appropriate type. More...

static bool	RescaleTransferFunction (vtkSMProxy *proxy, const double range[4], bool extend=false)
	Safely call RescaleTransferFunction() after casting the proxy to appropriate type. More...

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 ()

Static Public Attributes
static const int	BOX_PROPERTY_SIZE = 8
	Expected tuple size of the boxes property of the proxy. More...

Protected Member Functions
	vtkSMTransferFunction2DProxy ()=default

	~vtkSMTransferFunction2DProxy () override=default

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

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

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

bool	LoadPluginIfEnsured ()
	If a proxy need to ensure a plugin is loaded, make sure it is. 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...

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

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

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
vtkSmartPointer< vtkImageData >	Histogram2DCache
	Cache for the 2D histogram image. More...

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

vtkPVXMLElement *	XMLElement

vtkSMDocumentation *	Documentation

vtkPVXMLElement *	Hints = nullptr

vtkPVXMLElement *	Deprecated = nullptr

vtkPVXMLElement *	EnsurePluginLoaded = nullptr

vtkSMMessage *	State

int	InMarkModified

vtkWeakPointer< vtkSMProxy >	ParentProxy

vtkSMProxyInternals *	Internals

vtkSMProxyObserver *	SubProxyObserver

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< vtkSMSession >	Session
	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

typedef vtkSMProxy	Superclass
	Standard methods for the VTK class. More...

static int	IsTypeOf (const char *type)
	Standard methods for the VTK class. More...

static vtkSMTransferFunction2DProxy *	SafeDownCast (vtkObject *o)
	Standard methods for the VTK class. More...

virtual const char *	GetClassName ()
	Standard methods for the VTK class. More...

virtual int	IsA (const char *type)
	Standard methods for the VTK class. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for the VTK class. More...

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	ComputeDataRange (vtkSMProxy *proxy, double range[4])
	Helper method used by RescaleTransferFunctionToDataRange() to compute range from all visible representations using the transfer function. More...

virtual bool	ComputeDataRange (double range[4])
	Helper method used by RescaleTransferFunctionToDataRange() to compute range from all visible representations using the transfer function. More...

static vtkSmartPointer< vtkImageData >	ComputeDataHistogram2D (vtkSMProxy *proxy, int numberOfBins)
	Helper method used to compute a 2D histogram image with provided number of bins based on the data from all the visible representations using the transfer function. More...

virtual vtkSmartPointer< vtkImageData >	ComputeDataHistogram2D (int numberOfBins)
	Helper method used to compute a 2D histogram image with provided number of bins based on the data from all the visible representations using the transfer function. More...

static vtkImageData *	GetHistogram2DCache (vtkSMProxy *proxy)
	Helper method used to recover the last histogram computed by ComputeDataHistogram2D Returns the histogram as a vtkImageData if available, nullptr otherwise. More...

virtual vtkImageData *	GetHistogram2DCache ()
	Helper method used to recover the last histogram computed by ComputeDataHistogram2D Returns the histogram as a vtkImageData if available, nullptr otherwise. More...

static bool	GetRange (vtkSMProxy *proxy, double range[4])
	Returns current transfer function data range. More...

virtual bool	GetRange (double range[4])
	Returns current transfer function data range. More...

Additional Inherited Members
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

Detailed Description

vtkSMTransferFunction2DProxy is the proxy used for "TransferFunction2D".

vtkSMTransferFunction2DProxy provides the utility API to update 2D transfer function range, control boxes, etc.

Definition at line 24 of file vtkSMTransferFunction2DProxy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMProxy vtkSMTransferFunction2DProxy::Superclass

Standard methods for the VTK class.

Definition at line 36 of file vtkSMTransferFunction2DProxy.h.

Constructor & Destructor Documentation

◆ vtkSMTransferFunction2DProxy()

vtkSMTransferFunction2DProxy::vtkSMTransferFunction2DProxy ( )

protecteddefault

◆ ~vtkSMTransferFunction2DProxy()

vtkSMTransferFunction2DProxy::~vtkSMTransferFunction2DProxy ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkSMTransferFunction2DProxy* vtkSMTransferFunction2DProxy::New ( )

static

Instantiate the class.

◆ GetClassName()

virtual const char* vtkSMTransferFunction2DProxy::GetClassName ( )

virtual

Standard methods for the VTK class.

Reimplemented from vtkSMProxy.

◆ IsTypeOf()

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

static

Standard methods for the VTK class.

◆ IsA()

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

virtual

Standard methods for the VTK class.

Reimplemented from vtkSMProxy.

◆ SafeDownCast()

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

static

Standard methods for the VTK class.

◆ PrintSelf()

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

overridevirtual

Standard methods for the VTK class.

Reimplemented from vtkSMProxy.

◆ RescaleTransferFunction() [1/4]

virtual bool vtkSMTransferFunction2DProxy::RescaleTransferFunction	(	const double	range[4],
		bool	extend = `false`
	)

inlinevirtual

Rescale the control boxes for the 2D 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 46 of file vtkSMTransferFunction2DProxy.h.

◆ RescaleTransferFunction() [2/4]

virtual bool vtkSMTransferFunction2DProxy::RescaleTransferFunction	(	double	rangeXMin,
		double	rangeXMax,
		double	rangeYMin,
		double	rangeYMax,
		bool	extend = `false`
	)

virtual

◆ RescaleTransferFunction() [3/4]

static bool vtkSMTransferFunction2DProxy::RescaleTransferFunction	(	vtkSMProxy *	proxy,
		double	rangeXMin,
		double	rangeXMax,
		double	rangeYMin,
		double	rangeYMax,
		bool	extend = `false`
	)

static

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

◆ RescaleTransferFunction() [4/4]

static bool vtkSMTransferFunction2DProxy::RescaleTransferFunction	(	vtkSMProxy *	proxy,
		const double	range[4],
		bool	extend = `false`
	)

inlinestatic

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

Definition at line 60 of file vtkSMTransferFunction2DProxy.h.

◆ RescaleTransferFunctionToDataRange() [1/2]

virtual bool vtkSMTransferFunction2DProxy::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 vtkSMTransferFunction2DProxy::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 74 of file vtkSMTransferFunction2DProxy.h.

◆ ComputeDataRange() [1/2]

virtual bool vtkSMTransferFunction2DProxy::ComputeDataRange ( double range[4] )

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 vtkSMTransferFunction2DProxy::ComputeDataRange	(	vtkSMProxy *	proxy,
		double	range[4]
	)

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 88 of file vtkSMTransferFunction2DProxy.h.

◆ ComputeDataHistogram2D() [1/2]

virtual vtkSmartPointer<vtkImageData> vtkSMTransferFunction2DProxy::ComputeDataHistogram2D ( int numberOfBins )

virtual

Helper method used to compute a 2D histogram image 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 vtkImageData of type double. If not, returns nullptr.

◆ ComputeDataHistogram2D() [2/2]

static vtkSmartPointer<vtkImageData> vtkSMTransferFunction2DProxy::ComputeDataHistogram2D	(	vtkSMProxy *	proxy,
		int	numberOfBins
	)

inlinestatic

Helper method used to compute a 2D histogram image 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 vtkImageData of type double. If not, returns nullptr.

Definition at line 103 of file vtkSMTransferFunction2DProxy.h.

◆ GetHistogram2DCache() [1/2]

virtual vtkImageData* vtkSMTransferFunction2DProxy::GetHistogram2DCache ( )

inlinevirtual

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

Definition at line 115 of file vtkSMTransferFunction2DProxy.h.

◆ GetHistogram2DCache() [2/2]

static vtkImageData* vtkSMTransferFunction2DProxy::GetHistogram2DCache ( vtkSMProxy * proxy )

inlinestatic

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

Definition at line 116 of file vtkSMTransferFunction2DProxy.h.

◆ GetRange() [1/2]

virtual bool vtkSMTransferFunction2DProxy::GetRange ( double range[4] )

virtual

Returns current transfer function data range.

Returns false is a valid range could not be determined.

◆ GetRange() [2/2]

static bool vtkSMTransferFunction2DProxy::GetRange	(	vtkSMProxy *	proxy,
		double	range[4]
	)

inlinestatic

Returns current transfer function data range.

Returns false is a valid range could not be determined.

Definition at line 129 of file vtkSMTransferFunction2DProxy.h.

Member Data Documentation

◆ BOX_PROPERTY_SIZE

const int vtkSMTransferFunction2DProxy::BOX_PROPERTY_SIZE = 8

static

Expected tuple size of the boxes property of the proxy.

Internal use only.

Definition at line 140 of file vtkSMTransferFunction2DProxy.h.

◆ Histogram2DCache

vtkSmartPointer<vtkImageData> vtkSMTransferFunction2DProxy::Histogram2DCache

protected

Cache for the 2D histogram image.

Definition at line 150 of file vtkSMTransferFunction2DProxy.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkSMTransferFunction2DProxy.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMTransferFunction2DProxy()

◆ ~vtkSMTransferFunction2DProxy()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ RescaleTransferFunction() [1/4]

◆ RescaleTransferFunction() [2/4]

◆ RescaleTransferFunction() [3/4]

◆ RescaleTransferFunction() [4/4]

◆ RescaleTransferFunctionToDataRange() [1/2]

◆ RescaleTransferFunctionToDataRange() [2/2]

◆ ComputeDataRange() [1/2]

◆ ComputeDataRange() [2/2]

◆ ComputeDataHistogram2D() [1/2]

◆ ComputeDataHistogram2D() [2/2]

◆ GetHistogram2DCache() [1/2]

◆ GetHistogram2DCache() [2/2]

◆ GetRange() [1/2]

◆ GetRange() [2/2]

Member Data Documentation

◆ BOX_PROPERTY_SIZE

◆ Histogram2DCache