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

#include <vtkSMBoundsDomain.h>

Inheritance diagram for vtkSMBoundsDomain:

Collaboration diagram for vtkSMBoundsDomain:

Public Types
enum	Modes { NORMAL, MAGNITUDE, ORIENTED_MAGNITUDE, SCALED_EXTENT, ARRAY_SCALED_EXTENT, APPROXIMATE_CELL_LENGTH, DATA_BOUNDS, EXTENTS, COMPONENT_MAGNITUDE }
	SCALED_EXTENT: is used for vtkPVScaleFactorEntry. More...

enum	Axes { X_AXIS = 1, Y_AXIS = 2, Z_AXIS = 4, X_AND_Y_AXES = X_AXIS \| Y_AXIS, Y_AND_Z_AXES = Y_AXIS \| Z_AXIS, X_AND_Z_AXES = X_AXIS \| Z_AXIS, X_Y_AND_Z_AXES = X_AXIS \| Y_AXIS \| Z_AXIS }

typedef vtkSMDoubleRangeDomain	Superclass

Public Types inherited from vtkSMDoubleRangeDomain
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

void	Update (vtkSMProperty *) override
	Update self checking the "unchecked" values of all required properties. More...

virtual double	GetScaleFactor ()

virtual int	GetAxisFlags ()

int	SetDefaultValues (vtkSMProperty *property, bool use_unchecked_values) override
	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) override

virtual double	GetMinimum (unsigned int idx, int &exists)
	Return a min. More...

virtual double	GetMaximum (unsigned int idx, int &exists)
	Return a max. More...

virtual int	GetMinimumExists (unsigned int idx)
	Returns if minimum/maximum bound is set for the domain. More...

virtual int	GetMaximumExists (unsigned int idx)

virtual double	GetMinimum (unsigned int idx)
	Returns the minimum/maximum value, is exists, otherwise 0 is returned. More...

virtual double	GetMaximum (unsigned int idx)

virtual int	GetResolution ()
	Returns the resolution. 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...

vtkSMProperty *	GetProperty ()
	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...

