annotate the render window with scale and distance information More...

#include <vtkLegendScaleActor.h>

Inheritance diagram for vtkLegendScaleActor:

Collaboration diagram for vtkLegendScaleActor:

Public Types
enum	AttributeLocation { DISTANCE =0, XY_COORDINATES =1 }

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions

virtual void	SetLabelMode (int)

virtual int	GetLabelMode ()

void	SetLabelModeToDistance ()

void	SetLabelModeToXYCoordinates ()


virtual void	SetRightAxisVisibility (int)

virtual int	GetRightAxisVisibility ()

virtual void	RightAxisVisibilityOn ()

virtual void	RightAxisVisibilityOff ()

virtual void	SetTopAxisVisibility (int)

virtual int	GetTopAxisVisibility ()

virtual void	TopAxisVisibilityOn ()

virtual void	TopAxisVisibilityOff ()

virtual void	SetLeftAxisVisibility (int)

virtual int	GetLeftAxisVisibility ()

virtual void	LeftAxisVisibilityOn ()

virtual void	LeftAxisVisibilityOff ()

virtual void	SetBottomAxisVisibility (int)

virtual int	GetBottomAxisVisibility ()

virtual void	BottomAxisVisibilityOn ()

virtual void	BottomAxisVisibilityOff ()


virtual void	SetLegendVisibility (int)

virtual int	GetLegendVisibility ()

virtual void	LegendVisibilityOn ()

virtual void	LegendVisibilityOff ()


void	AllAxesOn ()

void	AllAxesOff ()


void	AllAnnotationsOn ()

void	AllAnnotationsOff ()


virtual void	SetRightBorderOffset (int)

virtual int	GetRightBorderOffset ()


virtual void	SetTopBorderOffset (int)

virtual int	GetTopBorderOffset ()


virtual void	SetLeftBorderOffset (int)

virtual int	GetLeftBorderOffset ()


virtual void	SetBottomBorderOffset (int)

virtual int	GetBottomBorderOffset ()


virtual void	SetCornerOffsetFactor (double)

virtual double	GetCornerOffsetFactor ()


virtual vtkTextProperty *	GetLegendTitleProperty ()

virtual vtkTextProperty *	GetLegendLabelProperty ()


virtual vtkAxisActor2D *	GetRightAxis ()

virtual vtkAxisActor2D *	GetTopAxis ()

virtual vtkAxisActor2D *	GetLeftAxis ()

virtual vtkAxisActor2D *	GetBottomAxis ()


virtual void	BuildRepresentation (vtkViewport *viewport)

virtual void	GetActors2D (vtkPropCollection *)

virtual void	ReleaseGraphicsResources (vtkWindow *)

virtual int	RenderOverlay (vtkViewport *)

virtual int	RenderOpaqueGeometry (vtkViewport *)

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

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Pick ()

virtual void	ShallowCopy (vtkProp *prop)

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors (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 double *	GetBounds ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (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 int	HasTranslucentPolygonalGeometry ()

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

virtual unsigned long	GetMTime ()

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

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

	~vtkLegendScaleActor ()

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	LabelMode

int	RightBorderOffset

int	TopBorderOffset

int	LeftBorderOffset

int	BottomBorderOffset

double	CornerOffsetFactor

vtkAxisActor2D *	RightAxis

vtkAxisActor2D *	TopAxis

vtkAxisActor2D *	LeftAxis

vtkAxisActor2D *	BottomAxis

int	RightAxisVisibility

int	TopAxisVisibility

int	LeftAxisVisibility

int	BottomAxisVisibility

int	LegendVisibility

vtkPolyData *	Legend

vtkPoints *	LegendPoints

vtkPolyDataMapper2D *	LegendMapper

vtkActor2D *	LegendActor

vtkTextMapper *	LabelMappers [6]

vtkActor2D *	LabelActors [6]

vtkTextProperty *	LegendTitleProperty

vtkTextProperty *	LegendLabelProperty

vtkCoordinate *	Coordinate

vtkTimeStamp	BuildTime

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 vtkProp	Superclass

static int	IsTypeOf (const char *type)

static vtkLegendScaleActor *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkLegendScaleActor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

annotate the render window with scale and distance information

This class is used to annotate the render window. Its basic goal is to provide an indication of the scale of the scene. Four axes surrounding the render window indicate (in a variety of ways) the scale of what the camera is viewing. An option also exists for displaying a scale legend.

The axes can be programmed either to display distance scales or x-y coordinate values. By default, the scales display a distance. However, if you know that the view is down the z-axis, the scales can be programmed to display x-y coordinate values.

Warning: Please be aware that the axes and scale values are subject to perspective effects. The distances are computed in the focal plane of the camera. When there are large view angles (i.e., perspective projection), the computed distances may provide users the wrong sense of scale. These effects are not present when parallel projection is enabled.

Tests:: vtkLegendScaleActor (Tests)

Definition at line 55 of file vtkLegendScaleActor.h.

Member Typedef Documentation

typedef vtkProp vtkLegendScaleActor::Superclass

Standard methods for the class.

Definition at line 63 of file vtkLegendScaleActor.h.

Member Enumeration Documentation

enum vtkLegendScaleActor::AttributeLocation

Enumerator
DISTANCE
XY_COORDINATES

Definition at line 68 of file vtkLegendScaleActor.h.

Constructor & Destructor Documentation

vtkLegendScaleActor::vtkLegendScaleActor ( )

protected

vtkLegendScaleActor::~vtkLegendScaleActor ( )

protected

Member Function Documentation

static vtkLegendScaleActor* vtkLegendScaleActor::New ( )

static

Instantiate the class.

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

static

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkProp.

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

static

Standard methods for the class.

virtual vtkObjectBase* vtkLegendScaleActor::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkProp.

vtkLegendScaleActor* vtkLegendScaleActor::NewInstance ( ) const

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkObject.

virtual void vtkLegendScaleActor::SetLabelMode ( int )

virtual

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

virtual int vtkLegendScaleActor::GetLabelMode ( )

virtual

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

void vtkLegendScaleActor::SetLabelModeToDistance ( )

inline

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

Definition at line 82 of file vtkLegendScaleActor.h.

void vtkLegendScaleActor::SetLabelModeToXYCoordinates ( )

inline

Specify the mode for labeling the scale axes. By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

Definition at line 83 of file vtkLegendScaleActor.h.

virtual void vtkLegendScaleActor::SetRightAxisVisibility ( int )

virtual