vtkActor Class Reference

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

#include <vtkActor.h>

Inheritance diagram for vtkActor:

Collaboration diagram for vtkActor:

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 int	IsA (const char *type)
vtkActor *	NewInstance () 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 vtkProperty *	MakeProperty ()
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)
vtkProperty *	GetProperty ()
void	SetBackfaceProperty (vtkProperty *lut)
virtual vtkProperty *	GetBackfaceProperty ()
virtual void	SetTexture (vtkTexture *)
virtual vtkTexture *	GetTexture ()
virtual vtkMapper *	GetMapper ()
void	GetBounds (double bounds[6])
double *	GetBounds ()
Public Member Functions inherited from vtkProp3D
vtkProp3D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	ShallowCopy (vtkProp *prop)
virtual void	SetPosition (double pos[3])
virtual double *	GetPosition ()
virtual void	GetPosition (double data[3])
void	AddPosition (double deltaPosition[3])
void	AddPosition (double deltaX, double deltaY, double deltaZ)
double *	GetCenter ()
double *	GetXRange ()
double *	GetYRange ()
double *	GetZRange ()
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])
double *	GetOrientationWXYZ ()
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 (const double pos[3])
virtual double *	GetOrigin ()
virtual void	GetOrigin (double data[3])
virtual void	SetScale (double x, double y, double z)
virtual void	SetScale (double scale[3])
virtual double *	GetScale ()
virtual void	GetScale (double data[3])
void	SetScale (double s)
void	SetUserTransform (vtkLinearTransform *transform)
virtual vtkLinearTransform *	GetUserTransform ()
void	SetUserMatrix (vtkMatrix4x4 *matrix)
vtkMatrix4x4 *	GetUserMatrix ()
virtual void	GetMatrix (vtkMatrix4x4 *m)
virtual void	GetMatrix (double m[16])
void	GetBounds (double bounds[6])
double *	GetOrientation ()
void	GetOrientation (double orentation[3])
vtkMatrix4x4 *	GetMatrix ()
virtual int	GetIsIdentity ()
Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const
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 vtkAssemblyPath *	GetNextPath ()
virtual int	GetNumberOfPaths ()
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkInformation *	GetPropertyKeys ()
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)
vtkObject *	GetConsumer (int i)
int	IsConsumer (vtkObject *c)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool 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)
vtkCommand *	GetCommand (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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)
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 vtkActor *	SafeDownCast (vtkObjectBase *o)
static vtkActor *	New ()
Static Public Member Functions inherited from vtkProp3D
static int	IsTypeOf (const char *type)
static vtkProp3D *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)
static vtkProp *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	GeneralTextureUnit ()
static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	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 &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkProperty *	Property
vtkProperty *	BackfaceProperty
vtkTexture *	Texture
vtkMapper *	Mapper
double	MapperBounds [6]
vtkTimeStamp	BoundsMTime
Protected Attributes inherited from vtkProp3D
vtkLinearTransform *	UserTransform
vtkMatrix4x4 *	UserMatrix
vtkMatrix4x4 *	Matrix
vtkTimeStamp	MatrixMTime
double	Origin [3]
double	Position [3]
double	Orientation [3]
double	Scale [3]
double	Center [3]
vtkTransform *	Transform
double	Bounds [6]
vtkProp3D *	CachedProp3D
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
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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 50 of file vtkActor.h.

Member Typedef Documentation

typedef vtkProp3D vtkActor::Superclass

Definition at line 53 of file vtkActor.h.

Constructor & Destructor Documentation

vtkActor::vtkActor ( )

protected

vtkActor::~vtkActor ( )

protected

Member Function Documentation

static int vtkActor::IsTypeOf ( const char *  type )

static

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

protectedvirtual

Reimplemented from vtkProp3D.

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

vtkActor* vtkActor::NewInstance

(

)

const

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 vtkObject.

Reimplemented in vtkLODActor, vtkQuadricLODActor, vtkFollower, 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.

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.

virtual int vtkActor::RenderTranslucentPolygonalGeometry ( vtkViewport *  viewport )

virtual

Support the standard render methods.

Reimplemented from vtkProp.

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

virtual int vtkActor::HasTranslucentPolygonalGeometry ( )

virtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

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

Reimplemented in 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 vtkQuadricLODActor, 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.

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.)

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.

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 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 vtkObject.

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

vtkProperty* vtkActor::Property

protected

Definition at line 171 of file vtkActor.h.

vtkProperty* vtkActor::BackfaceProperty

protected

Definition at line 172 of file vtkActor.h.

vtkTexture* vtkActor::Texture

protected

Definition at line 173 of file vtkActor.h.

vtkMapper* vtkActor::Mapper

protected

Definition at line 174 of file vtkActor.h.

double vtkActor::MapperBounds[6]

protected

Definition at line 178 of file vtkActor.h.

vtkTimeStamp vtkActor::BoundsMTime

protected

Definition at line 179 of file vtkActor.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkActor.h