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

int range domain based on the data dimensions. More...

#include <vtkSMDimensionsDomain.h>

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

Public Types

typedef vtkSMIntRangeDomain Superclass
 
- Public Types inherited from vtkSMIntRangeDomain
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 *)
 Update the domain using the "unchecked" values (if available) for all required properties. More...
 
- Public Member Functions inherited from vtkSMIntRangeDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetMinimum (unsigned int idx, int &exists)
 Return a min. More...
 
int 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)
 
int GetMinimum (unsigned int idx)
 Returns the minimum/maximum value, is exists, otherwise 0 is returned. More...
 
int 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 vtkSMDimensionsDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDimensionsDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMIntRangeDomain
static vtkSMIntRangeDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMIntRangeDomainSafeDownCast (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

 vtkSMDimensionsDomain ()
 
 ~vtkSMDimensionsDomain ()
 
void Update (vtkSMProxyProperty *pp, vtkSMIntVectorProperty *ivp)
 
int GetDirection (vtkSMIntVectorProperty *ivp)
 
void GetExtent (vtkSMProxyProperty *pp, int extent[6])
 
- Protected Member Functions inherited from vtkSMIntRangeDomain
 vtkSMIntRangeDomain ()
 
 ~vtkSMIntRangeDomain ()
 
- 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 ()
 

Additional Inherited Members

- 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 data dimensions.

vtkSMDimensionsDomain is a subclass of vtkSMIntRangeDomain. It relies on two required properties: "Input", "Direction". "Input" is generally an vtkSMInputProperty which provides the information about the data extents. "Direction" is an option required property which helps determine the direction (VTK_XY_PLANE, VTK_YZ_PLANE or VTK_XZ_PLANE). If "Direction" is not provided then the property must be a 3 element property while when Direction is provided the property must be a 1 element property.

Supported Required-Property functions:

Definition at line 42 of file vtkSMDimensionsDomain.h.

Member Typedef Documentation

§ Superclass

Definition at line 46 of file vtkSMDimensionsDomain.h.

Constructor & Destructor Documentation

§ vtkSMDimensionsDomain()

vtkSMDimensionsDomain::vtkSMDimensionsDomain ( )
protected

§ ~vtkSMDimensionsDomain()

vtkSMDimensionsDomain::~vtkSMDimensionsDomain ( )
protected

Member Function Documentation

§ New()

static vtkSMDimensionsDomain* vtkSMDimensionsDomain::New ( )
static

§ GetClassName()

virtual const char* vtkSMDimensionsDomain::GetClassName ( )
virtual

Reimplemented from vtkSMIntRangeDomain.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMIntRangeDomain.

§ SafeDownCast()

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

§ PrintSelf()

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

§ Update() [1/2]

virtual void vtkSMDimensionsDomain::Update ( vtkSMProperty )
virtual

Update the domain using the "unchecked" values (if available) for all required properties.

Reimplemented from vtkSMDomain.

§ Update() [2/2]

void vtkSMDimensionsDomain::Update ( vtkSMProxyProperty pp,
vtkSMIntVectorProperty ivp 
)
protected

§ GetDirection()

int vtkSMDimensionsDomain::GetDirection ( vtkSMIntVectorProperty ivp)
protected

§ GetExtent()

void vtkSMDimensionsDomain::GetExtent ( vtkSMProxyProperty pp,
int  extent[6] 
)
protected

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