a vtkProp3D that always faces the camera More...

#include <vtkProp3DFollower.h>

Inheritance diagram for vtkProp3DFollower:

Collaboration diagram for vtkProp3DFollower:

Public Member Functions
virtual int	HasTranslucentPolygonalGeometry ()

virtual void	ReleaseGraphicsResources (vtkWindow *)

virtual void	ComputeMatrix ()

void	ShallowCopy (vtkProp *prop)

virtual double *	GetBounds ()


virtual void	SetProp3D (vtkProp3D *prop)

virtual vtkProp3D *	GetProp3D ()


virtual void	SetCamera (vtkCamera *)

virtual vtkCamera *	GetCamera ()


virtual int	RenderOpaqueGeometry (vtkViewport *viewport)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)

virtual int	RenderVolumetricGeometry (vtkViewport *viewport)


void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

Public Member Functions inherited from vtkProp3D
vtkProp3D *	NewInstance () const

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)

unsigned long int	GetMTime ()

unsigned long int	GetUserTransformMatrixMTime ()

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	GetActors (vtkPropCollection *)

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 unsigned long	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

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 bool	GetSupportsSelection ()

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 vtkProp3DFollower *	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
	vtkProp3DFollower ()

	~vtkProp3DFollower ()

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
vtkCamera *	Camera

vtkProp3D *	Device

vtkMatrix4x4 *	InternalMatrix

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

typedef vtkProp3D	Superclass

static int	IsTypeOf (const char *type)

static vtkProp3DFollower *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkProp3DFollower *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkProp3D
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Detailed Description

a vtkProp3D that always faces the camera

vtkProp3DFollower is a type of vtkProp3D that always faces the camera. More specifically it will not change its position or scale, but it will continually update its orientation so that it is right side up and facing the camera. This is typically used for complex billboards or props that need to face the viewer at all times.

Note: All of the transformations that can be made to a vtkProp3D will take effect with the follower. Thus, if you change the orientation of the follower by 90 degrees, then it will follow the camera, but be off by 90 degrees.

See also: vtkFollower vtkProp3D vtkCamera vtkProp3DAxisFollower

Tests:: vtkProp3DFollower (Tests)

Definition at line 46 of file vtkProp3DFollower.h.

Member Typedef Documentation

typedef vtkProp3D vtkProp3DFollower::Superclass

Standard VTK methods for type and printing.

Definition at line 54 of file vtkProp3DFollower.h.

Constructor & Destructor Documentation

vtkProp3DFollower::vtkProp3DFollower ( )

protected

vtkProp3DFollower::~vtkProp3DFollower ( )

protected

Member Function Documentation

static vtkProp3DFollower* vtkProp3DFollower::New ( )

static

Creates a follower with no camera set.

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

static

Standard VTK methods for type and printing.

virtual int vtkProp3DFollower::IsA ( const char * type )

virtual

Standard VTK methods for type and printing.

Reimplemented from vtkProp3D.

Reimplemented in vtkProp3DAxisFollower.

static vtkProp3DFollower* vtkProp3DFollower::SafeDownCast ( vtkObjectBase * o )

static

Standard VTK methods for type and printing.

virtual vtkObjectBase* vtkProp3DFollower::NewInstanceInternal ( ) const

protectedvirtual

Standard VTK methods for type and printing.

Reimplemented from vtkProp3D.

Reimplemented in vtkProp3DAxisFollower.

vtkProp3DFollower* vtkProp3DFollower::NewInstance ( ) const

Standard VTK methods for type and printing.

void vtkProp3DFollower::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Standard VTK methods for type and printing.

Reimplemented from vtkProp3D.

virtual void vtkProp3DFollower::SetProp3D ( vtkProp3D * prop )

virtual

Set/Get the vtkProp3D to control (i.e., face the camera).

virtual vtkProp3D* vtkProp3DFollower::GetProp3D ( )

virtual

Set/Get the vtkProp3D to control (i.e., face the camera).

virtual void vtkProp3DFollower::SetCamera ( vtkCamera * )

virtual

Set/Get the camera to follow. If this is not set, then the follower won't know what to follow and will act like a normal vtkProp3D.

virtual vtkCamera* vtkProp3DFollower::GetCamera ( )

virtual

Set/Get the camera to follow. If this is not set, then the follower won't know what to follow and will act like a normal vtkProp3D.

virtual int vtkProp3DFollower::RenderOpaqueGeometry ( vtkViewport * viewport )

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.

Reimplemented from vtkProp.

Reimplemented in vtkProp3DAxisFollower.

virtual int vtkProp3DFollower::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport )

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.

Reimplemented from vtkProp.

Reimplemented in vtkProp3DAxisFollower.

virtual int vtkProp3DFollower::RenderVolumetricGeometry ( vtkViewport * viewport )

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.

Reimplemented from vtkProp.

Reimplemented in vtkProp3DAxisFollower.

virtual int vtkProp3DFollower::HasTranslucentPolygonalGeometry ( )

virtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

virtual void vtkProp3DFollower::ReleaseGraphicsResources ( vtkWindow * )

virtual

Release any graphics resources associated with this vtkProp3DFollower.

Reimplemented from vtkProp.

virtual void vtkProp3DFollower::ComputeMatrix ( )

virtual

Generate the matrix based on ivars. This method overloads its superclasses ComputeMatrix() method due to the special vtkProp3DFollower matrix operations.

Reimplemented from vtkProp3D.

Reimplemented in vtkProp3DAxisFollower.

void vtkProp3DFollower::ShallowCopy ( vtkProp * prop )

virtual

Shallow copy of a follower. Overloads the virtual vtkProp method.

Reimplemented from vtkProp3D.

virtual double* vtkProp3DFollower::GetBounds ( )

virtual

Return the bounds of this vtkProp3D.

Implements vtkProp3D.

void vtkProp3DFollower::InitPathTraversal ( )

virtual

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

Reimplemented from vtkProp3D.

virtual vtkAssemblyPath* vtkProp3DFollower::GetNextPath ( )

virtual

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

Reimplemented from vtkProp.

Member Data Documentation

vtkCamera* vtkProp3DFollower::Camera

protected

Definition at line 109 of file vtkProp3DFollower.h.

vtkProp3D* vtkProp3DFollower::Device

protected

Definition at line 110 of file vtkProp3DFollower.h.

vtkMatrix4x4* vtkProp3DFollower::InternalMatrix

protected

Definition at line 113 of file vtkProp3DFollower.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/vtkProp3DFollower.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation