VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkLegendScaleActor Class Reference

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

#include <vtkLegendScaleActor.h>

Inheritance diagram for vtkLegendScaleActor:
[legend]
Collaboration diagram for vtkLegendScaleActor:
[legend]

Public Types

enum  AttributeLocation { DISTANCE =0, XY_COORDINATES =1 }
 
typedef vtkProp Superclass
 Standard methods for the class. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkLegendScaleActorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetLabelMode (int)
 Specify the mode for labeling the scale axes. More...
 
virtual int GetLabelMode ()
 
void SetLabelModeToDistance ()
 
void SetLabelModeToXYCoordinates ()
 
virtual void SetRightAxisVisibility (vtkTypeBool)
 Set/Get the flags that control which of the four axes to display (top, bottom, left and right). More...
 
virtual vtkTypeBool GetRightAxisVisibility ()
 
virtual void RightAxisVisibilityOn ()
 
virtual void RightAxisVisibilityOff ()
 
virtual void SetTopAxisVisibility (vtkTypeBool)
 
virtual vtkTypeBool GetTopAxisVisibility ()
 
virtual void TopAxisVisibilityOn ()
 
virtual void TopAxisVisibilityOff ()
 
virtual void SetLeftAxisVisibility (vtkTypeBool)
 
virtual vtkTypeBool GetLeftAxisVisibility ()
 
virtual void LeftAxisVisibilityOn ()
 
virtual void LeftAxisVisibilityOff ()
 
virtual void SetBottomAxisVisibility (vtkTypeBool)
 
virtual vtkTypeBool GetBottomAxisVisibility ()
 
virtual void BottomAxisVisibilityOn ()
 
virtual void BottomAxisVisibilityOff ()
 
virtual void SetLegendVisibility (vtkTypeBool)
 Indicate whether the legend scale should be displayed or not. More...
 
virtual vtkTypeBool GetLegendVisibility ()
 
virtual void LegendVisibilityOn ()
 
virtual void LegendVisibilityOff ()
 
void AllAxesOn ()
 Convenience method that turns all the axes either on or off. More...
 
void AllAxesOff ()
 
void AllAnnotationsOn ()
 Convenience method that turns all the axes and the legend scale. More...
 
void AllAnnotationsOff ()
 
virtual void SetRightBorderOffset (int)
 Set/Get the offset of the right axis from the border. More...
 
virtual int GetRightBorderOffset ()
 
virtual void SetTopBorderOffset (int)
 Set/Get the offset of the top axis from the border. More...
 
virtual int GetTopBorderOffset ()
 
virtual void SetLeftBorderOffset (int)
 Set/Get the offset of the left axis from the border. More...
 
virtual int GetLeftBorderOffset ()
 
virtual void SetBottomBorderOffset (int)
 Set/Get the offset of the bottom axis from the border. More...
 
virtual int GetBottomBorderOffset ()
 
virtual void SetCornerOffsetFactor (double)
 Get/Set the corner offset. More...
 
virtual double GetCornerOffsetFactor ()
 
virtual vtkTextPropertyGetLegendTitleProperty ()
 Set/Get the labels text properties for the legend title and labels. More...
 
virtual vtkTextPropertyGetLegendLabelProperty ()
 
virtual vtkAxisActor2DGetRightAxis ()
 These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation. More...
 
virtual vtkAxisActor2DGetTopAxis ()
 
virtual vtkAxisActor2DGetLeftAxis ()
 
virtual vtkAxisActor2DGetBottomAxis ()
 
virtual void BuildRepresentation (vtkViewport *viewport)
 Standard methods supporting the rendering process. More...
 
void GetActors2D (vtkPropCollection *) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
int RenderOverlay (vtkViewport *) override
 
int RenderOpaqueGeometry (vtkViewport *) override
 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. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual bool GetUseBounds ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual doubleGetBounds ()
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
virtual void ShallowCopy (vtkProp *prop)
 Shallow copy of this vtkProp. More...
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual vtkTypeBool HasTranslucentPolygonalGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...
 
