is a helper object used by vtkGridAxesActor2D, vtkGridAxesActor3D, and vtkGridAxesPlane2DActor. More...

#include <vtkGridAxesHelper.h>

Inheritance diagram for vtkGridAxesHelper:

Collaboration diagram for vtkGridAxesHelper:

Public Types
enum	Faces : unsigned char { MIN_YZ = 0x01 , MIN_ZX = 0x02 , MIN_XY = 0x04 , MAX_YZ = 0x08 , MAX_ZX = 0x010 , MAX_XY = 0x020 }

enum	LabelMasks : unsigned char { 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 vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkGridAxesHelper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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

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.

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

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

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

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

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

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

vtkTuple< vtkVector2d, 4 >	GetViewportPointsAsDouble () const

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

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


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

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

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

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

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


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

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


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

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


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

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


virtual bool	GetBackface ()
	Get if the face is facing backwards in the current viewport.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkGridAxesHelper *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkGridAxesHelper *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGridAxesHelper ()

	~vtkGridAxesHelper () override

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

vtkTuple< bool, 4 >	GetLabelVisibilityOverrides ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Friends
class	vtkGridAxesActor3D

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

is a helper object used by vtkGridAxesActor2D, vtkGridAxesActor3D, and vtkGridAxesPlane2DActor.

vtkGridAxesActor2D, vtkGridAxesActor3D, 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.

Tests:: vtkGridAxesHelper (Tests)

Definition at line 31 of file vtkGridAxesHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkGridAxesHelper::Superclass

Definition at line 35 of file vtkGridAxesHelper.h.

Member Enumeration Documentation

◆ Faces

enum vtkGridAxesHelper::Faces : unsigned char

Enumerator
MIN_YZ
MIN_ZX
MIN_XY
MAX_YZ
MAX_ZX
MAX_XY

Definition at line 51 of file vtkGridAxesHelper.h.

◆ LabelMasks

enum vtkGridAxesHelper::LabelMasks : unsigned char

Valid values for LabelMask.

Enumerator
MIN_X
MIN_Y
MIN_Z
MAX_X
MAX_Y
MAX_Z

Definition at line 74 of file vtkGridAxesHelper.h.

Constructor & Destructor Documentation

◆ vtkGridAxesHelper()

vtkGridAxesHelper::vtkGridAxesHelper ( )

protected

◆ ~vtkGridAxesHelper()

vtkGridAxesHelper::~vtkGridAxesHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkGridAxesHelper * vtkGridAxesHelper::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkGridAxesHelper::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGridAxesHelper::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkGridAxesHelper * vtkGridAxesHelper::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

◆ SetGridBounds() [1/2]

virtual void vtkGridAxesHelper::SetGridBounds	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)

virtual

Set the bounding box defining the grid space.

This, together with the Face identify which planar surface this class is interested in. This class is designed to work with a single planar surface.