int interval specified by min and max More...

#include <vtkSMIntRangeDomain.h>

Inheritance diagram for vtkSMIntRangeDomain:

Collaboration diagram for vtkSMIntRangeDomain:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsInDomain (vtkSMProperty *property)
int	IsInDomain (unsigned int idx, int val)
int	GetMinimum (unsigned int idx, int &exists)
int	GetMaximum (unsigned int idx, int &exists)
int	GetResolution (unsigned int idx, int &exists)
int	GetResolutionExists (unsigned int idx)
int	GetResolution (unsigned int idx)
void	AddMinimum (unsigned int idx, int value)
void	RemoveMinimum (unsigned int idx)
void	RemoveAllMinima ()
void	AddMaximum (unsigned int idx, int value)
void	RemoveMaximum (unsigned int idx)
void	RemoveAllMaxima ()
void	AddResolution (unsigned int idx, int value)
void	RemoveResolution (unsigned int idx)
void	RemoveAllResolutions ()
unsigned int	GetNumberOfEntries ()
virtual void	Update (vtkSMProperty *)

int	GetMinimumExists (unsigned int idx)
int	GetMaximumExists (unsigned int idx)

int	GetMinimum (unsigned int idx)
int	GetMaximum (unsigned int idx)

virtual void	SetAnimationValue (vtkSMProperty *property, int idx, double value)
Static Public Member Functions
static vtkSMIntRangeDomain *	New ()
static int	IsTypeOf (const char *type)
static vtkSMIntRangeDomain *	SafeDownCast (vtkObject *o)
Protected Types
enum	{ MIN = 0, MAX = 1, RESOLUTION = 2 }
Protected Member Functions
virtual int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement element)
void	SetEntry (unsigned int idx, int minOrMax, int set, int value)
void	SetNumberOfEntries (unsigned int size)
Protected Attributes
vtkSMIntRangeDomainInternals *	IRInternals
virtual int	SetDefaultValues (vtkSMProperty *)
	vtkSMIntRangeDomain ()
	~vtkSMIntRangeDomain ()

Detailed Description

int interval specified by min and max

vtkSMIntRangeDomain represents an interger interval specified using a min and a max value. Valid XML attributes are:

 * min 
 * max

Both min and max attributes can have one or more space space separated (int) arguments. Optionally, a Required Property may be specified (which typically is a information property) which can be used to obtain the range for the values as follows:

 <IntRangeDomain ...>
    <RequiredProperties>
      <Property name="<InfoPropName>" function="RangeInfo" />
    </RequiredProperties>
 </IntRangeDomain>

See also:: vtkSMDomain

Definition at line 50 of file vtkSMIntRangeDomain.h.

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

MIN
MAX
RESOLUTION

Definition at line 177 of file vtkSMIntRangeDomain.h.

Constructor & Destructor Documentation

vtkSMIntRangeDomain::vtkSMIntRangeDomain ( ) [protected]

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.

vtkSMIntRangeDomain::~vtkSMIntRangeDomain ( ) [protected]

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.

Member Function Documentation

static vtkSMIntRangeDomain* vtkSMIntRangeDomain::New ( ) [static]

Reimplemented from vtkSMSessionObject.

Reimplemented in vtkSMNumberOfGroupsDomain, vtkSMDimensionsDomain, vtkSMNumberOfComponentsDomain, and vtkSMExtentDomain.

virtual const char* vtkSMIntRangeDomain::GetClassName ( ) [virtual]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMNumberOfGroupsDomain, vtkSMDimensionsDomain, vtkSMNumberOfComponentsDomain, and vtkSMExtentDomain.

static int vtkSMIntRangeDomain::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMNumberOfGroupsDomain, vtkSMDimensionsDomain, vtkSMNumberOfComponentsDomain, and vtkSMExtentDomain.

virtual int vtkSMIntRangeDomain::IsA ( const char * type ) [virtual]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMNumberOfGroupsDomain, vtkSMDimensionsDomain, vtkSMNumberOfComponentsDomain, and vtkSMExtentDomain.

static vtkSMIntRangeDomain* vtkSMIntRangeDomain::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMNumberOfGroupsDomain, vtkSMDimensionsDomain, vtkSMNumberOfComponentsDomain, and vtkSMExtentDomain.

void vtkSMIntRangeDomain::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMNumberOfGroupsDomain, vtkSMDimensionsDomain, vtkSMNumberOfComponentsDomain, and vtkSMExtentDomain.

virtual int vtkSMIntRangeDomain::IsInDomain ( vtkSMProperty * property ) [virtual]

Returns true if the value of the propery is in the domain. The propery has to be a vtkSMIntVectorProperty. If all vector values are in the domain, it returns 1. It returns 0 otherwise. A value is in the domain if it is between (min, max)

Implements vtkSMDomain.

Reimplemented in vtkSMNumberOfGroupsDomain.

