enumeration domain to select array association or attribute type. More...

#include <vtkSMFieldDataDomain.h>

Inheritance diagram for vtkSMFieldDataDomain:

Collaboration diagram for vtkSMFieldDataDomain:

Public Types
typedef vtkSMEnumerationDomain	Superclass

Public Types inherited from vtkSMEnumerationDomain
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

int	SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
	Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value. More...

void	Update (vtkSMProperty *property) override
	Updates the available field data based on the input dataset type, if possible. More...

Public Member Functions inherited from vtkSMEnumerationDomain
int	IsInDomain (vtkSMProperty *property) override
	Returns true if the value of the property is in the domain. More...

int	IsInDomain (int val, unsigned int &idx)
	Returns true if the int is in the domain. More...

unsigned int	GetNumberOfEntries ()
	Returns the number of entries in the enumeration. More...

int	GetEntryValue (unsigned int idx)
	Returns the integer value of an enumeration entry. More...

const char *	GetEntryText (unsigned int idx)
	Returns the descriptive string of an enumeration entry. More...

const char *	GetEntryTextForValue (int value)
	Returns the text for an enumeration value. More...

int	HasEntryText (const char *text)
	Return 1 is the text is present in the enumeration, otherwise 0. More...

int	GetEntryValueForText (const char *text)
	Get the value for an enumeration text. More...

int	GetEntryValue (const char *text, int &valid)
	Given an entry text, return the integer value. More...

const char *	GetInfoText (unsigned int idx)
	Returns the `info` text for an enumeration entry. More...

void	AddEntry (const char text, int value, const char info=nullptr)
	Add a new enumeration entry. More...

void	RemoveAllEntries ()
	Clear all entries. More...

int	SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
	Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value. 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	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...

Public Member Functions inherited from vtkSMSessionObject
void	PrintSelf (ostream &os, vtkIndent indent) override

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 vtkSMFieldDataDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMFieldDataDomain *	SafeDownCast (vtkObject *o)

static const char *	GetAttributeTypeAsString (int attrType)
	Convenience method to return the string for an attribute type. More...

static const char *	GetElementTypeAsString (int attrType)
	Convenience method to return the string for an element type. More...

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

static int	IsTypeOf (const char *type)

static vtkSMEnumerationDomain *	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
	vtkSMFieldDataDomain ()

	~vtkSMFieldDataDomain () override

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

Protected Member Functions inherited from vtkSMEnumerationDomain
void	ChildSaveState (vtkPVXMLElement *domainElement) override
	Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More...

	vtkSMEnumerationDomain ()
	Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value. More...

	~vtkSMEnumerationDomain () override
	Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value. More...

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

Protected Attributes
bool	EnableFieldDataSelection

bool	UseElementTypes

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

enumeration domain to select array association or attribute type.

vtkSMFieldDataDomain can be used on a vtkSMIntVectorProperty that is intended to specify the attribute type (vtkDataObject::AttributeTypes) or field association (vtkDataObject::FieldAssociations).

By default, vtkDataObject::Field (or vtkDataObject::FIELD_ASSOCIATION_NONE) is not added to the domain. If you want to support field data, then use enable_field_data="1" attribute in the XML configuration.

By default, the domain is assumed to represent field associations and hence the enumeration text is populated as "Point Data", "Cell Data", etc. To use element types for text, add attribute use_element_types="1" to the XML. In that case, the domain is populated with "Point", "Cell", etc.

Selecting the default value

vtkSMFieldDataDomain tries to respect the provided default_values. eg default_values=1 correspond to vtkDataObject::CELL If it is non-positive or not available, it will pick the default value to be the first attribute type that has non empty arrays and non-zero tuples. If all attributes have no tuples, then the first attribute with non empty arrays is selected. If all attributes have no arrays, then vtkSMEnumerationDomain picks the default. For this to work, the domain must be provided an Input property as a required property for function "Input".

Deprecated Usage

Previously (5.6 and earlier), vtkSMFieldDataDomain was added to vtkSMStringVectorProperty instances that allowed user to choose the array to process. This is no longer needed or supported. Simply remove the vtkSMFieldDataDomain from the XML for such properties.

The domain provided ability to limit the attribute types to the data type of the input dataset. This was clumsy since it did not correctly handle cases where data type changes or non empty attribute types changed. Hence we've dropped support for that. Simply remove disable_update_domain_entries and force_point_cell_data attributes from the XML for this domain since they are no longer supported.

Definition at line 53 of file vtkSMFieldDataDomain.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMEnumerationDomain vtkSMFieldDataDomain::Superclass

Definition at line 57 of file vtkSMFieldDataDomain.h.

Constructor & Destructor Documentation

◆ vtkSMFieldDataDomain()

vtkSMFieldDataDomain::vtkSMFieldDataDomain ( )

protected

◆ ~vtkSMFieldDataDomain()

vtkSMFieldDataDomain::~vtkSMFieldDataDomain ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMFieldDataDomain* vtkSMFieldDataDomain::New ( )

static

◆ GetClassName()

virtual const char* vtkSMFieldDataDomain::GetClassName ( )

virtual

Reimplemented from vtkSMEnumerationDomain.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMEnumerationDomain.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMEnumerationDomain.

◆ SetDefaultValues()

int vtkSMFieldDataDomain::SetDefaultValues	(	vtkSMProperty *	,
		bool	use_unchecked_values
	)

override

Overridden to ensure that the property's default value is valid for the enumeration, if not it will be set to the first enumeration value.

◆ GetAttributeTypeAsString()

static const char* vtkSMFieldDataDomain::GetAttributeTypeAsString ( int attrType )

static

Convenience method to return the string for an attribute type.

Will return nullptr for unsupported or invalid type.

◆ GetElementTypeAsString()

static const char* vtkSMFieldDataDomain::GetElementTypeAsString ( int attrType )

static

Convenience method to return the string for an element type.

Will return nullptr for unsupported or invalid type.

◆ Update()

void vtkSMFieldDataDomain::Update ( vtkSMProperty * property )

overridevirtual

Updates the available field data based on the input dataset type, if possible.

The provided property is not used.

Reimplemented from vtkSMEnumerationDomain.

◆ ReadXMLAttributes()

int vtkSMFieldDataDomain::ReadXMLAttributes	(	vtkSMProperty *	prop,
		vtkPVXMLElement *	elem
	)

overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMEnumerationDomain.

Member Data Documentation

◆ EnableFieldDataSelection

bool vtkSMFieldDataDomain::EnableFieldDataSelection

protected

Definition at line 95 of file vtkSMFieldDataDomain.h.

◆ UseElementTypes

bool vtkSMFieldDataDomain::UseElementTypes

protected

Definition at line 97 of file vtkSMFieldDataDomain.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMFieldDataDomain.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Selecting the default value

Deprecated Usage

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMFieldDataDomain()

◆ ~vtkSMFieldDataDomain()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetDefaultValues()

◆ GetAttributeTypeAsString()

◆ GetElementTypeAsString()

◆ Update()

◆ ReadXMLAttributes()

Member Data Documentation

◆ EnableFieldDataSelection

◆ UseElementTypes