represents a ranged vtkSMTransferFunctionProxy More...

#include <vtkSMRangedTransferFunctionDomain.h>

Inheritance diagram for vtkSMRangedTransferFunctionDomain:

Collaboration diagram for vtkSMRangedTransferFunctionDomain:

Public Types
typedef vtkSMProxyListDomain	Superclass

Public Types inherited from vtkSMProxyListDomain
typedef vtkSMDomain	Superclass

Public Types inherited from vtkSMDomain
enum	IsInDomainReturnCodes { NOT_APPLICABLE = -1, NOT_IN_DOMAIN = 0, IN_DOMAIN = 1 }
	Return values for `IsInDomain` calls. More...

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

double	GetRangeMinimum (unsigned int idx, int &exists)
	Return a range min. More...

double	GetRangeMaximum (unsigned int idx, int &exists)
	Return a range max. More...

int	SetDefaultValues (vtkSMProperty *prop, bool use_unchecked_values) override
	If prop is a vtkSMProxyProperty containing a vtkSMTransferFunctionProxy this set its range based on this domain min and max values. More...


bool	GetRangeMinimumExists (unsigned int idx)
	Returns if range minimum/maximum bound is set for the domain. More...

bool	GetRangeMaximumExists (unsigned int idx)
	Returns if range minimum/maximum bound is set for the domain. More...


double	GetRangeMinimum (unsigned int idx)
	Returns the range minimum/maximum value, is exists, otherwise 0 is returned. More...

double	GetRangeMaximum (unsigned int idx)
	Returns the range minimum/maximum value, is exists, otherwise 0 is returned. More...

Public Member Functions inherited from vtkSMProxyListDomain
const std::vector< ProxyType > &	GetProxyTypes () const
	Returns a vector of proxy types for the proxies in the domain. More...

unsigned int	GetNumberOfProxyTypes ()
	Returns the number of proxies in the domain. More...

const char *	GetProxyGroup (unsigned int index)
	Returns the xml group name for the proxy at a given index. More...

const char *	GetProxyName (unsigned int index)
	Returns the xml type name for the proxy at a given index. More...

const char *	GetProxyName (vtkSMProxy *proxy)
	If the `proxy` is part of the domain, then this returns the name used for the proxy in the domain. More...

vtkSMProxy *	GetProxyWithName (const char *pname)
	Inverse of `GetProxyName`, returns the first proxy with the given name. More...

int	IsInDomain (vtkSMProperty *property) override
	This always returns true. More...

void	AddProxy (vtkSMProxy *)
	Add a proxy to the domain. More...

bool	HasProxy (vtkSMProxy *)
	Returns if the proxy is present in the domain. More...

unsigned int	GetNumberOfProxies ()
	Get number of proxies in the domain. More...

vtkSMProxy *	GetProxy (unsigned int index)
	Get proxy at a given index. More...

vtkSMProxy *	FindProxy (const char xmlgroup, const char xmlname)
	Find a proxy in the domain of the given group and type. More...

int	RemoveProxy (vtkSMProxy *proxy)
	Removes the first occurrence of the `proxy` in the domain. More...

int	RemoveProxy (unsigned int index)
	Removes the proxy at the given index. More...

void	CreateProxies (vtkSMSessionProxyManager *pxm)
	Creates and populates the domain with the proxy-types. More...

int	SetDefaultValues (vtkSMProperty *prop, bool use_unchecked_values) override
	A vtkSMProperty is often defined with a default value in the XML itself. More...

void	SetLogName (const char *prefix)
	Sets log name for each of the proxy in the domain using the prefix provided. More...

virtual void	SetDefaultIndex (unsigned int)
	Set and Get the default proxy index. More...

virtual unsigned int	GetDefaultIndex ()
	Set and Get the default proxy index. More...

Public Member Functions inherited from vtkSMDomain
virtual int	IsInDomain (vtkSMProperty *vtkNotUsed(property))
	Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. More...

virtual void	Update (vtkSMProperty *requestingProperty)
	Update self based on the "unchecked" values of all required properties. More...

virtual void	SetAnimationValue (vtkSMProperty *, int vtkNotUsed(index), double vtkNotUsed(value))
	Set the value of an element of a property from the animation editor. More...

virtual int	SetDefaultValues (vtkSMProperty *, bool vtkNotUsed(use_unchecked_values))
	A vtkSMProperty is often defined with a default value in the XML itself. More...

vtkSMProperty *	GetProperty ()
	Provides access to the vtkSMProperty on which this domain is hooked up. More...

virtual unsigned int	GetNumberOfInputConnections (const char *function)
	Helper method to get the number of input connections hence the number of available vtkPVDataInformation from input proxy connected to the required property with the given function. More...

vtkSMProperty *	GetRequiredProperty (const char *function)
	Returns a given required property of the given function. More...

virtual char *	GetXMLName ()
	Assigned by the XML parser. More...

virtual bool	GetIsOptional ()
	When the IsOptional flag is set, IsInDomain() always returns true. More...

virtual vtkPVDataInformation *	GetInputDataInformation (const char *function, unsigned int index=0)
	Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...

virtual vtkPVDataInformation *	GetInputSubsetDataInformation (unsigned int compositeIndex, const char *function, unsigned int index=0)
	Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...

virtual vtkPVDataInformation *	GetInputSubsetDataInformation (const char selector, const char assemblyName, const char *function, unsigned int index=0)
	Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...

Public Member Functions inherited from vtkSMSessionObject
virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual void	SetSession (vtkSMSession *)
	Get/Set the session on wihch this object exists. 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 vtkSMRangedTransferFunctionDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMRangedTransferFunctionDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMProxyListDomain
static vtkSMProxyListDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProxyListDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMDomain
static vtkSMDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMDomain *	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
	vtkSMRangedTransferFunctionDomain ()

	~vtkSMRangedTransferFunctionDomain () override

int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement element) override
	Set the appropriate ivars from the xml element. More...

void	InvokeDomainModifiedEvent ()
	Callback to invoke DomainModified event. More...

Protected Member Functions inherited from vtkSMProxyListDomain
	vtkSMProxyListDomain ()

	~vtkSMProxyListDomain () override

void	AddProxy (const char group, const char name)
	Adds a proxy type, used by ReadXMLAttributes(). More...

void	ChildSaveState (vtkPVXMLElement *propertyElement) override
	Save state for this domain. More...

int	LoadState (vtkPVXMLElement domainElement, vtkSMProxyLocator loader) override

void	SetProxies (vtkSMProxy **proxies, unsigned int count)

Protected Member Functions inherited from vtkSMDomain
	vtkSMDomain ()

	~vtkSMDomain () override

virtual int	LoadState (vtkPVXMLElement vtkNotUsed(domainElement), vtkSMProxyLocator vtkNotUsed(loader))
	Load the state of the domain from the XML. More...

void	RemoveRequiredProperty (vtkSMProperty *prop)
	Remove the given property from the required properties list. More...

void	AddRequiredProperty (vtkSMProperty prop, const char function)
	Add a new required property to this domain. More...

void	DomainModified ()
	Invokes DomainModifiedEvent. More...

void	InvokeModified ()

unsigned int	GetNumberOfRequiredProperties ()
	Gets the number of required properties added. More...

void	SetProperty (vtkSMProperty *)
	Set the domain's property. More...

void	SaveState (vtkPVXMLElement parent, const char uid)
	Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More...

virtual void	SetIsOptional (bool)
	When the IsOptional flag is set, IsInDomain() always returns true. More...

virtual void	SetXMLName (const char *)
	Assigned by the XML parser. More...

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

Additional Inherited Members
Protected Attributes inherited from vtkSMProxyListDomain
unsigned int	DefaultIndex = 0

Protected Attributes inherited from vtkSMDomain
char *	XMLName

bool	IsOptional

vtkSMDomainInternals *	Internals

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

Detailed Description

represents a ranged vtkSMTransferFunctionProxy

This domain represent a single vtkSMTransferFunctionProxy with a range defined by a vtkSMArrayRangeDomain used internally.

Example usage :

<RangedTransferFunctionDomain name="domain">
  <RequiredProperties>
    <Property function="Input" name="Input" />
    <Property function="ArraySelection" name="OpacityArray" />
    <Property function="ComponentSelection" name="OpacityArrayComponent" />
  </RequiredProperties>
</RangedTransferFunctionDomain>

Definition at line 31 of file vtkSMRangedTransferFunctionDomain.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMProxyListDomain vtkSMRangedTransferFunctionDomain::Superclass

Definition at line 35 of file vtkSMRangedTransferFunctionDomain.h.

Constructor & Destructor Documentation

◆ vtkSMRangedTransferFunctionDomain()

vtkSMRangedTransferFunctionDomain::vtkSMRangedTransferFunctionDomain ( )

protected

◆ ~vtkSMRangedTransferFunctionDomain()

vtkSMRangedTransferFunctionDomain::~vtkSMRangedTransferFunctionDomain ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMRangedTransferFunctionDomain* vtkSMRangedTransferFunctionDomain::New ( )

static

◆ GetClassName()

virtual const char* vtkSMRangedTransferFunctionDomain::GetClassName ( )

virtual

Reimplemented from vtkSMProxyListDomain.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMProxyListDomain.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMProxyListDomain.

◆ GetRangeMinimum() [1/2]

double vtkSMRangedTransferFunctionDomain::GetRangeMinimum	(	unsigned int	idx,
		int &	exists
	)

Return a range min.

value if it exists. If the min. exists exists is set to 1. Otherwise, it is set to 0. An unspecified min. is equivalent to -inf

◆ GetRangeMaximum() [1/2]

double vtkSMRangedTransferFunctionDomain::GetRangeMaximum	(	unsigned int	idx,
		int &	exists
	)

Return a range max.

value if it exists. If the max. exists exists is set to 1. Otherwise, it is set to 0. An unspecified max. is equivalent to +inf

◆ GetRangeMinimumExists()

bool vtkSMRangedTransferFunctionDomain::GetRangeMinimumExists ( unsigned int idx )

Returns if range minimum/maximum bound is set for the domain.

◆ GetRangeMaximumExists()

bool vtkSMRangedTransferFunctionDomain::GetRangeMaximumExists ( unsigned int idx )

Returns if range minimum/maximum bound is set for the domain.

◆ GetRangeMinimum() [2/2]

double vtkSMRangedTransferFunctionDomain::GetRangeMinimum ( unsigned int idx )

inline

Returns the range minimum/maximum value, is exists, otherwise 0 is returned.

Use GetMaximumExists() GetMaximumExists() to make sure that the bound is set.

Definition at line 66 of file vtkSMRangedTransferFunctionDomain.h.

◆ GetRangeMaximum() [2/2]

double vtkSMRangedTransferFunctionDomain::GetRangeMaximum ( unsigned int idx )

inline

Returns the range minimum/maximum value, is exists, otherwise 0 is returned.

Use GetMaximumExists() GetMaximumExists() to make sure that the bound is set.

Definition at line 71 of file vtkSMRangedTransferFunctionDomain.h.

◆ SetDefaultValues()

int vtkSMRangedTransferFunctionDomain::SetDefaultValues	(	vtkSMProperty *	prop,
		bool	use_unchecked_values
	)

override

If prop is a vtkSMProxyProperty containing a vtkSMTransferFunctionProxy this set its range based on this domain min and max values.

◆ ReadXMLAttributes()

int vtkSMRangedTransferFunctionDomain::ReadXMLAttributes	(	vtkSMProperty *	prop,
		vtkPVXMLElement *	element
	)

overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMProxyListDomain.

◆ InvokeDomainModifiedEvent()

void vtkSMRangedTransferFunctionDomain::InvokeDomainModifiedEvent ( )

protected

Callback to invoke DomainModified event.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMRangedTransferFunctionDomain()

◆ ~vtkSMRangedTransferFunctionDomain()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetRangeMinimum() [1/2]

◆ GetRangeMaximum() [1/2]

◆ GetRangeMinimumExists()

◆ GetRangeMaximumExists()

◆ GetRangeMinimum() [2/2]

◆ GetRangeMaximum() [2/2]

◆ SetDefaultValues()

◆ ReadXMLAttributes()

◆ InvokeDomainModifiedEvent()