vtkPVBox Class Reference

extends vtkBox to add ParaView specific API. More...

#include <vtkPVBox.h>

Inheritance diagram for vtkPVBox:

Collaboration diagram for vtkPVBox:

Public Types
typedef vtkBox	Superclass
Public Types inherited from vtkBox
typedef vtkImplicitFunction	Superclass
Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetReferenceBounds (const double bds[6])
	These bounds are used when UseReferenceBounds is set to true. More...
void	SetReferenceBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
	These bounds are used when UseReferenceBounds is set to true. More...
virtual double *	GetReferenceBounds ()
	These bounds are used when UseReferenceBounds is set to true. More...
virtual void	GetReferenceBounds (double &, double &, double &, double &, double &, double &)
	These bounds are used when UseReferenceBounds is set to true. More...
virtual void	GetReferenceBounds (double [6])
	These bounds are used when UseReferenceBounds is set to true. More...
void	SetUseReferenceBounds (bool val)
	Set to true to use ReferenceBounds as the basis for the transformation instead of unit box. More...
virtual bool	GetUseReferenceBounds ()
	Set to true to use ReferenceBounds as the basis for the transformation instead of unit box. More...
void	SetPosition (double x, double y, double z)
	Get/Set Position of the box. More...
void	SetPosition (const double pos[3])
	Get/Set Position of the box. More...
virtual double *	GetPosition ()
	Get/Set Position of the box. More...
virtual void	GetPosition (double &, double &, double &)
	Get/Set Position of the box. More...
virtual void	GetPosition (double [3])
	Get/Set Position of the box. More...
void	SetRotation (double x, double y, double z)
	Get/Set Rotation for the box. More...
void	SetRotation (const double pos[3])
	Get/Set Rotation for the box. More...
virtual double *	GetRotation ()
	Get/Set Rotation for the box. More...
virtual void	GetRotation (double &, double &, double &)
	Get/Set Rotation for the box. More...
virtual void	GetRotation (double [3])
	Get/Set Rotation for the box. More...
void	SetScale (double x, double y, double z)
	Get/Set Scale for the box. More...
void	SetScale (const double pos[3])
	Get/Set Scale for the box. More...
virtual double *	GetScale ()
	Get/Set Scale for the box. More...
virtual void	GetScale (double &, double &, double &)
	Get/Set Scale for the box. More...
virtual void	GetScale (double [3])
	Get/Set Scale for the box. More...
Public Member Functions inherited from vtkBox
vtkBox *	NewInstance () const
void	EvaluateGradient (double x[3], double n[3])
void	SetXMax (double p[3])
void	SetXMax (double x, double y, double z)
void	GetXMax (double p[3])
void	GetXMax (double &x, double &y, double &z)
void	SetBounds (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
void	SetBounds (const double bounds[6])
void	GetBounds (double &xMin, double &xMax, double &yMin, double &yMax, double &zMin, double &zMax)
void	GetBounds (double bounds[6])
double *	GetBounds ()
void	AddBounds (const double bounds[6])
double	EvaluateFunction (double x[3])
double	EvaluateFunction (double x, double y, double z)
void	SetXMin (double p[3])
void	SetXMin (double x, double y, double z)
void	GetXMin (double p[3])
void	GetXMin (double &x, double &y, double &z)
double	EvaluateFunction (double x[3])
double	EvaluateFunction (double x, double y, double z)
void	SetXMin (double p[3])
void	SetXMin (double x, double y, double z)
void	GetXMin (double p[3])
void	GetXMin (double &x, double &y, double &z)
Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () const
vtkMTimeType	GetMTime ()
double	FunctionValue (const double x[3])
double	FunctionValue (double x, double y, double z)
void	FunctionGradient (const double x[3], double g[3])
double *	FunctionGradient (const double x[3])
double *	FunctionGradient (double x, double y, double z)
virtual void	SetTransform (vtkAbstractTransform *)
virtual void	SetTransform (const double elements[16])
virtual vtkAbstractTransform *	GetTransform ()
double	EvaluateFunction (double x, double y, double z)
double	FunctionValue (const double x[3])
double	FunctionValue (double x, double y, double z)
void	FunctionGradient (const double x[3], double g[3])
double *	FunctionGradient (const double x[3])
double *	FunctionGradient (double x, double y, double z)
virtual void	SetTransform (vtkAbstractTransform *)
virtual void	SetTransform (const double elements[16])
virtual vtkAbstractTransform *	GetTransform ()
double	EvaluateFunction (double x, double y, double z)
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
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 vtkPVBox *	New ()
static int	IsTypeOf (const char *type)
static vtkPVBox *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkBox
static int	IsTypeOf (const char *type)
static vtkBox *	SafeDownCast (vtkObjectBase *o)
static vtkBox *	New ()
static char	IntersectBox (double bounds[6], double origin[3], double dir[3], double coord[3], double &t)
static int	IntersectWithLine (const double bounds[6], const double p1[3], const double p2[3], double &t1, double &t2, double x1[3], double x2[3], int &plane1, int &plane2)
static char	IntersectBox (double bounds[6], double origin[3], double dir[3], double coord[3], double &t)
static int	IntersectWithLine (const double bounds[6], const double p1[3], const double p2[3], double &t1, double &t2, double x1[3], double x2[3], int &plane1, int &plane2)
Static Public Member Functions inherited from vtkImplicitFunction
static int	IsTypeOf (const char *type)
static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)
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
	vtkPVBox ()
	~vtkPVBox () override
