a 3D cube with face labels More...

#include <vtkAnnotatedCubeActor.h>

Inheritance diagram for vtkAnnotatedCubeActor:

Collaboration diagram for vtkAnnotatedCubeActor:

Public Types
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)

vtkAnnotatedCubeActor *	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 ()

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

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 unsigned long	GetRedrawMTime ()

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 int	RenderOverlay (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 vtkAnnotatedCubeActor *	New ()

static int	IsTypeOf (const char *type)

static vtkAnnotatedCubeActor *	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

	vtkAnnotatedCubeActor ()

	~vtkAnnotatedCubeActor ()

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

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 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 62 of file vtkAnnotatedCubeActor.h.

Member Typedef Documentation

typedef vtkProp3D vtkAnnotatedCubeActor::Superclass

Definition at line 66 of file vtkAnnotatedCubeActor.h.

Constructor & Destructor Documentation

vtkAnnotatedCubeActor::vtkAnnotatedCubeActor ( )

protected

vtkAnnotatedCubeActor::~vtkAnnotatedCubeActor ( )

protected

Member Function Documentation

static vtkAnnotatedCubeActor* vtkAnnotatedCubeActor::New ( )

static

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

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkAnnotatedCubeActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProp3D.

vtkAnnotatedCubeActor* vtkAnnotatedCubeActor::NewInstance ( ) const

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

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

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

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

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