a subclass of vtkProp3DFollower that ensures that data is always parallel to the axis defined by a vtkAxisActor. More...

#include <vtkProp3DAxisFollower.h>

Inheritance diagram for vtkProp3DAxisFollower:

[legend]

Collaboration diagram for vtkProp3DAxisFollower:

[legend]

Public Member Functions
virtual void	ComputeMatrix ()

void	ShallowCopy (vtkProp *prop)

virtual void	SetViewport (vtkViewport *viewport)

virtual vtkViewport *	GetViewport ()


virtual void	SetAxis (vtkAxisActor *)

virtual vtkAxisActor *	GetAxis ()


virtual void	SetAutoCenter (int)

virtual int	GetAutoCenter ()

virtual void	AutoCenterOn ()

virtual void	AutoCenterOff ()


virtual void	SetEnableDistanceLOD (int)

virtual int	GetEnableDistanceLOD ()


virtual void	SetDistanceLODThreshold (double)

virtual double	GetDistanceLODThreshold ()


virtual void	SetEnableViewAngleLOD (int)

virtual int	GetEnableViewAngleLOD ()


virtual void	SetViewAngleLODThreshold (double)

virtual double	GetViewAngleLODThreshold ()


virtual void	SetScreenOffset (double)

virtual double	GetScreenOffset ()


virtual int	RenderOpaqueGeometry (vtkViewport *viewport)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)

virtual int	RenderVolumetricGeometry (vtkViewport *viewport)

Public Member Functions inherited from vtkProp3DFollower
virtual int	HasTranslucentPolygonalGeometry ()

virtual void	ReleaseGraphicsResources (vtkWindow *)

void	ShallowCopy (vtkProp *prop)

virtual double *	GetBounds ()

virtual void	SetProp3D (vtkProp3D *prop)

virtual vtkProp3D *	GetProp3D ()

virtual void	SetCamera (vtkCamera *)

virtual vtkCamera *	GetCamera ()

void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

vtkProp3DFollower *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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 vtkProp3DAxisFollower *	New ()


static double	AutoScale (vtkViewport viewport, vtkCamera camera, double screenSize, double position[3])

Static Public Member Functions inherited from vtkProp3DFollower
static vtkProp3DFollower *	New ()

static int	IsTypeOf (const char *type)

static vtkProp3DFollower *	SafeDownCast (vtkObjectBase *o)

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
	vtkProp3DAxisFollower ()

	~vtkProp3DAxisFollower ()

void	CalculateOrthogonalVectors (double Rx[3], double Ry[3], double Rz[3], vtkAxisActor axis1, double dop, vtkViewport *ren)

void	ComputeRotationAndTranlation (vtkViewport ren, double translation[3], double Rx[3], double Ry[3], double Rz[3], vtkAxisActor axis)

void	ComputerAutoCenterTranslation (const double &autoScaleFactor, double translation[3])

int	TestDistanceVisibility ()

void	ExecuteViewAngleVisibility (double normal[3])

bool	IsTextUpsideDown (double a, double b)

Protected Member Functions inherited from vtkProp3DFollower
	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
int	AutoCenter

int	EnableDistanceLOD

double	DistanceLODThreshold

int	EnableViewAngleLOD

double	ViewAngleLODThreshold

double	ScreenOffset

vtkWeakPointer< vtkAxisActor >	Axis

vtkWeakPointer< vtkViewport >	Viewport

Protected Attributes inherited from vtkProp3DFollower
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 vtkProp3DFollower	Superclass

static int	IsTypeOf (const char *type)

static vtkProp3DAxisFollower *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkProp3DAxisFollower *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkProp3DFollower
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

Detailed Description

a subclass of vtkProp3DFollower that ensures that data is always parallel to the axis defined by a vtkAxisActor.

vtkProp3DAxisFollower is a subclass of vtkProp3DFollower that always follows its specified axis. More specifically it will not change its position or scale, but it will continually update its orientation so that it is aligned with the axis and facing at angle to the camera to provide maximum visibilty. This is typically used for text labels for 3d plots.

See also: vtkFollower vtkAxisFollower vtkProp3DFollower

Definition at line 38 of file vtkProp3DAxisFollower.h.

Member Typedef Documentation

typedef vtkProp3DFollower vtkProp3DAxisFollower::Superclass

Standard VTK methods for type and printing.

Definition at line 47 of file vtkProp3DAxisFollower.h.

Constructor & Destructor Documentation

vtkProp3DAxisFollower::vtkProp3DAxisFollower ( )

protected

vtkProp3DAxisFollower::~vtkProp3DAxisFollower ( )

protected

Member Function Documentation

static vtkProp3DAxisFollower* vtkProp3DAxisFollower::New ( )

static

Creates a follower with no camera set.

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

static

Standard VTK methods for type and printing.

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

virtual

Standard VTK methods for type and printing.

Reimplemented from vtkProp3DFollower.

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

static

Standard VTK methods for type and printing.

virtual vtkObjectBase* vtkProp3DAxisFollower::NewInstanceInternal ( ) const

protectedvirtual

Standard VTK methods for type and printing.

Reimplemented from vtkProp3DFollower.

vtkProp3DAxisFollower* vtkProp3DAxisFollower::NewInstance ( ) const

Standard VTK methods for type and printing.

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

virtual

Standard VTK methods for type and printing.

Reimplemented from vtkObject.

virtual void vtkProp3DAxisFollower::SetAxis ( vtkAxisActor * )

virtual

