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

#include <vtkAxisFollower.h>

Inheritance diagram for vtkAxisFollower:

Collaboration diagram for vtkAxisFollower:

Public Types
typedef vtkFollower	Superclass

Public Types inherited from vtkFollower
typedef vtkActor	Superclass

Public Types inherited from vtkActor
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)

vtkAxisFollower *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	ComputeTransformMatrix (vtkRenderer *ren)

void	ShallowCopy (vtkProp *prop)


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 void	Render (vtkRenderer *ren)

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

void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	HasTranslucentPolygonalGeometry ()

virtual void	ReleaseGraphicsResources (vtkWindow *)

virtual void	ComputeMatrix ()

void	ShallowCopy (vtkProp *prop)

virtual void	SetCamera (vtkCamera *)

virtual vtkCamera *	GetCamera ()

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

virtual void	GetActors (vtkPropCollection *)

virtual vtkProperty *	MakeProperty ()

virtual void	SetMapper (vtkMapper *)

virtual void	ApplyProperties ()

unsigned long int	GetMTime ()

virtual unsigned long	GetRedrawMTime ()

virtual bool	GetSupportsSelection ()

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	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 vtkAxisFollower *	SafeDownCast (vtkObjectBase *o)

static vtkAxisFollower *	New ()


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

Static Public Member Functions inherited from vtkFollower
static int	IsTypeOf (const char *type)

static vtkFollower *	SafeDownCast (vtkObjectBase *o)

static vtkFollower *	New ()

Static Public Member Functions inherited from vtkActor
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

	vtkAxisFollower ()

	~vtkAxisFollower ()

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

void	ComputeRotationAndTranlation (vtkRenderer 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 vtkFollower
	vtkFollower ()

	~vtkFollower ()

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

int	EnableDistanceLOD

double	DistanceLODThreshold

int	EnableViewAngleLOD

double	ViewAngleLODThreshold

double	ScreenOffset

vtkWeakPointer< vtkAxisActor >	Axis

Protected Attributes inherited from vtkFollower
vtkCamera *	Camera

vtkActor *	Device

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

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

vtkAxisFollower is a subclass of vtkFollower 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 aliged 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: vtkActor vtkFollower vtkCamera vtkAxisActor vtkCubeAxesActor

Definition at line 40 of file vtkAxisFollower.h.

Member Typedef Documentation

typedef vtkFollower vtkAxisFollower::Superclass

Definition at line 43 of file vtkAxisFollower.h.

Constructor & Destructor Documentation

vtkAxisFollower::vtkAxisFollower ( )

protected

vtkAxisFollower::~vtkAxisFollower ( )

protected

Member Function Documentation

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

static

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

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

static

virtual vtkObjectBase* vtkAxisFollower::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkFollower.

vtkAxisFollower* vtkAxisFollower::NewInstance ( ) const

virtual void vtkAxisFollower::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.

static vtkAxisFollower* vtkAxisFollower::New ( )

static

Creates a follower with no camera set

virtual void vtkAxisFollower::SetAxis ( vtkAxisActor * )

virtual

Set axis that needs to be followed.

virtual vtkAxisActor* vtkAxisFollower::GetAxis ( )

virtual

Set axis that needs to be followed.

virtual void vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::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 vtkAxisFollower::SetScreenOffset ( double )

virtual

Set/Get the desired screen offset from the axis.

virtual double vtkAxisFollower::GetScreenOffset ( )

virtual

Set/Get the desired screen offset from the axis.

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

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

virtual void vtkAxisFollower::Render ( vtkRenderer * ren )

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

virtual void vtkAxisFollower::ComputeTransformMatrix ( vtkRenderer * ren )

virtual

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

void vtkAxisFollower::ShallowCopy ( vtkProp * prop )

virtual

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

Reimplemented from vtkProp.

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

static

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

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

protected

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

protected

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

protected

int vtkAxisFollower::TestDistanceVisibility ( )

protected

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

protected

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

protected

Member Data Documentation

int vtkAxisFollower::AutoCenter

protected

Definition at line 148 of file vtkAxisFollower.h.

int vtkAxisFollower::EnableDistanceLOD

protected

Definition at line 150 of file vtkAxisFollower.h.

double vtkAxisFollower::DistanceLODThreshold

protected

Definition at line 151 of file vtkAxisFollower.h.

int vtkAxisFollower::EnableViewAngleLOD

protected

Definition at line 153 of file vtkAxisFollower.h.

double vtkAxisFollower::ViewAngleLODThreshold

protected

Definition at line 154 of file vtkAxisFollower.h.

double vtkAxisFollower::ScreenOffset

protected

Definition at line 156 of file vtkAxisFollower.h.

vtkWeakPointer<vtkAxisActor> vtkAxisFollower::Axis

protected

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation