vtkLegendScaleActor Class Reference

#include <vtkLegendScaleActor.h>

Inheritance diagram for vtkLegendScaleActor:

[legend]

Collaboration diagram for vtkLegendScaleActor:

[legend]

List of all members.

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 54 of file vtkLegendScaleActor.h.


typedef vtkProp	Superclass
static int	IsTypeOf (const char *type)
static vtkLegendScaleActor *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Public Types
enum	AttributeLocation { DISTANCE = 0, XY_COORDINATES = 1 }
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 *)
Static Public Member Functions
static vtkLegendScaleActor *	New ()
Protected Member Functions
	vtkLegendScaleActor ()
	~vtkLegendScaleActor ()
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

Member Typedef Documentation

typedef vtkProp vtkLegendScaleActor::Superclass

Standard methods for the class.

Reimplemented from vtkProp.

Definition at line 62 of file vtkLegendScaleActor.h.

Member Enumeration Documentation

enum vtkLegendScaleActor::AttributeLocation

Enumerator:

DISTANCE
XY_COORDINATES

Definition at line 67 of file vtkLegendScaleActor.h.

Constructor & Destructor Documentation

vtkLegendScaleActor::vtkLegendScaleActor ( ) [protected]

vtkLegendScaleActor::~vtkLegendScaleActor ( ) [protected]

Member Function Documentation

static vtkLegendScaleActor* vtkLegendScaleActor::New ( ) [static]

Instantiate the class.

Reimplemented from vtkObject.

virtual const char* vtkLegendScaleActor::GetClassName ( ) [virtual]

Standard methods for the class.

Reimplemented from vtkProp.

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

Standard methods for the class.

Reimplemented from vtkProp.

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

Standard methods for the class.

Reimplemented from vtkProp.

static vtkLegendScaleActor* vtkLegendScaleActor::SafeDownCast ( vtkObject * o ) [static]

Standard methods for the class.

Reimplemented from vtkProp.

void vtkLegendScaleActor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Standard methods for the class.

Reimplemented from vtkProp.

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 81 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 82 of file vtkLegendScaleActor.h.

virtual void vtkLegendScaleActor::SetRightAxisVisibility ( int ) [virtual]