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

#include <vtkLegendScaleActor.h>

Inheritance diagram for vtkLegendScaleActor:

Collaboration diagram for vtkLegendScaleActor:

Public Types
enum	AttributeLocation { DISTANCE = 0 , COORDINATES = 1 , XY_COORDINATES = COORDINATES }

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions

virtual void	SetLabelMode (int)
	Specify the mode for labeling the scale axes.

virtual int	GetLabelMode ()
	Specify the mode for labeling the scale axes.

void	SetLabelModeToDistance ()
	Specify the mode for labeling the scale axes.

void	SetLabelModeToXYCoordinates ()
	Specify the mode for labeling the scale axes.

void	SetLabelModeToCoordinates ()
	Specify the mode for labeling the scale axes.


virtual void	SetRightAxisVisibility (vtkTypeBool)
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual vtkTypeBool	GetRightAxisVisibility ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	RightAxisVisibilityOn ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	RightAxisVisibilityOff ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	SetTopAxisVisibility (vtkTypeBool)
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual vtkTypeBool	GetTopAxisVisibility ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	TopAxisVisibilityOn ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	TopAxisVisibilityOff ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	SetLeftAxisVisibility (vtkTypeBool)
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual vtkTypeBool	GetLeftAxisVisibility ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	LeftAxisVisibilityOn ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	LeftAxisVisibilityOff ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	SetBottomAxisVisibility (vtkTypeBool)
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual vtkTypeBool	GetBottomAxisVisibility ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	BottomAxisVisibilityOn ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

virtual void	BottomAxisVisibilityOff ()
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).


virtual void	SetLegendVisibility (vtkTypeBool)
	Indicate whether the legend scale should be displayed or not.

virtual vtkTypeBool	GetLegendVisibility ()
	Indicate whether the legend scale should be displayed or not.

virtual void	LegendVisibilityOn ()
	Indicate whether the legend scale should be displayed or not.

virtual void	LegendVisibilityOff ()
	Indicate whether the legend scale should be displayed or not.


void	AllAxesOn ()
	Convenience method that turns all the axes either on or off.

void	AllAxesOff ()
	Convenience method that turns all the axes either on or off.


void	AllAnnotationsOn ()
	Convenience method that turns all the axes and the legend scale.

void	AllAnnotationsOff ()
	Convenience method that turns all the axes and the legend scale.


virtual void	SetGridVisibility (bool)
	Set/Get visibility of the grid.

virtual bool	GetGridVisibility ()
	Set/Get visibility of the grid.

virtual void	GridVisibilityOn ()
	Set/Get visibility of the grid.

virtual void	GridVisibilityOff ()
	Set/Get visibility of the grid.


virtual void	SetRightBorderOffset (int)
	Set/Get the offset of the right axis from the border.

virtual int	GetRightBorderOffset ()
	Set/Get the offset of the right axis from the border.


virtual void	SetTopBorderOffset (int)
	Set/Get the offset of the top axis from the border.

virtual int	GetTopBorderOffset ()
	Set/Get the offset of the top axis from the border.


virtual void	SetLeftBorderOffset (int)
	Set/Get the offset of the left axis from the border.

virtual int	GetLeftBorderOffset ()
	Set/Get the offset of the left axis from the border.


virtual void	SetBottomBorderOffset (int)
	Set/Get the offset of the bottom axis from the border.

virtual int	GetBottomBorderOffset ()
	Set/Get the offset of the bottom axis from the border.


virtual void	SetCornerOffsetFactor (double)
	Get/Set the corner offset.

virtual double	GetCornerOffsetFactor ()
	Get/Set the corner offset.


void	SetNotation (int notation)
	Get/set the numerical notation for axes labels: standard, scientific or mixed (0, 1, 2).

int	GetNotation ()
	Get/set the numerical notation for axes labels: standard, scientific or mixed (0, 1, 2).


void	SetPrecision (int val)
	Get/set the numerical precision to use for axis labels, default is 2.

int	GetPrecision ()
	Get/set the numerical precision to use for axis labels, default is 2.


void	SetNumberOfHorizontalLabels (int val)
	Get/set the number of ticks (and labels) for the horizontal axis, default is 5.

int	GetNumberOfHorizontalLabels ()
	Get/set the number of ticks (and labels) for the horizontal axis, default is 5.


void	SetNumberOfVerticalLabels (int val)
	Get/set the number of ticks (and labels) for the vertical axis, default is 5.

int	GetNumberOfVerticalLabels ()
	Get/set the number of ticks (and labels) for the vertical axis, default is 5.


virtual void	SetOrigin (double, double, double)
	Get/Set the origin of the data.

virtual void	SetOrigin (double[3])
	Get/Set the origin of the data.

virtual double *	GetOrigin ()
	Get/Set the origin of the data.

virtual void	GetOrigin (double &, double &, double &)
	Get/Set the origin of the data.

virtual void	GetOrigin (double[3])
	Get/Set the origin of the data.


virtual vtkTextProperty *	GetLegendTitleProperty ()
	Set/Get the labels text properties for the legend title and labels.

virtual vtkTextProperty *	GetLegendLabelProperty ()
	Set/Get the labels text properties for the legend title and labels.


void	SetAxesTextProperty (vtkTextProperty *property)
	Configuration forwarded to each axis.

void	SetAxesProperty (vtkProperty2D *property)
	Set the 2D property for both axis and grid.

vtkProperty2D *	GetAxesProperty ()
	Return the property used for the right axis which should be the same as the other ones if set using `SetAxesProperty`

