a 3D axes representation More...

#include <vtkAxesActor.h>

Inheritance diagram for vtkAxesActor:

Collaboration diagram for vtkAxesActor:

Public Types
enum	{ CYLINDER_SHAFT , LINE_SHAFT , USER_DEFINED_SHAFT }

enum	{ CONE_TIP , SPHERE_TIP , USER_DEFINED_TIP }

typedef vtkProp3D	Superclass

Public Types inherited from vtkProp3D
typedef vtkProp	Superclass

enum	CoordinateSystems { WORLD = 0 , PHYSICAL = 1 , DEVICE = 2 }
	Specify the coordinate system that this prop is relative to. More...

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

vtkAxesActor *	NewInstance () const

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

void	GetActors (vtkPropCollection *) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of an axes actor.

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.

vtkMTimeType	GetMTime () override
	Get the actors mtime plus consider its properties and texture if set.

vtkMTimeType	GetRedrawMTime () override
	Return the mtime of anything that would cause the rendered image to appear differently.

vtkCaptionActor2D *	GetXAxisCaptionActor2D ()
	Retrieve handles to the X, Y and Z axis (so that you can set their text properties for example)

vtkCaptionActor2D *	GetYAxisCaptionActor2D ()

vtkCaptionActor2D *	GetZAxisCaptionActor2D ()


int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Support the standard render methods.

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
	Support the standard render methods.

int	RenderOverlay (vtkViewport *viewport) override
	Support the standard render methods.


void	GetBounds (double bounds[6])
	Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

double *	GetBounds () override
	Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).


void	SetTotalLength (double v[3])
	Set the total length of the axes in 3 dimensions.

void	SetTotalLength (double x, double y, double z)
	Set the total length of the axes in 3 dimensions.

virtual double *	GetTotalLength ()
	Set the total length of the axes in 3 dimensions.

virtual void	GetTotalLength (double data[3])
	Set the total length of the axes in 3 dimensions.


void	SetNormalizedShaftLength (double v[3])
	Set the normalized (0-1) length of the shaft.

void	SetNormalizedShaftLength (double x, double y, double z)
	Set the normalized (0-1) length of the shaft.

virtual double *	GetNormalizedShaftLength ()
	Set the normalized (0-1) length of the shaft.

virtual void	GetNormalizedShaftLength (double data[3])
	Set the normalized (0-1) length of the shaft.


void	SetNormalizedTipLength (double v[3])
	Set the normalized (0-1) length of the tip.

void	SetNormalizedTipLength (double x, double y, double z)
	Set the normalized (0-1) length of the tip.

virtual double *	GetNormalizedTipLength ()
	Set the normalized (0-1) length of the tip.

virtual void	GetNormalizedTipLength (double data[3])
	Set the normalized (0-1) length of the tip.


void	SetNormalizedLabelPosition (double v[3])
	Set the normalized (0-1) position of the label along the length of the shaft.

void	SetNormalizedLabelPosition (double x, double y, double z)
	Set the normalized (0-1) position of the label along the length of the shaft.

virtual double *	GetNormalizedLabelPosition ()
	Set the normalized (0-1) position of the label along the length of the shaft.

virtual void	GetNormalizedLabelPosition (double data[3])
	Set the normalized (0-1) position of the label along the length of the shaft.


virtual void	SetConeResolution (int)
	Set/get the resolution of the pieces of the axes actor.

virtual int	GetConeResolution ()
	Set/get the resolution of the pieces of the axes actor.

virtual void	SetSphereResolution (int)
	Set/get the resolution of the pieces of the axes actor.

virtual int	GetSphereResolution ()
	Set/get the resolution of the pieces of the axes actor.

virtual void	SetCylinderResolution (int)
	Set/get the resolution of the pieces of the axes actor.

virtual int	GetCylinderResolution ()
	Set/get the resolution of the pieces of the axes actor.


virtual void	SetConeRadius (double)
	Set/get the radius of the pieces of the axes actor.

virtual double	GetConeRadius ()
	Set/get the radius of the pieces of the axes actor.

virtual void	SetSphereRadius (double)
	Set/get the radius of the pieces of the axes actor.

virtual double	GetSphereRadius ()
	Set/get the radius of the pieces of the axes actor.

virtual void	SetCylinderRadius (double)
	Set/get the radius of the pieces of the axes actor.

virtual double	GetCylinderRadius ()
	Set/get the radius of the pieces of the axes actor.


void	SetShaftType (int type)
	Set the type of the shaft to a cylinder, line, or user defined geometry.

void	SetShaftTypeToCylinder ()
	Set the type of the shaft to a cylinder, line, or user defined geometry.

void	SetShaftTypeToLine ()
	Set the type of the shaft to a cylinder, line, or user defined geometry.

void	SetShaftTypeToUserDefined ()
	Set the type of the shaft to a cylinder, line, or user defined geometry.

virtual int	GetShaftType ()
	Set the type of the shaft to a cylinder, line, or user defined geometry.


void	SetTipType (int type)
	Set the type of the tip to a cone, sphere, or user defined geometry.

void	SetTipTypeToCone ()
	Set the type of the tip to a cone, sphere, or user defined geometry.

void	SetTipTypeToSphere ()
	Set the type of the tip to a cone, sphere, or user defined geometry.

void	SetTipTypeToUserDefined ()
	Set the type of the tip to a cone, sphere, or user defined geometry.

virtual int	GetTipType ()
	Set the type of the tip to a cone, sphere, or user defined geometry.


void	SetUserDefinedTip (vtkPolyData *)
	Set the user defined tip polydata.

virtual vtkPolyData *	GetUserDefinedTip ()
	Set the user defined tip polydata.


void	SetUserDefinedShaft (vtkPolyData *)
	Set the user defined shaft polydata.

virtual vtkPolyData *	GetUserDefinedShaft ()
	Set the user defined shaft polydata.


vtkProperty *	GetXAxisTipProperty ()
	Get the tip properties.

vtkProperty *	GetYAxisTipProperty ()
	Get the tip properties.

vtkProperty *	GetZAxisTipProperty ()
	Get the tip properties.


vtkProperty *	GetXAxisShaftProperty ()
	Get the shaft properties.

vtkProperty *	GetYAxisShaftProperty ()
	Get the shaft properties.

vtkProperty *	GetZAxisShaftProperty ()
	Get the shaft properties.


virtual void	SetXAxisLabelText (const char *)
	Set/get the label text.

virtual char *	GetXAxisLabelText ()
	Set/get the label text.

virtual void	SetYAxisLabelText (const char *)
	Set/get the label text.

virtual char *	GetYAxisLabelText ()
	Set/get the label text.

virtual void	SetZAxisLabelText (const char *)
	Set/get the label text.

virtual char *	GetZAxisLabelText ()
	Set/get the label text.


virtual void	SetAxisLabels (vtkTypeBool)
	Enable/disable drawing the axis labels.

virtual vtkTypeBool	GetAxisLabels ()
	Enable/disable drawing the axis labels.

virtual void	AxisLabelsOn ()
	Enable/disable drawing the axis labels.

virtual void	AxisLabelsOff ()
	Enable/disable drawing the axis labels.

Public Member Functions inherited from vtkProp3D
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkProp3D *	NewInstance () const

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

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkProp3D.

virtual void	SetPosition (double pos[3])

virtual double *	GetPosition ()

virtual void	GetPosition (double data[3])

void	AddPosition (double deltaPosition[3])

void	AddPosition (double deltaX, double deltaY, double deltaZ)

void	SetScale (double s)
	Method to set the scale isotropically.

virtual void	SetPropertiesFromModelToWorldMatrix (vtkMatrix4x4 *modelToWorld)
	Set the position, scale, orientation from a provided model to world matrix.

double *	GetCenter ()
	Get the center of the bounding box in world coordinates.

double *	GetXRange ()
	Get the Prop3D's x range in world coordinates.

