ParaView extensions for vtkGridAxesActor3D. More...

#include <vtkPVGridAxes3DActor.h>

Inherits vtkGridAxesActor3D.

Collaboration diagram for vtkPVGridAxes3DActor:

Public Types
typedef vtkGridAxesActor3D	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ShallowCopy (vtkProp *prop) override
	Shallow copy from another vtkPVGridAxes3DActor. More...

void	InvertDisplayTransformScaleForTickLabels (bool enabled)
	If enabled, the scale will be applied to the data but the tick values will still show the non-scaled model dimensions. More...

virtual void	SetDataPosition (double, double, double)

virtual void	SetDataPosition (double [3])

virtual double *	GetDataPosition ()

virtual void	GetDataPosition (double &, double &, double &)

virtual void	GetDataPosition (double [3])

virtual void	SetUseModelTransform (bool)

virtual bool	GetUseModelTransform ()

virtual void	UseModelTransformOn ()

virtual void	UseModelTransformOff ()

virtual void	SetModelBounds (double, double, double, double, double, double)

virtual void	SetModelBounds (double [6])

virtual double *	GetModelBounds ()

virtual void	GetModelBounds (double &, double &, double &, double &, double &, double &)

virtual void	GetModelBounds (double [6])

void	SetModelTransformMatrix (double *matrix)

double *	GetBounds () override
	Overridden to ensure that the transform information is passed on the superclass. More...


virtual void	SetDataScale (double, double, double)
	Specify transformation used by the data. More...

virtual void	SetDataScale (double [3])
	Specify transformation used by the data. More...

virtual double *	GetDataScale ()
	Specify transformation used by the data. More...

virtual void	GetDataScale (double &, double &, double &)
	Specify transformation used by the data. More...

virtual void	GetDataScale (double [3])
	Specify transformation used by the data. More...


void	SetDisplayTransformScale (double scaleX, double scaleY, double scaleZ)
	Specify the scale used in the display transformation. More...

void	SetDisplayTransformScale (double scale[3])
	Specify the scale used in the display transformation. More...

virtual double *	GetDisplayTransformScale ()
	Specify the scale used in the display transformation. More...

virtual void	GetDisplayTransformScale (double &, double &, double &)
	Specify the scale used in the display transformation. More...

virtual void	GetDisplayTransformScale (double [3])
	Specify the scale used in the display transformation. More...


virtual void	SetDataBoundsScaleFactor (double)
	Specify the scale factor used to proportionally scale each axis. More...

virtual double	GetDataBoundsScaleFactor ()
	Specify the scale factor used to proportionally scale each axis. More...


virtual void	SetTransformedBounds (double, double, double, double, double, double)
	Another way for specifying grid bounds except here the bounds are considered to be pre-transformed. More...

virtual void	SetTransformedBounds (double [6])
	Another way for specifying grid bounds except here the bounds are considered to be pre-transformed. More...

virtual double *	GetTransformedBounds ()
	Another way for specifying grid bounds except here the bounds are considered to be pre-transformed. More...

virtual void	GetTransformedBounds (double &, double &, double &, double &, double &, double &)
	Another way for specifying grid bounds except here the bounds are considered to be pre-transformed. More...

virtual void	GetTransformedBounds (double [6])
	Another way for specifying grid bounds except here the bounds are considered to be pre-transformed. More...


virtual void	SetUseCustomTransformedBounds (bool)
	If set to true, CustomTransformedBounds are used instead of TransformedBounds. More...

virtual bool	GetUseCustomTransformedBounds ()
	If set to true, CustomTransformedBounds are used instead of TransformedBounds. More...


virtual void	SetCustomTransformedBounds (double, double, double, double, double, double)
	Same as TransformedBounds, except used only when UseCustomTransformedBounds is set. More...

virtual void	SetCustomTransformedBounds (double [6])
	Same as TransformedBounds, except used only when UseCustomTransformedBounds is set. More...

virtual double *	GetCustomTransformedBounds ()
	Same as TransformedBounds, except used only when UseCustomTransformedBounds is set. More...

virtual void	GetCustomTransformedBounds (double &, double &, double &, double &, double &, double &)
	Same as TransformedBounds, except used only when UseCustomTransformedBounds is set. More...

virtual void	GetCustomTransformedBounds (double [6])
	Same as TransformedBounds, except used only when UseCustomTransformedBounds is set. More...