virtual vtkTypeBool HasOpaqueGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. More...
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...
 
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkLegendScaleActorNew ()
 Instantiate the class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLegendScaleActorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLegendScaleActor ()
 
 ~vtkLegendScaleActor () override
 
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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
 
vtkAxisActor2DRightAxis
 
vtkAxisActor2DTopAxis
 
vtkAxisActor2DLeftAxis
 
vtkAxisActor2DBottomAxis
 
vtkTypeBool RightAxisVisibility
 
vtkTypeBool TopAxisVisibility
 
vtkTypeBool LeftAxisVisibility
 
vtkTypeBool BottomAxisVisibility
 
vtkTypeBool LegendVisibility
 
vtkPolyDataLegend
 
vtkPointsLegendPoints
 
vtkPolyDataMapper2DLegendMapper
 
vtkActor2DLegendActor
 
vtkTextMapperLabelMappers [6]
 
vtkActor2DLabelActors [6]
 
vtkTextPropertyLegendTitleProperty
 
vtkTextPropertyLegendLabelProperty
 
vtkCoordinateCoordinate
 
vtkTimeStamp BuildTime
 
- Protected Attributes inherited from vtkProp
vtkTypeBool Visibility
 
vtkTypeBool Pickable
 
vtkTypeBool Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Member Typedef Documentation

◆ Superclass

Standard methods for the class.

Definition at line 68 of file vtkLegendScaleActor.h.

Member Enumeration Documentation

◆ AttributeLocation

Enumerator
DISTANCE 
XY_COORDINATES 

Definition at line 72 of file vtkLegendScaleActor.h.

Constructor & Destructor Documentation

◆ vtkLegendScaleActor()

vtkLegendScaleActor::vtkLegendScaleActor ( )
protected

◆ ~vtkLegendScaleActor()

vtkLegendScaleActor::~vtkLegendScaleActor ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkLegendScaleActor* vtkLegendScaleActor::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkLegendScaleActor::IsA ( const char *  name)
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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLegendScaleActor::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkProp.

◆ NewInstance()

vtkLegendScaleActor* vtkLegendScaleActor::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetLabelMode()

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.

◆ GetLabelMode()

virtual int vtkLegendScaleActor::GetLabelMode ( )
virtual

◆ SetLabelModeToDistance()

void vtkLegendScaleActor::SetLabelModeToDistance ( )
inline

Definition at line 87 of file vtkLegendScaleActor.h.

◆ SetLabelModeToXYCoordinates()

void vtkLegendScaleActor::SetLabelModeToXYCoordinates ( )
inline

Definition at line 88 of file vtkLegendScaleActor.h.

◆ SetRightAxisVisibility()

virtual void vtkLegendScaleActor::SetRightAxisVisibility ( vtkTypeBool  )
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.

◆ GetRightAxisVisibility()

virtual vtkTypeBool vtkLegendScaleActor::GetRightAxisVisibility ( )
virtual

◆ RightAxisVisibilityOn()

virtual void vtkLegendScaleActor::RightAxisVisibilityOn ( )
virtual

◆ RightAxisVisibilityOff()

virtual void vtkLegendScaleActor::RightAxisVisibilityOff ( )
virtual

◆ SetTopAxisVisibility()

virtual void vtkLegendScaleActor::SetTopAxisVisibility ( vtkTypeBool  )
virtual

◆ GetTopAxisVisibility()

virtual vtkTypeBool vtkLegendScaleActor::GetTopAxisVisibility ( )
virtual

◆ TopAxisVisibilityOn()

virtual void vtkLegendScaleActor::TopAxisVisibilityOn ( )
virtual

◆ TopAxisVisibilityOff()

virtual void vtkLegendScaleActor::TopAxisVisibilityOff ( )
virtual

◆ SetLeftAxisVisibility()

virtual void vtkLegendScaleActor::SetLeftAxisVisibility ( vtkTypeBool  )
virtual

◆ GetLeftAxisVisibility()

virtual vtkTypeBool vtkLegendScaleActor::GetLeftAxisVisibility ( )
virtual

◆ LeftAxisVisibilityOn()

