ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMBoundsDomain Class Reference

double range domain based on data set bounds More...

#include <vtkSMBoundsDomain.h>

Inheritance diagram for vtkSMBoundsDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMBoundsDomain:
Collaboration graph
[legend]

Public Types

enum  Modes {
  NORMAL, MAGNITUDE, ORIENTED_MAGNITUDE, SCALED_EXTENT,
  ARRAY_SCALED_EXTENT, APPROXIMATE_CELL_LENGTH, DATA_BOUNDS, EXTENTS
}
 SCALED_EXTENT: is used for vtkPVScaleFactorEntry. More...
 
typedef vtkSMDoubleRangeDomain Superclass
 
- Public Types inherited from vtkSMDoubleRangeDomain
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

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Update (vtkSMProperty *)
 Update self checking the "unchecked" values of all required properties. More...
 
virtual double GetScaleFactor ()
 
virtual int SetDefaultValues (vtkSMProperty *property, bool use_unchecked_values)
 Overridden to handle APPROXIMATE_CELL_LENGTH. More...
 
virtual void SetMode (int)
 
virtual int GetMode ()
 
- Public Member Functions inherited from vtkSMDoubleRangeDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
double GetMinimum (unsigned int idx, int &exists)
 Return a min. More...
 
double GetMaximum (unsigned int idx, int &exists)
 Return a max. More...
 
int GetMinimumExists (unsigned int idx)
 Returns if minimum/maximum bound is set for the domain. More...
 
int GetMaximumExists (unsigned int idx)
 
double GetMinimum (unsigned int idx)
 Returns the minimum/maximum value, is exists, otherwise 0 is returned. More...
 
double GetMaximum (unsigned int idx)
 
- Public Member Functions inherited from vtkSMDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsInDomain (vtkSMProperty *property)=0
 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 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)
 

Static Public Member Functions

static vtkSMBoundsDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMBoundsDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDoubleRangeDomain
static vtkSMDoubleRangeDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDoubleRangeDomainSafeDownCast (vtkObject *o)
 
- 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)
 

Protected Member Functions

 vtkSMBoundsDomain ()
 
 ~vtkSMBoundsDomain ()
 
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
 Set the appropriate ivars from the xml element. More...
 
vtkPVDataInformationGetInputInformation ()
 
void SetDomainValues (double bounds[6])
 
void UpdateOriented ()
 
- Protected Member Functions inherited from vtkSMDoubleRangeDomain
 vtkSMDoubleRangeDomain ()
 
 ~vtkSMDoubleRangeDomain ()
 
- 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

int Mode
 
double ScaleFactor
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

Detailed Description

double range domain based on data set bounds

vtkSMBoundsDomain extends vtkSMDoubleRangeDomain to add support to determine the valid range for the values based on the dataset bounds. There are several Modes which can be used to control how the range is computed based on the data bounds (defined by the vtkSMBoundsDomain::Modes enum).

To determine the input data bounds, this domain depends on a required property with function Input. The data-information from the source-proxy set as the value for that property is used to determine the bounds.

Supported XML attributes:

Definition at line 67 of file vtkSMBoundsDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 71 of file vtkSMBoundsDomain.h.

Member Enumeration Documentation

◆ Modes

SCALED_EXTENT: is used for vtkPVScaleFactorEntry.

Enumerator
NORMAL 
MAGNITUDE 
ORIENTED_MAGNITUDE 
SCALED_EXTENT 
ARRAY_SCALED_EXTENT 
APPROXIMATE_CELL_LENGTH 
DATA_BOUNDS 
EXTENTS 

Definition at line 88 of file vtkSMBoundsDomain.h.

Constructor & Destructor Documentation

◆ vtkSMBoundsDomain()

vtkSMBoundsDomain::vtkSMBoundsDomain ( )
protected

◆ ~vtkSMBoundsDomain()

vtkSMBoundsDomain::~vtkSMBoundsDomain ( )
protected

Member Function Documentation

◆ New()

static vtkSMBoundsDomain* vtkSMBoundsDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMBoundsDomain::GetClassName ( )
virtual

Reimplemented from vtkSMDoubleRangeDomain.

◆ IsTypeOf()

static int vtkSMBoundsDomain::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkSMBoundsDomain::IsA ( const char *  type)
virtual

Reimplemented from vtkSMDoubleRangeDomain.

◆ SafeDownCast()

static vtkSMBoundsDomain* vtkSMBoundsDomain::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkSMBoundsDomain::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ Update()

virtual void vtkSMBoundsDomain::Update ( vtkSMProperty )
virtual

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

Overwritten by sub-classes.

Reimplemented from vtkSMDomain.

◆ SetMode()

virtual void vtkSMBoundsDomain::SetMode ( int  )
virtual

◆ GetMode()

virtual int vtkSMBoundsDomain::GetMode ( )
virtual

◆ GetScaleFactor()

virtual double vtkSMBoundsDomain::GetScaleFactor ( )
virtual

◆ SetDefaultValues()

virtual int vtkSMBoundsDomain::SetDefaultValues ( vtkSMProperty property,
bool  use_unchecked_values 
)
virtual

Overridden to handle APPROXIMATE_CELL_LENGTH.

◆ ReadXMLAttributes()

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

◆ GetInputInformation()

vtkPVDataInformation* vtkSMBoundsDomain::GetInputInformation ( )
protected

◆ SetDomainValues()

void vtkSMBoundsDomain::SetDomainValues ( double  bounds[6])
protected

◆ UpdateOriented()

void vtkSMBoundsDomain::UpdateOriented ( )
protected

Member Data Documentation

◆ Mode

int vtkSMBoundsDomain::Mode
protected

Definition at line 125 of file vtkSMBoundsDomain.h.

◆ ScaleFactor

double vtkSMBoundsDomain::ScaleFactor
protected

Definition at line 126 of file vtkSMBoundsDomain.h.


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