Static Public Member Functions
static vtkPVGridAxes3DActor *	New ()

static int	IsTypeOf (const char *type)

static vtkPVGridAxes3DActor *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkPVGridAxes3DActor ()

	~vtkPVGridAxes3DActor () override

void	Update (vtkViewport *viewport) override

void	UpdateGridBounds ()

void	UpdateGridBoundsUsingDataBounds ()

void	UpdateGridBoundsUsingModelTransform ()

Protected Attributes
double	DataScale [3]

double	DataPosition [3]

double	DataBoundsScaleFactor

double	TransformedBounds [6]

double	DisplayTransformScale [3]

bool	UseModelTransform

double	ModelBounds [6]

vtkNew< vtkMatrix4x4 >	ModelTransformMatrix

bool	UseCustomTransformedBounds

double	CustomTransformedBounds [6]

Detailed Description

ParaView extensions for vtkGridAxesActor3D.

vtkPVGridAxes3DActor adds support for ParaView-specific use-cases to vtkGridAxesActor3D. The special use-cases are:

Showing original data bounds when data has been transformed by specifying a transform on the Display properties: To support this, we add API to set the DataScale and DataPosition (we cannot support rotations, I am afraid). User is expected to set these to match the Scale and Position set on the Display properties of the data. vtkPVGridAxes3DActor converts that to scale and position on the vtkProperty for the superclass and sets the GridBounds on the superclass transformed using an inverse of the specified transform on the bounds reported by vtkPVRenderView. vtkPVRenderView uses SetTransformedBounds to set the bounds.

Supporting change of basis transformations: for that, one is expected to set UseModelTransform to true, and then specify the ModelBounds and ModelTransformMatrix. Note: ModelTransform and DataScale/DataPosition are mutually exclusive.

Definition at line 34 of file vtkPVGridAxes3DActor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkGridAxesActor3D vtkPVGridAxes3DActor::Superclass

Definition at line 38 of file vtkPVGridAxes3DActor.h.

Constructor & Destructor Documentation

◆ vtkPVGridAxes3DActor()

vtkPVGridAxes3DActor::vtkPVGridAxes3DActor ( )

protected

◆ ~vtkPVGridAxes3DActor()

vtkPVGridAxes3DActor::~vtkPVGridAxes3DActor ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVGridAxes3DActor* vtkPVGridAxes3DActor::New ( )

static

◆ GetClassName()

virtual const char* vtkPVGridAxes3DActor::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

override

◆ ShallowCopy()

void vtkPVGridAxes3DActor::ShallowCopy ( vtkProp * prop )

override

Shallow copy from another vtkPVGridAxes3DActor.

◆ SetDataScale() [1/2]

virtual void vtkPVGridAxes3DActor::SetDataScale	(	double	,
		double	,
		double
	)

virtual

Specify transformation used by the data.

◆ SetDataScale() [2/2]

virtual void vtkPVGridAxes3DActor::SetDataScale ( double [3] )

virtual

Specify transformation used by the data.

◆ GetDataScale() [1/3]

virtual double* vtkPVGridAxes3DActor::GetDataScale ( )

virtual

Specify transformation used by the data.

◆ GetDataScale() [2/3]

virtual void vtkPVGridAxes3DActor::GetDataScale	(	double &	,
		double &	,
		double &
	)

virtual

Specify transformation used by the data.

◆ GetDataScale() [3/3]

virtual void vtkPVGridAxes3DActor::GetDataScale ( double [3] )

virtual

Specify transformation used by the data.

◆ SetDisplayTransformScale() [1/2]

void vtkPVGridAxes3DActor::SetDisplayTransformScale	(	double	scaleX,
		double	scaleY,
		double	scaleZ
	)

Specify the scale used in the display transformation.

◆ SetDisplayTransformScale() [2/2]

void vtkPVGridAxes3DActor::SetDisplayTransformScale ( double scale[3] )

inline

Specify the scale used in the display transformation.

Definition at line 59 of file vtkPVGridAxes3DActor.h.

◆ GetDisplayTransformScale() [1/3]

virtual double* vtkPVGridAxes3DActor::GetDisplayTransformScale ( )

virtual

Specify the scale used in the display transformation.

◆ GetDisplayTransformScale() [2/3]

virtual void vtkPVGridAxes3DActor::GetDisplayTransformScale	(	double &	,
		double &	,
		double &
	)

virtual

Specify the scale used in the display transformation.

