a 3D axes representation More...

#include <vtkPVAxesActor.h>

Inheritance diagram for vtkPVAxesActor:

Collaboration diagram for vtkPVAxesActor:

Public Types
enum	{ CYLINDER_SHAFT, LINE_SHAFT, USER_DEFINED_SHAFT }
enum	{ CONE_TIP, SPHERE_TIP, USER_DEFINED_TIP }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	GetActors (vtkPropCollection *)
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	HasTranslucentPolygonalGeometry ()

void	GetBounds (double bounds[6])
double *	GetBounds ()

void	SetTotalLength (float v[3])
void	SetTotalLength (float x, float y, float z)
virtual float *	GetTotalLength ()
virtual void	GetTotalLength (float data[3])

void	SetNormalizedShaftLength (float v[3])
void	SetNormalizedShaftLength (float x, float y, float z)
virtual float *	GetNormalizedShaftLength ()
virtual void	GetNormalizedShaftLength (float data[3])

void	SetNormalizedTipLength (float v[3])
void	SetNormalizedTipLength (float x, float y, float z)
virtual float *	GetNormalizedTipLength ()
virtual void	GetNormalizedTipLength (float 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 (float)
virtual float	GetConeRadius ()
virtual void	SetSphereRadius (float)
virtual float	GetSphereRadius ()
virtual void	SetCylinderRadius (float)
virtual float	GetCylinderRadius ()

virtual void	SetXAxisLabelPosition (float)
virtual float	GetXAxisLabelPosition ()
virtual void	SetYAxisLabelPosition (float)
virtual float	GetYAxisLabelPosition ()
virtual void	SetZAxisLabelPosition (float)
virtual float	GetZAxisLabelPosition ()

void	SetShaftType (int type)
void	SetShaftTypeToCylinder ()
void	SetShaftTypeToLine ()
void	SetShaftTypeToUserDefined ()

void	SetTipType (int type)
void	SetTipTypeToCone ()
void	SetTipTypeToSphere ()
void	SetTipTypeToUserDefined ()

void	SetUserDefinedTip (vtkPolyData *)
virtual vtkPolyData *	GetUserDefinedTip ()

void	SetUserDefinedShaft (vtkPolyData *)
virtual vtkPolyData *	GetUserDefinedShaft ()

vtkProperty *	GetXAxisTipProperty ()
vtkProperty *	GetYAxisTipProperty ()
vtkProperty *	GetZAxisTipProperty ()

vtkProperty *	GetXAxisShaftProperty ()
vtkProperty *	GetYAxisShaftProperty ()
vtkProperty *	GetZAxisShaftProperty ()

vtkProperty *	GetXAxisLabelProperty ()
vtkProperty *	GetYAxisLabelProperty ()
vtkProperty *	GetZAxisLabelProperty ()

virtual void	SetXAxisLabelText (const char *)
virtual void	SetYAxisLabelText (const char *)
virtual void	SetZAxisLabelText (const char *)
Static Public Member Functions
static vtkPVAxesActor *	New ()
static int	IsTypeOf (const char *type)
static vtkPVAxesActor *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPVAxesActor ()
	~vtkPVAxesActor ()
void	UpdateProps ()
Protected Attributes
vtkCylinderSource *	CylinderSource
vtkLineSource *	LineSource
vtkConeSource *	ConeSource
vtkSphereSource *	SphereSource
vtkActor *	XAxisShaft
vtkActor *	YAxisShaft
vtkActor *	ZAxisShaft
vtkActor *	XAxisTip
vtkActor *	YAxisTip
vtkActor *	ZAxisTip
float	TotalLength [3]
float	NormalizedShaftLength [3]
float	NormalizedTipLength [3]
int	ShaftType
int	TipType
vtkPolyData *	UserDefinedTip
vtkPolyData *	UserDefinedShaft
char *	XAxisLabelText
char *	YAxisLabelText
char *	ZAxisLabelText
vtkVectorText *	XAxisVectorText
vtkVectorText *	YAxisVectorText
vtkVectorText *	ZAxisVectorText
vtkFollower *	XAxisLabel
vtkFollower *	YAxisLabel
vtkFollower *	ZAxisLabel
int	ConeResolution
int	SphereResolution
int	CylinderResolution
float	ConeRadius
float	SphereRadius
float	CylinderRadius
float	XAxisLabelPosition
float	YAxisLabelPosition
float	ZAxisLabelPosition

Detailed Description

a 3D axes representation

vtkPVAxesActor is used to represent 3D axes in the scene. The user can define the geometry to use for the shaft and the tip, and the user can set the text for the three axes. The text will follow the camera.

Definition at line 42 of file vtkPVAxesActor.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

CYLINDER_SHAFT
LINE_SHAFT
USER_DEFINED_SHAFT

Definition at line 207 of file vtkPVAxesActor.h.

anonymous enum

Enumerator:

CONE_TIP
SPHERE_TIP
USER_DEFINED_TIP

Definition at line 215 of file vtkPVAxesActor.h.

Constructor & Destructor Documentation

vtkPVAxesActor::vtkPVAxesActor ( ) [protected]

vtkPVAxesActor::~vtkPVAxesActor ( ) [protected]

Member Function Documentation

static vtkPVAxesActor* vtkPVAxesActor::New ( ) [static]

Reimplemented from vtkObject.

virtual const char* vtkPVAxesActor::GetClassName ( ) [virtual]

Reimplemented from vtkProp3D.

static int vtkPVAxesActor::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkProp3D.

virtual int vtkPVAxesActor::IsA ( const char * type ) [virtual]

Reimplemented from vtkProp3D.

static vtkPVAxesActor* vtkPVAxesActor::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkProp3D.

void vtkPVAxesActor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkProp3D.

virtual void vtkPVAxesActor::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 vtkPVAxesActor::RenderOpaqueGeometry ( vtkViewport * viewport ) [virtual]

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkPVAxesActor::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport ) [virtual]

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkPVAxesActor::HasTranslucentPolygonalGeometry ( ) [virtual]

Support the standard render methods.

Reimplemented from vtkProp.

void vtkPVAxesActor::ShallowCopy ( vtkProp * prop ) [virtual]

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

Reimplemented from vtkProp3D.

void vtkPVAxesActor::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 vtkPVAxesActor::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.)

Reimplemented from vtkProp3D.

double* vtkPVAxesActor::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 vtkPVAxesActor::GetMTime ( ) [virtual]

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

Reimplemented from vtkProp3D.

virtual unsigned long vtkPVAxesActor::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 vtkPVAxesActor::SetTotalLength ( float v[3] ) [inline]

Set the total length of the axes in 3 dimensions.

Definition at line 89 of file vtkPVAxesActor.h.

void vtkPVAxesActor::SetTotalLength	(	float	x,
		float	y,
		float	z
	)

Set the total length of the axes in 3 dimensions.

virtual float* vtkPVAxesActor::GetTotalLength ( ) [virtual]

Set the total length of the axes in 3 dimensions.

virtual void vtkPVAxesActor::GetTotalLength ( float data[3] ) [virtual]

Set the total length of the axes in 3 dimensions.

void vtkPVAxesActor::SetNormalizedShaftLength ( float v[3] ) [inline]

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

Definition at line 97 of file vtkPVAxesActor.h.

void vtkPVAxesActor::SetNormalizedShaftLength	(	float	x,
		float	y,
		float	z
	)

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

virtual float* vtkPVAxesActor::GetNormalizedShaftLength ( ) [virtual]

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

virtual void vtkPVAxesActor::GetNormalizedShaftLength ( float data[3] ) [virtual]

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

void vtkPVAxesActor::SetNormalizedTipLength ( float v[3] ) [inline]

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

Definition at line 105 of file vtkPVAxesActor.h.

void vtkPVAxesActor::SetNormalizedTipLength	(	float	x,
		float	y,
		float	z
	)

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

virtual float* vtkPVAxesActor::GetNormalizedTipLength ( ) [virtual]

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

virtual void vtkPVAxesActor::GetNormalizedTipLength ( float data[3] ) [virtual]

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

virtual void vtkPVAxesActor::SetConeResolution ( int ) [virtual]