VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkProp3D Class Reference

represents an 3D object for placement in a rendered scene More...

#include <vtkProp3D.h>

Inheritance diagram for vtkProp3D:
Inheritance graph
[legend]
Collaboration diagram for vtkProp3D:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkProp Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkProp3DNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
void ShallowCopy (vtkProp *prop)
virtual void SetPosition (double pos[3])
virtual doubleGetPosition ()
virtual void GetPosition (double data[3])
void AddPosition (double deltaPosition[3])
void AddPosition (double deltaX, double deltaY, double deltaZ)
doubleGetCenter ()
doubleGetXRange ()
doubleGetYRange ()
doubleGetZRange ()
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])
doubleGetOrientationWXYZ ()
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 (double pos[3])
virtual doubleGetOrigin ()
virtual void GetOrigin (double data[3])
virtual void SetScale (double x, double y, double z)
virtual void SetScale (double scale[3])
virtual doubleGetScale ()
virtual void GetScale (double data[3])
void SetScale (double s)
void SetUserTransform (vtkLinearTransform *transform)
virtual vtkLinearTransformGetUserTransform ()
void SetUserMatrix (vtkMatrix4x4 *matrix)
vtkMatrix4x4GetUserMatrix ()
virtual void GetMatrix (vtkMatrix4x4 *m)
virtual void GetMatrix (double m[16])
void GetBounds (double bounds[6])
virtual doubleGetBounds ()=0
doubleGetOrientation ()
void GetOrientation (double orentation[3])
vtkMatrix4x4GetMatrix ()
virtual int GetIsIdentity ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkProp3DSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkProp3D ()
 ~vtkProp3D ()

Protected Attributes

vtkLinearTransformUserTransform
vtkMatrix4x4UserMatrix
vtkMatrix4x4Matrix
vtkTimeStamp MatrixMTime
double Origin [3]
double Position [3]
double Orientation [3]
double Scale [3]
double Center [3]
vtkTransformTransform
double Bounds [6]
vtkProp3DCachedProp3D
int IsIdentity

Detailed Description

represents an 3D object for placement in a rendered scene

vtkProp3D is an abstract class used to represent an entity in a rendering scene (i.e., vtkProp3D is a vtkProp with an associated transformation matrix). It handles functions related to the position, orientation and scaling. It combines these instance variables into one 4x4 transformation matrix as follows: [x y z 1] = [x y z 1] Translate(-origin) Scale(scale) Rot(y) Rot(x) Rot (z) Trans(origin) Trans(position). Both vtkActor and vtkVolume are specializations of class vtkProp. The constructor defaults to: origin(0,0,0) position=(0,0,0) orientation=(0,0,0), no user defined matrix or transform, and no texture map.

See also:
vtkProp vtkActor vtkAssembly vtkVolume

Definition at line 42 of file vtkProp3D.h.


Member Typedef Documentation


Constructor & Destructor Documentation

vtkProp3D::vtkProp3D ( ) [protected]
vtkProp3D::~vtkProp3D ( ) [protected]

Member Function Documentation

static int vtkProp3D::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 vtkProp.

Reimplemented in vtkAxisActor, vtkCubeAxesActor, vtkAssembly, vtkLODActor, vtkAxesActor, vtkLODProp3D, vtkQuadricLODActor, vtkAnnotatedCubeActor, vtkPolarAxesActor, vtkLightActor, vtkTextActor3D, vtkImageSlice, vtkProp3DFollower, vtkActor, vtkVolume, vtkImageActor, vtkFollower, vtkImageStack, vtkResliceCursorActor, vtkAxisFollower, vtkCameraActor, and vtkOpenGLActor.

virtual int vtkProp3D::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 vtkProp.

Reimplemented in vtkAxisActor, vtkCubeAxesActor, vtkAssembly, vtkLODActor, vtkAxesActor, vtkLODProp3D, vtkQuadricLODActor, vtkAnnotatedCubeActor, vtkPolarAxesActor, vtkLightActor, vtkTextActor3D, vtkImageSlice, vtkProp3DFollower, vtkActor, vtkVolume, vtkImageActor, vtkFollower, vtkImageStack, vtkResliceCursorActor, vtkAxisFollower, vtkCameraActor, and vtkOpenGLActor.

static vtkProp3D* vtkProp3D::SafeDownCast ( vtkObjectBase o) [static]
virtual vtkObjectBase* vtkProp3D::NewInstanceInternal ( ) const [protected, virtual]
void vtkProp3D::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 vtkProp.

Reimplemented in vtkAxisActor, vtkCubeAxesActor, vtkAssembly, vtkLODActor, vtkAxesActor, vtkLODProp3D, vtkQuadricLODActor, vtkAnnotatedCubeActor, vtkPolarAxesActor, vtkLightActor, vtkTextActor3D, vtkImageSlice, vtkProp3DFollower, vtkActor, vtkVolume, vtkImageActor, vtkFollower, vtkImageStack, vtkResliceCursorActor, vtkAxisFollower, vtkCameraActor, and vtkOpenGLActor.

