vtkAnnotatedCubeActor Class Reference

#include <vtkAnnotatedCubeActor.h>

Inheritance diagram for vtkAnnotatedCubeActor:

[legend]

Collaboration diagram for vtkAnnotatedCubeActor:

[legend]

List of all members.

Detailed Description

a 3D cube with face labels

vtkAnnotatedCubeActor is a hybrid 3D actor used to represent an anatomical orientation marker in a scene. The class consists of a 3D unit cube centered on the origin with each face labelled in correspondance to a particular coordinate direction. For example, with Cartesian directions, the user defined text labels could be: +X, -X, +Y, -Y, +Z, -Z, while for anatomical directions: A, P, L, R, S, I. Text is automatically centered on each cube face and is not restriceted to single characters. In addition to or in replace of a solid text label representation, the outline edges of the labels can be displayed. The individual properties of the cube, face labels and text outlines can be manipulated as can their visibility.

Warning:: vtkAnnotatedCubeActor is primarily intended for use with vtkOrientationMarkerWidget. The cube face text is generated by vtkVectorText and therefore the font attributes are restricted.

See also:: vtkAxesActor vtkOrientationMarkerWidget vtkVectorText

Examples:: vtkAnnotatedCubeActor (Examples)

Tests:: vtkAnnotatedCubeActor (Tests)

Definition at line 61 of file vtkAnnotatedCubeActor.h.


Public Types
typedef vtkProp3D	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	GetActors (vtkPropCollection *)
virtual int	HasTranslucentPolygonalGeometry ()
void	ShallowCopy (vtkProp *prop)
void	ReleaseGraphicsResources (vtkWindow *)
unsigned long int	GetMTime ()
vtkProperty *	GetCubeProperty ()
vtkProperty *	GetTextEdgesProperty ()

virtual int	RenderOpaqueGeometry (vtkViewport *viewport)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)

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

void	SetFaceTextScale (double)
virtual double	GetFaceTextScale ()

vtkProperty *	GetXPlusFaceProperty ()
vtkProperty *	GetXMinusFaceProperty ()
vtkProperty *	GetYPlusFaceProperty ()
vtkProperty *	GetYMinusFaceProperty ()
vtkProperty *	GetZPlusFaceProperty ()
vtkProperty *	GetZMinusFaceProperty ()

virtual void	SetXPlusFaceText (const char *)
virtual char *	GetXPlusFaceText ()
virtual void	SetXMinusFaceText (const char *)
virtual char *	GetXMinusFaceText ()
virtual void	SetYPlusFaceText (const char *)
virtual char *	GetYPlusFaceText ()
virtual void	SetYMinusFaceText (const char *)
virtual char *	GetYMinusFaceText ()
virtual void	SetZPlusFaceText (const char *)
virtual char *	GetZPlusFaceText ()
virtual void	SetZMinusFaceText (const char *)
virtual char *	GetZMinusFaceText ()

void	SetTextEdgesVisibility (int)
int	GetTextEdgesVisibility ()

void	SetCubeVisibility (int)
int	GetCubeVisibility ()

void	SetFaceTextVisibility (int)
int	GetFaceTextVisibility ()

virtual void	SetXFaceTextRotation (double)
virtual double	GetXFaceTextRotation ()
virtual void	SetYFaceTextRotation (double)
virtual double	GetYFaceTextRotation ()
virtual void	SetZFaceTextRotation (double)
virtual double	GetZFaceTextRotation ()

vtkAssembly *	GetAssembly ()
Static Public Member Functions
static vtkAnnotatedCubeActor *	New ()
static int	IsTypeOf (const char *type)
static vtkAnnotatedCubeActor *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkAnnotatedCubeActor ()
	~vtkAnnotatedCubeActor ()
void	UpdateProps ()
Protected Attributes
vtkCubeSource *	CubeSource
vtkActor *	CubeActor
vtkAppendPolyData *	AppendTextEdges
vtkFeatureEdges *	ExtractTextEdges
vtkActor *	TextEdgesActor
char *	XPlusFaceText
char *	XMinusFaceText
char *	YPlusFaceText
char *	YMinusFaceText
char *	ZPlusFaceText
char *	ZMinusFaceText
double	FaceTextScale
double	XFaceTextRotation
double	YFaceTextRotation
double	ZFaceTextRotation
vtkVectorText *	XPlusFaceVectorText
vtkVectorText *	XMinusFaceVectorText
vtkVectorText *	YPlusFaceVectorText
vtkVectorText *	YMinusFaceVectorText
vtkVectorText *	ZPlusFaceVectorText
vtkVectorText *	ZMinusFaceVectorText
vtkActor *	XPlusFaceActor
vtkActor *	XMinusFaceActor
vtkActor *	YPlusFaceActor
vtkActor *	YMinusFaceActor
vtkActor *	ZPlusFaceActor
vtkActor *	ZMinusFaceActor
vtkTransformFilter *	TransformFilter
vtkTransform *	Transform
vtkAssembly *	Assembly

Member Typedef Documentation

typedef vtkProp3D vtkAnnotatedCubeActor::Superclass

Reimplemented from vtkProp3D.

Definition at line 65 of file vtkAnnotatedCubeActor.h.

Constructor & Destructor Documentation

vtkAnnotatedCubeActor::vtkAnnotatedCubeActor ( ) [protected]

vtkAnnotatedCubeActor::~vtkAnnotatedCubeActor ( ) [protected]

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

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

Reimplemented from vtkProp3D.

static int vtkAnnotatedCubeActor::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkAnnotatedCubeActor::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 vtkAnnotatedCubeActor* vtkAnnotatedCubeActor::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkProp3D.

void vtkAnnotatedCubeActor::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 vtkProp3D.

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

Support the standard render methods.

Reimplemented from vtkProp.

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

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkAnnotatedCubeActor::HasTranslucentPolygonalGeometry ( ) [virtual]

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

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

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

Reimplemented from vtkProp3D.

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

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

Reimplemented from vtkProp3D.

void vtkAnnotatedCubeActor::SetFaceTextScale ( double )

Set/Get the scale factor for the face text

virtual double vtkAnnotatedCubeActor::GetFaceTextScale ( ) [virtual]

Set/Get the scale factor for the face text

vtkProperty* vtkAnnotatedCubeActor::GetXPlusFaceProperty ( )