is a helper object used by vtkGridAxes2DActor, vtkGridAxes3DActor, and vtkGridAxesPlane2DActor. More...

#include <vtkGridAxesHelper.h>

Inheritance diagram for vtkGridAxesHelper:

Collaboration diagram for vtkGridAxesHelper:

[legend]

Public Types
enum	Faces { MIN_YZ, MIN_ZX, MIN_XY, MAX_YZ, MAX_ZX, MAX_XY }

enum	LabelMasks { MIN_X = 0x01, MIN_Y = 0x02, MIN_Z = 0x04, MAX_X = 0x08, MAX_Y = 0x010, MAX_Z = 0x020 }
	Valid values for LabelMask. More...

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

vtkTuple< vtkVector3d, 4 >	GetPoints ()
	Get the 4 points in world coordinates that define the grid plane. More...

vtkVector2i	GetActiveAxes ()
	Returns which of the 3 coordinate axes for the 2 axes for this plane: 0 for X axis, 1, for Y axis, and 3 for Z axis. More...

vtkTuple< bool, 4 >	GetLabelVisibilities ()
	Returns the visibility for labels for each of the 4 axis defined by the face points based on the LabelMask. More...

vtkTuple< vtkVector3d, 4 >	GetTransformedPoints ()
	Get the 4 points of the plane transformed using the transformation matrix set using SetMatrix(), if any. More...

vtkVector3d	TransformPoint (const vtkVector3d &point)
	Transforms the give point using the Matrix. More...

vtkVector3d	GetTransformedFaceNormal ()
	Get the normal to the grid plane face after applying the transform specified using transformation matrix. More...

bool	UpdateForViewport (vtkViewport *viewport)
	Call this method before accessing any of the attributes in viewport space. More...

vtkTuple< vtkVector2i, 4 >	GetViewportPoints () const
	Get the positions for the plane points in viewport coordinates. More...

vtkTuple< vtkVector2d, 4 >	GetViewportPointsAsDouble () const

vtkTuple< vtkVector2d, 4 >	GetViewportVectors () const
	Get the axis vectors formed using the points returned by GetViewportPoints(). More...

vtkTuple< vtkVector2d, 4 >	GetViewportNormals () const
	Get the normals to the axis vectors in viewport space. More...


virtual void	SetGridBounds (double, double, double, double, double, double)
	Set the bounding box defining the grid space. More...

virtual void	SetGridBounds (double [6])
	Set the bounding box defining the grid space. More...

virtual double *	GetGridBounds ()
	Set the bounding box defining the grid space. More...

virtual void	GetGridBounds (double &, double &, double &, double &, double &, double &)
	Set the bounding box defining the grid space. More...

virtual void	GetGridBounds (double [6])
	Set the bounding box defining the grid space. More...


virtual void	SetFace (int)
	Indicate which face of the specified bounds is this class operating with. More...

virtual int	GetFace ()
	Indicate which face of the specified bounds is this class operating with. More...


virtual void	SetLabelMask (unsigned int)
	Set the axes to label. More...

virtual unsigned int	GetLabelMask ()
	Set the axes to label. More...


void	SetMatrix (vtkMatrix4x4 *)
	Set the transform matrix to use to transform the points. More...

virtual vtkMatrix4x4 *	GetMatrix ()
	Set the transform matrix to use to transform the points. More...


virtual bool	GetBackface ()
	Get if the face is facing backwards in the current viewport. 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 vtkGridAxesHelper *	New ()

static int	IsTypeOf (const char *type)

static vtkGridAxesHelper *	SafeDownCast (vtkObject *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
	vtkGridAxesHelper ()

	~vtkGridAxesHelper () override

void	SetLabelVisibilityOverrides (const vtkTuple< bool, 4 > &overrides)
	Get/Set label visibility overrides. More...

vtkTuple< bool, 4 >	GetLabelVisibilityOverrides ()

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	GridBounds [6]

int	Face

unsigned int	LabelMask

vtkMatrix4x4 *	Matrix

vtkTuple< vtkVector3d, 4 >	Points

vtkVector2i	ActiveAxes

vtkTuple< bool, 4 >	LabelVisibilities

vtkTuple< bool, 4 >	ComputedLabelVisibilities

vtkTuple< bool, 4 >	LabelVisibilityOverrides

vtkTuple< vtkVector3d, 4 >	TransformedPoints

vtkVector3d	TransformedFaceNormal

vtkTuple< vtkVector2i, 4 >	ViewportPoints

vtkTuple< vtkVector2d, 4 >	ViewportPointsAsDouble

vtkTuple< vtkVector2d, 4 >	ViewportVectors

vtkTuple< vtkVector2d, 4 >	ViewportNormals

bool	Backface

vtkMTimeType	GetPointsMTime

vtkMTimeType	GetTransformedPointsMTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkGridAxes3DActor

Detailed Description

is a helper object used by vtkGridAxes2DActor, vtkGridAxes3DActor, and vtkGridAxesPlane2DActor.

vtkGridAxes2DActor, vtkGridAxes3DActor, and vtkGridAxesPlane2DActor shares a lot of the computations and logic. This class makes it possible to share all such information between these classes. This class works with a single face of the bounding box specified using the GridBounds.

Definition at line 27 of file vtkGridAxesHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkGridAxesHelper::Superclass

Definition at line 31 of file vtkGridAxesHelper.h.

Member Enumeration Documentation

◆ Faces

enum vtkGridAxesHelper::Faces

Enumerator
MIN_YZ
MIN_ZX
MIN_XY
MAX_YZ
MAX_ZX
MAX_XY

Definition at line 45 of file vtkGridAxesHelper.h.

◆ LabelMasks

enum vtkGridAxesHelper::LabelMasks

Valid values for LabelMask.

Enumerator
MIN_X
MIN_Y
MIN_Z
MAX_X
MAX_Y
MAX_Z

Definition at line 66 of file vtkGridAxesHelper.h.

Constructor & Destructor Documentation

◆ vtkGridAxesHelper()

vtkGridAxesHelper::vtkGridAxesHelper ( )

protected

◆ ~vtkGridAxesHelper()

vtkGridAxesHelper::~vtkGridAxesHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkGridAxesHelper* vtkGridAxesHelper::New ( )

static

◆ GetClassName()

virtual const char* vtkGridAxesHelper::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.