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

represents an object (geometry & properties) in a rendered scene More...

#include <vtkActor.h>

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

List of all members.

Public Types

typedef vtkProp3D Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkActorNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void GetActors (vtkPropCollection *)
virtual int HasTranslucentPolygonalGeometry ()
virtual void Render (vtkRenderer *, vtkMapper *)
void ShallowCopy (vtkProp *prop)
void ReleaseGraphicsResources (vtkWindow *)
virtual vtkPropertyMakeProperty ()
virtual void SetMapper (vtkMapper *)
virtual void ApplyProperties ()
unsigned long int GetMTime ()
virtual unsigned long GetRedrawMTime ()
virtual bool GetSupportsSelection ()
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
void SetProperty (vtkProperty *lut)
vtkPropertyGetProperty ()
void SetBackfaceProperty (vtkProperty *lut)
virtual vtkPropertyGetBackfaceProperty ()
virtual void SetTexture (vtkTexture *)
virtual vtkTextureGetTexture ()
virtual vtkMapperGetMapper ()
void GetBounds (double bounds[6])
doubleGetBounds ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkActorSafeDownCast (vtkObjectBase *o)
static vtkActorNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkActor ()
 ~vtkActor ()
int GetIsOpaque ()

Protected Attributes

vtkPropertyProperty
vtkPropertyBackfaceProperty
vtkTextureTexture
vtkMapperMapper
double MapperBounds [6]
vtkTimeStamp BoundsMTime

Detailed Description

represents an object (geometry & properties) in a rendered scene

vtkActor is used to represent an entity in a rendering scene. It inherits functions related to the actors position, and orientation from vtkProp. The actor also has scaling and maintains a reference to the defining geometry (i.e., the mapper), rendering properties, and possibly a texture map. vtkActor 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)

See also:
vtkProperty vtkTexture vtkMapper vtkAssembly vtkFollower vtkLODActor
Examples:
vtkActor (Examples)
Tests:
vtkActor (Tests)

Definition at line 50 of file vtkActor.h.


Member Typedef Documentation


Constructor & Destructor Documentation

vtkActor::vtkActor ( ) [protected]
vtkActor::~vtkActor ( ) [protected]

Member Function Documentation

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

Reimplemented in vtkAxisActor, vtkCubeAxesActor, vtkLODActor, vtkQuadricLODActor, vtkPolarAxesActor, vtkFollower, vtkAxisFollower, vtkOpenGLActor, and vtkOpenGLActor.

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

Reimplemented in vtkAxisActor, vtkCubeAxesActor, vtkLODActor, vtkQuadricLODActor, vtkPolarAxesActor, vtkFollower, vtkAxisFollower, vtkOpenGLActor, and vtkOpenGLActor.

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

Reimplemented in vtkAxisActor, vtkCubeAxesActor, vtkLODActor, vtkQuadricLODActor, vtkPolarAxesActor, vtkFollower, vtkAxisFollower, vtkOpenGLActor, and vtkOpenGLActor.

static vtkActor* vtkActor::New ( ) [static]

Creates an actor with the following defaults: origin(0,0,0) position=(0,0,0) scale=(1,1,1) visibility=1 pickable=1 dragable=1 orientation=(0,0,0). No user defined matrix and no texture map.

Reimplemented from vtkObject.

Reimplemented in vtkAxisActor, vtkCubeAxesActor, vtkLODActor, vtkQuadricLODActor, vtkPolarAxesActor, vtkFollower, vtkAxisFollower, vtkOpenGLActor, and vtkOpenGLActor.

virtual void vtkActor::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 vtkActor::RenderOpaqueGeometry ( vtkViewport viewport) [virtual]

Support the standard render methods.

Reimplemented from vtkProp.

Reimplemented in vtkAxisActor, vtkQuadricLODActor, vtkAxisFollower, vtkCubeAxesActor, vtkLODActor, vtkPolarAxesActor, and vtkFollower.

Support the standard render methods.

Reimplemented from vtkProp.

Reimplemented in vtkAxisActor, vtkAxisFollower, vtkCubeAxesActor, vtkPolarAxesActor, and vtkFollower.

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

