vtkAnnotatedCubeActor Class Reference

#include <vtkAnnotatedCubeActor.h>

Inheritance diagram for vtkAnnotatedCubeActor:

Inheritance graph
[legend]
Collaboration diagram for vtkAnnotatedCubeActor:

Collaboration graph
[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 ()
vtkPropertyGetCubeProperty ()
vtkPropertyGetTextEdgesProperty ()
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
void GetBounds (double bounds[6])
double * GetBounds ()
void SetFaceTextScale (double)
virtual double GetFaceTextScale ()
vtkPropertyGetXPlusFaceProperty ()
vtkPropertyGetXMinusFaceProperty ()
vtkPropertyGetYPlusFaceProperty ()
vtkPropertyGetYMinusFaceProperty ()
vtkPropertyGetZPlusFaceProperty ()
vtkPropertyGetZMinusFaceProperty ()
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 ()
vtkAssemblyGetAssembly ()

Static Public Member Functions

static vtkAnnotatedCubeActorNew ()
static int IsTypeOf (const char *type)
static vtkAnnotatedCubeActorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkAnnotatedCubeActor ()
 ~vtkAnnotatedCubeActor ()
void UpdateProps ()

Protected Attributes

vtkCubeSourceCubeSource
vtkActorCubeActor
vtkAppendPolyDataAppendTextEdges
vtkFeatureEdgesExtractTextEdges
vtkActorTextEdgesActor
char * XPlusFaceText
char * XMinusFaceText
char * YPlusFaceText
char * YMinusFaceText
char * ZPlusFaceText
char * ZMinusFaceText
double FaceTextScale
double XFaceTextRotation
double YFaceTextRotation
double ZFaceTextRotation
vtkVectorTextXPlusFaceVectorText
vtkVectorTextXMinusFaceVectorText
vtkVectorTextYPlusFaceVectorText
vtkVectorTextYMinusFaceVectorText
vtkVectorTextZPlusFaceVectorText
vtkVectorTextZMinusFaceVectorText
vtkActorXPlusFaceActor
vtkActorXMinusFaceActor
vtkActorYPlusFaceActor
vtkActorYMinusFaceActor
vtkActorZPlusFaceActor
vtkActorZMinusFaceActor
vtkTransformFilterTransformFilter
vtkTransformTransform
vtkAssemblyAssembly

Member Typedef Documentation

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

Get the individual face text properties.

vtkProperty* vtkAnnotatedCubeActor::GetXMinusFaceProperty (  ) 

Get the individual face text properties.

vtkProperty* vtkAnnotatedCubeActor::GetYPlusFaceProperty (  ) 

Get the individual face text properties.

vtkProperty* vtkAnnotatedCubeActor::GetYMinusFaceProperty (  ) 

Get the individual face text properties.

vtkProperty* vtkAnnotatedCubeActor::GetZPlusFaceProperty (  ) 

Get the individual face text properties.

vtkProperty* vtkAnnotatedCubeActor::GetZMinusFaceProperty (  ) 

Get the individual face text properties.

vtkProperty* vtkAnnotatedCubeActor::GetCubeProperty (  ) 

Get the cube properties.

vtkProperty* vtkAnnotatedCubeActor::GetTextEdgesProperty (  ) 

Get the text edges properties.

virtual void vtkAnnotatedCubeActor::SetXPlusFaceText ( const char *   )  [virtual]

Set/get the face text.

virtual char* vtkAnnotatedCubeActor::GetXPlusFaceText (  )  [virtual]

Set/get the face text.

virtual void vtkAnnotatedCubeActor::SetXMinusFaceText ( const char *   )  [virtual]

Set/get the face text.

virtual char* vtkAnnotatedCubeActor::GetXMinusFaceText (  )  [virtual]

Set/get the face text.

virtual void vtkAnnotatedCubeActor::SetYPlusFaceText ( const char *   )  [virtual]

Set/get the face text.

virtual char* vtkAnnotatedCubeActor::GetYPlusFaceText (  )  [virtual]

Set/get the face text.

virtual void vtkAnnotatedCubeActor::SetYMinusFaceText ( const char *   )  [virtual]

Set/get the face text.

virtual char* vtkAnnotatedCubeActor::GetYMinusFaceText (  )  [virtual]

Set/get the face text.

virtual void vtkAnnotatedCubeActor::SetZPlusFaceText ( const char *   )  [virtual]

Set/get the face text.

virtual char* vtkAnnotatedCubeActor::GetZPlusFaceText (  )  [virtual]

Set/get the face text.

virtual void vtkAnnotatedCubeActor::SetZMinusFaceText ( const char *   )  [virtual]

Set/get the face text.

virtual char* vtkAnnotatedCubeActor::GetZMinusFaceText (  )  [virtual]

Set/get the face text.

void vtkAnnotatedCubeActor::SetTextEdgesVisibility ( int   ) 

Enable/disable drawing the vector text edges.

int vtkAnnotatedCubeActor::GetTextEdgesVisibility (  ) 

Enable/disable drawing the vector text edges.

void vtkAnnotatedCubeActor::SetCubeVisibility ( int   ) 

Enable/disable drawing the cube.

int vtkAnnotatedCubeActor::GetCubeVisibility (  ) 

Enable/disable drawing the cube.

void vtkAnnotatedCubeActor::SetFaceTextVisibility ( int   ) 

Enable/disable drawing the vector text.

int vtkAnnotatedCubeActor::GetFaceTextVisibility (  ) 

Enable/disable drawing the vector text.

virtual void vtkAnnotatedCubeActor::SetXFaceTextRotation ( double   )  [virtual]

Augment individual face text orientations.

virtual double vtkAnnotatedCubeActor::GetXFaceTextRotation (  )  [virtual]

Augment individual face text orientations.

virtual void vtkAnnotatedCubeActor::SetYFaceTextRotation ( double   )  [virtual]

Augment individual face text orientations.

virtual double vtkAnnotatedCubeActor::GetYFaceTextRotation (  )  [virtual]

Augment individual face text orientations.

virtual void vtkAnnotatedCubeActor::SetZFaceTextRotation ( double   )  [virtual]

Augment individual face text orientations.

virtual double vtkAnnotatedCubeActor::GetZFaceTextRotation (  )  [virtual]

Augment individual face text orientations.

vtkAssembly* vtkAnnotatedCubeActor::GetAssembly (  )  [inline]

Get the assembly so that user supplied transforms can be applied

Definition at line 169 of file vtkAnnotatedCubeActor.h.

void vtkAnnotatedCubeActor::UpdateProps (  )  [protected]


Member Data Documentation

Definition at line 177 of file vtkAnnotatedCubeActor.h.

Definition at line 178 of file vtkAnnotatedCubeActor.h.

Definition at line 180 of file vtkAnnotatedCubeActor.h.

Definition at line 181 of file vtkAnnotatedCubeActor.h.

Definition at line 182 of file vtkAnnotatedCubeActor.h.

Definition at line 186 of file vtkAnnotatedCubeActor.h.

Definition at line 187 of file vtkAnnotatedCubeActor.h.

Definition at line 188 of file vtkAnnotatedCubeActor.h.

Definition at line 189 of file vtkAnnotatedCubeActor.h.

Definition at line 190 of file vtkAnnotatedCubeActor.h.

Definition at line 191 of file vtkAnnotatedCubeActor.h.

Definition at line 193 of file vtkAnnotatedCubeActor.h.

Definition at line 195 of file vtkAnnotatedCubeActor.h.

Definition at line 196 of file vtkAnnotatedCubeActor.h.

Definition at line 197 of file vtkAnnotatedCubeActor.h.

Definition at line 199 of file vtkAnnotatedCubeActor.h.

Definition at line 200 of file vtkAnnotatedCubeActor.h.

Definition at line 201 of file vtkAnnotatedCubeActor.h.

Definition at line 202 of file vtkAnnotatedCubeActor.h.

Definition at line 203 of file vtkAnnotatedCubeActor.h.

Definition at line 204 of file vtkAnnotatedCubeActor.h.

Definition at line 206 of file vtkAnnotatedCubeActor.h.

Definition at line 207 of file vtkAnnotatedCubeActor.h.

Definition at line 208 of file vtkAnnotatedCubeActor.h.

Definition at line 209 of file vtkAnnotatedCubeActor.h.

Definition at line 210 of file vtkAnnotatedCubeActor.h.

Definition at line 211 of file vtkAnnotatedCubeActor.h.

Definition at line 213 of file vtkAnnotatedCubeActor.h.

Reimplemented from vtkProp3D.

Definition at line 214 of file vtkAnnotatedCubeActor.h.

Definition at line 216 of file vtkAnnotatedCubeActor.h.


The documentation for this class was generated from the following file:

Generated on Mon Sep 27 18:17:50 2010 for VTK by  doxygen 1.5.6