◆ GetDisplayTransformScale() [3/3]

virtual void vtkPVGridAxes3DActor::GetDisplayTransformScale ( double [3] )

virtual

Specify the scale used in the display transformation.

◆ InvertDisplayTransformScaleForTickLabels()

void vtkPVGridAxes3DActor::InvertDisplayTransformScaleForTickLabels ( bool enabled )

If enabled, the scale will be applied to the data but the tick values will still show the non-scaled model dimensions.

By default, this option is false.

◆ SetDataPosition() [1/2]

virtual void vtkPVGridAxes3DActor::SetDataPosition	(	double	,
		double	,
		double
	)

virtual

◆ SetDataPosition() [2/2]

virtual void vtkPVGridAxes3DActor::SetDataPosition ( double [3] )

virtual

◆ GetDataPosition() [1/3]

virtual double* vtkPVGridAxes3DActor::GetDataPosition ( )

virtual

◆ GetDataPosition() [2/3]

virtual void vtkPVGridAxes3DActor::GetDataPosition	(	double &	,
		double &	,
		double &
	)

virtual

◆ GetDataPosition() [3/3]

virtual void vtkPVGridAxes3DActor::GetDataPosition ( double [3] )

virtual

◆ SetDataBoundsScaleFactor()

virtual void vtkPVGridAxes3DActor::SetDataBoundsScaleFactor ( double )

virtual

Specify the scale factor used to proportionally scale each axis.

1 means no change.

◆ GetDataBoundsScaleFactor()

virtual double vtkPVGridAxes3DActor::GetDataBoundsScaleFactor ( )

virtual

Specify the scale factor used to proportionally scale each axis.

1 means no change.

◆ SetTransformedBounds() [1/2]

virtual void vtkPVGridAxes3DActor::SetTransformedBounds	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)

virtual

Another way for specifying grid bounds except here the bounds are considered to be pre-transformed.

Using the DataPosition, DataScale, and DataBoundsScaleFactor, the provided bounds will un-transformed before calling this->SetGridBounds() and then position and scale are instead passed on the vtkActor. This results in display scaling rather than data scaling.

◆ SetTransformedBounds() [2/2]

virtual void vtkPVGridAxes3DActor::SetTransformedBounds ( double [6] )

virtual

Another way for specifying grid bounds except here the bounds are considered to be pre-transformed.

Using the DataPosition, DataScale, and DataBoundsScaleFactor, the provided bounds will un-transformed before calling this->SetGridBounds() and then position and scale are instead passed on the vtkActor. This results in display scaling rather than data scaling.

◆ GetTransformedBounds() [1/3]

virtual double* vtkPVGridAxes3DActor::GetTransformedBounds ( )

virtual

Another way for specifying grid bounds except here the bounds are considered to be pre-transformed.

Using the DataPosition, DataScale, and DataBoundsScaleFactor, the provided bounds will un-transformed before calling this->SetGridBounds() and then position and scale are instead passed on the vtkActor. This results in display scaling rather than data scaling.

◆ GetTransformedBounds() [2/3]

virtual void vtkPVGridAxes3DActor::GetTransformedBounds	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &
	)

virtual

Another way for specifying grid bounds except here the bounds are considered to be pre-transformed.

Using the DataPosition, DataScale, and DataBoundsScaleFactor, the provided bounds will un-transformed before calling this->SetGridBounds() and then position and scale are instead passed on the vtkActor. This results in display scaling rather than data scaling.

◆ GetTransformedBounds() [3/3]

virtual void vtkPVGridAxes3DActor::GetTransformedBounds ( double [6] )

virtual

Another way for specifying grid bounds except here the bounds are considered to be pre-transformed.

Using the DataPosition, DataScale, and DataBoundsScaleFactor, the provided bounds will un-transformed before calling this->SetGridBounds() and then position and scale are instead passed on the vtkActor. This results in display scaling rather than data scaling.

◆ SetUseCustomTransformedBounds()

virtual void vtkPVGridAxes3DActor::SetUseCustomTransformedBounds ( bool )

virtual

If set to true, CustomTransformedBounds are used instead of TransformedBounds.

Default is false.

◆ GetUseCustomTransformedBounds()

virtual bool vtkPVGridAxes3DActor::GetUseCustomTransformedBounds ( )

virtual

If set to true, CustomTransformedBounds are used instead of TransformedBounds.

Default is false.