vtkSMDoubleRangeDomain Class Reference

double interval specified by min and max More...

#include <vtkSMDoubleRangeDomain.h>

Inheritance diagram for vtkSMDoubleRangeDomain:

Collaboration diagram for vtkSMDoubleRangeDomain:

List of all members.

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, double val)
double	GetMinimum (unsigned int idx, int &exists)
double	GetMaximum (unsigned int idx, int &exists)
double	GetResolution (unsigned int idx, int &exists)
int	GetResolutionExists (unsigned int idx)
double	GetResolution (unsigned int idx)
void	AddMinimum (unsigned int idx, double value)
void	RemoveMinimum (unsigned int idx)
void	RemoveAllMinima ()
void	AddMaximum (unsigned int idx, double value)
void	RemoveMaximum (unsigned int idx)
void	RemoveAllMaxima ()
void	AddResolution (unsigned int idx, double value)
void	RemoveResolution (unsigned int idx)
void	RemoveAllResolutions ()
virtual void	Update (vtkSMProperty *)
unsigned int	GetNumberOfEntries ()
int	GetMinimumExists (unsigned int idx)
int	GetMaximumExists (unsigned int idx)
double	GetMinimum (unsigned int idx)
double	GetMaximum (unsigned int idx)
virtual void	SetAnimationValue (vtkSMProperty *property, int idx, double value)
Static Public Member Functions
static vtkSMDoubleRangeDomain *	New ()
static int	IsTypeOf (const char *type)
static vtkSMDoubleRangeDomain *	SafeDownCast (vtkObject *o)
Protected Types
enum	{ MIN = 0, MAX = 1, RESOLUTION = 2 }
Protected Member Functions
	vtkSMDoubleRangeDomain ()
	~vtkSMDoubleRangeDomain ()
virtual int	ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
void	SetEntry (unsigned int idx, int minOrMax, int set, double value)
void	SetNumberOfEntries (unsigned int size)
Protected Attributes
vtkSMDoubleRangeDomainInternals *	DRInternals

---

Detailed Description

double interval specified by min and max

vtkSMDoubleRangeDomain represents an interval in real space (using double precision) 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 (double) 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:

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

See also:

vtkSMDomain

Definition at line 50 of file vtkSMDoubleRangeDomain.h.

---

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

MIN
MAX
RESOLUTION

Definition at line 167 of file vtkSMDoubleRangeDomain.h.

---

Constructor & Destructor Documentation

vtkSMDoubleRangeDomain::vtkSMDoubleRangeDomain

(

)

[protected]

vtkSMDoubleRangeDomain::~vtkSMDoubleRangeDomain

(

)

[protected]

---

Member Function Documentation

static vtkSMDoubleRangeDomain* vtkSMDoubleRangeDomain::New

(

)

[static]

Reimplemented from vtkSMSessionObject.

Reimplemented in vtkSMArrayRangeDomain, and vtkSMBoundsDomain.

virtual const char* vtkSMDoubleRangeDomain::GetClassName

(

)

[virtual]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMArrayRangeDomain, and vtkSMBoundsDomain.

static int vtkSMDoubleRangeDomain::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMArrayRangeDomain, and vtkSMBoundsDomain.

virtual int vtkSMDoubleRangeDomain::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMArrayRangeDomain, and vtkSMBoundsDomain.

static vtkSMDoubleRangeDomain* vtkSMDoubleRangeDomain::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMArrayRangeDomain, and vtkSMBoundsDomain.

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

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMArrayRangeDomain, and vtkSMBoundsDomain.

virtual int vtkSMDoubleRangeDomain::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.

int vtkSMDoubleRangeDomain::IsInDomain	(	unsigned int	idx,
		double	val
	)

Returns true if the double (val) 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)

double vtkSMDoubleRangeDomain::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

double vtkSMDoubleRangeDomain::GetMaximum	(	unsigned int	idx,
		int &	exists
	)

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

int vtkSMDoubleRangeDomain::GetMinimumExists

(

unsigned int

idx

)

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

int vtkSMDoubleRangeDomain::GetMaximumExists

(

unsigned int

idx

)

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

double vtkSMDoubleRangeDomain::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.

double vtkSMDoubleRangeDomain::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.

double vtkSMDoubleRangeDomain::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 vtkSMDoubleRangeDomain::GetResolutionExists

(

unsigned int

idx

)

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

double vtkSMDoubleRangeDomain::GetResolution

(

unsigned int

idx

)

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

void vtkSMDoubleRangeDomain::AddMinimum	(	unsigned int	idx,
		double	value
	)

Set a min. of a given index.

void vtkSMDoubleRangeDomain::RemoveMinimum

(

unsigned int

idx

)

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

void vtkSMDoubleRangeDomain::RemoveAllMinima

(

)

Clear all minimum values.

void vtkSMDoubleRangeDomain::AddMaximum	(	unsigned int	idx,
		double	value
	)

Set a max. of a given index.

void vtkSMDoubleRangeDomain::RemoveMaximum

(

unsigned int

idx

)

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

void vtkSMDoubleRangeDomain::RemoveAllMaxima

(

)

Clear all maximum values.

void vtkSMDoubleRangeDomain::AddResolution	(	unsigned int	idx,
		double	value
	)

Set a resolution. of a given index.

void vtkSMDoubleRangeDomain::RemoveResolution

(

unsigned int

idx

)

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

void vtkSMDoubleRangeDomain::RemoveAllResolutions

(

)

Clear all resolution values.

virtual void vtkSMDoubleRangeDomain::Update

(

vtkSMProperty *

)

[virtual]

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

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMArrayRangeDomain, and vtkSMBoundsDomain.

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

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

Reimplemented from vtkSMDomain.

unsigned int vtkSMDoubleRangeDomain::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 int vtkSMDoubleRangeDomain::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 vtkSMBoundsDomain.

void vtkSMDoubleRangeDomain::SetEntry	(	unsigned int	idx,
		int	minOrMax,
		int	set,
		double	value
	)		[protected]

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

void vtkSMDoubleRangeDomain::SetNumberOfEntries

(

unsigned int

size

)

[protected]

---

Member Data Documentation

vtkSMDoubleRangeDomainInternals* vtkSMDoubleRangeDomain::DRInternals [protected]

Definition at line 164 of file vtkSMDoubleRangeDomain.h.

---

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

• dox/ParaViewCore/ServerManager/vtkSMDoubleRangeDomain.h