Classes | Public Types | Public Member Functions | Static 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
enum  IsInDomainReturnCodes { NOT_APPLICABLE = -1, NOT_IN_DOMAIN = 0, IN_DOMAIN = 1 }
 Return values for IsInDomain calls. More...
 
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) override
 
int IsInDomain (vtkSMProperty *property) override
 Returns true if the value of the propertyy 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...
 
int GetResolution ()
 Returns a resolution. More...
 
bool GetResolutionExists ()
 Returns if a resolution is set for the domain. 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...
 
void Update (vtkSMProperty *) override
 Update self checking the "unchecked" values of all required properties. More...
 
void SetAnimationValue (vtkSMProperty *property, int idx, double value) override
 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...
 
int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
 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 int IsInDomain (vtkSMProperty *vtkNotUsed(property))
 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 unsigned int GetNumberOfInputConnections (const char *function)
 Helper method to get the number of input connections hence the number of available vtkPVDataInformation from input proxy connected to the required property with the given function. More...
 
vtkSMPropertyGetRequiredProperty (const char *function)
 Returns a given required property of the given function. More...
 
virtual char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual bool GetIsOptional ()
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
virtual vtkPVDataInformationGetInputDataInformation (const char *function, unsigned int index=0)
 Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
 
virtual vtkPVDataInformationGetInputSubsetDataInformation (unsigned int compositeIndex, const char *function, unsigned int index=0)
 Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
 
- Public Member Functions inherited from vtkSMSessionObject
void PrintSelf (ostream &os, vtkIndent indent) override
 
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 vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSMRangeDomainTemplateSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
static vtkSMDomainNew ()
 
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)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMRangeDomainTemplate ()
 
 ~vtkSMRangeDomainTemplate () override
 
int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) override
 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 () override
 
virtual int LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader))
 Load the state of the domain from the XML. 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...
 
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 () override
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

std::vector< DefaultModesDefaultModeVector
 
DefaultModes DefaultDefaultMode
 
int Resolution
 Resolution is the number of steps in the values list. More...
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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
* * resolution
* 

Both min and max attributes can have one or more space space separated value arguments. Resolution expects only one value. 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 64 of file vtkSMRangeDomainTemplate.h.

Member Typedef Documentation

◆ Superclass

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

Definition at line 67 of file vtkSMRangeDomainTemplate.h.

Member Enumeration Documentation

◆ DefaultModes

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

Definition at line 152 of file vtkSMRangeDomainTemplate.h.

Constructor & Destructor Documentation

◆ vtkSMRangeDomainTemplate()

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

◆ ~vtkSMRangeDomainTemplate()

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

Member Function Documentation

◆ GetClassName()

template<class T >
virtual const char* vtkSMRangeDomainTemplate< T >::GetClassName ( )
virtual

Reimplemented from vtkSMDomain.

◆ IsTypeOf()

template<class T >
static int vtkSMRangeDomainTemplate< T >::IsTypeOf ( const char *  type)
static

◆ IsA()

template<class T >
virtual int vtkSMRangeDomainTemplate< T >::IsA ( const char *  type)
virtual

Reimplemented from vtkSMDomain.

◆ SafeDownCast()

template<class T >
static vtkSMRangeDomainTemplate* vtkSMRangeDomainTemplate< T >::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

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

Reimplemented from vtkSMDomain.

◆ IsInDomain() [1/2]

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

Returns true if the value of the propertyy 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).

◆ 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

◆ GetResolution()

template<class T >
int vtkSMRangeDomainTemplate< T >::GetResolution ( )

Returns a resolution.

Default is -1.

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

◆ GetResolutionExists()

template<class T >
bool vtkSMRangeDomainTemplate< T >::GetResolutionExists ( )

Returns if a resolution 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 122 of file vtkSMRangeDomainTemplate.h.

◆ GetMaximum() [2/2]

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

Definition at line 127 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 >
void vtkSMRangeDomainTemplate< T >::Update ( vtkSMProperty )
overridevirtual

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

Reimplemented from vtkSMDomain.

◆ SetAnimationValue()

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

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 >
int vtkSMRangeDomainTemplate< T >::SetDefaultValues ( vtkSMProperty ,
bool  use_unchecked_values 
)
override

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 >
int vtkSMRangeDomainTemplate< T >::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement element 
)
overrideprotectedvirtual

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 211 of file vtkSMRangeDomainTemplate.h.

◆ SetEntries()

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

Definition at line 212 of file vtkSMRangeDomainTemplate.h.

Member Data Documentation

◆ DefaultModeVector

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

Definition at line 223 of file vtkSMRangeDomainTemplate.h.

◆ DefaultDefaultMode

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

Definition at line 224 of file vtkSMRangeDomainTemplate.h.

◆ Resolution

template<class T >
int vtkSMRangeDomainTemplate< T >::Resolution
protected

Resolution is the number of steps in the values list.

Definition at line 229 of file vtkSMRangeDomainTemplate.h.


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