void vtkProp3D::ShallowCopy ( vtkProp prop) [virtual]
virtual void vtkProp3D::SetPosition ( double  x,
double  y,
double  z 
) [inline, virtual]

Set/Get/Add the position of the Prop3D in world coordinates.

Definition at line 53 of file vtkProp3D.h.

virtual void vtkProp3D::SetPosition ( double  pos[3]) [inline, virtual]

Definition at line 71 of file vtkProp3D.h.

virtual double* vtkProp3D::GetPosition ( ) [virtual]
virtual void vtkProp3D::GetPosition ( double  data[3]) [virtual]
void vtkProp3D::AddPosition ( double  deltaPosition[3])
void vtkProp3D::AddPosition ( double  deltaX,
double  deltaY,
double  deltaZ 
)
virtual void vtkProp3D::SetOrigin ( double  x,
double  y,
double  z 
) [inline, virtual]

Set/Get the origin of the Prop3D. This is the point about which all rotations take place.

Definition at line 80 of file vtkProp3D.h.

virtual void vtkProp3D::SetOrigin ( double  pos[3]) [inline, virtual]

Set/Get the origin of the Prop3D. This is the point about which all rotations take place.

Definition at line 96 of file vtkProp3D.h.

virtual double* vtkProp3D::GetOrigin ( ) [virtual]

Set/Get the origin of the Prop3D. This is the point about which all rotations take place.

virtual void vtkProp3D::GetOrigin ( double  data[3]) [virtual]

Set/Get the origin of the Prop3D. This is the point about which all rotations take place.

virtual void vtkProp3D::SetScale ( double  x,
double  y,
double  z 
) [inline, virtual]

Set/Get the scale of the actor. Scaling in performed independently on the X, Y and Z axis. A scale of zero is illegal and will be replaced with one.

Definition at line 105 of file vtkProp3D.h.

virtual void vtkProp3D::SetScale ( double  scale[3]) [inline, virtual]

Set/Get the scale of the actor. Scaling in performed independently on the X, Y and Z axis. A scale of zero is illegal and will be replaced with one.

Definition at line 121 of file vtkProp3D.h.

virtual double* vtkProp3D::GetScale ( ) [virtual]

Set/Get the scale of the actor. Scaling in performed independently on the X, Y and Z axis. A scale of zero is illegal and will be replaced with one.

virtual void vtkProp3D::GetScale ( double  data[3]) [virtual]

Set/Get the scale of the actor. Scaling in performed independently on the X, Y and Z axis. A scale of zero is illegal and will be replaced with one.

void vtkProp3D::SetScale ( double  s) [inline]

Method to set the scale isotropically

Definition at line 128 of file vtkProp3D.h.

In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. This transformation is concatenated with the actor's internal transformation, which you implicitly create through the use of SetPosition(), SetOrigin() and SetOrientation().