double *	GetYRange ()
	Get the Prop3D's y range in world coordinates.

double *	GetZRange ()
	Get the Prop3D's z range in world coordinates.

double	GetLength ()
	Get the length of the diagonal of the bounding box.

void	RotateX (double)
	Rotate the Prop3D in degrees about the X axis using the right hand rule.

void	RotateY (double)
	Rotate the Prop3D in degrees about the Y axis using the right hand rule.

void	RotateZ (double)
	Rotate the Prop3D in degrees about the Z axis using the right hand rule.

void	RotateWXYZ (double w, double x, double y, double z)
	Rotate the Prop3D in degrees about an arbitrary axis specified by the last three arguments.

void	SetOrientation (double x, double y, double z)
	Sets the orientation of the Prop3D.

void	SetOrientation (double orientation[3])
	Sets the orientation of the Prop3D.

double *	GetOrientationWXYZ ()
	Returns the WXYZ orientation of the Prop3D.

void	AddOrientation (double x, double y, double z)
	Add to the current orientation.

void	AddOrientation (double orentation[3])
	Add to the current orientation.

void	PokeMatrix (vtkMatrix4x4 *matrix) override
	This method modifies the vtkProp3D so that its transformation state is set to the matrix specified.

void	InitPathTraversal () override
	Overload vtkProp's method for setting up assembly paths.

vtkMTimeType	GetMTime () override
	Get the vtkProp3D's mtime.

vtkMTimeType	GetUserTransformMatrixMTime ()
	Get the modified time of the user matrix or user transform.

virtual void	SetPosition (double x, double y, double z)
	Set/Get/Add the position of the Prop3D in world coordinates.

virtual void	SetOrigin (double x, double y, double z)
	Set/Get the origin of the Prop3D.

virtual void	SetOrigin (const double pos[3])
	Set/Get the origin of the Prop3D.

virtual double *	GetOrigin ()
	Set/Get the origin of the Prop3D.

virtual void	GetOrigin (double data[3])
	Set/Get the origin of the Prop3D.

virtual void	SetScale (double x, double y, double z)
	Set/Get the scale of the actor.

virtual void	SetScale (double scale[3])
	Set/Get the scale of the actor.

virtual double *	GetScale ()
	Set/Get the scale of the actor.

virtual void	GetScale (double data[3])
	Set/Get the scale of the actor.

void	SetUserTransform (vtkLinearTransform *transform)
	In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.

virtual vtkLinearTransform *	GetUserTransform ()
	In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.

void	SetUserMatrix (vtkMatrix4x4 *matrix)
	The UserMatrix can be used in place of UserTransform.

vtkMatrix4x4 *	GetUserMatrix ()
	The UserMatrix can be used in place of UserTransform.

virtual void	GetMatrix (vtkMatrix4x4 *result)
	Return a reference to the Prop3D's 4x4 composite matrix.

virtual void	GetMatrix (double result[16])
	Return a reference to the Prop3D's 4x4 composite matrix.

virtual void	GetModelToWorldMatrix (vtkMatrix4x4 *result)
	Return a reference to the Prop3D's Model to World matrix.

void	GetBounds (double bounds[6])
	Return a reference to the Prop3D's composite transform.

double *	GetOrientation ()
	Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.

void	GetOrientation (double orentation[3])
	Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.

virtual void	ComputeMatrix ()
	Generate the matrix based on ivars.

vtkMatrix4x4 *	GetMatrix () override
	Get a pointer to an internal vtkMatrix4x4.

virtual vtkTypeBool	GetIsIdentity ()
	Is the matrix for this actor identity.

void	SetCoordinateSystemRenderer (vtkRenderer *ren)
	Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE.

vtkRenderer *	GetCoordinateSystemRenderer ()
	Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE.

virtual void	SetCoordinateSystemDevice (int)
	Specify the device to be used when the coordinate system is set to DEVICE.

virtual int	GetCoordinateSystemDevice ()
	Specify the device to be used when the coordinate system is set to DEVICE.

void	SetCoordinateSystemToWorld ()
	Specify the coordinate system that this prop is relative to.

void	SetCoordinateSystemToPhysical ()
	Specify the coordinate system that this prop is relative to.

void	SetCoordinateSystemToDevice ()
	Specify the coordinate system that this prop is relative to.

void	SetCoordinateSystem (CoordinateSystems val)
	Specify the coordinate system that this prop is relative to.

virtual CoordinateSystems	GetCoordinateSystem ()
	Specify the coordinate system that this prop is relative to.

const char *	GetCoordinateSystemAsString ()
	Specify the coordinate system that this prop is relative to.

Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkProp *	NewInstance () const

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

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked.

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.

virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.

virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.

virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.

virtual void	PickableOn ()
	Set/Get the pickable instance variable.

virtual void	PickableOff ()
	Set/Get the pickable instance variable.

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

virtual int	GetNumberOfConsumers ()
	Get the number of consumers.

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.

virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAxesActor *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkProp3D
static vtkTypeBool	IsTypeOf (const char *type)

static vtkProp3D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkProp
static vtkTypeBool	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.

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

	vtkAxesActor ()

	~vtkAxesActor () override

void	UpdateProps ()

Protected Member Functions inherited from vtkProp3D
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProp3D ()

	~vtkProp3D () override

Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProp ()

	~vtkProp () override

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

Protected Attributes
vtkCylinderSource *	CylinderSource

vtkLineSource *	LineSource

vtkConeSource *	ConeSource

vtkSphereSource *	SphereSource

vtkActor *	XAxisShaft

vtkActor *	YAxisShaft

vtkActor *	ZAxisShaft

vtkActor *	XAxisTip

vtkActor *	YAxisTip

vtkActor *	ZAxisTip

double	TotalLength [3]

double	NormalizedShaftLength [3]

double	NormalizedTipLength [3]

double	NormalizedLabelPosition [3]

int	ShaftType

int	TipType

vtkPolyData *	UserDefinedTip

vtkPolyData *	UserDefinedShaft

char *	XAxisLabelText

char *	YAxisLabelText

char *	ZAxisLabelText

vtkCaptionActor2D *	XAxisLabel

vtkCaptionActor2D *	YAxisLabel

vtkCaptionActor2D *	ZAxisLabel

vtkTypeBool	AxisLabels

int	ConeResolution

int	SphereResolution

int	CylinderResolution

double	ConeRadius

double	SphereRadius

double	CylinderRadius

Protected Attributes inherited from vtkProp3D
vtkLinearTransform *	UserTransform

vtkMatrix4x4 *	UserMatrix

vtkMatrix4x4 *	Matrix

vtkTimeStamp	MatrixMTime

double	Origin [3]

double	Position [3]

double	Orientation [3]

double	Scale [3]

double	Center [3]

vtkTransform *	Transform

double	Bounds [6]

vtkProp3D *	CachedProp3D

vtkTypeBool	IsIdentity

int	CoordinateSystemDevice

CoordinateSystems	CoordinateSystem = WORLD

vtkWeakPointer< vtkRenderer >	CoordinateSystemRenderer

vtkNew< vtkMatrix4x4 >	TempMatrix4x4

Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

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

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a 3D axes representation

vtkAxesActor is a hybrid 2D/3D actor used to represent 3D axes in a scene. The user can define the geometry to use for the shaft or the tip, and the user can set the text for the three axes. The text will appear to follow the camera since it is implemented by means of vtkCaptionActor2D. All of the functionality of the underlying vtkCaptionActor2D objects are accessible so that, for instance, the font attributes of the axes text can be manipulated through vtkTextProperty. Since this class inherits from vtkProp3D, one can apply a user transform to the underlying geometry and the positioning of the labels. For example, a rotation transform could be used to generate a left-handed axes representation.

Thanks:: Thanks to Goodwin Lawlor for posting a tcl script which featured the use of vtkCaptionActor2D to implement the text labels. This class is based on Paraview's vtkPVAxesActor.