int vtkSMIntRangeDomain::IsInDomain	(	unsigned int	idx,
		int	val
	)

Returns true if the int is in the domain. If value is in domain, it's index is return in idx. A value is in the domain if it is between (min, max)

int vtkSMIntRangeDomain::GetMinimum	(	unsigned int	idx,
		int &	exists
	)

Return a min. value if it exists. If the min. exists exists is set to 1. Otherwise, it is set to 0. An unspecified min. is equivalent to -inf

int vtkSMIntRangeDomain::GetMaximum	(	unsigned int	idx,
		int &	exists
	)

Return a max. value if it exists. If the min. exists exists is set to 1. Otherwise, it is set to 0. An unspecified max. is equivalent to inf

int vtkSMIntRangeDomain::GetMinimumExists ( unsigned int idx )

Returns if minimum/maximum bound is set for the domain.

int vtkSMIntRangeDomain::GetMaximumExists ( unsigned int idx )

Returns if minimum/maximum bound is set for the domain.

int vtkSMIntRangeDomain::GetMinimum ( unsigned int idx )

Returns the minimum/maximum value, is exists, otherwise 0 is returned. Use GetMaximumExists() GetMaximumExists() to make sure that the bound is set.

int vtkSMIntRangeDomain::GetMaximum ( unsigned int idx )

Returns the minimum/maximum value, is exists, otherwise 0 is returned. Use GetMaximumExists() GetMaximumExists() to make sure that the bound is set.

int vtkSMIntRangeDomain::GetResolution	(	unsigned int	idx,
		int &	exists
	)

Return a resolution. value if it exists. If the resolution. exists exists is set to 1. Otherwise, it is set to 0. An unspecified max. is equivalent to 1

int vtkSMIntRangeDomain::GetResolutionExists ( unsigned int idx )

Returns is the relution value is set for the given index.

int vtkSMIntRangeDomain::GetResolution ( unsigned int idx )

Return a resolution. value if it exists, otherwise 0. Use GetResolutionExists() to make sure that the value exists.

void vtkSMIntRangeDomain::AddMinimum	(	unsigned int	idx,
		int	value
	)

Set a min. of a given index.

void vtkSMIntRangeDomain::RemoveMinimum ( unsigned int idx )

Remove a min. of a given index. An unspecified min. is equivalent to -inf

void vtkSMIntRangeDomain::RemoveAllMinima ( )

Clear all minimum values.

void vtkSMIntRangeDomain::AddMaximum	(	unsigned int	idx,
		int	value
	)

Set a max. of a given index.

void vtkSMIntRangeDomain::RemoveMaximum ( unsigned int idx )

Remove a max. of a given index. An unspecified min. is equivalent to inf

void vtkSMIntRangeDomain::RemoveAllMaxima ( )

Clear all maximum values.

void vtkSMIntRangeDomain::AddResolution	(	unsigned int	idx,
		int	value
	)

Set a resolution. of a given index.

void vtkSMIntRangeDomain::RemoveResolution ( unsigned int idx )

Remove a resolution. of a given index. An unspecified resolution. is equivalent to 1

void vtkSMIntRangeDomain::RemoveAllResolutions ( )

Clear all resolution values.

unsigned int vtkSMIntRangeDomain::GetNumberOfEntries ( )

Returns the number of entries in the internal maxima/minima list. No maxima/minima exists beyond this index. Maxima/minima below this number may or may not exist.

virtual void vtkSMIntRangeDomain::Update ( vtkSMProperty * ) [virtual]

Update self checking the "unchecked" values of all required properties. Overwritten by sub-classes.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMNumberOfGroupsDomain, vtkSMNumberOfComponentsDomain, vtkSMDimensionsDomain, and vtkSMExtentDomain.

virtual void vtkSMIntRangeDomain::SetAnimationValue	(	vtkSMProperty *	property,
		int	idx,
		double	value
	)		`[virtual]`

Set the value of an element of a property from the animation editor.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMExtentDomain.

virtual int vtkSMIntRangeDomain::SetDefaultValues ( vtkSMProperty * ) [virtual]

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.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMExtentDomain.

virtual int vtkSMIntRangeDomain::ReadXMLAttributes	(	vtkSMProperty *	prop,
		vtkPVXMLElement *	element
	)		`[protected, virtual]`

Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMNumberOfGroupsDomain.

void vtkSMIntRangeDomain::SetEntry	(	unsigned int	idx,
		int	minOrMax,
		int	set,
		int	value
	)		`[protected]`

General purpose method called by both AddMinimum() and AddMaximum()

void vtkSMIntRangeDomain::SetNumberOfEntries ( unsigned int size ) [protected]

Member Data Documentation

vtkSMIntRangeDomainInternals* vtkSMIntRangeDomain::IRInternals [protected]

Definition at line 174 of file vtkSMIntRangeDomain.h.

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

dox/ParaViewCore/ServerManager/vtkSMIntRangeDomain.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation