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

extends vtkSMArrayListDomain to add support for arrays from represented data information. More...

#include <vtkSMRepresentedArrayListDomain.h>

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

Public Types

typedef vtkSMArrayListDomain Superclass
 
- Public Types inherited from vtkSMArrayListDomain
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 *) override
 Update the domain. More...
 
virtual bool GetUseTrueParentForRepresentatedDataInformation ()
 Set this to true (default) to let this domain use the represented-data-information from the outer most representation proxy. More...
 
- Public Member Functions inherited from vtkSMArrayListDomain
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
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 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...
 
vtkSMPropertyGetProperty ()
 Provides access to the vtkSMProperty on which this domain is hooked up. More...
 
virtual vtkPVDataInformationGetInputDataInformation (const char *function, unsigned int index=0)
 Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. 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...
 
virtual char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual bool GetIsOptional ()
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
- Public Member Functions inherited from vtkSMSessionObject
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSMRepresentedArrayListDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMRepresentedArrayListDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMArrayListDomain
static vtkSMArrayListDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMArrayListDomainSafeDownCast (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 vtkSMStringListDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMStringListDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
static vtkSMDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMRepresentedArrayListDomain ()
 
 ~vtkSMRepresentedArrayListDomain () override
 
int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *elem) override
 Overridden to process "use_true_parent". More...
 
bool IsFilteredArray (vtkPVDataInformation *info, int association, const char *arrayName) override
 Returns true if an array should be filtered out based on its name or number of tuples (for field data arrays). More...
 
vtkPVDataInformationGetExtraDataInformation () override
 HACK: Provides a temporary mechanism for subclasses to provide an "additional" vtkPVDataInformation instance to get available arrays list from. More...
 
void SetRepresentationProxy (vtkSMRepresentationProxy *)
 
void OnRepresentationDataUpdated ()
 
virtual void SetUseTrueParentForRepresentatedDataInformation (bool)
 
- Protected Member Functions inherited from vtkSMArrayListDomain
 vtkSMArrayListDomain ()
 
 ~vtkSMArrayListDomain () override
 
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...
 
virtual void SetAttributeType (int)
 Set to an attribute type defined in vtkDataSetAttributes. More...
 
- Protected Member Functions inherited from vtkSMStringListDomain
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...
 
vtkSMPropertyGetRequiredProperty (const char *function)
 Returns a given required property of the given function. 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

vtkWeakPointer< vtkSMRepresentationProxyRepresentationProxy
 
unsigned long ObserverId
 
bool UseTrueParentForRepresentatedDataInformation
 
- Protected Attributes inherited from vtkSMArrayListDomain
char * InputDomainName
 
bool PickFirstAvailableArrayByDefault
 
int AttributeType
 Set to an attribute type defined in vtkDataSetAttributes. More...
 
- 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< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

extends vtkSMArrayListDomain to add support for arrays from represented data information.

Representations often add new arrays on top of the ones provided by the inputs to the representations. In that case, the domains for properties that allow users to pick one of those newly added arrays need to show those arrays e.g. "ColorArrayName" property of geometry representations. This domain extends vtkSMArrayListDomain to add arrays from represented data for representations. If the chosen attribute type is not present on the data, no array (or none_string if available) will be chosen.

Definition at line 38 of file vtkSMRepresentedArrayListDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkSMRepresentedArrayListDomain.h.

Constructor & Destructor Documentation

◆ vtkSMRepresentedArrayListDomain()

vtkSMRepresentedArrayListDomain::vtkSMRepresentedArrayListDomain ( )
protected

◆ ~vtkSMRepresentedArrayListDomain()

vtkSMRepresentedArrayListDomain::~vtkSMRepresentedArrayListDomain ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMRepresentedArrayListDomain* vtkSMRepresentedArrayListDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMRepresentedArrayListDomain::GetClassName ( )
virtual

Reimplemented from vtkSMArrayListDomain.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMArrayListDomain.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkSMArrayListDomain.

◆ Update()

void vtkSMRepresentedArrayListDomain::Update ( vtkSMProperty )
overridevirtual

Update the domain.

Reimplemented from vtkSMArrayListDomain.

◆ GetUseTrueParentForRepresentatedDataInformation()

virtual bool vtkSMRepresentedArrayListDomain::GetUseTrueParentForRepresentatedDataInformation ( )
virtual

Set this to true (default) to let this domain use the represented-data-information from the outer most representation proxy.

This ensures that for composite representations where user is provided with a selection between multiple representations, the represented array list domain fills its values up based on the currently active representation type, rather than the representation subproxy from which the property was exposed. In XML, use 'use_true_parent' attribute on the domain element to set this value.

◆ ReadXMLAttributes()

int vtkSMRepresentedArrayListDomain::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement elem 
)
overrideprotectedvirtual

Overridden to process "use_true_parent".

Reimplemented from vtkSMArrayListDomain.

◆ IsFilteredArray()

bool vtkSMRepresentedArrayListDomain::IsFilteredArray ( vtkPVDataInformation info,
int  association,
const char *  arrayName 
)
overrideprotectedvirtual

Returns true if an array should be filtered out based on its name or number of tuples (for field data arrays).

This implementation returns true if the array name matches an expression in the vtkPVColorArrayListSettings singleton.

Reimplemented from vtkSMArrayListDomain.

◆ GetExtraDataInformation()

vtkPVDataInformation* vtkSMRepresentedArrayListDomain::GetExtraDataInformation ( )
overrideprotectedvirtual

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

Reimplemented from vtkSMArrayListDomain.

◆ SetRepresentationProxy()

void vtkSMRepresentedArrayListDomain::SetRepresentationProxy ( vtkSMRepresentationProxy )
protected

◆ OnRepresentationDataUpdated()

void vtkSMRepresentedArrayListDomain::OnRepresentationDataUpdated ( )
protected

◆ SetUseTrueParentForRepresentatedDataInformation()

virtual void vtkSMRepresentedArrayListDomain::SetUseTrueParentForRepresentatedDataInformation ( bool  )
protectedvirtual

Member Data Documentation

◆ RepresentationProxy

vtkWeakPointer<vtkSMRepresentationProxy> vtkSMRepresentedArrayListDomain::RepresentationProxy
protected

Definition at line 92 of file vtkSMRepresentedArrayListDomain.h.

◆ ObserverId

unsigned long vtkSMRepresentedArrayListDomain::ObserverId
protected

Definition at line 93 of file vtkSMRepresentedArrayListDomain.h.

◆ UseTrueParentForRepresentatedDataInformation

bool vtkSMRepresentedArrayListDomain::UseTrueParentForRepresentatedDataInformation
protected

Definition at line 95 of file vtkSMRepresentedArrayListDomain.h.


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