ParaView
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMRangeDomainTemplate< T > Class Template Reference

superclass for type-specific range domains i.e. More...

#include <vtkSMRangeDomainTemplate.h>

Inheritance diagram for vtkSMRangeDomainTemplate< T >:
Inheritance graph
[legend]
Collaboration diagram for vtkSMRangeDomainTemplate< T >:
Collaboration graph
[legend]

Classes

struct  vtkEntry
 

Public Types

enum  DefaultModes { MIN, MAX, MID }
 
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

void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsInDomain (vtkSMProperty *property)
 Returns true if the value of the properyy is in the domain. More...
 
bool IsInDomain (unsigned int idx, T val)
 Returns true if the double (val) is in the domain. More...
 
GetMinimum (unsigned int idx, int &exists)
 Return a min. More...
 
GetMaximum (unsigned int idx, int &exists)
 Return a max. More...
 
GetMinimum (unsigned int idx)
 Returns the minimum/maximum value, is exists, otherwise 0 is returned. More...
 
GetMaximum (unsigned int idx)
 
unsigned int GetNumberOfEntries ()
 Returns the number of entries in the internal maxima/minima list. More...
 
virtual void Update (vtkSMProperty *)
 Update self checking the "unchecked" values of all required properties. More...
 
virtual void SetAnimationValue (vtkSMProperty *property, int idx, double value)
 Set the value of an element of a property from the animation editor. More...
 
DefaultModes GetDefaultMode (unsigned int index=0)
 Get the default-mode that controls how SetDefaultValues() behaves. More...
 
virtual int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values)
 Set the property's default value based on the domain. More...
 
bool GetMinimumExists (unsigned int idx)
 Returns if minimum/maximum bound is set for the domain. More...
 
bool GetMaximumExists (unsigned int idx)
 Returns if minimum/maximum bound is set for the domain. More...
 
- Public Member Functions inherited from vtkSMDomain
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
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)
 

Protected Member Functions

 vtkSMRangeDomainTemplate ()
 
 ~vtkSMRangeDomainTemplate ()
 
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
 Set the appropriate ivars from the xml element. More...
 
const std::vector< vtkEntry > & GetEntries () const
 
void SetEntries (const std::vector< vtkEntry > &new_value)
 
- 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...
 
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 ()
 

Protected Attributes

std::vector< DefaultModesDefaultModeVector
 
DefaultModes DefaultDefaultMode
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

Additional Inherited Members

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

Detailed Description

template<class T>
class vtkSMRangeDomainTemplate< T >

superclass for type-specific range domains i.e.

domains that constrain a value within a min and max.

vtkSMRangeDomainTemplate represents an interval in real space (using precision based on the data-type) 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 value 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>
* 

vtkSMRangeDomainTemplate provides a mechanism to control how the default value for any property can be determined using the domain either the min, max or mid of the range. One can do that using the "default_mode" attribute in XML with valid values as "min", "max", "mid", or a comma separated sequence of the three e.g "min,max,min". If none is specified, "mid" is assumed. The comma-separated sequence can be used to set a different mode for each component of the property i.e. "min,max,min" means set element 0 as min, element 1 as max and element 2 and min. If the number of elements on the property is less than the number of default specified, the last value is assumed to be repeated. Thus, "min,max,min" is same as the regular expression "min,max,min(,min)*".

Definition at line 62 of file vtkSMRangeDomainTemplate.h.

Member Typedef Documentation

◆ Superclass

template<class T >
typedef vtkSMDomain vtkSMRangeDomainTemplate< T >::Superclass

Definition at line 65 of file vtkSMRangeDomainTemplate.h.

Member Enumeration Documentation

◆ DefaultModes

template<class T >
enum vtkSMRangeDomainTemplate::DefaultModes
Enumerator
MIN 
MAX 
MID 

Definition at line 139 of file vtkSMRangeDomainTemplate.h.

Constructor & Destructor Documentation

◆ vtkSMRangeDomainTemplate()

template<class T >
vtkSMRangeDomainTemplate< T >::vtkSMRangeDomainTemplate ( )
protected

