VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkActor Class Reference

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

#include <vtkActor.h>

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

Public Types

typedef vtkProp3D Superclass
- Public Types inherited from vtkProp3D
typedef vtkProp Superclass
- Public Types inherited from vtkProp
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
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])
double * GetBounds ()
virtual void InitPartTraversal ()
virtual vtkActorGetNextPart ()
virtual int GetNumberOfParts ()
- Public Member Functions inherited from vtkProp3D
void SetScale (double s)
double * GetCenter ()
double * GetXRange ()
double * GetYRange ()
double * GetZRange ()
double GetLength ()
void RotateX (double)
void RotateY (double)
void RotateZ (double)
void RotateWXYZ (double, double, double, double)
void SetOrientation (double, double, double)
void SetOrientation (double a[3])
double * GetOrientationWXYZ ()
void AddOrientation (double, double, double)
void AddOrientation (double a[3])
void PokeMatrix (vtkMatrix4x4 *matrix)
void InitPathTraversal ()
unsigned long int GetUserTransformMatrixMTime ()
virtual void ComputeMatrix ()
virtual void SetPosition (double _arg1, double _arg2, double _arg3)
virtual void SetPosition (double _arg[3])
virtual double * GetPosition ()
virtual void GetPosition (double data[3])
void AddPosition (double deltaPosition[3])
void AddPosition (double deltaX, double deltaY, double deltaZ)
virtual void SetOrigin (double _arg1, double _arg2, double _arg3)
virtual void SetOrigin (double _arg[3])
virtual double * GetOrigin ()
virtual void GetOrigin (double data[3])
virtual void SetScale (double _arg1, double _arg2, double _arg3)
virtual void SetScale (double _arg[3])
virtual double * GetScale ()
virtual void GetScale (double data[3])
void SetUserTransform (vtkLinearTransform *transform)
virtual vtkLinearTransformGetUserTransform ()
void SetUserMatrix (vtkMatrix4x4 *matrix)
vtkMatrix4x4GetUserMatrix ()
virtual void GetMatrix (vtkMatrix4x4 *m)
virtual void GetMatrix (double m[16])
double * GetOrientation ()
void GetOrientation (double o[3])
vtkMatrix4x4GetMatrix ()
virtual int GetIsIdentity ()
- Public Member Functions inherited from vtkProp
virtual void Pick ()
virtual bool HasKeys (vtkInformation *requiredKeys)
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void GetActors2D (vtkPropCollection *)
virtual void GetVolumes (vtkPropCollection *)
virtual void SetVisibility (int)
virtual int GetVisibility ()
virtual void VisibilityOn ()
virtual void VisibilityOff ()
virtual void SetPickable (int)
virtual int GetPickable ()
virtual void PickableOn ()
virtual void PickableOff ()
virtual void SetDragable (int)
virtual int GetDragable ()
virtual void DragableOn ()
virtual void DragableOff ()
virtual void SetUseBounds (bool)
virtual bool GetUseBounds ()
virtual void UseBoundsOn ()
virtual void UseBoundsOff ()
virtual vtkAssemblyPathGetNextPath ()
virtual int GetNumberOfPaths ()
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkInformationGetPropertyKeys ()
virtual void SetPropertyKeys (vtkInformation *keys)
virtual int RenderVolumetricGeometry (vtkViewport *)
virtual int RenderOverlay (vtkViewport *)
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
virtual double GetEstimatedRenderTime (vtkViewport *)
virtual double GetEstimatedRenderTime ()
virtual void SetEstimatedRenderTime (double t)
virtual void RestoreEstimatedRenderTime ()
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
virtual double GetAllocatedRenderTime ()
void SetRenderTimeMultiplier (double t)
virtual double GetRenderTimeMultiplier ()
virtual int GetNumberOfConsumers ()
void AddConsumer (vtkObject *c)
void RemoveConsumer (vtkObject *c)
vtkObjectGetConsumer (int i)
int IsConsumer (vtkObject *c)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

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

Protected Member Functions

 vtkActor ()
 ~vtkActor ()
