list of arrays obtained from input More...

#include <vtkSMArrayListDomain.h>

Inheritance diagram for vtkSMArrayListDomain:

[legend]

Collaboration diagram for vtkSMArrayListDomain:

Public Types
enum	InformationKeyStrategy { NEED_KEY, REJECT_KEY }

typedef vtkSMStringListDomain	Superclass

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

void	Update (vtkSMProperty *prop) override
	Updates the string list based on the available arrays. More...

int	IsArrayPartial (unsigned int idx)
	Returns true if the array with the given idx is partial false otherwise. More...

int	GetFieldAssociation (unsigned int idx)
	Get field association for the array. More...

int	GetDomainAssociation (unsigned int idx)
	Get the true field association for the array. More...

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

unsigned int	RemoveInformationKey (const char location, const char name)
	Removes an InformationKey from this domain. More...

unsigned int	GetNumberOfInformationKeys ()
	Returns the number of InformationKeys in this domain. More...

void	RemoveAllInformationKeys ()
	Removes all InformationKeys from this domain. More...


virtual int	GetAttributeType ()
	Return the attribute type. More...


virtual unsigned int	AddInformationKey (const char location, const char name, int strategy)
	Adds a new InformationKey to the domain. More...

virtual unsigned int	AddInformationKey (const char location, const char name)
	Adds a new InformationKey to the domain. More...


const char *	GetInformationKeyLocation (unsigned int)
	Returns the location/name/strategy of a given InformationKey. More...

const char *	GetInformationKeyName (unsigned int)
	Returns the location/name/strategy of a given InformationKey. More...

int	GetInformationKeyStrategy (unsigned int)
	Returns the location/name/strategy of a given InformationKey. More...

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

int	IsInDomain (vtkSMProperty *property) override
	Returns true if the value of the property is in the domain. More...

int	IsInDomain (const char *string, unsigned int &idx)
	Returns true if the string is in the domain. More...

const char *	GetString (unsigned int idx)
	Returns a string in the domain. More...

unsigned int	GetNumberOfStrings ()
	Returns the number of strings in the domain. More...

void	Update (vtkSMProperty *) override
	Update self checking the "unchecked" values of all required properties. More...

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

virtual char *	GetNoneString ()
	Return the string that is used as "none_string" in XML configuration. More...

virtual void	SetNoneString (const char *)
	Return the string that is used as "none_string" in XML configuration. More...

int	SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
	A vtkSMProperty is often defined with a default value in the XML itself. 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...

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

static int	IsTypeOf (const char *type)

static vtkSMArrayListDomain *	SafeDownCast (vtkObject *o)

static std::string	CreateMangledName (vtkPVArrayInformation *arrayInfo, int component)
	returns the mangled name for the component index that is passed in. More...


static std::string	ArrayNameFromMangledName (const char *name)
	returns the mangled name for the component index that is passed in. More...

static int	ComponentIndexFromMangledName (vtkPVArrayInformation info, const char name)
	returns the mangled name for the component index that is passed in. More...

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

static int	IsTypeOf (const char *type)

static vtkSMStringListDomain *	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
	vtkSMArrayListDomain ()

	~vtkSMArrayListDomain () override

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

virtual vtkPVDataInformation *	GetExtraDataInformation ()
	HACK: Provides a temporary mechanism for subclasses to provide an "additional" vtkPVDataInformation instance to get available arrays list from. More...

virtual bool	IsFilteredArray (vtkPVDataInformation info, int association, const char arrayName)
	Returns true if an array should be filtered out. More...


virtual char *	GetInputDomainName ()
	InputDomainName refers to a input property domain that describes the type of array is needed by this property. More...

virtual void	SetInputDomainName (const char *)
	InputDomainName refers to a input property domain that describes the type of array is needed by this property. More...

Protected Member Functions inherited from vtkSMStringListDomain
int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement element) override
	Set the appropriate ivars from the xml element. More...

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

virtual void	SetStrings (const std::vector< std::string > &strings)
	Call to set the strings. More...

const std::vector< std::string > &	GetStrings ()
	Call to set the strings. More...

	vtkSMStringListDomain ()
	A vtkSMProperty is often defined with a default value in the XML itself. More...

	~vtkSMStringListDomain () override
	A vtkSMProperty is often defined with a default value in the XML itself. 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