void	UpdateTransform ()
Protected Member Functions inherited from vtkBox
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkBox ()
	~vtkBox ()
Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()
	~vtkImplicitFunction ()
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
double	Position [3]
double	Rotation [3]
double	Scale [3]
double	ReferenceBounds [6]
bool	UseReferenceBounds
Protected Attributes inherited from vtkBox
vtkBoundingBox *	BBox
double	Bounds [6]
Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransform *	Transform
double	ReturnValue [3]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

extends vtkBox to add ParaView specific API.

vtkPVBox extends vtkBox to add ParaView specific API. We add ability to provide a transform using position, scale and orientation. The transform can be applied to a unit box or a explicitly specified bounds.

Definition at line 18 of file vtkPVBox.h.

Member Typedef Documentation

Superclass

typedef vtkBox vtkPVBox::Superclass

Definition at line 22 of file vtkPVBox.h.

Constructor & Destructor Documentation

vtkPVBox()

vtkPVBox::vtkPVBox ( )

protected

~vtkPVBox()

vtkPVBox::~vtkPVBox ( )

overrideprotected

Member Function Documentation

New()

static vtkPVBox* vtkPVBox::New ( )

static

GetClassName()

virtual const char* vtkPVBox::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkBox.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkBox.

SetReferenceBounds() [1/2]

void vtkPVBox::SetReferenceBounds

(

const double

bds[6]

)

These bounds are used when UseReferenceBounds is set to true.

In that case, the position, rotation and scale is assumed to be relative to these bounds. Otherwise, it's assumed to be absolute values i.e. relative to a unit box.

SetReferenceBounds() [2/2]

void vtkPVBox::SetReferenceBounds ( double  xmin, double  xmax, double  ymin, double  ymax, double  zmin, double  zmax  )

inline

These bounds are used when UseReferenceBounds is set to true.

In that case, the position, rotation and scale is assumed to be relative to these bounds. Otherwise, it's assumed to be absolute values i.e. relative to a unit box.

Definition at line 33 of file vtkPVBox.h.

GetReferenceBounds() [1/3]

virtual double* vtkPVBox::GetReferenceBounds ( )

virtual

These bounds are used when UseReferenceBounds is set to true.

In that case, the position, rotation and scale is assumed to be relative to these bounds. Otherwise, it's assumed to be absolute values i.e. relative to a unit box.

GetReferenceBounds() [2/3]

virtual void vtkPVBox::GetReferenceBounds ( double &  , double &  , double &  , double &  , double &  , double &    )

virtual

These bounds are used when UseReferenceBounds is set to true.

In that case, the position, rotation and scale is assumed to be relative to these bounds. Otherwise, it's assumed to be absolute values i.e. relative to a unit box.

GetReferenceBounds() [3/3]

virtual void vtkPVBox::GetReferenceBounds ( double  [6] )

virtual

These bounds are used when UseReferenceBounds is set to true.

In that case, the position, rotation and scale is assumed to be relative to these bounds. Otherwise, it's assumed to be absolute values i.e. relative to a unit box.

SetUseReferenceBounds()

void vtkPVBox::SetUseReferenceBounds

(

bool

val

)

Set to true to use ReferenceBounds as the basis for the transformation instead of unit box.

GetUseReferenceBounds()

virtual bool vtkPVBox::GetUseReferenceBounds ( )

virtual

Set to true to use ReferenceBounds as the basis for the transformation instead of unit box.

SetPosition() [1/2]

void vtkPVBox::SetPosition ( double  x, double  y, double  z  )

inline

Get/Set Position of the box.

Definition at line 55 of file vtkPVBox.h.

SetPosition() [2/2]

void vtkPVBox::SetPosition

(

const double

pos[3]

)

Get/Set Position of the box.

GetPosition() [1/3]

virtual double* vtkPVBox::GetPosition ( )

virtual

Get/Set Position of the box.

GetPosition() [2/3]

virtual void vtkPVBox::GetPosition ( double &  , double &  , double &    )

virtual

Get/Set Position of the box.

GetPosition() [3/3]

virtual void vtkPVBox::GetPosition ( double  [3] )

virtual

Get/Set Position of the box.

SetRotation() [1/2]

void vtkPVBox::SetRotation ( double  x, double  y, double  z  )

inline

Get/Set Rotation for the box.

Definition at line 68 of file vtkPVBox.h.

SetRotation() [2/2]

void vtkPVBox::SetRotation

(

const double

pos[3]

)

Get/Set Rotation for the box.

GetRotation() [1/3]

virtual double* vtkPVBox::GetRotation ( )

virtual

Get/Set Rotation for the box.

GetRotation() [2/3]

virtual void vtkPVBox::GetRotation ( double &  , double &  , double &    )

virtual

Get/Set Rotation for the box.

GetRotation() [3/3]

virtual void vtkPVBox::GetRotation ( double  [3] )

virtual

Get/Set Rotation for the box.

SetScale() [1/2]

void vtkPVBox::SetScale ( double  x, double  y, double  z  )

inline

Get/Set Scale for the box.

Definition at line 81 of file vtkPVBox.h.

SetScale() [2/2]

void vtkPVBox::SetScale

(

const double

pos[3]

)

Get/Set Scale for the box.

GetScale() [1/3]

virtual double* vtkPVBox::GetScale ( )

virtual

Get/Set Scale for the box.

GetScale() [2/3]

virtual void vtkPVBox::GetScale ( double &  , double &  , double &    )

virtual

Get/Set Scale for the box.

GetScale() [3/3]

virtual void vtkPVBox::GetScale ( double  [3] )

virtual

Get/Set Scale for the box.

UpdateTransform()

void vtkPVBox::UpdateTransform ( )

protected

Member Data Documentation

Position

double vtkPVBox::Position[3]

protected

Definition at line 95 of file vtkPVBox.h.

Rotation

double vtkPVBox::Rotation[3]

protected

Definition at line 96 of file vtkPVBox.h.

Scale

double vtkPVBox::Scale[3]

protected

Definition at line 97 of file vtkPVBox.h.

ReferenceBounds

double vtkPVBox::ReferenceBounds[6]

protected

Definition at line 98 of file vtkPVBox.h.

UseReferenceBounds

bool vtkPVBox::UseReferenceBounds

protected

Definition at line 99 of file vtkPVBox.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/VTKExtensions/Misc/vtkPVBox.h