int GetIsOpaque ()
- Protected Member Functions inherited from vtkProp3D
 vtkProp3D ()
 ~vtkProp3D ()
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 ~vtkProp ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkPropertyProperty
vtkPropertyBackfaceProperty
vtkTextureTexture
vtkMapperMapper
double MapperBounds [6]
vtkTimeStamp BoundsMTime
- Protected Attributes inherited from vtkProp3D
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
- Protected Attributes inherited from vtkProp
int Visibility
int Pickable
int Dragable
bool UseBounds
double AllocatedRenderTime
double EstimatedRenderTime
double SavedEstimatedRenderTime
double RenderTimeMultiplier
int NumberOfConsumers
vtkObject ** Consumers
vtkAssemblyPathsPaths
vtkInformationPropertyKeys
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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 49 of file vtkActor.h.

Member Typedef Documentation

Definition at line 52 of file vtkActor.h.

Constructor & Destructor Documentation

vtkActor::vtkActor ( )
protected
vtkActor::~vtkActor ( )
protected

Member Function Documentation

virtual const char* vtkActor::GetClassName ( )
virtual
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, vtkLODActor, vtkCubeAxesActor, vtkQuadricLODActor, vtkFollower, vtkMesaActor, 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, vtkLODActor, vtkCubeAxesActor, vtkQuadricLODActor, vtkFollower, vtkMesaActor, and vtkOpenGLActor.

static vtkActor* vtkActor::SafeDownCast ( vtkObject o)
static
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, vtkLODActor, vtkCubeAxesActor, vtkQuadricLODActor, vtkFollower, vtkMesaActor, 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, vtkLODActor, vtkCubeAxesActor, vtkQuadricLODActor, vtkFollower, vtkMesaActor, 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, vtkLODActor, vtkCubeAxesActor, and vtkFollower.

virtual int vtkActor::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
virtual

Support the standard render methods.

Reimplemented from vtkProp.

Reimplemented in vtkFollower.

virtual int vtkActor::HasTranslucentPolygonalGeometry ( )
virtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

Reimplemented in vtkFollower.

virtual void vtkActor::Render ( vtkRenderer ,
vtkMapper  
)
inlinevirtual

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, vtkMesaActor, and vtkOpenGLActor.

Definition at line 79 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 vtkAxisActor, vtkQuadricLODActor, vtkLODActor, and vtkFollower.

void vtkActor::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.

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

void vtkActor::SetProperty ( vtkProperty lut)

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.

vtkProperty* vtkActor::GetProperty ( )

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.

Reimplemented in vtkMesaActor.

void vtkActor::SetBackfaceProperty ( vtkProperty lut)

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 vtkProperty* vtkActor::GetBackfaceProperty ( )
virtual

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 vtkAxisActor, and vtkCubeAxesActor.

Definition at line 136 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 vtkAxisActor, and vtkCubeAxesActor.

virtual void vtkActor::ApplyProperties ( )
inlinevirtual

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 146 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 void vtkActor::InitPartTraversal ( )
virtual

The following methods are for compatibility. The methods will be deprecated in the near future. Use vtkProp::GetNextPath() (and related functionality) to get the parts in an assembly (or more correctly, the paths in the assembly).

virtual vtkActor* vtkActor::GetNextPart ( )
virtual

The following methods are for compatibility. The methods will be deprecated in the near future. Use vtkProp::GetNextPath() (and related functionality) to get the parts in an assembly (or more correctly, the paths in the assembly).

virtual int vtkActor::GetNumberOfParts ( )
virtual

The following methods are for compatibility. The methods will be deprecated in the near future. Use vtkProp::GetNextPath() (and related functionality) to get the parts in an assembly (or more correctly, the paths in the assembly).

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

vtkProperty* vtkActor::Property
protected

Definition at line 177 of file vtkActor.h.

vtkProperty* vtkActor::BackfaceProperty
protected

Definition at line 178 of file vtkActor.h.

vtkTexture* vtkActor::Texture
protected

Definition at line 179 of file vtkActor.h.

vtkMapper* vtkActor::Mapper
protected

Definition at line 180 of file vtkActor.h.

double vtkActor::MapperBounds[6]
protected

Definition at line 187 of file vtkActor.h.

vtkTimeStamp vtkActor::BoundsMTime
protected

Definition at line 188 of file vtkActor.h.


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