Reimplemented in vtkAxisActor, vtkCubeAxesActor, and vtkFollower.

virtual void vtkActor::Render ( vtkRenderer ,
vtkMapper  
) [inline, virtual]

This causes the actor to be rendered. It in turn will render the actor's property, texture map and then mapper. If a property hasn't been assigned, then the actor will create one automatically. Note that a side effect of this method is that the pipeline will be updated.

Reimplemented in vtkQuadricLODActor, vtkLODActor, vtkOpenGLActor, and vtkOpenGLActor.

Definition at line 80 of file vtkActor.h.

void vtkActor::ShallowCopy ( vtkProp prop) [virtual]

Shallow copy of an actor. Overloads the virtual vtkProp method.

Reimplemented from vtkProp3D.

Reimplemented in vtkQuadricLODActor, vtkLODActor, vtkAxisFollower, and vtkFollower.

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.

Reimplemented in vtkAxisActor, vtkCubeAxesActor, vtkQuadricLODActor, vtkPolarAxesActor, vtkLODActor, and vtkFollower.

Set/Get the property object that controls this actors surface properties. This should be an instance of a vtkProperty object. Every actor must have a property associated with it. If one isn't specified, then one will be generated automatically. Multiple actors can share one property object.

Set/Get the property object that controls this actors surface properties. This should be an instance of a vtkProperty object. Every actor must have a property associated with it. If one isn't specified, then one will be generated automatically. Multiple actors can share one property object.

virtual vtkProperty* vtkActor::MakeProperty ( ) [virtual]

Create a new property suitable for use with this type of Actor. For example, a vtkMesaActor should create a vtkMesaProperty in this function. The default is to just call vtkProperty::New.

Set/Get the property object that controls this actors backface surface properties. This should be an instance of a vtkProperty object. If one isn't specified, then the front face properties will be used. Multiple actors can share one property object.

Set/Get the property object that controls this actors backface surface properties. This should be an instance of a vtkProperty object. If one isn't specified, then the front face properties will be used. Multiple actors can share one property object.

virtual void vtkActor::SetTexture ( vtkTexture ) [virtual]

Set/Get the texture object to control rendering texture maps. This will be a vtkTexture object. An actor does not need to have an associated texture map and multiple actors can share one texture.

virtual vtkTexture* vtkActor::GetTexture ( ) [virtual]

Set/Get the texture object to control rendering texture maps. This will be a vtkTexture object. An actor does not need to have an associated texture map and multiple actors can share one texture.

virtual void vtkActor::SetMapper ( vtkMapper ) [virtual]

This is the method that is used to connect an actor to the end of a visualization pipeline, i.e. the mapper. This should be a subclass of vtkMapper. Typically vtkPolyDataMapper and vtkDataSetMapper will be used.

virtual vtkMapper* vtkActor::GetMapper ( ) [virtual]

Returns the Mapper that this actor is getting its data from.

void vtkActor::GetBounds ( double  bounds[6]) [inline]

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.

Reimplemented in vtkPolarAxesActor, vtkAxisActor, and vtkCubeAxesActor.

Definition at line 137 of file vtkActor.h.

double* vtkActor::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.

Reimplemented in vtkPolarAxesActor, vtkAxisActor, and vtkCubeAxesActor.

virtual void vtkActor::ApplyProperties ( ) [inline, virtual]

Apply the current properties to all parts that compose this actor. This method is overloaded in vtkAssembly to apply the assemblies' properties to all its parts in a recursive manner. Typically the use of this method is to set the desired properties in the assembly, and then push the properties down to the assemblies parts with ApplyProperties().

Definition at line 147 of file vtkActor.h.

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

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

Reimplemented from vtkProp3D.

virtual unsigned long vtkActor::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.

virtual bool vtkActor::GetSupportsSelection ( ) [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

Reimplemented from vtkProp.

int vtkActor::GetIsOpaque ( ) [protected]

Member Data Documentation

Definition at line 171 of file vtkActor.h.

Definition at line 172 of file vtkActor.h.

Definition at line 173 of file vtkActor.h.

Definition at line 174 of file vtkActor.h.

Definition at line 178 of file vtkActor.h.

Definition at line 179 of file vtkActor.h.


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