Set axis that needs to be followed.

virtual vtkAxisActor* vtkProp3DAxisFollower::GetAxis ( )

virtual

Set axis that needs to be followed.

virtual void vtkProp3DAxisFollower::SetAutoCenter ( int )

virtual

Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds.

virtual int vtkProp3DAxisFollower::GetAutoCenter ( )

virtual

Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds.

virtual void vtkProp3DAxisFollower::AutoCenterOn ( )

virtual

Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds.

virtual void vtkProp3DAxisFollower::AutoCenterOff ( )

virtual

Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds.

virtual void vtkProp3DAxisFollower::SetEnableDistanceLOD ( int )

virtual

Enable / disable use of distance based LOD. If enabled the actor will not be visible at a certain distance from the camera. Default is false.

virtual int vtkProp3DAxisFollower::GetEnableDistanceLOD ( )

virtual

Enable / disable use of distance based LOD. If enabled the actor will not be visible at a certain distance from the camera. Default is false.

virtual void vtkProp3DAxisFollower::SetDistanceLODThreshold ( double )

virtual

Set distance LOD threshold (0.0 - 1.0).This determines at what fraction of camera far clip range, actor is not visible. Default is 0.80.

virtual double vtkProp3DAxisFollower::GetDistanceLODThreshold ( )

virtual

Set distance LOD threshold (0.0 - 1.0).This determines at what fraction of camera far clip range, actor is not visible. Default is 0.80.

virtual void vtkProp3DAxisFollower::SetEnableViewAngleLOD ( int )

virtual

Enable / disable use of view angle based LOD. If enabled the actor will not be visible at a certain view angle. Default is true.

virtual int vtkProp3DAxisFollower::GetEnableViewAngleLOD ( )

virtual

Enable / disable use of view angle based LOD. If enabled the actor will not be visible at a certain view angle. Default is true.

virtual void vtkProp3DAxisFollower::SetViewAngleLODThreshold ( double )

virtual

Set view angle LOD threshold (0.0 - 1.0).This determines at what view angle to geometry will make the geometry not visibile. Default is 0.34.

virtual double vtkProp3DAxisFollower::GetViewAngleLODThreshold ( )

virtual

Set view angle LOD threshold (0.0 - 1.0).This determines at what view angle to geometry will make the geometry not visibile. Default is 0.34.

virtual void vtkProp3DAxisFollower::SetScreenOffset ( double )

virtual

Set/Get the desired screen offset from the axis.

virtual double vtkProp3DAxisFollower::GetScreenOffset ( )

virtual

Set/Get the desired screen offset from the axis.

virtual void vtkProp3DAxisFollower::ComputeMatrix ( )

virtual

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

Reimplemented from vtkProp3DFollower.

void vtkProp3DAxisFollower::ShallowCopy ( vtkProp * prop )

virtual

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

Reimplemented from vtkProp.

static double vtkProp3DAxisFollower::AutoScale	(	vtkViewport *	viewport,
		vtkCamera *	camera,
		double	screenSize,
		double	position[3]
	)

static

Calculate scale factor to maintain same size of a object on the screen.

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

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

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

virtual void vtkProp3DAxisFollower::SetViewport ( vtkViewport * viewport )

virtual

virtual vtkViewport* vtkProp3DAxisFollower::GetViewport ( )

virtual

void vtkProp3DAxisFollower::CalculateOrthogonalVectors	(	double	Rx[3],
		double	Ry[3],
		double	Rz[3],
		vtkAxisActor *	axis1,
		double *	dop,
		vtkViewport *	ren
	)

protected

void vtkProp3DAxisFollower::ComputeRotationAndTranlation	(	vtkViewport *	ren,
		double	translation[3],
		double	Rx[3],
		double	Ry[3],
		double	Rz[3],
		vtkAxisActor *	axis
	)

protected

void vtkProp3DAxisFollower::ComputerAutoCenterTranslation	(	const double &	autoScaleFactor,
		double	translation[3]
	)

protected

int vtkProp3DAxisFollower::TestDistanceVisibility ( )

protected

void vtkProp3DAxisFollower::ExecuteViewAngleVisibility ( double normal[3] )

protected

bool vtkProp3DAxisFollower::IsTextUpsideDown	(	double *	a,
		double *	b
	)

protected

Member Data Documentation

int vtkProp3DAxisFollower::AutoCenter

protected

Definition at line 153 of file vtkProp3DAxisFollower.h.

int vtkProp3DAxisFollower::EnableDistanceLOD

protected

Definition at line 155 of file vtkProp3DAxisFollower.h.

double vtkProp3DAxisFollower::DistanceLODThreshold

protected

Definition at line 156 of file vtkProp3DAxisFollower.h.

int vtkProp3DAxisFollower::EnableViewAngleLOD

protected

Definition at line 158 of file vtkProp3DAxisFollower.h.

double vtkProp3DAxisFollower::ViewAngleLODThreshold

protected

Definition at line 159 of file vtkProp3DAxisFollower.h.

double vtkProp3DAxisFollower::ScreenOffset

protected

Definition at line 161 of file vtkProp3DAxisFollower.h.

vtkWeakPointer<vtkAxisActor> vtkProp3DAxisFollower::Axis

protected

Definition at line 163 of file vtkProp3DAxisFollower.h.

vtkWeakPointer<vtkViewport> vtkProp3DAxisFollower::Viewport

protected

Definition at line 164 of file vtkProp3DAxisFollower.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/Annotation/vtkProp3DAxisFollower.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