|
VTK
|
annotate the render window with scale and distance information More...
#include <vtkLegendScaleActor.h>
Public Types | |
| enum | AttributeLocation { DISTANCE =0, XY_COORDINATES =1 } |
| 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) |
| vtkLegendScaleActor * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| 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 | 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 | Pick () |
| 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 | ShallowCopy (vtkProp *prop) |
| 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 bool | HasKeys (vtkInformation *requiredKeys) |
| 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 void | BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path) |
| 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 | PrintHeader (ostream &os, vtkIndent indent) |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| virtual void | Register (vtkObjectBase *o) |
| virtual void | UnRegister (vtkObjectBase *o) |
| int | GetReferenceCount () |
| void | SetReferenceCount (int) |
| void | PrintRevisions (ostream &) |
Static Public Member Functions | |
| static vtkLegendScaleActor * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkLegendScaleActor * | 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 |
| 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 &) |
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.
Definition at line 55 of file vtkLegendScaleActor.h.
Standard methods for the class.
Definition at line 63 of file vtkLegendScaleActor.h.
| Enumerator | |
|---|---|
| DISTANCE | |
| XY_COORDINATES | |
Definition at line 68 of file vtkLegendScaleActor.h.
|
protected |
|
protected |
|
static |
Instantiate the class.
|
static |
|
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 vtkProp.
|
static |
|
protectedvirtual |
Reimplemented from vtkProp.
| vtkLegendScaleActor* vtkLegendScaleActor::NewInstance | ( | ) | const |
|
virtual |
|
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 |
|
inline |
Definition at line 82 of file vtkLegendScaleActor.h.
|
inline |
Definition at line 83 of file vtkLegendScaleActor.h.
|
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 |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Indicate whether the legend scale should be displayed or not. The default is On.
|
virtual |
|
virtual |
|
virtual |
| void vtkLegendScaleActor::AllAxesOn | ( | ) |
Convenience method that turns all the axes either on or off.
| void vtkLegendScaleActor::AllAxesOff | ( | ) |
| void vtkLegendScaleActor::AllAnnotationsOn | ( | ) |
Convenience method that turns all the axes and the legend scale.
| void vtkLegendScaleActor::AllAnnotationsOff | ( | ) |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
virtual |
Set/Get the labels text properties for the legend title and labels.
|
virtual |
|
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 |
|
virtual |
|
virtual |
|
virtual |
Standard methods supporting the rendering process.
|
virtual |
Reimplemented from vtkProp.
|
virtual |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.
Reimplemented from vtkProp.
|
virtual |
Reimplemented from vtkProp.
|
virtual |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. There are four key render methods in vtk and they correspond to four different points in the rendering cycle. Any given prop may implement one or more of these methods. The first method is intended for rendering all opaque geometry. The second method is intended for rendering all translucent polygonal geometry. The third one is intended for rendering all translucent volumetric geometry. Most of the volume rendering mappers draw their results during this third method. The last method is to render any 2D annotation or overlays. Each of these methods return an integer value indicating whether or not this render method was applied to this data.
Reimplemented from vtkProp.
|
protected |
Definition at line 192 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 193 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 194 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 195 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 196 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 197 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 200 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 201 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 202 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 203 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 206 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 207 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 208 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 209 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 212 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 213 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 214 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 215 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 216 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 217 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 218 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 219 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 220 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 221 of file vtkLegendScaleActor.h.
|
protected |
Definition at line 223 of file vtkLegendScaleActor.h.