Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

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 60 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)
void ShallowCopy (vtkProp *prop)
unsigned long int GetMTime ()
vtkPropertyGetCubeProperty ()
virtual void GetActors (vtkPropCollection *)
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int RenderTranslucentGeometry (vtkViewport *viewport)
void ReleaseGraphicsResources (vtkWindow *)
void GetBounds (double bounds[6])
double * GetBounds ()
virtual unsigned long GetRedrawMTime ()
void SetFaceTextScale (double)
virtual double GetFaceTextScale ()
vtkPropertyGetXPlusFaceProperty ()
vtkPropertyGetXMinusFaceProperty ()
vtkPropertyGetYPlusFaceProperty ()
vtkPropertyGetYMinusFaceProperty ()
vtkPropertyGetZPlusFaceProperty ()
vtkPropertyGetZMinusFaceProperty ()
vtkPropertyGetTextEdgesProperty ()
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 ()
virtual void SetTextEdges (int)
virtual int GetTextEdges ()
virtual void TextEdgesOn ()
virtual void TextEdgesOff ()
virtual void SetCube (int)
virtual int GetCube ()
virtual void CubeOn ()
virtual void CubeOff ()
virtual void SetFaceText (int)
virtual int GetFaceText ()
virtual void FaceTextOn ()
virtual void FaceTextOff ()
virtual void SetXFaceTextRotation (double)
virtual double GetXFaceTextRotation ()
virtual void SetYFaceTextRotation (double)
virtual double GetYFaceTextRotation ()
virtual void SetZFaceTextRotation (double)
virtual double GetZFaceTextRotation ()

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
int Cube
vtkAppendPolyDataAppendTextEdges
vtkFeatureEdgesExtractTextEdges
vtkActorTextEdgesActor
int TextEdges
char * XPlusFaceText
char * XMinusFaceText
char * YPlusFaceText
char * YMinusFaceText
char * ZPlusFaceText
char * ZMinusFaceText
double FaceTextScale
int FaceText
double XFaceTextRotation
double YFaceTextRotation
double ZFaceTextRotation
vtkVectorTextXPlusFaceVectorText
vtkVectorTextXMinusFaceVectorText
vtkVectorTextYPlusFaceVectorText
vtkVectorTextYMinusFaceVectorText
vtkVectorTextZPlusFaceVectorText
vtkVectorTextZMinusFaceVectorText
vtkActorXPlusFaceActor
vtkActorXMinusFaceActor
vtkActorYPlusFaceActor
vtkActorYMinusFaceActor
vtkActorZPlusFaceActor
vtkActorZMinusFaceActor
vtkTransformFilterTransformFilter
vtkTransformTransform


Member Typedef Documentation

typedef vtkProp3D vtkAnnotatedCubeActor::Superclass
 

Reimplemented from vtkProp3D.

Definition at line 64 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 *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkProp3D.

virtual int vtkAnnotatedCubeActor::IsA const char *  type  )  [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 vtkTypeRevisionMacro 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::RenderTranslucentGeometry vtkViewport viewport  )  [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.

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]
 

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Implements vtkProp3D.

unsigned long int vtkAnnotatedCubeActor::GetMTime  )  [virtual]
 

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

Reimplemented from vtkProp3D.

virtual unsigned long vtkAnnotatedCubeActor::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 vtkAnnotatedCubeActor::SetFaceTextScale double   ) 
 

Set/Get the scale factor for the face text

virtual double vtkAnnotatedCubeActor::GetFaceTextScale  )  [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.

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]
 

Get the text edges properties.

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

Get the text edges properties.

virtual char* vtkAnnotatedCubeActor::GetXMinusFaceText  )  [virtual]
 

Get the text edges properties.

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

Get the text edges properties.

virtual char* vtkAnnotatedCubeActor::GetYPlusFaceText  )  [virtual]
 

Get the text edges properties.

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

Get the text edges properties.

virtual char* vtkAnnotatedCubeActor::GetYMinusFaceText  )  [virtual]
 

Get the text edges properties.

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

Get the text edges properties.

virtual char* vtkAnnotatedCubeActor::GetZPlusFaceText  )  [virtual]
 

Get the text edges properties.

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

Get the text edges properties.

virtual char* vtkAnnotatedCubeActor::GetZMinusFaceText  )  [virtual]
 

Get the text edges properties.

virtual void vtkAnnotatedCubeActor::SetTextEdges int   )  [virtual]
 

Enable/disable drawing the vector text edges.

virtual int vtkAnnotatedCubeActor::GetTextEdges  )  [virtual]
 

Enable/disable drawing the vector text edges.

virtual void vtkAnnotatedCubeActor::TextEdgesOn  )  [virtual]
 

Enable/disable drawing the vector text edges.

virtual void vtkAnnotatedCubeActor::TextEdgesOff  )  [virtual]
 

Enable/disable drawing the vector text edges.

virtual void vtkAnnotatedCubeActor::SetCube int   )  [virtual]
 

Enable/disable drawing the cube.

virtual int vtkAnnotatedCubeActor::GetCube  )  [virtual]
 

Enable/disable drawing the cube.

virtual void vtkAnnotatedCubeActor::CubeOn  )  [virtual]
 

Enable/disable drawing the cube.

virtual void vtkAnnotatedCubeActor::CubeOff  )  [virtual]
 

Enable/disable drawing the cube.

virtual void vtkAnnotatedCubeActor::SetFaceText int   )  [virtual]
 

Enable/disable drawing the vector text.

virtual int vtkAnnotatedCubeActor::GetFaceText  )  [virtual]
 