vtkSMProperty *	GetRequiredProperty (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 vtkPVDataInformation *	GetInputDataInformation (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 vtkPVDataInformation *	GetInputSubsetDataInformation (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 vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual void	SetSession (vtkSMSession *)
	Get/Set the session on wihch this object exists. More...

virtual vtkSMSession *	GetSession ()
	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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkSMBoundsDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMBoundsDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMDoubleRangeDomain
static vtkSMDoubleRangeDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMDoubleRangeDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMDomain
static vtkSMDomain *	New ()

static int	IsTypeOf (const char *type)

static vtkSMDomain *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMBoundsDomain ()

	~vtkSMBoundsDomain () override

int	ReadXMLAttributes (vtkSMProperty prop, vtkPVXMLElement element) override
	Set the appropriate ivars from the xml element. More...

vtkPVDataInformation *	GetInputInformation ()

vtkSMIntVectorProperty *	GetAxisFlagsInformation ()

bool	IsAxisEnabled (int axis)

void	SetDomainValues (double bounds[6])

void	UpdateOriented ()

Protected Member Functions inherited from vtkSMDoubleRangeDomain
	vtkSMDoubleRangeDomain ()

	~vtkSMDoubleRangeDomain () override

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
int	Mode

double	ScaleFactor

int	AxisFlags

Protected Attributes inherited from vtkSMDomain
char *	XMLName

bool	IsOptional

vtkSMDomainInternals *	Internals

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	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

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

NORMAL : this is the basic mode where the domain will have 3 ranges which are the min and max for the bounds along each of the coordinate axis.
MAGNITUDE: the domain has a single range set to (-magn/2.0, +magn/2.0) where magn is the magnitude of the diagonal.
ORIENTED_MAGNITUDE: same as MAGNITUDE, but instead of the diagonal, a vector determined using two additional required properties with functions Normal, and Origin is used.
COMPONENT_MAGNITUDE: similar to MAGNITUDE except suitable for 3 component properties where each component is given range for the corresponding axis i.e. (0, xmax-xmin), (0, ymax-ymin), (0, zmax-zmin).
SCALED_EXTENT: the range is set to (0, maxbounds * this->ScaleFactor) where maxbounds is the length of the longest axis for the bounding box.
ARRAY_SCALED_EXTENT: the range is set to (0, (arrayMagnitude / maxbounds) * this->ScaleFactor) where maxbounds is the length of the longest axis for the bounding box. and arrayMagnitude the maximum magnitude of the array.
APPROXIMATE_CELL_LENGTH: approximation for cell length computed using the
DATA_BOUNDS: this mode for a 6 tuple property that takes the data bounds. The range will have 6 ranges: (xmin,xmax), (xmin,xmax), (ymin,ymax), (ymin,ymax), (zmin,zmax), and (zmin,zmax). If default_mode is not specified, then "min,max,min,max,min,max" is assumed.
EXTENTS: this mode for a property that takes a value between 0 and (max-min) for each component.

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:

mode : used to specify the Mode. Value can be "normal", "magnitude", "oriented_magnitude", "scaled_extent", "array_scaled_extent", or "approximate_cell_length", "data_bounds".
scale_factor : used in SCALED_EXTENT, ARRAY_SCALED_EXTENT and APPROXIMATE_CELL_LENGTH mode. Value is a floating point number that is used as the scale factor.

Definition at line 59 of file vtkSMBoundsDomain.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMDoubleRangeDomain vtkSMBoundsDomain::Superclass

Definition at line 63 of file vtkSMBoundsDomain.h.

Member Enumeration Documentation

◆ Modes

enum vtkSMBoundsDomain::Modes

SCALED_EXTENT: is used for vtkPVScaleFactorEntry.

Enumerator
NORMAL
MAGNITUDE
ORIENTED_MAGNITUDE
SCALED_EXTENT
ARRAY_SCALED_EXTENT
APPROXIMATE_CELL_LENGTH
DATA_BOUNDS
EXTENTS
COMPONENT_MAGNITUDE

Definition at line 80 of file vtkSMBoundsDomain.h.

◆ Axes

enum vtkSMBoundsDomain::Axes

Enumerator
X_AXIS
Y_AXIS
Z_AXIS
X_AND_Y_AXES
Y_AND_Z_AXES
X_AND_Z_AXES
X_Y_AND_Z_AXES

Definition at line 95 of file vtkSMBoundsDomain.h.

Constructor & Destructor Documentation

◆ vtkSMBoundsDomain()

vtkSMBoundsDomain::vtkSMBoundsDomain ( )

protected

◆ ~vtkSMBoundsDomain()

vtkSMBoundsDomain::~vtkSMBoundsDomain ( )

overrideprotected

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
	)

overridevirtual

Reimplemented from vtkObject.

◆ Update()

void vtkSMBoundsDomain::Update ( vtkSMProperty * )

overridevirtual

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

◆ GetAxisFlags()

virtual int vtkSMBoundsDomain::GetAxisFlags ( )

virtual

◆ SetDefaultValues()

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

override

Overridden to handle APPROXIMATE_CELL_LENGTH.

◆ ReadXMLAttributes()

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

◆ GetInputInformation()

vtkPVDataInformation* vtkSMBoundsDomain::GetInputInformation ( )

protected

◆ GetAxisFlagsInformation()

vtkSMIntVectorProperty* vtkSMBoundsDomain::GetAxisFlagsInformation ( )

protected

◆ IsAxisEnabled()

bool vtkSMBoundsDomain::IsAxisEnabled ( int axis )

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 136 of file vtkSMBoundsDomain.h.

◆ ScaleFactor

double vtkSMBoundsDomain::ScaleFactor

protected

Definition at line 137 of file vtkSMBoundsDomain.h.

◆ AxisFlags

int vtkSMBoundsDomain::AxisFlags

protected

Definition at line 138 of file vtkSMBoundsDomain.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMBoundsDomain.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ Modes

◆ Axes

Constructor & Destructor Documentation

◆ vtkSMBoundsDomain()

◆ ~vtkSMBoundsDomain()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Update()

◆ SetMode()

◆ GetMode()

◆ GetScaleFactor()

◆ GetAxisFlags()

◆ SetDefaultValues()

◆ ReadXMLAttributes()

◆ GetInputInformation()

◆ GetAxisFlagsInformation()

◆ IsAxisEnabled()

◆ SetDomainValues()

◆ UpdateOriented()

Member Data Documentation

◆ Mode

◆ ScaleFactor

◆ AxisFlags