Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkSMIntRangeDomain Class Reference

int interval specified by min and max More...

#include <vtkSMIntRangeDomain.h>

Inheritance diagram for vtkSMIntRangeDomain:

Inheritance graph
[legend]
Collaboration diagram for vtkSMIntRangeDomain:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkSMIntRangeDomain, vtkSMDomain)
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)
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 *)
virtual void SetAnimationValue (vtkSMProperty *property, int idx, double value)

Static Public Member Functions

vtkSMIntRangeDomainNew ()

Protected Types

enum  { MIN = 0, MAX = 1, RESOLUTION = 2 }

Protected Member Functions

 vtkSMIntRangeDomain ()
 ~vtkSMIntRangeDomain ()
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
virtual void SaveState (const char *name, ostream *file, vtkIndent indent)
void SetEntry (unsigned int idx, int minOrMax, int set, int value)
void SetNumberOfEntries (unsigned int size)

Protected Attributes

vtkSMIntRangeDomainInternals * IRInternals

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.
See also:
vtkSMDomain

Definition at line 40 of file vtkSMIntRangeDomain.h.


Member Enumeration Documentation

anonymous enum [protected]
 

Enumeration values:
MIN 
MAX 
RESOLUTION 

Definition at line 138 of file vtkSMIntRangeDomain.h.


Constructor & Destructor Documentation

vtkSMIntRangeDomain::vtkSMIntRangeDomain  )  [protected]
 

vtkSMIntRangeDomain::~vtkSMIntRangeDomain  )  [protected]
 


Member Function Documentation

vtkSMIntRangeDomain* vtkSMIntRangeDomain::New  )  [static]
 

Reimplemented from vtkSMObject.

Reimplemented in vtkSMExtentDomain, and vtkSMNumberOfGroupsDomain.

vtkSMIntRangeDomain::vtkTypeRevisionMacro vtkSMIntRangeDomain  ,
vtkSMDomain 
 

void vtkSMIntRangeDomain::PrintSelf ostream &  os,
vtkIndent  indent
 

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMExtentDomain, and vtkSMNumberOfGroupsDomain.

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

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 vtkSMExtentDomain, and vtkSMNumberOfGroupsDomain.

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

virtual void vtkSMIntRangeDomain::SaveState const char *  name,
ostream *  file,
vtkIndent  indent
[protected, virtual]
 

Saves the state of the object in XML format. Should be overwritten by proxies and properties.

Reimplemented from vtkSMObject.

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 135 of file vtkSMIntRangeDomain.h.


The documentation for this class was generated from the following file:
Generated on Tue May 30 12:39:24 2006 for ParaView by doxygen 1.3.5