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

double range domain based on array range More...

#include <vtkSMArrayRangeDomain.h>

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

Public Types

typedef vtkSMDoubleRangeDomain Superclass
 
- Public Types inherited from vtkSMDoubleRangeDomain
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 vtkSMDoubleRangeDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
double GetMinimum (unsigned int idx, int &exists)
 Return a min. More...
 
double GetMaximum (unsigned int idx, int &exists)
 Return a max. More...
 
int GetMinimumExists (unsigned int idx)
 Returns if minimum/maximum bound is set for the domain. More...
 
int GetMaximumExists (unsigned int idx)
 
double GetMinimum (unsigned int idx)
 Returns the minimum/maximum value, is exists, otherwise 0 is returned. More...
 
double GetMaximum (unsigned int idx)
 
- Public Member Functions inherited from vtkSMDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsInDomain (vtkSMProperty *property)=0
 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 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 vtkSMArrayRangeDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMArrayRangeDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDoubleRangeDomain
static vtkSMDoubleRangeDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDoubleRangeDomainSafeDownCast (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

 vtkSMArrayRangeDomain ()
 
 ~vtkSMArrayRangeDomain ()
 
void Update (const char *arrayName, int fieldAssociation, vtkSMSourceProxy *producer, int producerPort)
 
- Protected Member Functions inherited from vtkSMDoubleRangeDomain
 vtkSMDoubleRangeDomain ()
 
 ~vtkSMDoubleRangeDomain ()
 
- 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...
 
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *elem)
 Set the appropriate ivars from the xml element. 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 ChildSaveState (vtkPVXMLElement *domainElement)
 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 ()
 

Friends

class vtkSMBoundsDomain
 

Additional Inherited Members

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

Detailed Description

double range domain based on array range

vtkSMArrayRangeDomain is a sub-class of vtkSMDoubleRangeDomain. In it's Update(), it sets min/max values based on the range of an input array. It requires Input (vtkSMProxyProperty) and ArraySelection (vtkSMStringVectorProperty) properties.

See also
vtkSMDoubleRangeDomain vtkSMProxyProperty vtkSMStringVectorProperty

Definition at line 35 of file vtkSMArrayRangeDomain.h.

Member Typedef Documentation

§ Superclass

Definition at line 39 of file vtkSMArrayRangeDomain.h.

Constructor & Destructor Documentation

§ vtkSMArrayRangeDomain()

vtkSMArrayRangeDomain::vtkSMArrayRangeDomain ( )
protected

§ ~vtkSMArrayRangeDomain()

vtkSMArrayRangeDomain::~vtkSMArrayRangeDomain ( )
protected

Member Function Documentation

§ New()

static vtkSMArrayRangeDomain* vtkSMArrayRangeDomain::New ( )
static

§ GetClassName()

virtual const char* vtkSMArrayRangeDomain::GetClassName ( )
virtual

Reimplemented from vtkSMDoubleRangeDomain.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMDoubleRangeDomain.

§ SafeDownCast()

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

§ PrintSelf()

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

§ Update() [1/2]

virtual void vtkSMArrayRangeDomain::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 vtkSMDomain.

§ Update() [2/2]

void vtkSMArrayRangeDomain::Update ( const char *  arrayName,
int  fieldAssociation,
vtkSMSourceProxy producer,
int  producerPort 
)
protected

Friends And Related Function Documentation

§ vtkSMBoundsDomain

friend class vtkSMBoundsDomain
friend

Definition at line 57 of file vtkSMArrayRangeDomain.h.


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