Warning: vtkAxesActor is primarily intended for use with vtkOrientationMarkerWidget. The bounds of this actor are calculated as though the geometry of the axes were symmetric: that is, although only positive axes are visible, bounds are calculated as though negative axes are present too. This is done intentionally to implement functionality of the camera update mechanism in vtkOrientationMarkerWidget.

See also: vtkAnnotatedCubeActor vtkOrientationMarkerWidget vtkCaptionActor2D vtkTextProperty

Online Examples:

Axes

IsoparametricCellsDemo

DisplayCoordinateAxes

FroggieSurface

MovableAxes

AnatomicalOrientation

Tests:: vtkAxesActor (Tests)

Definition at line 167 of file vtkAxesActor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkProp3D vtkAxesActor::Superclass

Definition at line 171 of file vtkAxesActor.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
CYLINDER_SHAFT
LINE_SHAFT
USER_DEFINED_SHAFT

Definition at line 379 of file vtkAxesActor.h.

◆ anonymous enum

anonymous enum

Enumerator
CONE_TIP
SPHERE_TIP
USER_DEFINED_TIP

Definition at line 386 of file vtkAxesActor.h.

Constructor & Destructor Documentation

◆ vtkAxesActor()

vtkAxesActor::vtkAxesActor ( )

protected

◆ ~vtkAxesActor()

vtkAxesActor::~vtkAxesActor ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkAxesActor * vtkAxesActor::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkAxesActor::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 vtkProp3D.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAxesActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProp3D.

◆ NewInstance()

vtkAxesActor * vtkAxesActor::NewInstance ( ) const

◆ PrintSelf()

void vtkAxesActor::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.

◆ GetActors()

void vtkAxesActor::GetActors ( vtkPropCollection * )

overridevirtual

For some exporters and other other operations we must be able to collect all the actors or volumes.

These methods are used in that process.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkAxesActor::RenderOpaqueGeometry ( vtkViewport * viewport )

overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkAxesActor::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport )

overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkAxesActor::RenderOverlay ( vtkViewport * viewport )

overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkAxesActor::HasTranslucentPolygonalGeometry ( )

overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

◆ ShallowCopy()

void vtkAxesActor::ShallowCopy ( vtkProp * prop )

overridevirtual

Shallow copy of an axes actor.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkAxesActor::ReleaseGraphicsResources ( vtkWindow * )

overridevirtual

Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

◆ GetBounds() [1/2]

void vtkAxesActor::GetBounds ( double bounds[6] )

Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

(The method GetBounds(double bounds[6]) is available from the superclass.)

◆ GetBounds() [2/2]

double * vtkAxesActor::GetBounds ( )

overridevirtual

Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

(The method GetBounds(double bounds[6]) is available from the superclass.)

Implements vtkProp3D.

◆ GetMTime()

vtkMTimeType vtkAxesActor::GetMTime ( )

overridevirtual

Get the actors mtime plus consider its properties and texture if set.

Reimplemented from vtkObject.

◆ GetRedrawMTime()

vtkMTimeType vtkAxesActor::GetRedrawMTime ( )

overridevirtual

Return the mtime of anything that would cause the rendered image to appear differently.

Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, textures etc.

Reimplemented from vtkProp.

◆ SetTotalLength() [1/2]

void vtkAxesActor::SetTotalLength ( double v[3] )

inline

Set the total length of the axes in 3 dimensions.

Definition at line 233 of file vtkAxesActor.h.

◆ SetTotalLength() [2/2]

void vtkAxesActor::SetTotalLength	(	double	x,
		double	y,
		double	z
	)

Set the total length of the axes in 3 dimensions.

◆ GetTotalLength() [1/2]

virtual double * vtkAxesActor::GetTotalLength ( )

virtual

Set the total length of the axes in 3 dimensions.

◆ GetTotalLength() [2/2]

virtual void vtkAxesActor::GetTotalLength ( double data[3] )

