annotate the render window with scale and distance information More...
#include <vtkLegendScaleActor.h>
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.
Definition at line 55 of file vtkLegendScaleActor.h.
Member Typedef Documentation
Standard methods for the class.
Reimplemented from vtkProp.
Definition at line 63 of file vtkLegendScaleActor.h.
Member Enumeration Documentation
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.
Reimplemented from vtkObject.
| 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 | ( | vtkObjectBase * | o | ) | [static] |
Standard methods for the class.
Reimplemented from vtkProp.
| virtual vtkObjectBase* vtkLegendScaleActor::NewInstanceInternal | ( | ) | const [protected, virtual] |
Standard methods for the class.
Reimplemented from vtkProp.
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 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] |
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.
Convenience method that turns all the axes and the legend scale.
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
int vtkLegendScaleActor::LabelMode [protected] |
Definition at line 192 of file vtkLegendScaleActor.h.
int vtkLegendScaleActor::RightBorderOffset [protected] |
Definition at line 193 of file vtkLegendScaleActor.h.
int vtkLegendScaleActor::TopBorderOffset [protected] |
Definition at line 194 of file vtkLegendScaleActor.h.
int vtkLegendScaleActor::LeftBorderOffset [protected] |
Definition at line 195 of file vtkLegendScaleActor.h.
int vtkLegendScaleActor::BottomBorderOffset [protected] |
Definition at line 196 of file vtkLegendScaleActor.h.
double vtkLegendScaleActor::CornerOffsetFactor [protected] |
Definition at line 197 of file vtkLegendScaleActor.h.
vtkAxisActor2D* vtkLegendScaleActor::RightAxis [protected] |
Definition at line 200 of file vtkLegendScaleActor.h.
vtkAxisActor2D* vtkLegendScaleActor::TopAxis [protected] |
Definition at line 201 of file vtkLegendScaleActor.h.
vtkAxisActor2D* vtkLegendScaleActor::LeftAxis [protected] |
Definition at line 202 of file vtkLegendScaleActor.h.
vtkAxisActor2D* vtkLegendScaleActor::BottomAxis [protected] |
Definition at line 203 of file vtkLegendScaleActor.h.
int vtkLegendScaleActor::RightAxisVisibility [protected] |
Definition at line 206 of file vtkLegendScaleActor.h.
int vtkLegendScaleActor::TopAxisVisibility [protected] |
Definition at line 207 of file vtkLegendScaleActor.h.
int vtkLegendScaleActor::LeftAxisVisibility [protected] |
Definition at line 208 of file vtkLegendScaleActor.h.
int vtkLegendScaleActor::BottomAxisVisibility [protected] |
Definition at line 209 of file vtkLegendScaleActor.h.
int vtkLegendScaleActor::LegendVisibility [protected] |
Definition at line 212 of file vtkLegendScaleActor.h.
vtkPolyData* vtkLegendScaleActor::Legend [protected] |
Definition at line 213 of file vtkLegendScaleActor.h.
vtkPoints* vtkLegendScaleActor::LegendPoints [protected] |
Definition at line 214 of file vtkLegendScaleActor.h.
vtkPolyDataMapper2D* vtkLegendScaleActor::LegendMapper [protected] |
Definition at line 215 of file vtkLegendScaleActor.h.
vtkActor2D* vtkLegendScaleActor::LegendActor [protected] |
Definition at line 216 of file vtkLegendScaleActor.h.
vtkTextMapper* vtkLegendScaleActor::LabelMappers[6] [protected] |
Definition at line 217 of file vtkLegendScaleActor.h.
vtkActor2D* vtkLegendScaleActor::LabelActors[6] [protected] |
Definition at line 218 of file vtkLegendScaleActor.h.
vtkTextProperty* vtkLegendScaleActor::LegendTitleProperty [protected] |
Definition at line 219 of file vtkLegendScaleActor.h.
vtkTextProperty* vtkLegendScaleActor::LegendLabelProperty [protected] |
Definition at line 220 of file vtkLegendScaleActor.h.
vtkCoordinate* vtkLegendScaleActor::Coordinate [protected] |
Definition at line 221 of file vtkLegendScaleActor.h.
vtkTimeStamp vtkLegendScaleActor::BuildTime [protected] |
Definition at line 223 of file vtkLegendScaleActor.h.
The documentation for this class was generated from the following file:
- dox/Rendering/Annotation/vtkLegendScaleActor.h