char *	InputDomainName

bool	PickFirstAvailableArrayByDefault

Protected Attributes inherited from vtkSMStringListDomain
char *	NoneString
	Default string always present in this string list. More...

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

Friends
class	vtkSMArrayListDomainInternals

int	AttributeType
	Set to an attribute type defined in vtkDataSetAttributes. More...

virtual void	SetAttributeType (int)
	Set to an attribute type defined in vtkDataSetAttributes. More...

Detailed Description

list of arrays obtained from input

vtkSMArrayListDomain is used on vtkSMStringVectorProperty when the values on the property correspond to data arrays in the input.

Supported Required Property Functions:

Input : (required) this point to a vtkSMInputProperty on the parent proxy. The value of this property provides the source that provides the data information to determine the available arrays.
FieldDataSelection : (optional) this points a vtkSMIntVectorProperty that provide the array association for accepted arrays as defined by vtkDataObject::FieldAssociations. If FieldDataSelection is missing, then the array association is determined using the vtkSMInputArrayDomain on the vtkSMInputProperty pointed by the required function Input. If the input property has multiple vtkSMInputArrayDomain types, you can identify the domain to use by using the
input_domain_name XML attribute. If neither the FieldDataSelection is specified and no vtkSMInputArrayDomain is found, then this domain assumes that all array associations are valid.
AssemblyName : (optional) Instead of checking all the arrays, you can check only the arrays that are part of a specific assembly using specified selectors. This is useful when you want to get a subset of the arrays.
Selectors : (optional) The selectors are used in conjunction with the AssemblyName property. The selectors are used to filter the arrays that are part of the assembly.

Supported XML attributes:

attribute_type : (optional) when specified, this is used to pick the default value in SetDefaultValues. This specifies the array-attribute type to pick as the default, if available e.g. if value is "Scalars", then by default the active scalar array will be picked, if available. Not to be confused with vtkDataObject::AttributeTypes, this corresponds to vtkDataSetAttributes::AttributeTypes. Accepted values are "Scalars", "Vectors", etc., as defined by vtkDataSetAttributes::AttributeNames.
data_type: (optional) when specified qualifies the acceptable arrays list to the types specified. Value can be one or more of VTK_BIT, VTK_CHAR, VTK_INT, VTK_FLOAT, VTK_DOUBLE,... etc. or the equivalent integers from vtkType.h. VTK_VOID, and 0 are equivalent to not specifying, meaning any data type. VTK_DATA_ARRAY can be used to limit to vtkDataArray subclasses.
none_string: (optional) when specified, this string appears as the first entry in the domain the list and can be used to show "None", or "Not available" etc.
key_location / key_name / key_strategy: (optional) those tree attributes are related to InformationKey of the array. key_location/key_name are the location and name of the given InformationKey key_strategy specifies if this specific key is needed to be in the domain or if this key is rejected. One of need_key or reject_key. if nothing is specified, the default is to add a vtkAbstractArray::GUI_HIDE key, with the reject_key strategy, so that arrays that have this InformationKey are not visible in the user interface.

Definition at line 79 of file vtkSMArrayListDomain.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMStringListDomain vtkSMArrayListDomain::Superclass

Definition at line 83 of file vtkSMArrayListDomain.h.

Member Enumeration Documentation

◆ InformationKeyStrategy

enum vtkSMArrayListDomain::InformationKeyStrategy

Enumerator
NEED_KEY
REJECT_KEY

Definition at line 154 of file vtkSMArrayListDomain.h.

Constructor & Destructor Documentation

◆ vtkSMArrayListDomain()

vtkSMArrayListDomain::vtkSMArrayListDomain ( )

protected

◆ ~vtkSMArrayListDomain()

vtkSMArrayListDomain::~vtkSMArrayListDomain ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMArrayListDomain* vtkSMArrayListDomain::New ( )

static

◆ GetClassName()

virtual const char* vtkSMArrayListDomain::GetClassName ( )

virtual

Reimplemented from vtkSMStringListDomain.

Reimplemented in vtkSMRepresentedArrayListDomain.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMStringListDomain.