virtual void vtkLegendScaleActor::LeftAxisVisibilityOn ( )
virtual

◆ LeftAxisVisibilityOff()

virtual void vtkLegendScaleActor::LeftAxisVisibilityOff ( )
virtual

◆ SetBottomAxisVisibility()

virtual void vtkLegendScaleActor::SetBottomAxisVisibility ( vtkTypeBool  )
virtual

◆ GetBottomAxisVisibility()

virtual vtkTypeBool vtkLegendScaleActor::GetBottomAxisVisibility ( )
virtual

◆ BottomAxisVisibilityOn()

virtual void vtkLegendScaleActor::BottomAxisVisibilityOn ( )
virtual

◆ BottomAxisVisibilityOff()

virtual void vtkLegendScaleActor::BottomAxisVisibilityOff ( )
virtual

◆ SetLegendVisibility()

virtual void vtkLegendScaleActor::SetLegendVisibility ( vtkTypeBool  )
virtual

Indicate whether the legend scale should be displayed or not.

The default is On.

◆ GetLegendVisibility()

virtual vtkTypeBool vtkLegendScaleActor::GetLegendVisibility ( )
virtual

◆ LegendVisibilityOn()

virtual void vtkLegendScaleActor::LegendVisibilityOn ( )
virtual

◆ LegendVisibilityOff()

virtual void vtkLegendScaleActor::LegendVisibilityOff ( )
virtual

◆ AllAxesOn()

void vtkLegendScaleActor::AllAxesOn ( )

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

◆ AllAxesOff()

void vtkLegendScaleActor::AllAxesOff ( )

◆ AllAnnotationsOn()

void vtkLegendScaleActor::AllAnnotationsOn ( )

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

◆ AllAnnotationsOff()

void vtkLegendScaleActor::AllAnnotationsOff ( )

◆ SetRightBorderOffset()

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.

◆ GetRightBorderOffset()

virtual int vtkLegendScaleActor::GetRightBorderOffset ( )
virtual

◆ SetTopBorderOffset()

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.

◆ GetTopBorderOffset()

virtual int vtkLegendScaleActor::GetTopBorderOffset ( )
virtual

◆ SetLeftBorderOffset()

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.

◆ GetLeftBorderOffset()

virtual int vtkLegendScaleActor::GetLeftBorderOffset ( )
virtual

◆ SetBottomBorderOffset()

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.

◆ GetBottomBorderOffset()

virtual int vtkLegendScaleActor::GetBottomBorderOffset ( )
virtual

◆ SetCornerOffsetFactor()

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.

◆ GetCornerOffsetFactor()

virtual double vtkLegendScaleActor::GetCornerOffsetFactor ( )
virtual

◆ GetLegendTitleProperty()

virtual vtkTextProperty* vtkLegendScaleActor::GetLegendTitleProperty ( )
virtual

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

◆ GetLegendLabelProperty()

virtual vtkTextProperty* vtkLegendScaleActor::GetLegendLabelProperty ( )
virtual

◆ GetRightAxis()

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.

◆ GetTopAxis()

virtual vtkAxisActor2D* vtkLegendScaleActor::GetTopAxis ( )
virtual

◆ GetLeftAxis()

virtual vtkAxisActor2D* vtkLegendScaleActor::GetLeftAxis ( )
virtual

◆ GetBottomAxis()

virtual vtkAxisActor2D* vtkLegendScaleActor::GetBottomAxis ( )
virtual

◆ BuildRepresentation()

virtual void vtkLegendScaleActor::BuildRepresentation ( vtkViewport viewport)
virtual

Standard methods supporting the rendering process.

◆ GetActors2D()

void vtkLegendScaleActor::GetActors2D ( vtkPropCollection )
overridevirtual

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkLegendScaleActor::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

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.

◆ RenderOverlay()

int vtkLegendScaleActor::RenderOverlay ( vtkViewport )
overridevirtual

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkLegendScaleActor::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

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.

Member Data Documentation

◆ LabelMode

int vtkLegendScaleActor::LabelMode
protected

Definition at line 220 of file vtkLegendScaleActor.h.

