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 60 of file vtkAnnotatedCubeActor.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkAnnotatedCubeActor::vtkAnnotatedCubeActor |
( |
|
) |
[protected] |
|
| vtkAnnotatedCubeActor::~vtkAnnotatedCubeActor |
( |
|
) |
[protected] |
|
Member Function Documentation
|
|
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] |
|
| 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. |
| 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. |
|
|
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 |
( |
|
) |
|
|
| vtkProperty* vtkAnnotatedCubeActor::GetTextEdgesProperty |
( |
|
) |
|
|
|
|
Get the text edges properties. |
| virtual void vtkAnnotatedCubeActor::SetXPlusFaceText |
( |
const char * |
|
) |
[virtual] |
|
| 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
The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:33:45 2008 for VTK by
1.4.3-20050530