vtkLegendScaleActor Class Reference

#include <vtkLegendScaleActor.h>

Inheritance diagram for vtkLegendScaleActor:

Inheritance graph
[legend]
Collaboration diagram for vtkLegendScaleActor:

Collaboration graph
[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 vtkLegendScaleActorSafeDownCast (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 vtkTextPropertyGetLegendTitleProperty ()
virtual vtkTextPropertyGetLegendLabelProperty ()
virtual vtkAxisActor2DGetRightAxis ()
virtual vtkAxisActor2DGetTopAxis ()
virtual vtkAxisActor2DGetLeftAxis ()
virtual vtkAxisActor2DGetBottomAxis ()
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 vtkLegendScaleActorNew ()

Protected Member Functions

 vtkLegendScaleActor ()
 ~vtkLegendScaleActor ()

Protected Attributes

int LabelMode
int RightBorderOffset
int TopBorderOffset
int LeftBorderOffset
int BottomBorderOffset
double CornerOffsetFactor
vtkAxisActor2DRightAxis
vtkAxisActor2DTopAxis
vtkAxisActor2DLeftAxis
vtkAxisActor2DBottomAxis
int RightAxisVisibility
int TopAxisVisibility
int LeftAxisVisibility
int BottomAxisVisibility
int LegendVisibility
vtkPolyDataLegend
vtkPointsLegendPoints
vtkPolyDataMapper2DLegendMapper
vtkActor2DLegendActor
vtkTextMapperLabelMappers [6]
vtkActor2DLabelActors [6]
vtkTextPropertyLegendTitleProperty
vtkTextPropertyLegendLabelProperty
vtkCoordinateCoordinate
vtkTimeStamp BuildTime

Member Typedef Documentation

Standard methods for the class.

Reimplemented from vtkProp.

Definition at line 62 of file vtkLegendScaleActor.h.


Member Enumeration Documentation

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]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual int vtkLegendScaleActor::GetRightAxisVisibility (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void vtkLegendScaleActor::RightAxisVisibilityOn (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void vtkLegendScaleActor::RightAxisVisibilityOff (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

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

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual int vtkLegendScaleActor::GetTopAxisVisibility (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void vtkLegendScaleActor::TopAxisVisibilityOn (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void vtkLegendScaleActor::TopAxisVisibilityOff (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

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

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual int vtkLegendScaleActor::GetLeftAxisVisibility (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void vtkLegendScaleActor::LeftAxisVisibilityOn (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void vtkLegendScaleActor::LeftAxisVisibilityOff (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

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

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual int vtkLegendScaleActor::GetBottomAxisVisibility (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void vtkLegendScaleActor::BottomAxisVisibilityOn (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

virtual void vtkLegendScaleActor::BottomAxisVisibilityOff (  )  [virtual]

Set/Get the flags that control which of the four axes to display (top, bottom, left and right). By default, all the axes are displayed.

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

Indicate whether the legend scale should be displayed or not. The default is On.

virtual int vtkLegendScaleActor::GetLegendVisibility (  )  [virtual]

Indicate whether the legend scale should be displayed or not. The default is On.

virtual void vtkLegendScaleActor::LegendVisibilityOn (  )  [virtual]

Indicate whether the legend scale should be displayed or not. The default is On.

virtual void vtkLegendScaleActor::LegendVisibilityOff (  )  [virtual]

Indicate whether the legend scale should be displayed or not. The default is On.

void vtkLegendScaleActor::AllAxesOn (  ) 

Convenience method that turns all the axes either on or off.

void vtkLegendScaleActor::AllAxesOff (  ) 

Convenience method that turns all the axes either on or off.

void vtkLegendScaleActor::AllAnnotationsOn (  ) 

Convenience method that turns all the axes and the legend scale.

void vtkLegendScaleActor::AllAnnotationsOff (  ) 

Convenience method that turns all the axes and the legend scale.

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

Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

virtual int vtkLegendScaleActor::GetRightBorderOffset (  )  [virtual]

Set/Get the offset of the right axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

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

Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

virtual int vtkLegendScaleActor::GetTopBorderOffset (  )  [virtual]

Set/Get the offset of the top axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

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

Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

virtual int vtkLegendScaleActor::GetLeftBorderOffset (  )  [virtual]

Set/Get the offset of the left axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

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

Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

virtual int vtkLegendScaleActor::GetBottomBorderOffset (  )  [virtual]

Set/Get the offset of the bottom axis from the border. This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

virtual void vtkLegendScaleActor::SetCornerOffsetFactor ( double   )  [virtual]

Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.

virtual double vtkLegendScaleActor::GetCornerOffsetFactor (  )  [virtual]

Get/Set the corner offset. This is the offset factor used to offset the axes at the corners. Default value is 2.0.

virtual vtkTextProperty* vtkLegendScaleActor::GetLegendTitleProperty (  )  [virtual]

Set/Get the labels text properties for the legend title and labels.

virtual vtkTextProperty* vtkLegendScaleActor::GetLegendLabelProperty (  )  [virtual]

Set/Get the labels text properties for the legend title and labels.

virtual vtkAxisActor2D* vtkLegendScaleActor::GetRightAxis (  )  [virtual]

These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.

virtual vtkAxisActor2D* vtkLegendScaleActor::GetTopAxis (  )  [virtual]

These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.

virtual vtkAxisActor2D* vtkLegendScaleActor::GetLeftAxis (  )  [virtual]

These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.

virtual vtkAxisActor2D* vtkLegendScaleActor::GetBottomAxis (  )  [virtual]

These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. Users may retrieve and then modify these axes to control their appearance.

virtual void vtkLegendScaleActor::BuildRepresentation ( vtkViewport viewport  )  [virtual]

Standard methods supporting the rendering process.

virtual void vtkLegendScaleActor::GetActors2D ( vtkPropCollection  )  [virtual]

Standard methods supporting the rendering process.

Reimplemented from vtkProp.

virtual void vtkLegendScaleActor::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

Standard methods supporting the rendering process.

Reimplemented from vtkProp.

virtual int vtkLegendScaleActor::RenderOverlay ( vtkViewport  )  [virtual]

Standard methods supporting the rendering process.

Reimplemented from vtkProp.

virtual int vtkLegendScaleActor::RenderOpaqueGeometry ( vtkViewport  )  [virtual]

Standard methods supporting the rendering process.

Reimplemented from vtkProp.


Member Data Documentation

Definition at line 191 of file vtkLegendScaleActor.h.

Definition at line 192 of file vtkLegendScaleActor.h.

Definition at line 193 of file vtkLegendScaleActor.h.

Definition at line 194 of file vtkLegendScaleActor.h.

Definition at line 195 of file vtkLegendScaleActor.h.

Definition at line 196 of file vtkLegendScaleActor.h.

Definition at line 199 of file vtkLegendScaleActor.h.

Definition at line 200 of file vtkLegendScaleActor.h.

Definition at line 201 of file vtkLegendScaleActor.h.

Definition at line 202 of file vtkLegendScaleActor.h.

Definition at line 205 of file vtkLegendScaleActor.h.

Definition at line 206 of file vtkLegendScaleActor.h.

Definition at line 207 of file vtkLegendScaleActor.h.

Definition at line 208 of file vtkLegendScaleActor.h.

Definition at line 211 of file vtkLegendScaleActor.h.

Definition at line 212 of file vtkLegendScaleActor.h.

Definition at line 213 of file vtkLegendScaleActor.h.

Definition at line 214 of file vtkLegendScaleActor.h.

Definition at line 215 of file vtkLegendScaleActor.h.

Definition at line 216 of file vtkLegendScaleActor.h.

Definition at line 217 of file vtkLegendScaleActor.h.

Definition at line 218 of file vtkLegendScaleActor.h.

Definition at line 219 of file vtkLegendScaleActor.h.

Definition at line 220 of file vtkLegendScaleActor.h.

Definition at line 222 of file vtkLegendScaleActor.h.


The documentation for this class was generated from the following file:

Generated on Mon Sep 27 18:32:24 2010 for VTK by  doxygen 1.5.6