◆ ~vtkSMRangeDomainTemplate()

template<class T >
vtkSMRangeDomainTemplate< T >::~vtkSMRangeDomainTemplate ( )
protected

Member Function Documentation

◆ PrintSelf()

template<class T >
void vtkSMRangeDomainTemplate< T >::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ IsInDomain() [1/2]

template<class T >
virtual int vtkSMRangeDomainTemplate< T >::IsInDomain ( vtkSMProperty property)
virtual

Returns true if the value of the properyy is in the domain.

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.

◆ IsInDomain() [2/2]

template<class T >
bool vtkSMRangeDomainTemplate< T >::IsInDomain ( unsigned int  idx,
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)

◆ GetMinimum() [1/2]

template<class T >
T vtkSMRangeDomainTemplate< T >::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

◆ GetMaximum() [1/2]

template<class T >
T vtkSMRangeDomainTemplate< T >::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

◆ GetMinimumExists()

template<class T >
bool vtkSMRangeDomainTemplate< T >::GetMinimumExists ( unsigned int  idx)

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

◆ GetMaximumExists()

template<class T >
bool vtkSMRangeDomainTemplate< T >::GetMaximumExists ( unsigned int  idx)

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

◆ GetMinimum() [2/2]

template<class T >
T vtkSMRangeDomainTemplate< T >::GetMinimum ( unsigned int  idx)
inline

Returns the minimum/maximum value, is exists, otherwise 0 is returned.

Use GetMaximumExists() GetMaximumExists() to make sure that the bound is set.

Definition at line 109 of file vtkSMRangeDomainTemplate.h.

◆ GetMaximum() [2/2]

template<class T >
T vtkSMRangeDomainTemplate< T >::GetMaximum ( unsigned int  idx)
inline

Definition at line 114 of file vtkSMRangeDomainTemplate.h.

◆ GetNumberOfEntries()

template<class T >
unsigned int vtkSMRangeDomainTemplate< T >::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.

◆ Update()

template<class T >
virtual void vtkSMRangeDomainTemplate< T >::Update ( vtkSMProperty )
virtual

Update self checking the "unchecked" values of all required properties.

Reimplemented from vtkSMDomain.

◆ SetAnimationValue()

template<class T >
virtual void vtkSMRangeDomainTemplate< T >::SetAnimationValue ( vtkSMProperty property,
int  idx,
double  value 
)
virtual

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

◆ GetDefaultMode()

template<class T >
DefaultModes vtkSMRangeDomainTemplate< T >::GetDefaultMode ( unsigned int  index = 0)

Get the default-mode that controls how SetDefaultValues() behaves.

◆ SetDefaultValues()

template<class T >
virtual int vtkSMRangeDomainTemplate< T >::SetDefaultValues ( vtkSMProperty ,
bool  use_unchecked_values 
)
virtual

Set the property's default value based on the domain.

How the value is determined using the range is controlled by DefaultMode.

◆ ReadXMLAttributes()

template<class T >
virtual int vtkSMRangeDomainTemplate< T >::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement element 
)
protectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

◆ GetEntries()

template<class T >
const std::vector<vtkEntry>& vtkSMRangeDomainTemplate< T >::GetEntries ( ) const
inlineprotected

Definition at line 198 of file vtkSMRangeDomainTemplate.h.

◆ SetEntries()

template<class T >
void vtkSMRangeDomainTemplate< T >::SetEntries ( const std::vector< vtkEntry > &  new_value)
inlineprotected

Definition at line 199 of file vtkSMRangeDomainTemplate.h.

Member Data Documentation

◆ DefaultModeVector

template<class T >
std::vector<DefaultModes> vtkSMRangeDomainTemplate< T >::DefaultModeVector
protected

Definition at line 210 of file vtkSMRangeDomainTemplate.h.

◆ DefaultDefaultMode

template<class T >
DefaultModes vtkSMRangeDomainTemplate< T >::DefaultDefaultMode
protected

Definition at line 211 of file vtkSMRangeDomainTemplate.h.


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