If the internal transformation is identity (i.e. if you don't set the Position, Origin, or Orientation) then the actors final transformation will be the UserTransform, concatenated with the UserMatrix if the UserMatrix is present.

In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. This transformation is concatenated with the actor's internal transformation, which you implicitly create through the use of SetPosition(), SetOrigin() and SetOrientation().

If the internal transformation is identity (i.e. if you don't set the Position, Origin, or Orientation) then the actors final transformation will be the UserTransform, concatenated with the UserMatrix if the UserMatrix is present.

The UserMatrix can be used in place of UserTransform.

Reimplemented in vtkResliceCursorActor.

The UserMatrix can be used in place of UserTransform.

virtual void vtkProp3D::GetMatrix ( vtkMatrix4x4 m) [virtual]

Return a reference to the Prop3D's 4x4 composite matrix. Get the matrix from the position, origin, scale and orientation This matrix is cached, so multiple GetMatrix() calls will be efficient.

virtual void vtkProp3D::GetMatrix ( double  m[16]) [virtual]

Return a reference to the Prop3D's 4x4 composite matrix. Get the matrix from the position, origin, scale and orientation This matrix is cached, so multiple GetMatrix() calls will be efficient.

void vtkProp3D::GetBounds ( double  bounds[6])

Return a reference to the Prop3D's composite transform.

Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Reimplemented in vtkPolarAxesActor, vtkAssembly, vtkActor, vtkAxisActor, vtkCubeAxesActor, vtkAxesActor, vtkImageActor, vtkAnnotatedCubeActor, vtkImageStack, vtkVolume, vtkImageSlice, and vtkLODProp3D.

virtual double* vtkProp3D::GetBounds ( ) [pure virtual]

Return a reference to the Prop3D's composite transform.

Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Reimplemented from vtkProp.

Implemented in vtkPolarAxesActor, vtkAssembly, vtkActor, vtkAxisActor, vtkCubeAxesActor, vtkAxesActor, vtkImageActor, vtkAnnotatedCubeActor, vtkProp3DFollower, vtkLightActor, vtkImageStack, vtkVolume, vtkImageSlice, vtkLODProp3D, vtkTextActor3D, vtkCameraActor, and vtkResliceCursorActor.

Get the center of the bounding box in world coordinates.

Get the Prop3D's x range in world coordinates.

Get the Prop3D's y range in world coordinates.

Get the Prop3D's z range in world coordinates.

Get the length of the diagonal of the bounding box.

Rotate the Prop3D in degrees about the X axis using the right hand rule. The axis is the Prop3D's X axis, which can change as other rotations are performed. To rotate about the world X axis use RotateWXYZ (angle, 1, 0, 0). This rotation is applied before all others in the current transformation matrix.

Rotate the Prop3D in degrees about the Y axis using the right hand rule. The axis is the Prop3D's Y axis, which can change as other rotations are performed. To rotate about the world Y axis use RotateWXYZ (angle, 0, 1, 0). This rotation is applied before all others in the current transformation matrix.

Rotate the Prop3D in degrees about the Z axis using the right hand rule. The axis is the Prop3D's Z axis, which can change as other rotations are performed. To rotate about the world Z axis use RotateWXYZ (angle, 0, 0, 1). This rotation is applied before all others in the current transformation matrix.

void vtkProp3D::RotateWXYZ ( double  w,
double  x,
double  y,
double  z 
)

Rotate the Prop3D in degrees about an arbitrary axis specified by the last three arguments. The axis is specified in world coordinates. To rotate an about its model axes, use RotateX, RotateY, RotateZ.

void vtkProp3D::SetOrientation ( double  x,
double  y,
double  z 
)

Sets the orientation of the Prop3D. Orientation is specified as X,Y and Z rotations in that order, but they are performed as RotateZ, RotateX, and finally RotateY.

void vtkProp3D::SetOrientation ( double  orientation[3])

Sets the orientation of the Prop3D. Orientation is specified as X,Y and Z rotations in that order, but they are performed as RotateZ, RotateX, and finally RotateY.

Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. The ordering in which these rotations must be done to generate the same matrix is RotateZ, RotateX, and finally RotateY. See also SetOrientation.

void vtkProp3D::GetOrientation ( double  orentation[3])

Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. The ordering in which these rotations must be done to generate the same matrix is RotateZ, RotateX, and finally RotateY. See also SetOrientation.

Returns the WXYZ orientation of the Prop3D.

void vtkProp3D::AddOrientation ( double  x,
double  y,
double  z 
)

Add to the current orientation. See SetOrientation and GetOrientation for more details. This basically does a GetOrientation, adds the passed in arguments, and then calls SetOrientation.

void vtkProp3D::AddOrientation ( double  orentation[3])

Add to the current orientation. See SetOrientation and GetOrientation for more details. This basically does a GetOrientation, adds the passed in arguments, and then calls SetOrientation.

void vtkProp3D::PokeMatrix ( vtkMatrix4x4 matrix)

This method modifies the vtkProp3D so that its transformation state is set to the matrix specified. The method does this by setting appropriate transformation-related ivars to initial values (i.e., not transformed), and placing the user-supplied matrix into the UserMatrix of this vtkProp3D. If the method is called again with a NULL matrix, then the original state of the vtkProp3D will be restored. This method is used to support picking and assembly structures.

void vtkProp3D::InitPathTraversal ( ) [virtual]

Overload vtkProp's method for setting up assembly paths. See the documentation for vtkProp.

Reimplemented from vtkProp.

Reimplemented in vtkAssembly, vtkImageStack, and vtkProp3DFollower.

unsigned long int vtkProp3D::GetMTime ( ) [virtual]

Get the modified time of the user matrix or user transform.

virtual void vtkProp3D::ComputeMatrix ( ) [virtual]

Generate the matrix based on ivars

Reimplemented in vtkProp3DFollower, and vtkFollower.

vtkMatrix4x4* vtkProp3D::GetMatrix ( ) [inline, virtual]

Get a pointer to an internal vtkMatrix4x4. that represents

Reimplemented from vtkProp.

Definition at line 266 of file vtkProp3D.h.

virtual int vtkProp3D::GetIsIdentity ( ) [virtual]

Is the matrix for this actor identity


Member Data Documentation

Definition at line 282 of file vtkProp3D.h.

Definition at line 283 of file vtkProp3D.h.

Definition at line 284 of file vtkProp3D.h.

Definition at line 285 of file vtkProp3D.h.

double vtkProp3D::Origin[3] [protected]

Definition at line 286 of file vtkProp3D.h.

double vtkProp3D::Position[3] [protected]

Definition at line 287 of file vtkProp3D.h.

Definition at line 288 of file vtkProp3D.h.

double vtkProp3D::Scale[3] [protected]

Definition at line 289 of file vtkProp3D.h.

double vtkProp3D::Center[3] [protected]

Definition at line 290 of file vtkProp3D.h.

Reimplemented in vtkAnnotatedCubeActor.

Definition at line 291 of file vtkProp3D.h.

double vtkProp3D::Bounds[6] [protected]

Reimplemented in vtkAxisActor, vtkCubeAxesActor, and vtkPolarAxesActor.

Definition at line 292 of file vtkProp3D.h.

Definition at line 293 of file vtkProp3D.h.

Definition at line 294 of file vtkProp3D.h.


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