virtual

Set the total length of the axes in 3 dimensions.

◆ SetNormalizedShaftLength() [1/2]

void vtkAxesActor::SetNormalizedShaftLength ( double v[3] )

inline

Set the normalized (0-1) length of the shaft.

Definition at line 242 of file vtkAxesActor.h.

◆ SetNormalizedShaftLength() [2/2]

void vtkAxesActor::SetNormalizedShaftLength	(	double	x,
		double	y,
		double	z
	)

Set the normalized (0-1) length of the shaft.

◆ GetNormalizedShaftLength() [1/2]

virtual double * vtkAxesActor::GetNormalizedShaftLength ( )

virtual

Set the normalized (0-1) length of the shaft.

◆ GetNormalizedShaftLength() [2/2]

virtual void vtkAxesActor::GetNormalizedShaftLength ( double data[3] )

virtual

Set the normalized (0-1) length of the shaft.

◆ SetNormalizedTipLength() [1/2]

void vtkAxesActor::SetNormalizedTipLength ( double v[3] )

inline

Set the normalized (0-1) length of the tip.

Normally, this would be 1 - the normalized length of the shaft.

Definition at line 252 of file vtkAxesActor.h.

◆ SetNormalizedTipLength() [2/2]

void vtkAxesActor::SetNormalizedTipLength	(	double	x,
		double	y,
		double	z
	)

Set the normalized (0-1) length of the tip.

Normally, this would be 1 - the normalized length of the shaft.

◆ GetNormalizedTipLength() [1/2]

virtual double * vtkAxesActor::GetNormalizedTipLength ( )

virtual

Set the normalized (0-1) length of the tip.

Normally, this would be 1 - the normalized length of the shaft.

◆ GetNormalizedTipLength() [2/2]

virtual void vtkAxesActor::GetNormalizedTipLength ( double data[3] )

virtual

Set the normalized (0-1) length of the tip.

Normally, this would be 1 - the normalized length of the shaft.

◆ SetNormalizedLabelPosition() [1/2]

void vtkAxesActor::SetNormalizedLabelPosition ( double v[3] )

inline

Set the normalized (0-1) position of the label along the length of the shaft.

A value > 1 is permissible.

Definition at line 262 of file vtkAxesActor.h.

◆ SetNormalizedLabelPosition() [2/2]

void vtkAxesActor::SetNormalizedLabelPosition	(	double	x,
		double	y,
		double	z
	)

Set the normalized (0-1) position of the label along the length of the shaft.

A value > 1 is permissible.

◆ GetNormalizedLabelPosition() [1/2]

virtual double * vtkAxesActor::GetNormalizedLabelPosition ( )

virtual

Set the normalized (0-1) position of the label along the length of the shaft.

A value > 1 is permissible.

◆ GetNormalizedLabelPosition() [2/2]

virtual void vtkAxesActor::GetNormalizedLabelPosition ( double data[3] )

virtual

Set the normalized (0-1) position of the label along the length of the shaft.

A value > 1 is permissible.

◆ SetConeResolution()

virtual void vtkAxesActor::SetConeResolution ( int )

virtual

Set/get the resolution of the pieces of the axes actor.

◆ GetConeResolution()

virtual int vtkAxesActor::GetConeResolution ( )

virtual

Set/get the resolution of the pieces of the axes actor.

◆ SetSphereResolution()

virtual void vtkAxesActor::SetSphereResolution ( int )

virtual

Set/get the resolution of the pieces of the axes actor.

◆ GetSphereResolution()

virtual int vtkAxesActor::GetSphereResolution ( )

virtual

Set/get the resolution of the pieces of the axes actor.

◆ SetCylinderResolution()

virtual void vtkAxesActor::SetCylinderResolution ( int )

virtual

Set/get the resolution of the pieces of the axes actor.

◆ GetCylinderResolution()

virtual int vtkAxesActor::GetCylinderResolution ( )

virtual

Set/get the resolution of the pieces of the axes actor.