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

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAxesActor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	GetActors (vtkPropCollection *)

virtual int	HasTranslucentPolygonalGeometry ()

void	ShallowCopy (vtkProp *prop)

void	ReleaseGraphicsResources (vtkWindow *)

unsigned long int	GetMTime ()

virtual unsigned long	GetRedrawMTime ()


virtual int	RenderOpaqueGeometry (vtkViewport *viewport)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)

virtual int	RenderOverlay (vtkViewport *viewport)


void	GetBounds (double bounds[6])

double *	GetBounds ()


void	SetTotalLength (double v[3])

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

virtual double *	GetTotalLength ()

virtual void	GetTotalLength (double data[3])


void	SetNormalizedShaftLength (double v[3])

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

virtual double *	GetNormalizedShaftLength ()

virtual void	GetNormalizedShaftLength (double data[3])


void	SetNormalizedTipLength (double v[3])

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

virtual double *	GetNormalizedTipLength ()

virtual void	GetNormalizedTipLength (double data[3])


void	SetNormalizedLabelPosition (double v[3])

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

virtual double *	GetNormalizedLabelPosition ()

virtual void	GetNormalizedLabelPosition (double data[3])


virtual void	SetConeResolution (int)

virtual int	GetConeResolution ()

virtual void	SetSphereResolution (int)

virtual int	GetSphereResolution ()

virtual void	SetCylinderResolution (int)

virtual int	GetCylinderResolution ()


virtual void	SetConeRadius (double)

virtual double	GetConeRadius ()

virtual void	SetSphereRadius (double)

virtual double	GetSphereRadius ()

virtual void	SetCylinderRadius (double)

virtual double	GetCylinderRadius ()


void	SetShaftType (int type)

void	SetShaftTypeToCylinder ()

void	SetShaftTypeToLine ()

void	SetShaftTypeToUserDefined ()

virtual int	GetShaftType ()


void	SetTipType (int type)

void	SetTipTypeToCone ()

void	SetTipTypeToSphere ()

void	SetTipTypeToUserDefined ()

virtual int	GetTipType ()


void	SetUserDefinedTip (vtkPolyData *)

virtual vtkPolyData *	GetUserDefinedTip ()


void	SetUserDefinedShaft (vtkPolyData *)

virtual vtkPolyData *	GetUserDefinedShaft ()


vtkProperty *	GetXAxisTipProperty ()

vtkProperty *	GetYAxisTipProperty ()

vtkProperty *	GetZAxisTipProperty ()


vtkProperty *	GetXAxisShaftProperty ()

vtkProperty *	GetYAxisShaftProperty ()

vtkProperty *	GetZAxisShaftProperty ()


vtkCaptionActor2D *	GetXAxisCaptionActor2D ()

vtkCaptionActor2D *	GetYAxisCaptionActor2D ()

vtkCaptionActor2D *	GetZAxisCaptionActor2D ()


virtual void	SetXAxisLabelText (const char *)

virtual char *	GetXAxisLabelText ()

virtual void	SetYAxisLabelText (const char *)

virtual char *	GetYAxisLabelText ()

virtual void	SetZAxisLabelText (const char *)

virtual char *	GetZAxisLabelText ()


virtual void	SetAxisLabels (int)

virtual int	GetAxisLabels ()

virtual void	AxisLabelsOn ()

virtual void	AxisLabelsOff ()

Public Member Functions inherited from vtkProp3D
vtkProp3D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	ShallowCopy (vtkProp *prop)

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)

double *	GetCenter ()

double *	GetXRange ()

double *	GetYRange ()

double *	GetZRange ()

double	GetLength ()

void	RotateX (double)

void	RotateY (double)

void	RotateZ (double)

void	RotateWXYZ (double w, double x, double y, double z)

void	SetOrientation (double x, double y, double z)

void	SetOrientation (double orientation[3])

double *	GetOrientationWXYZ ()

void	AddOrientation (double x, double y, double z)

void	AddOrientation (double orentation[3])

void	PokeMatrix (vtkMatrix4x4 *matrix)

void	InitPathTraversal ()

unsigned long int	GetMTime ()

unsigned long int	GetUserTransformMatrixMTime ()

virtual void	ComputeMatrix ()

virtual void	SetPosition (double x, double y, double z)

virtual void	SetOrigin (double x, double y, double z)

virtual void	SetOrigin (const double pos[3])

virtual double *	GetOrigin ()

virtual void	GetOrigin (double data[3])

virtual void	SetScale (double x, double y, double z)

virtual void	SetScale (double scale[3])

virtual double *	GetScale ()

virtual void	GetScale (double data[3])

void	SetScale (double s)

void	SetUserTransform (vtkLinearTransform *transform)

virtual vtkLinearTransform *	GetUserTransform ()

void	SetUserMatrix (vtkMatrix4x4 *matrix)

vtkMatrix4x4 *	GetUserMatrix ()

virtual void	GetMatrix (vtkMatrix4x4 *m)

virtual void	GetMatrix (double m[16])

void	GetBounds (double bounds[6])

double *	GetOrientation ()

void	GetOrientation (double orentation[3])

vtkMatrix4x4 *	GetMatrix ()

virtual int	GetIsIdentity ()

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

virtual void	Pick ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

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 )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkAxesActor *	New ()

static int	IsTypeOf (const char *type)

static vtkAxesActor *	SafeDownCast (vtkObjectBase *o)

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

static vtkProp3D *	SafeDownCast (vtkObjectBase *o)

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAxesActor ()

	~vtkAxesActor ()

void	UpdateProps ()

Protected Member Functions inherited from vtkProp3D
	vtkProp3D ()

	~vtkProp3D ()

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

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

int	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

int	IsIdentity

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Examples:: vtkAxesActor (Examples)

Tests:: vtkAxesActor (Tests)

Definition at line 70 of file vtkAxesActor.h.

Member Typedef Documentation

typedef vtkProp3D vtkAxesActor::Superclass

Definition at line 74 of file vtkAxesActor.h.

Member Enumeration Documentation

anonymous enum

Enumerator
CYLINDER_SHAFT
LINE_SHAFT
USER_DEFINED_SHAFT

Definition at line 251 of file vtkAxesActor.h.

anonymous enum

Enumerator
CONE_TIP
SPHERE_TIP
USER_DEFINED_TIP

Definition at line 258 of file vtkAxesActor.h.

Constructor & Destructor Documentation

vtkAxesActor::vtkAxesActor ( )

protected

vtkAxesActor::~vtkAxesActor ( )

protected

Member Function Documentation

static vtkAxesActor* vtkAxesActor::New ( )

static

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

static

virtual int 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.

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

static

virtual vtkObjectBase* vtkAxesActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProp3D.

vtkAxesActor* vtkAxesActor::NewInstance ( ) const

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

virtual

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 vtkObject.

virtual void vtkAxesActor::GetActors ( vtkPropCollection * )

virtual

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.

virtual int vtkAxesActor::RenderOpaqueGeometry ( vtkViewport * viewport )

virtual

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkAxesActor::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport )

virtual

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkAxesActor::RenderOverlay ( vtkViewport * viewport )

virtual

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkAxesActor::HasTranslucentPolygonalGeometry ( )

virtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

void vtkAxesActor::ShallowCopy ( vtkProp * prop )

virtual

Shallow copy of an axes actor. Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

void vtkAxesActor::ReleaseGraphicsResources ( vtkWindow * )

virtual

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.

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

double* vtkAxesActor::GetBounds ( )

virtual

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.

unsigned long int vtkAxesActor::GetMTime ( )

virtual

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

Reimplemented from vtkObject.

virtual unsigned long vtkAxesActor::GetRedrawMTime ( )

virtual

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.

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

inline

Set the total length of the axes in 3 dimensions.

Definition at line 119 of file vtkAxesActor.h.

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

Set the total length of the axes in 3 dimensions.

virtual double* vtkAxesActor::GetTotalLength ( )

virtual

Set the total length of the axes in 3 dimensions.

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

virtual

Set the total length of the axes in 3 dimensions.

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

inline

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

Definition at line 127 of file vtkAxesActor.h.

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

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

virtual double* vtkAxesActor::GetNormalizedShaftLength ( )

virtual

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

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

virtual

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

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 136 of file vtkAxesActor.h.

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.

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.

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.

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 145 of file vtkAxesActor.h.

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.

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.

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.

virtual void vtkAxesActor::SetConeResolution ( int )

virtual

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

virtual int vtkAxesActor::GetConeResolution ( )

virtual

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

virtual void vtkAxesActor::SetSphereResolution ( int )

virtual

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

virtual int vtkAxesActor::GetSphereResolution ( )

virtual

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

virtual void vtkAxesActor::SetCylinderResolution ( int )

virtual

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

virtual int vtkAxesActor::GetCylinderResolution ( )

virtual

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

virtual void vtkAxesActor::SetConeRadius ( double )

virtual