void	SetUseFontSizeFromProperty (bool sizeFromProp)
	Set the axes to get font size from text property.

void	SetAdjustLabels (bool adjust)
	Set the axes to adjust labels to a "nice" one.

void	SetSnapToGrid (bool snap)
	If on, labels are positioned on rounded values.


virtual vtkAxisActor2D *	GetRightAxis ()
	These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation.

virtual vtkAxisActor2D *	GetTopAxis ()
	These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation.

virtual vtkAxisActor2D *	GetLeftAxis ()
	These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation.

virtual vtkAxisActor2D *	GetBottomAxis ()
	These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation.


virtual void	BuildRepresentation (vtkViewport *viewport)
	Standard methods supporting the rendering process.

void	GetActors2D (vtkPropCollection *) override
	Standard methods supporting the rendering process.

void	ReleaseGraphicsResources (vtkWindow *) override
	Standard methods supporting the rendering process.

int	RenderOverlay (vtkViewport *) override
	Standard methods supporting the rendering process.

int	RenderOpaqueGeometry (vtkViewport *) override
	Standard methods supporting the rendering process.

Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked.

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.

virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.

virtual int	RenderOpaqueGeometry (vtkViewport *)
	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.

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.

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.

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.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

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.

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.

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.

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.

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.

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.

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.

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.

virtual void	PickableOn ()
	Set/Get the pickable instance variable.

virtual void	PickableOff ()
	Set/Get the pickable instance variable.

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.

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().

virtual bool	GetUseBounds ()
	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().

virtual void	UseBoundsOn ()
	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().

virtual void	UseBoundsOff ()
	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().

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.

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.

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

virtual int	GetNumberOfConsumers ()
	Get the number of consumers.

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.

virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkLegendScaleActor *	New ()
	Instantiate the class.

Static Public Member Functions inherited from vtkProp
static vtkTypeBool	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkLegendScaleActor ()

	~vtkLegendScaleActor () override

Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const

	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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	LabelMode = DISTANCE

int	RightBorderOffset = 50

int	TopBorderOffset = 30

int	LeftBorderOffset = 50

int	BottomBorderOffset = 30

double	CornerOffsetFactor = 2.

vtkNew< vtkAxisActor2D >	RightAxis

vtkNew< vtkAxisActor2D >	TopAxis

vtkNew< vtkAxisActor2D >	LeftAxis

vtkNew< vtkAxisActor2D >	BottomAxis

vtkNew< vtkAxisGridActorPrivate >	GridActor

vtkNew< vtkPolyDataMapper2D >	GridMapper

bool	GridVisibility = false

vtkTypeBool	RightAxisVisibility = 1

vtkTypeBool	TopAxisVisibility = 1

vtkTypeBool	LeftAxisVisibility = 1

vtkTypeBool	BottomAxisVisibility = 1

vtkTypeBool	LegendVisibility = 1

vtkNew< vtkPolyData >	Legend

vtkNew< vtkPoints >	LegendPoints

vtkNew< vtkPolyDataMapper2D >	LegendMapper

vtkNew< vtkActor2D >	LegendActor

vtkNew< vtkTextMapper >	LabelMappers [6]

vtkNew< vtkActor2D >	LabelActors [6]

vtkNew< vtkTextProperty >	LegendTitleProperty

vtkNew< vtkTextProperty >	LegendLabelProperty

vtkNew< vtkCoordinate >	Coordinate

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

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkProp	Superclass
	Standard methods for the class.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for the class.

static vtkLegendScaleActor *	SafeDownCast (vtkObjectBase *o)
	Standard methods for the class.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for the class.

vtkLegendScaleActor *	NewInstance () const
	Standard methods for the class.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for the class.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for the class.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 coordinate values. By default, the scales display a distance. However, if you know that the view is down a scene axis, the scales can be programmed to display 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.

Online Examples:

LegendScaleActor

Tests:: vtkLegendScaleActor (Tests)

Definition at line 69 of file vtkLegendScaleActor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkProp vtkLegendScaleActor::Superclass

Standard methods for the class.

Definition at line 81 of file vtkLegendScaleActor.h.

Member Enumeration Documentation

◆ AttributeLocation

enum vtkLegendScaleActor::AttributeLocation

Enumerator
DISTANCE
COORDINATES
XY_COORDINATES

Definition at line 85 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

Standard methods for the class.

◆ IsA()

virtual vtkTypeBool vtkLegendScaleActor::IsA ( const char * type )

virtual

Standard methods for the class.

Reimplemented from vtkProp.

◆ SafeDownCast()

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

static

Standard methods for the class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkLegendScaleActor::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkProp.

◆ NewInstance()

vtkLegendScaleActor * vtkLegendScaleActor::NewInstance ( ) const

Standard methods for the class.

◆ PrintSelf()

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

overridevirtual

Standard methods for the class.

Reimplemented from vtkObjectBase.

◆ 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 align with the scene axes, axes can be labeled with coordinates values.

◆ GetLabelMode()

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 align with the scene axes, axes can be labeled with coordinates values.

◆ SetLabelModeToDistance()

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 align with the scene axes, axes can be labeled with coordinates values.

Definition at line 101 of file vtkLegendScaleActor.h.

◆ SetLabelModeToXYCoordinates()

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 align with the scene axes, axes can be labeled with coordinates values.

Definition at line 104 of file vtkLegendScaleActor.h.

◆ SetLabelModeToCoordinates()

void vtkLegendScaleActor::SetLabelModeToCoordinates ( )

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 align with the scene axes, axes can be labeled with coordinates values.

Definition at line 105 of file vtkLegendScaleActor.h.