Enable/disable drawing the vector text.

virtual void vtkAnnotatedCubeActor::FaceTextOn  )  [virtual]
 

Enable/disable drawing the vector text.

virtual void vtkAnnotatedCubeActor::FaceTextOff  )  [virtual]
 

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.

void vtkAnnotatedCubeActor::UpdateProps  )  [protected]
 


Member Data Documentation

vtkCubeSource* vtkAnnotatedCubeActor::CubeSource [protected]
 

Definition at line 176 of file vtkAnnotatedCubeActor.h.

vtkActor* vtkAnnotatedCubeActor::CubeActor [protected]
 

Definition at line 177 of file vtkAnnotatedCubeActor.h.

int vtkAnnotatedCubeActor::Cube [protected]
 

Definition at line 178 of file vtkAnnotatedCubeActor.h.

vtkAppendPolyData* vtkAnnotatedCubeActor::AppendTextEdges [protected]
 

Definition at line 180 of file vtkAnnotatedCubeActor.h.

vtkFeatureEdges* vtkAnnotatedCubeActor::ExtractTextEdges [protected]
 

Definition at line 181 of file vtkAnnotatedCubeActor.h.

vtkActor* vtkAnnotatedCubeActor::TextEdgesActor [protected]
 

Definition at line 182 of file vtkAnnotatedCubeActor.h.

int vtkAnnotatedCubeActor::TextEdges [protected]
 

Definition at line 183 of file vtkAnnotatedCubeActor.h.

char* vtkAnnotatedCubeActor::XPlusFaceText [protected]
 

Definition at line 187 of file vtkAnnotatedCubeActor.h.

char* vtkAnnotatedCubeActor::XMinusFaceText [protected]
 

Definition at line 188 of file vtkAnnotatedCubeActor.h.

char* vtkAnnotatedCubeActor::YPlusFaceText [protected]
 

Definition at line 189 of file vtkAnnotatedCubeActor.h.

char* vtkAnnotatedCubeActor::YMinusFaceText [protected]
 

Definition at line 190 of file vtkAnnotatedCubeActor.h.

char* vtkAnnotatedCubeActor::ZPlusFaceText [protected]
 

Definition at line 191 of file vtkAnnotatedCubeActor.h.

char* vtkAnnotatedCubeActor::ZMinusFaceText [protected]
 

Definition at line 192 of file vtkAnnotatedCubeActor.h.

double vtkAnnotatedCubeActor::FaceTextScale [protected]
 

Definition at line 194 of file vtkAnnotatedCubeActor.h.

int vtkAnnotatedCubeActor::FaceText [protected]
 

Definition at line 195 of file vtkAnnotatedCubeActor.h.

double vtkAnnotatedCubeActor::XFaceTextRotation [protected]
 

Definition at line 197 of file vtkAnnotatedCubeActor.h.

double vtkAnnotatedCubeActor::YFaceTextRotation [protected]
 

Definition at line 198 of file vtkAnnotatedCubeActor.h.

double vtkAnnotatedCubeActor::ZFaceTextRotation [protected]
 

Definition at line 199 of file vtkAnnotatedCubeActor.h.

vtkVectorText* vtkAnnotatedCubeActor::XPlusFaceVectorText [protected]
 

Definition at line 201 of file vtkAnnotatedCubeActor.h.

vtkVectorText* vtkAnnotatedCubeActor::XMinusFaceVectorText [protected]
 

Definition at line 202 of file vtkAnnotatedCubeActor.h.

vtkVectorText* vtkAnnotatedCubeActor::YPlusFaceVectorText [protected]
 

Definition at line 203 of file vtkAnnotatedCubeActor.h.

vtkVectorText* vtkAnnotatedCubeActor::YMinusFaceVectorText [protected]
 

Definition at line 204 of file vtkAnnotatedCubeActor.h.

vtkVectorText* vtkAnnotatedCubeActor::ZPlusFaceVectorText [protected]
 

Definition at line 205 of file vtkAnnotatedCubeActor.h.

vtkVectorText* vtkAnnotatedCubeActor::ZMinusFaceVectorText [protected]
 

Definition at line 206 of file vtkAnnotatedCubeActor.h.

vtkActor* vtkAnnotatedCubeActor::XPlusFaceActor [protected]
 

Definition at line 208 of file vtkAnnotatedCubeActor.h.

vtkActor* vtkAnnotatedCubeActor::XMinusFaceActor [protected]
 

Definition at line 209 of file vtkAnnotatedCubeActor.h.

vtkActor* vtkAnnotatedCubeActor::YPlusFaceActor [protected]
 

Definition at line 210 of file vtkAnnotatedCubeActor.h.

vtkActor* vtkAnnotatedCubeActor::YMinusFaceActor [protected]
 

Definition at line 211 of file vtkAnnotatedCubeActor.h.

vtkActor* vtkAnnotatedCubeActor::ZPlusFaceActor [protected]
 

Definition at line 212 of file vtkAnnotatedCubeActor.h.

vtkActor* vtkAnnotatedCubeActor::ZMinusFaceActor [protected]
 

Definition at line 213 of file vtkAnnotatedCubeActor.h.

vtkTransformFilter* vtkAnnotatedCubeActor::TransformFilter [protected]
 

Definition at line 215 of file vtkAnnotatedCubeActor.h.

vtkTransform* vtkAnnotatedCubeActor::Transform [protected]
 

Reimplemented from vtkProp3D.

Definition at line 216 of file vtkAnnotatedCubeActor.h.


The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:33:45 2008 for VTK by  doxygen 1.4.3-20050530