◆ RightBorderOffset

int vtkLegendScaleActor::RightBorderOffset
protected

Definition at line 221 of file vtkLegendScaleActor.h.

◆ TopBorderOffset

int vtkLegendScaleActor::TopBorderOffset
protected

Definition at line 222 of file vtkLegendScaleActor.h.

◆ LeftBorderOffset

int vtkLegendScaleActor::LeftBorderOffset
protected

Definition at line 223 of file vtkLegendScaleActor.h.

◆ BottomBorderOffset

int vtkLegendScaleActor::BottomBorderOffset
protected

Definition at line 224 of file vtkLegendScaleActor.h.

◆ CornerOffsetFactor

double vtkLegendScaleActor::CornerOffsetFactor
protected

Definition at line 225 of file vtkLegendScaleActor.h.

◆ RightAxis

vtkAxisActor2D* vtkLegendScaleActor::RightAxis
protected

Definition at line 228 of file vtkLegendScaleActor.h.

◆ TopAxis

vtkAxisActor2D* vtkLegendScaleActor::TopAxis
protected

Definition at line 229 of file vtkLegendScaleActor.h.

◆ LeftAxis

vtkAxisActor2D* vtkLegendScaleActor::LeftAxis
protected

Definition at line 230 of file vtkLegendScaleActor.h.

◆ BottomAxis

vtkAxisActor2D* vtkLegendScaleActor::BottomAxis
protected

Definition at line 231 of file vtkLegendScaleActor.h.

◆ RightAxisVisibility

vtkTypeBool vtkLegendScaleActor::RightAxisVisibility
protected

Definition at line 234 of file vtkLegendScaleActor.h.

◆ TopAxisVisibility

vtkTypeBool vtkLegendScaleActor::TopAxisVisibility
protected

Definition at line 235 of file vtkLegendScaleActor.h.

◆ LeftAxisVisibility

vtkTypeBool vtkLegendScaleActor::LeftAxisVisibility
protected

Definition at line 236 of file vtkLegendScaleActor.h.

◆ BottomAxisVisibility

vtkTypeBool vtkLegendScaleActor::BottomAxisVisibility
protected

Definition at line 237 of file vtkLegendScaleActor.h.

◆ LegendVisibility

vtkTypeBool vtkLegendScaleActor::LegendVisibility
protected

Definition at line 240 of file vtkLegendScaleActor.h.

◆ Legend

vtkPolyData* vtkLegendScaleActor::Legend
protected

Definition at line 241 of file vtkLegendScaleActor.h.

◆ LegendPoints

vtkPoints* vtkLegendScaleActor::LegendPoints
protected

Definition at line 242 of file vtkLegendScaleActor.h.

◆ LegendMapper

vtkPolyDataMapper2D* vtkLegendScaleActor::LegendMapper
protected

Definition at line 243 of file vtkLegendScaleActor.h.

◆ LegendActor

vtkActor2D* vtkLegendScaleActor::LegendActor
protected

Definition at line 244 of file vtkLegendScaleActor.h.

◆ LabelMappers

vtkTextMapper* vtkLegendScaleActor::LabelMappers[6]
protected

Definition at line 245 of file vtkLegendScaleActor.h.

◆ LabelActors

vtkActor2D* vtkLegendScaleActor::LabelActors[6]
protected

Definition at line 246 of file vtkLegendScaleActor.h.

◆ LegendTitleProperty

vtkTextProperty* vtkLegendScaleActor::LegendTitleProperty
protected

Definition at line 247 of file vtkLegendScaleActor.h.

◆ LegendLabelProperty

vtkTextProperty* vtkLegendScaleActor::LegendLabelProperty
protected

Definition at line 248 of file vtkLegendScaleActor.h.

◆ Coordinate

vtkCoordinate* vtkLegendScaleActor::Coordinate
protected

Definition at line 249 of file vtkLegendScaleActor.h.

◆ BuildTime

vtkTimeStamp vtkLegendScaleActor::BuildTime
protected

Definition at line 251 of file vtkLegendScaleActor.h.


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