Reimplemented in vtkSMRepresentedArrayListDomain.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkSMRepresentedArrayListDomain.

◆ Update()

void vtkSMArrayListDomain::Update ( vtkSMProperty * prop )

overridevirtual

Updates the string list based on the available arrays.

Requires a property of class vtkSMProxyProperty which points to a vtkSMSourceProxy and contains a vtkSMInputArrayDomain. Only the first proxy and domain are used.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMRepresentedArrayListDomain.

◆ IsArrayPartial()

int vtkSMArrayListDomain::IsArrayPartial ( unsigned int idx )

Returns true if the array with the given idx is partial false otherwise.

See vtkPVArrayInformation for more information.

◆ GetFieldAssociation()

int vtkSMArrayListDomain::GetFieldAssociation ( unsigned int idx )

Get field association for the array.

When vtkSMInputArrayDomain::AutomaticPropertyConversion is ON, this is not the true association for a particular array, but what the target filter is expecting. Thus use this to set the value on the property. To correctly show icons in UI, use GetDomainAssociation().

◆ GetDomainAssociation()

int vtkSMArrayListDomain::GetDomainAssociation ( unsigned int idx )

Get the true field association for the array.

This is same as GetFieldAssociation() except when vtkSMInputArrayDomain::AutomaticPropertyConversion is ON. In that case, this may be different. e.g. let's say Pressure is a point array on the input, however this filter only works with cell array. In that case, since AutomaticPropertyConversion is ON, vtkPVPostFilter is going to automatically convert the point array Pressure to a cell array for the filter. Now in this case, the SetInputArrayToProcess property on the filter must be set to ask a "cell" array named Pressure, despite the fact that there's no such cell array. And the UI needs to show the "Pressure" as a point array, since that's what the user is expecting. In this case, GetFieldAssociation() is going to return "CELL" for the "Pressure", while GetDomainAssociation() is going to return "POINT". Thus, use GetFieldAssociation() for setting the property value, but use GetDomainAssociation() for the icon.

◆ GetAttributeType()

virtual int vtkSMArrayListDomain::GetAttributeType ( )

virtual

Return the attribute type.

The values are listed in vtkDataSetAttributes.h.

◆ SetDefaultValues()

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

override

A vtkSMProperty is often defined with a default value in the XML itself.

However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property. Returns 1 if the domain updated the property.

◆ AddInformationKey() [1/2]

virtual unsigned int vtkSMArrayListDomain::AddInformationKey	(	const char *	location,
		const char *	name,
		int	strategy
	)

virtual

Adds a new InformationKey to the domain.

The default strategy is NEED_KEY if none is specified. If no InformationKey is specified in the xml, the default behavior is to create a rejected key vtkAbstractArray::GUI_HIDE

◆ AddInformationKey() [2/2]

virtual unsigned int vtkSMArrayListDomain::AddInformationKey	(	const char *	location,
		const char *	name
	)

inlinevirtual

Adds a new InformationKey to the domain.

The default strategy is NEED_KEY if none is specified. If no InformationKey is specified in the xml, the default behavior is to create a rejected key vtkAbstractArray::GUI_HIDE

Definition at line 168 of file vtkSMArrayListDomain.h.

◆ RemoveInformationKey()

unsigned int vtkSMArrayListDomain::RemoveInformationKey	(	const char *	location,
		const char *	name
	)

Removes an InformationKey from this domain.

◆ GetNumberOfInformationKeys()

unsigned int vtkSMArrayListDomain::GetNumberOfInformationKeys ( )

Returns the number of InformationKeys in this domain.

◆ RemoveAllInformationKeys()

void vtkSMArrayListDomain::RemoveAllInformationKeys ( )

Removes all InformationKeys from this domain.

◆ GetInformationKeyLocation()

const char* vtkSMArrayListDomain::GetInformationKeyLocation ( unsigned int )

Returns the location/name/strategy of a given InformationKey.

◆ GetInformationKeyName()

const char* vtkSMArrayListDomain::GetInformationKeyName ( unsigned int )

Returns the location/name/strategy of a given InformationKey.

◆ GetInformationKeyStrategy()

int vtkSMArrayListDomain::GetInformationKeyStrategy ( unsigned int )

