ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSMNumberOfComponentsDomain Class Reference

int range domain based on the number of components available in a particular data array. More...

#include <vtkSMNumberOfComponentsDomain.h>

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

Public Types

typedef vtkSMEnumerationDomain Superclass
 
- Public Types inherited from vtkSMEnumerationDomain
typedef vtkSMDomain Superclass
 
- Public Types inherited from vtkSMDomain
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)
 
virtual void Update (vtkSMProperty *prop)
 Updates the range based on the scalar range of the currently selected array. More...
 
- Public Member Functions inherited from vtkSMEnumerationDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsInDomain (vtkSMProperty *property)
 Returns true if the value of the propery 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...
 
void AddEntry (const char *text, int value)
 Add a new enumeration entry. More...
 
void RemoveAllEntries ()
 Clear all entries. More...
 
virtual int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values)
 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
void PrintSelf (ostream &os, vtkIndent indent)
 
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 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
void PrintSelf (ostream &os, vtkIndent indent)
 
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 vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMNumberOfComponentsDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMNumberOfComponentsDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMEnumerationDomain
static vtkSMEnumerationDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMEnumerationDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
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)
 

Protected Member Functions

 vtkSMNumberOfComponentsDomain ()
 
 ~vtkSMNumberOfComponentsDomain ()
 
void Update (const char *arrayname, vtkSMSourceProxy *sp, vtkSMInputArrayDomain *iad, int outputport)
 Internal update method doing the actual work. More...
 
- Protected Member Functions inherited from vtkSMEnumerationDomain
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
 Set the appropriate ivars from the xml element. More...
 
virtual void ChildSaveState (vtkPVXMLElement *domainElement)
 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 ()
 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 ()
 
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...
 
virtual vtkPVDataInformationGetInputDataInformation (const char *function, int index=0)
 Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function. 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 ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMEnumerationDomain
vtkSMEnumerationDomainInternals * EInternals
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

Detailed Description

int range domain based on the number of components available in a particular data array.

vtkSMNumberOfComponentsDomain is used for properties that allow the user to choose the component number (or associated name) to process for the choosen array. It needs two required properties with following functions:

Definition at line 37 of file vtkSMNumberOfComponentsDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkSMNumberOfComponentsDomain.h.

Constructor & Destructor Documentation

◆ vtkSMNumberOfComponentsDomain()

vtkSMNumberOfComponentsDomain::vtkSMNumberOfComponentsDomain ( )
protected

◆ ~vtkSMNumberOfComponentsDomain()

vtkSMNumberOfComponentsDomain::~vtkSMNumberOfComponentsDomain ( )
protected

Member Function Documentation

◆ New()

static vtkSMNumberOfComponentsDomain* vtkSMNumberOfComponentsDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMNumberOfComponentsDomain::GetClassName ( )
virtual

Reimplemented from vtkSMEnumerationDomain.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMEnumerationDomain.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ Update() [1/2]

virtual void vtkSMNumberOfComponentsDomain::Update ( vtkSMProperty prop)
virtual

Updates the range based on the scalar range of the currently selected array.

This requires Input (vtkSMProxyProperty) and ArraySelection (vtkSMStringVectorProperty) properties. Currently, this uses only the first component of the array.

Reimplemented from vtkSMEnumerationDomain.

◆ Update() [2/2]

void vtkSMNumberOfComponentsDomain::Update ( const char *  arrayname,
vtkSMSourceProxy sp,
vtkSMInputArrayDomain iad,
int  outputport 
)
protected

Internal update method doing the actual work.


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