Returns the location/name/strategy of a given InformationKey.

◆ CreateMangledName()

static std::string vtkSMArrayListDomain::CreateMangledName	(	vtkPVArrayInformation *	arrayInfo,
		int	component
	)

static

returns the mangled name for the component index that is passed in.

◆ ArrayNameFromMangledName()

static std::string vtkSMArrayListDomain::ArrayNameFromMangledName ( const char * name )

static

returns the mangled name for the component index that is passed in.

◆ ComponentIndexFromMangledName()

static int vtkSMArrayListDomain::ComponentIndexFromMangledName	(	vtkPVArrayInformation *	info,
		const char *	name
	)

static

returns the mangled name for the component index that is passed in.

◆ ReadXMLAttributes()

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

overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMRepresentedArrayListDomain.

◆ GetExtraDataInformation()

virtual vtkPVDataInformation* vtkSMArrayListDomain::GetExtraDataInformation ( )

inlineprotectedvirtual

HACK: Provides a temporary mechanism for subclasses to provide an "additional" vtkPVDataInformation instance to get available arrays list from.

Reimplemented in vtkSMRepresentedArrayListDomain.

Definition at line 228 of file vtkSMArrayListDomain.h.

◆ IsFilteredArray()

virtual bool vtkSMArrayListDomain::IsFilteredArray	(	vtkPVDataInformation *	info,
		int	association,
		const char *	arrayName
	)

protectedvirtual

Returns true if an array should be filtered out.

This is typically used to filter out arrays based on their names by subclasses. This implementation always returns false, but subclasses may override.

Reimplemented in vtkSMRepresentedArrayListDomain.

◆ SetAttributeType()

virtual void vtkSMArrayListDomain::SetAttributeType ( int )

protectedvirtual

Set to an attribute type defined in vtkDataSetAttributes.

◆ GetInputDomainName()

virtual char* vtkSMArrayListDomain::GetInputDomainName ( )

protectedvirtual

InputDomainName refers to a input property domain that describes the type of array is needed by this property.

◆ SetInputDomainName()

virtual void vtkSMArrayListDomain::SetInputDomainName ( const char * )

protectedvirtual

InputDomainName refers to a input property domain that describes the type of array is needed by this property.

Friends And Related Function Documentation

◆ vtkSMArrayListDomainInternals

friend class vtkSMArrayListDomainInternals

friend

Definition at line 265 of file vtkSMArrayListDomain.h.

Member Data Documentation

◆ AttributeType

int vtkSMArrayListDomain::AttributeType

protected

Set to an attribute type defined in vtkDataSetAttributes.

Definition at line 241 of file vtkSMArrayListDomain.h.

◆ InputDomainName

char* vtkSMArrayListDomain::InputDomainName

protected

Definition at line 251 of file vtkSMArrayListDomain.h.

◆ PickFirstAvailableArrayByDefault

bool vtkSMArrayListDomain::PickFirstAvailableArrayByDefault

protected

Definition at line 259 of file vtkSMArrayListDomain.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ InformationKeyStrategy

Constructor & Destructor Documentation

◆ vtkSMArrayListDomain()

◆ ~vtkSMArrayListDomain()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Update()

◆ IsArrayPartial()

◆ GetFieldAssociation()

◆ GetDomainAssociation()

◆ GetAttributeType()

◆ SetDefaultValues()

◆ AddInformationKey() [1/2]

◆ AddInformationKey() [2/2]

◆ RemoveInformationKey()

◆ GetNumberOfInformationKeys()

◆ RemoveAllInformationKeys()

◆ GetInformationKeyLocation()

◆ GetInformationKeyName()

◆ GetInformationKeyStrategy()

◆ CreateMangledName()

◆ ArrayNameFromMangledName()

◆ ComponentIndexFromMangledName()

◆ ReadXMLAttributes()

◆ GetExtraDataInformation()

◆ IsFilteredArray()

◆ SetAttributeType()

◆ GetInputDomainName()

◆ SetInputDomainName()

Friends And Related Function Documentation

◆ vtkSMArrayListDomainInternals

Member Data Documentation

◆ AttributeType

◆ InputDomainName

◆ PickFirstAvailableArrayByDefault