vtkScalarBarActor Class Reference

Create a scalar bar with labels. More...

#include <vtkScalarBarActor.h>

Inheritance diagram for vtkScalarBarActor:

Collaboration diagram for vtkScalarBarActor:

Public Types
enum	{ PrecedeScalarBar = 0 , SucceedScalarBar }
typedef vtkActor2D	Superclass
Public Types inherited from vtkActor2D
typedef vtkProp	Superclass
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.
vtkScalarBarActor *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.
virtual void	GetScalarBarRect (int rect[4], vtkViewport *viewport)
	Fills rect with the dimensions of the scalar bar in viewport coordinates.
void	ShallowCopy (vtkProp *prop) override
	Shallow copy of a scalar bar actor.
int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Draw the scalar bar and annotation text to the screen.
int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	Draw the scalar bar and annotation text to the screen.
int	RenderOverlay (vtkViewport *viewport) override
	Draw the scalar bar and annotation text to the screen.
virtual void	SetLookupTable (vtkScalarsToColors *)
	Set/Get the lookup table to use.
virtual vtkScalarsToColors *	GetLookupTable ()
	Set/Get the lookup table to use.
virtual void	SetOpacityFunction (vtkPiecewiseFunction *)
	Set/Get the piecewise function that denotes opacity function to map values through.
virtual vtkPiecewiseFunction *	GetOpacityFunction ()
	Set/Get the piecewise function that denotes opacity function to map values through.
virtual void	SetUseOpacity (vtkTypeBool)
	Should be display the opacity as well.
virtual vtkTypeBool	GetUseOpacity ()
	Should be display the opacity as well.
virtual void	UseOpacityOn ()
	Should be display the opacity as well.
virtual void	UseOpacityOff ()
	Should be display the opacity as well.
virtual void	SetMaximumNumberOfColors (int)
	Set/Get the maximum number of scalar bar segments to show.
virtual int	GetMaximumNumberOfColors ()
	Set/Get the maximum number of scalar bar segments to show.
virtual void	SetNumberOfLabels (int)
	Set/Get the number of automatic tick labels to show.
virtual int	GetNumberOfLabels ()
	Set/Get the number of automatic tick labels to show.
virtual void	SetCustomLabels (vtkDoubleArray *labels)
	Set/Get the fixed locations to use.
virtual vtkDoubleArray *	GetCustomLabels ()
	Set/Get the fixed locations to use.
virtual bool	GetUseCustomLabels ()
	Get/Set whether custom labels will be used.
virtual void	SetUseCustomLabels (bool)
	Get/Set whether custom labels will be used.
virtual void	UseCustomLabelsOn ()
	Get/Set whether custom labels will be used.
virtual void	UseCustomLabelsOff ()
	Get/Set whether custom labels will be used.
virtual void	SetOrientation (int)
	Control the orientation of the scalar bar.
virtual int	GetOrientation ()
	Control the orientation of the scalar bar.
void	SetOrientationToHorizontal ()
	Control the orientation of the scalar bar.
void	SetOrientationToVertical ()
	Control the orientation of the scalar bar.
virtual bool	GetForceVerticalTitle ()
	Force the scalar bar title to be vertical.
virtual void	SetForceVerticalTitle (bool)
	Force the scalar bar title to be vertical.
virtual void	SetTitleTextProperty (vtkTextProperty *p)
	Set/Get the title text property.
virtual vtkTextProperty *	GetTitleTextProperty ()
	Set/Get the title text property.
virtual void	SetLabelTextProperty (vtkTextProperty *p)
	Set/Get the labels text property.
virtual vtkTextProperty *	GetLabelTextProperty ()
	Set/Get the labels text property.
virtual void	SetAnnotationTextProperty (vtkTextProperty *p)
	Set/Get the annotation text property.
virtual vtkTextProperty *	GetAnnotationTextProperty ()
	Set/Get the annotation text property.
virtual void	SetLabelFormat (const char *)
	Set/Get the format with which to print the labels on the scalar bar.
virtual char *	GetLabelFormat ()
	Set/Get the format with which to print the labels on the scalar bar.
virtual void	SetTitle (const char *)
	Set/Get the title of the scalar bar actor,.
virtual char *	GetTitle ()
	Set/Get the title of the scalar bar actor,.
virtual void	SetComponentTitle (const char *)
	Set/Get the title for the component that is selected,.
virtual char *	GetComponentTitle ()
	Set/Get the title for the component that is selected,.
virtual void	SetTextureGridWidth (double)
	Set the width of the texture grid.
virtual double	GetTextureGridWidth ()
	Set the width of the texture grid.
virtual vtkTexturedActor2D *	GetTextureActor ()
	Get the texture actor.
virtual void	SetTextPosition (int)
	Should the title and tick marks precede the scalar bar or succeed it? This is measured along the viewport coordinate direction perpendicular to the long axis of the scalar bar, not the reading direction.
virtual int	GetTextPosition ()
	Should the title and tick marks precede the scalar bar or succeed it? This is measured along the viewport coordinate direction perpendicular to the long axis of the scalar bar, not the reading direction.
virtual void	SetTextPositionToPrecedeScalarBar ()
	Should the title and tick marks precede the scalar bar or succeed it? This is measured along the viewport coordinate direction perpendicular to the long axis of the scalar bar, not the reading direction.
virtual void	SetTextPositionToSucceedScalarBar ()
	Should the title and tick marks precede the scalar bar or succeed it? This is measured along the viewport coordinate direction perpendicular to the long axis of the scalar bar, not the reading direction.
virtual void	SetMaximumWidthInPixels (int)
	Set/Get the maximum width and height in pixels.
virtual int	GetMaximumWidthInPixels ()
	Set/Get the maximum width and height in pixels.
virtual void	SetMaximumHeightInPixels (int)
	Set/Get the maximum width and height in pixels.
virtual int	GetMaximumHeightInPixels ()
	Set/Get the maximum width and height in pixels.
virtual void	SetAnnotationLeaderPadding (double)
	Set/get the padding between the scalar bar and the text annotations.
virtual double	GetAnnotationLeaderPadding ()
	Set/get the padding between the scalar bar and the text annotations.
virtual void	SetDrawAnnotations (vtkTypeBool)
	Set/get whether text annotations should be rendered or not.
virtual vtkTypeBool	GetDrawAnnotations ()
	Set/get whether text annotations should be rendered or not.
virtual void	DrawAnnotationsOn ()
	Set/get whether text annotations should be rendered or not.
virtual void	DrawAnnotationsOff ()
	Set/get whether text annotations should be rendered or not.
virtual void	SetDrawNanAnnotation (vtkTypeBool)
	Set/get whether the NaN annotation should be rendered or not.
virtual vtkTypeBool	GetDrawNanAnnotation ()
	Set/get whether the NaN annotation should be rendered or not.
virtual void	DrawNanAnnotationOn ()
	Set/get whether the NaN annotation should be rendered or not.
virtual void	DrawNanAnnotationOff ()
	Set/get whether the NaN annotation should be rendered or not.
virtual void	SetDrawBelowRangeSwatch (bool)
	Set/get whether the Below range swatch should be rendered or not.
virtual bool	GetDrawBelowRangeSwatch ()
	Set/get whether the Below range swatch should be rendered or not.
virtual void	DrawBelowRangeSwatchOn ()
	Set/get whether the Below range swatch should be rendered or not.
virtual void	DrawBelowRangeSwatchOff ()
	Set/get whether the Below range swatch should be rendered or not.
virtual void	SetBelowRangeAnnotation (const char *)
	Set/get the annotation text for "Below Range" values.
virtual char *	GetBelowRangeAnnotation ()
	Set/get the annotation text for "Below Range" values.
virtual void	SetDrawAboveRangeSwatch (bool)
	Set/get whether the Above range swatch should be rendered or not.
virtual bool	GetDrawAboveRangeSwatch ()
	Set/get whether the Above range swatch should be rendered or not.
virtual void	DrawAboveRangeSwatchOn ()
	Set/get whether the Above range swatch should be rendered or not.
virtual void	DrawAboveRangeSwatchOff ()
	Set/get whether the Above range swatch should be rendered or not.
virtual void	SetAboveRangeAnnotation (const char *)
	Set/get the annotation text for "Above Range Swatch" values.
virtual char *	GetAboveRangeAnnotation ()
	Set/get the annotation text for "Above Range Swatch" values.
virtual void	SetFixedAnnotationLeaderLineColor (vtkTypeBool)
	Set/get how leader lines connecting annotations to values should be colored.
virtual vtkTypeBool	GetFixedAnnotationLeaderLineColor ()
	Set/get how leader lines connecting annotations to values should be colored.
virtual void	FixedAnnotationLeaderLineColorOn ()
	Set/get how leader lines connecting annotations to values should be colored.
virtual void	FixedAnnotationLeaderLineColorOff ()
	Set/get how leader lines connecting annotations to values should be colored.
virtual void	SetNanAnnotation (const char *)
	Set/get the annotation text for "NaN" values.
virtual char *	GetNanAnnotation ()
	Set/get the annotation text for "NaN" values.
virtual void	SetAnnotationTextScaling (vtkTypeBool)
	Set/get whether annotation labels should be scaled with the viewport.
virtual vtkTypeBool	GetAnnotationTextScaling ()
	Set/get whether annotation labels should be scaled with the viewport.
virtual void	AnnotationTextScalingOn ()
	Set/get whether annotation labels should be scaled with the viewport.
virtual void	AnnotationTextScalingOff ()
	Set/get whether annotation labels should be scaled with the viewport.
virtual void	SetDrawBackground (vtkTypeBool)
	Set/Get whether a background should be drawn around the scalar bar.
virtual vtkTypeBool	GetDrawBackground ()
	Set/Get whether a background should be drawn around the scalar bar.
virtual void	DrawBackgroundOn ()
	Set/Get whether a background should be drawn around the scalar bar.
virtual void	DrawBackgroundOff ()
	Set/Get whether a background should be drawn around the scalar bar.
virtual void	SetDrawFrame (vtkTypeBool)
	Set/Get whether a frame should be drawn around the scalar bar.
virtual vtkTypeBool	GetDrawFrame ()
	Set/Get whether a frame should be drawn around the scalar bar.
virtual void	DrawFrameOn ()
	Set/Get whether a frame should be drawn around the scalar bar.
virtual void	DrawFrameOff ()
	Set/Get whether a frame should be drawn around the scalar bar.
virtual void	SetDrawColorBar (vtkTypeBool)
	Set/Get whether the color bar should be drawn.
virtual vtkTypeBool	GetDrawColorBar ()
	Set/Get whether the color bar should be drawn.
virtual void	DrawColorBarOn ()
	Set/Get whether the color bar should be drawn.
virtual void	DrawColorBarOff ()
	Set/Get whether the color bar should be drawn.
virtual void	SetDrawTickLabels (vtkTypeBool)
	Set/Get whether the tick labels should be drawn.
virtual vtkTypeBool	GetDrawTickLabels ()
	Set/Get whether the tick labels should be drawn.
virtual void	DrawTickLabelsOn ()
	Set/Get whether the tick labels should be drawn.
virtual void	DrawTickLabelsOff ()
	Set/Get whether the tick labels should be drawn.
virtual void	SetBackgroundProperty (vtkProperty2D *p)
	Set/Get the background property.
virtual vtkProperty2D *	GetBackgroundProperty ()
	Set/Get the background property.
virtual void	SetFrameProperty (vtkProperty2D *p)
	Set/Get the frame property.
virtual vtkProperty2D *	GetFrameProperty ()
	Set/Get the frame property.
virtual int	GetTextPad ()
	Set/get the amount of padding around text boxes.
virtual void	SetTextPad (int)
	Set/get the amount of padding around text boxes.
virtual int	GetVerticalTitleSeparation ()
	Set/get the margin in pixels, between the title and the bar, when the Orientation is vertical.
virtual void	SetVerticalTitleSeparation (int)
	Set/get the margin in pixels, between the title and the bar, when the Orientation is vertical.
virtual double	GetBarRatio ()
	Set/get the thickness of the color bar relative to the widget frame.
virtual void	SetBarRatio (double)
	Set/get the thickness of the color bar relative to the widget frame.
virtual double	GetTitleRatio ()
	Set/get the ratio of the title height to the tick label height (used only when the Orientation is horizontal).
virtual void	SetTitleRatio (double)
	Set/get the ratio of the title height to the tick label height (used only when the Orientation is horizontal).
virtual void	SetUnconstrainedFontSize (bool)
	Set/Get whether the font size of title and labels is unconstrained.
virtual bool	GetUnconstrainedFontSize ()
	Set/Get whether the font size of title and labels is unconstrained.
virtual void	UnconstrainedFontSizeOn ()
	Set/Get whether the font size of title and labels is unconstrained.
virtual void	UnconstrainedFontSizeOff ()
	Set/Get whether the font size of title and labels is unconstrained.
Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkActor2D *	NewInstance () const
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?
vtkProperty2D *	GetProperty ()
	Returns this actor's vtkProperty2D.
virtual void	SetProperty (vtkProperty2D *)
	Set this vtkProp's vtkProperty2D.
void	SetDisplayPosition (int, int)
	Set the Prop2D's position in display coordinates.
vtkMTimeType	GetMTime () override
	Return this objects MTime.
void	GetActors2D (vtkPropCollection *pc) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.
void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkActor2D.
void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.
virtual vtkCoordinate *	GetActualPositionCoordinate ()
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.
virtual vtkCoordinate *	GetActualPosition2Coordinate ()
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.
virtual void	SetMapper (vtkMapper2D *mapper)
	Set/Get the vtkMapper2D which defines the data to be drawn.
virtual vtkMapper2D *	GetMapper ()
	Set/Get the vtkMapper2D which defines the data to be drawn.
virtual void	SetLayerNumber (int)
	Set/Get the layer number in the overlay planes into which to render.
virtual int	GetLayerNumber ()
	Set/Get the layer number in the overlay planes into which to render.
virtual vtkCoordinate *	GetPositionCoordinate ()
	Get the PositionCoordinate instance of vtkCoordinate.
virtual void	SetPosition (float x[2])
	Get the PositionCoordinate instance of vtkCoordinate.
virtual void	SetPosition (float x, float y)
	Get the PositionCoordinate instance of vtkCoordinate.
virtual float *	GetPosition ()
	Get the PositionCoordinate instance of vtkCoordinate.
virtual vtkCoordinate *	GetPosition2Coordinate ()
	Access the Position2 instance variable.
virtual void	SetPosition2 (float x[2])
	Access the Position2 instance variable.
virtual void	SetPosition2 (float x, float y)
	Access the Position2 instance variable.
virtual float *	GetPosition2 ()
	Access the Position2 instance variable.
void	SetWidth (double w)
	Set/Get the height and width of the Actor2D.
double	GetWidth ()
	Set/Get the height and width of the Actor2D.
void	SetHeight (double h)
	Set/Get the height and width of the Actor2D.
double	GetHeight ()
	Set/Get the height and width of the Actor2D.
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 vtkTypeBool	IsTypeOf (const char *type)
static vtkScalarBarActor *	SafeDownCast (vtkObjectBase *o)
static vtkScalarBarActor *	New ()
	Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label format, no title, and vertical orientation.
Static Public Member Functions inherited from vtkActor2D
static vtkTypeBool	IsTypeOf (const char *type)
static vtkActor2D *	SafeDownCast (vtkObjectBase *o)
static vtkActor2D *	New ()
	Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0.
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
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkScalarBarActor ()
	~vtkScalarBarActor () override
virtual void	RebuildLayout (vtkViewport *viewport)
	Called from within RenderOpaqueGeometry when the internal state members need to be updated before rendering.
virtual int	RebuildLayoutIfNeeded (vtkViewport *viewport)
	Calls RebuildLayout if it is needed such as when positions etc have changed.
virtual void	FreeLayoutStorage ()
	Free internal storage used by the previous layout.
virtual void	ComputeFrame ()
	If the scalar bar should be inset into a frame or rendered with a solid background, this method will inset the outermost scalar bar rectangle by a small amount to avoid having the scalar bar illustration overlap any edges.
virtual void	ComputeScalarBarThickness ()
	Determine how thick the scalar bar should be (on an axis perpendicular to the direction in which scalar values vary).
virtual void	ComputeSwatchPad ()
	Compute a correct SwatchPad.
virtual void	LayoutNanSwatch ()
virtual void	LayoutBelowRangeSwatch ()
	Determine the size of the Below Range if it is to be rendered.
virtual void	LayoutAboveRangeSwatch ()
	Determine the size of the Above Range if it is to be rendered.
virtual void	LayoutAboveRangeSwatchPosn ()
	Determine the position of the Above Range if it is to be rendered.
virtual void	PrepareTitleText ()
	Set the title actor's input to the latest title (and subtitle) text.
virtual void	LayoutTitle ()
	Determine the position and size of the scalar bar title box.
virtual void	LayoutForUnconstrainedFont ()
	This method sets the title and tick-box size and position for the UnconstrainedFontSize mode.
virtual void	ComputeScalarBarLength ()
	Determine how long the scalar bar should be (on an axis parallel to the direction in which scalar values vary).
virtual void	LayoutTicks ()
	Determine the size and placement of any tick marks to be rendered.
virtual void	LayoutAnnotations ()
	This method must lay out annotation text and leader lines so they do not overlap.
virtual void	ConfigureAnnotations ()
	Generate/configure the annotation labels using the laid-out geometry.
virtual void	ConfigureFrame ()
	Generate/configure the representation of the frame from laid-out geometry.
virtual void	DrawBoxes ()
	For debugging, add placement boxes to the frame polydata.
virtual void	ConfigureScalarBar ()
	Generate/configure the scalar bar representation from laid-out geometry.
virtual void	ConfigureTitle ()
	Generate/configure the title actor using the laid-out geometry.
virtual void	ConfigureTicks ()
	Generate/configure the tick-mark actors using the laid-out geometry.
virtual void	ConfigureNanSwatch ()
	Generate/configure the NaN swatch using the laid-out geometry.
virtual void	ConfigureAboveBelowRangeSwatch (bool above)
	Generate/configure the above/below range swatch using the laid-out geometry.
virtual void	EditAnnotations ()
	Subclasses may override this method to alter this->P->Labels, allowing the addition and removal of annotations.
virtual void	SizeTitle (double *titleSize, int *size, vtkViewport *viewport)
	Compute the best size for the legend title.
int	MapAnnotationLabels (vtkScalarsToColors *lkup, double start, double delta, const double *range)
	Allocate actors for lookup table annotations and position them properly.
int	PlaceAnnotationsVertically (double barX, double barY, double barWidth, double barHeight, double delta, double pad)
	This method is called by ConfigureAnnotationLabels when Orientation is VTK_ORIENT_VERTICAL.
int	PlaceAnnotationsHorizontally (double barX, double barY, double barWidth, double barHeight, double delta, double pad)
	This method is called by ConfigureAnnotationLabels when Orientation is VTK_ORIENT_HORIZONTAL.
Protected Member Functions inherited from vtkActor2D
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkActor2D ()
	~vtkActor2D () 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	MaximumNumberOfColors
	User-changeable settings.
int	NumberOfLabels
	User-changeable settings.
int	NumberOfLabelsBuilt
	User-changeable settings.
int	Orientation
	User-changeable settings.
vtkDoubleArray *	CustomLabels = nullptr
	User-changeable settings.
bool	UseCustomLabels = false
	User-changeable settings.
vtkTypeBool	DrawBackground
	User-changeable settings.
vtkTypeBool	DrawFrame
	User-changeable settings.
vtkTypeBool	DrawColorBar
	User-changeable settings.
vtkTypeBool	DrawTickLabels
	User-changeable settings.
vtkTypeBool	DrawAnnotations
	User-changeable settings.
vtkTypeBool	DrawNanAnnotation
	User-changeable settings.
vtkTypeBool	AnnotationTextScaling
	User-changeable settings.
vtkTypeBool	FixedAnnotationLeaderLineColor
	User-changeable settings.
vtkProperty2D *	BackgroundProperty
	User-changeable settings.
vtkProperty2D *	FrameProperty
	User-changeable settings.
char *	Title
	User-changeable settings.
char *	ComponentTitle
	User-changeable settings.
char *	LabelFormat
	User-changeable settings.
vtkTypeBool	UseOpacity
	User-changeable settings.
double	TextureGridWidth
	User-changeable settings.
int	TextPosition
	User-changeable settings.
char *	NanAnnotation
	User-changeable settings.
char *	BelowRangeAnnotation
	User-changeable settings.
char *	AboveRangeAnnotation
	User-changeable settings.
double	AnnotationLeaderPadding
	User-changeable settings.
int	MaximumWidthInPixels
	User-changeable settings.
int	MaximumHeightInPixels
	User-changeable settings.
int	TextPad
	User-changeable settings.
int	VerticalTitleSeparation
	User-changeable settings.
double	BarRatio
	User-changeable settings.
double	TitleRatio
	User-changeable settings.
bool	UnconstrainedFontSize
	User-changeable settings.
bool	ForceVerticalTitle
	User-changeable settings.
bool	DrawBelowRangeSwatch
	User-changeable settings.
bool	DrawAboveRangeSwatch
	User-changeable settings.
vtkTimeStamp	BuildTime
	Internal state used for rendering.
int	LastSize [2]
	Projected size in viewport coordinates of last build.
int	LastOrigin [2]
	Projected origin (viewport coordinates) of last build.
vtkScalarBarActorInternal *	P
	Containers shared with subclasses.
vtkScalarsToColors *	LookupTable
	The object this actor illustrates.
vtkPiecewiseFunction *	OpacityFunction
	The opacity function if UseOpacity is true.
vtkTextProperty *	TitleTextProperty
	Font for the legend title.
vtkTextProperty *	LabelTextProperty
	Font for tick labels.
vtkTextProperty *	AnnotationTextProperty
	Font for annotation labels.
vtkTextActor *	TitleActor
	The legend title text renderer.
vtkPolyData *	ScalarBar
	Polygon(s) colored by LookupTable.
vtkPolyDataMapper2D *	ScalarBarMapper
	Mapper for ScalarBar.
vtkActor2D *	ScalarBarActor
	Actor for ScalarBar.
vtkPolyData *	TexturePolyData
	Polygon colored when UseOpacity is true.
vtkTexture *	Texture
	Color data for TexturePolyData.
vtkTexturedActor2D *	TextureActor
	Actor for TexturePolyData.
vtkPolyData *	Background
	Polygon used to fill the background.
vtkPolyDataMapper2D *	BackgroundMapper
	Mapper for Background.
vtkActor2D *	BackgroundActor
	Actor for Background.
vtkPolyData *	Frame
	Polyline used to highlight frame.
vtkPolyDataMapper2D *	FrameMapper
	Mapper for Frame.
vtkActor2D *	FrameActor
	Actor for Frame.
Protected Attributes inherited from vtkActor2D
vtkMapper2D *	Mapper
int	LayerNumber
vtkProperty2D *	Property
vtkCoordinate *	PositionCoordinate
vtkCoordinate *	Position2Coordinate
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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Create a scalar bar with labels.

vtkScalarBarActor creates a scalar bar with tick marks. A scalar bar is a legend that indicates to the viewer the correspondence between color value and data value. The legend consists of a rectangular bar made of rectangular pieces each colored a constant value. Since vtkScalarBarActor is a subclass of vtkActor2D, it is drawn in the image plane (i.e., in the renderer's viewport) on top of the 3D graphics window.

To use vtkScalarBarActor you must associate a vtkScalarsToColors (or subclass) with it. The lookup table defines the colors and the range of scalar values used to map scalar data. Typically, the number of colors shown in the scalar bar is not equal to the number of colors in the lookup table, in which case sampling of the lookup table is performed.

Other optional capabilities include specifying the fraction of the viewport size (both x and y directions) which will control the size of the scalar bar and the number of tick labels. The actual position of the scalar bar on the screen is controlled by using the vtkActor2D::SetPosition() method (by default the scalar bar is centered in the viewport). Other features include the ability to orient the scalar bar horizontally of vertically and controlling the format (printf style) with which to print the labels on the scalar bar. Also, the vtkScalarBarActor's property is applied to the scalar bar and annotations (including layer, and compositing operator).

Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated to this actor.

Warning

If a vtkLogLookupTable is specified as the lookup table to use, then the labels are created using a logarithmic scale.

See also

vtkActor2D vtkTextProperty vtkTextMapper vtkPolyDataMapper2D

Online Examples:

SignedDistance

Curvatures

CurvaturesAdjustEdges

DistancePolyDataFilter

RescaleReverseLUT

CurvatureBandsWithGlyphs

ElevationBandsWithGlyphs

ScalarBarActor

ScalarBarActorColorSeries

ScalarBarWidget

Tests:

vtkScalarBarActor (Tests)

Definition at line 181 of file vtkScalarBarActor.h.

Member Typedef Documentation

Superclass

typedef vtkActor2D vtkScalarBarActor::Superclass

Definition at line 184 of file vtkScalarBarActor.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
PrecedeScalarBar
SucceedScalarBar

Definition at line 386 of file vtkScalarBarActor.h.

Constructor & Destructor Documentation

vtkScalarBarActor()

vtkScalarBarActor::vtkScalarBarActor ( )

protected

~vtkScalarBarActor()

vtkScalarBarActor::~vtkScalarBarActor ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkScalarBarActor::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 vtkActor2D.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkScalarBarActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

NewInstance()

vtkScalarBarActor * vtkScalarBarActor::NewInstance

(

)

const

PrintSelf()

void vtkScalarBarActor::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 vtkActor2D.

New()

static vtkScalarBarActor * vtkScalarBarActor::New ( )

static

Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label format, no title, and vertical orientation.

The initial scalar bar size is (0.05 x 0.8) of the viewport size.

RenderOpaqueGeometry()

int vtkScalarBarActor::RenderOpaqueGeometry ( vtkViewport *  viewport )

overridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

RenderTranslucentPolygonalGeometry()

int vtkScalarBarActor::RenderTranslucentPolygonalGeometry ( vtkViewport *  )

inlineoverridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

Definition at line 199 of file vtkScalarBarActor.h.

RenderOverlay()

int vtkScalarBarActor::RenderOverlay ( vtkViewport *  viewport )

overridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

HasTranslucentPolygonalGeometry()

vtkTypeBool vtkScalarBarActor::HasTranslucentPolygonalGeometry ( )

overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkActor2D.

ReleaseGraphicsResources()

void vtkScalarBarActor::ReleaseGraphicsResources ( vtkWindow *  )

overridevirtual

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 vtkActor2D.

GetScalarBarRect()

virtual void vtkScalarBarActor::GetScalarBarRect ( int  rect[4], vtkViewport *  viewport  )

virtual

Fills rect with the dimensions of the scalar bar in viewport coordinates.

Only the color bar is considered – text labels are not considered. rect is {xmin, xmax, width, height}

SetLookupTable()

virtual void vtkScalarBarActor::SetLookupTable ( vtkScalarsToColors *  )

virtual

Set/Get the lookup table to use.

The lookup table specifies the number of colors to use in the table (if not overridden), the scalar range, and any annotated values. Annotated values are rendered using vtkTextActor.

GetLookupTable()

virtual vtkScalarsToColors * vtkScalarBarActor::GetLookupTable ( )

virtual

Set/Get the lookup table to use.

The lookup table specifies the number of colors to use in the table (if not overridden), the scalar range, and any annotated values. Annotated values are rendered using vtkTextActor.

SetOpacityFunction()

virtual void vtkScalarBarActor::SetOpacityFunction ( vtkPiecewiseFunction *  )

virtual

Set/Get the piecewise function that denotes opacity function to map values through.

Note

Only checked iff UseOpacity is true.

See also

SetUseOpacity()

GetOpacityFunction()

virtual vtkPiecewiseFunction * vtkScalarBarActor::GetOpacityFunction ( )

virtual

Set/Get the piecewise function that denotes opacity function to map values through.

Note

Only checked iff UseOpacity is true.

See also

SetUseOpacity()

SetUseOpacity()

virtual void vtkScalarBarActor::SetUseOpacity ( vtkTypeBool  )

virtual

Should be display the opacity as well.

This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off]

Note

If true, the scalar bar will first check to see if OpacityFunction is set. If not, it will query the opacity value from the lookup table.

See also

SetOpacityFunction(), SetLookupTable()

GetUseOpacity()

virtual vtkTypeBool vtkScalarBarActor::GetUseOpacity ( )

virtual

Should be display the opacity as well.

This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off]

Note

If true, the scalar bar will first check to see if OpacityFunction is set. If not, it will query the opacity value from the lookup table.

See also

SetOpacityFunction(), SetLookupTable()

UseOpacityOn()

virtual void vtkScalarBarActor::UseOpacityOn ( )

virtual

Should be display the opacity as well.

This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off]

Note

If true, the scalar bar will first check to see if OpacityFunction is set. If not, it will query the opacity value from the lookup table.

See also

SetOpacityFunction(), SetLookupTable()

UseOpacityOff()

virtual void vtkScalarBarActor::UseOpacityOff ( )

virtual

Should be display the opacity as well.

This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off]

Note

If true, the scalar bar will first check to see if OpacityFunction is set. If not, it will query the opacity value from the lookup table.

See also

SetOpacityFunction(), SetLookupTable()

SetMaximumNumberOfColors()

virtual void vtkScalarBarActor::SetMaximumNumberOfColors ( int  )

virtual

Set/Get the maximum number of scalar bar segments to show.

This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.

GetMaximumNumberOfColors()

virtual int vtkScalarBarActor::GetMaximumNumberOfColors ( )

virtual

Set/Get the maximum number of scalar bar segments to show.

This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.

SetNumberOfLabels()

virtual void vtkScalarBarActor::SetNumberOfLabels ( int  )

virtual

Set/Get the number of automatic tick labels to show.

GetNumberOfLabels()

virtual int vtkScalarBarActor::GetNumberOfLabels ( )

virtual

Set/Get the number of automatic tick labels to show.

SetCustomLabels()

virtual void vtkScalarBarActor::SetCustomLabels ( vtkDoubleArray *  labels )

virtual

Set/Get the fixed locations to use.

GetCustomLabels()

virtual vtkDoubleArray * vtkScalarBarActor::GetCustomLabels ( )

virtual

Set/Get the fixed locations to use.

GetUseCustomLabels()

virtual bool vtkScalarBarActor::GetUseCustomLabels ( )

virtual

Get/Set whether custom labels will be used.

bonds. Default: Off.

SetUseCustomLabels()

virtual void vtkScalarBarActor::SetUseCustomLabels ( bool  )

virtual

Get/Set whether custom labels will be used.

bonds. Default: Off.

UseCustomLabelsOn()

virtual void vtkScalarBarActor::UseCustomLabelsOn ( )

virtual

Get/Set whether custom labels will be used.

bonds. Default: Off.

UseCustomLabelsOff()

virtual void vtkScalarBarActor::UseCustomLabelsOff ( )

virtual

Get/Set whether custom labels will be used.

bonds. Default: Off.

SetOrientation()

virtual void vtkScalarBarActor::SetOrientation ( int  )

virtual

Control the orientation of the scalar bar.

GetOrientation()

virtual int vtkScalarBarActor::GetOrientation ( )

virtual

Control the orientation of the scalar bar.

SetOrientationToHorizontal()

void vtkScalarBarActor::SetOrientationToHorizontal ( )

inline

Control the orientation of the scalar bar.

Definition at line 305 of file vtkScalarBarActor.h.

SetOrientationToVertical()

void vtkScalarBarActor::SetOrientationToVertical ( )

inline

Control the orientation of the scalar bar.

Definition at line 306 of file vtkScalarBarActor.h.

GetForceVerticalTitle()

virtual bool vtkScalarBarActor::GetForceVerticalTitle ( )

virtual

Force the scalar bar title to be vertical.

SetForceVerticalTitle()

virtual void vtkScalarBarActor::SetForceVerticalTitle ( bool  )

virtual

Force the scalar bar title to be vertical.

SetTitleTextProperty()

virtual void vtkScalarBarActor::SetTitleTextProperty ( vtkTextProperty *  p )

virtual

Set/Get the title text property.

GetTitleTextProperty()

virtual vtkTextProperty * vtkScalarBarActor::GetTitleTextProperty ( )

virtual

Set/Get the title text property.

SetLabelTextProperty()

virtual void vtkScalarBarActor::SetLabelTextProperty ( vtkTextProperty *  p )

virtual

Set/Get the labels text property.

GetLabelTextProperty()

virtual vtkTextProperty * vtkScalarBarActor::GetLabelTextProperty ( )

virtual

Set/Get the labels text property.

SetAnnotationTextProperty()

virtual void vtkScalarBarActor::SetAnnotationTextProperty ( vtkTextProperty *  p )

virtual

Set/Get the annotation text property.

GetAnnotationTextProperty()

virtual vtkTextProperty * vtkScalarBarActor::GetAnnotationTextProperty ( )

virtual

Set/Get the annotation text property.

SetLabelFormat()

virtual void vtkScalarBarActor::SetLabelFormat ( const char *  )

virtual

Set/Get the format with which to print the labels on the scalar bar.

GetLabelFormat()

virtual char * vtkScalarBarActor::GetLabelFormat ( )

virtual

Set/Get the format with which to print the labels on the scalar bar.

SetTitle()

virtual void vtkScalarBarActor::SetTitle ( const char *  )

virtual

Set/Get the title of the scalar bar actor,.

GetTitle()

virtual char * vtkScalarBarActor::GetTitle ( )

virtual

Set/Get the title of the scalar bar actor,.

SetComponentTitle()

virtual void vtkScalarBarActor::SetComponentTitle ( const char *  )

virtual

Set/Get the title for the component that is selected,.

GetComponentTitle()

virtual char * vtkScalarBarActor::GetComponentTitle ( )

virtual

Set/Get the title for the component that is selected,.

ShallowCopy()

void vtkScalarBarActor::ShallowCopy ( vtkProp *  prop )

overridevirtual

Shallow copy of a scalar bar actor.

Overloads the virtual vtkProp method.

Reimplemented from vtkActor2D.

SetTextureGridWidth()

virtual void vtkScalarBarActor::SetTextureGridWidth ( double  )

virtual

Set the width of the texture grid.

Used only if UseOpacity is ON.

GetTextureGridWidth()

virtual double vtkScalarBarActor::GetTextureGridWidth ( )

virtual

Set the width of the texture grid.

Used only if UseOpacity is ON.

GetTextureActor()

virtual vtkTexturedActor2D * vtkScalarBarActor::GetTextureActor ( )

virtual

Get the texture actor.

. you may want to change some properties on it

SetTextPosition()

virtual void vtkScalarBarActor::SetTextPosition ( int  )

virtual

Should the title and tick marks precede the scalar bar or succeed it? This is measured along the viewport coordinate direction perpendicular to the long axis of the scalar bar, not the reading direction.

Thus, succeed implies the that the text is above scalar bar if the orientation is horizontal or right of scalar bar if the orientation is vertical. Precede is the opposite.

GetTextPosition()

virtual int vtkScalarBarActor::GetTextPosition ( )

virtual

Should the title and tick marks precede the scalar bar or succeed it? This is measured along the viewport coordinate direction perpendicular to the long axis of the scalar bar, not the reading direction.

Thus, succeed implies the that the text is above scalar bar if the orientation is horizontal or right of scalar bar if the orientation is vertical. Precede is the opposite.

SetTextPositionToPrecedeScalarBar()

virtual void vtkScalarBarActor::SetTextPositionToPrecedeScalarBar ( )

inlinevirtual

Should the title and tick marks precede the scalar bar or succeed it? This is measured along the viewport coordinate direction perpendicular to the long axis of the scalar bar, not the reading direction.

Thus, succeed implies the that the text is above scalar bar if the orientation is horizontal or right of scalar bar if the orientation is vertical. Precede is the opposite.

Definition at line 403 of file vtkScalarBarActor.h.

SetTextPositionToSucceedScalarBar()

virtual void vtkScalarBarActor::SetTextPositionToSucceedScalarBar ( )

inlinevirtual

Should the title and tick marks precede the scalar bar or succeed it? This is measured along the viewport coordinate direction perpendicular to the long axis of the scalar bar, not the reading direction.

Thus, succeed implies the that the text is above scalar bar if the orientation is horizontal or right of scalar bar if the orientation is vertical. Precede is the opposite.

Definition at line 407 of file vtkScalarBarActor.h.

SetMaximumWidthInPixels()

virtual void vtkScalarBarActor::SetMaximumWidthInPixels ( int  )

virtual

Set/Get the maximum width and height in pixels.

Specifying the size as a relative fraction of the viewport can sometimes undesirably stretch the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.

GetMaximumWidthInPixels()

virtual int vtkScalarBarActor::GetMaximumWidthInPixels ( )

virtual

Set/Get the maximum width and height in pixels.

Specifying the size as a relative fraction of the viewport can sometimes undesirably stretch the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.

SetMaximumHeightInPixels()

virtual void vtkScalarBarActor::SetMaximumHeightInPixels ( int  )

virtual

Set/Get the maximum width and height in pixels.

Specifying the size as a relative fraction of the viewport can sometimes undesirably stretch the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.

GetMaximumHeightInPixels()

virtual int vtkScalarBarActor::GetMaximumHeightInPixels ( )

virtual

Set/Get the maximum width and height in pixels.

Specifying the size as a relative fraction of the viewport can sometimes undesirably stretch the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.

SetAnnotationLeaderPadding()

virtual void vtkScalarBarActor::SetAnnotationLeaderPadding ( double  )

virtual

Set/get the padding between the scalar bar and the text annotations.

This space is used to draw leader lines. The default is 8 pixels.

GetAnnotationLeaderPadding()

virtual double vtkScalarBarActor::GetAnnotationLeaderPadding ( )

virtual

Set/get the padding between the scalar bar and the text annotations.

This space is used to draw leader lines. The default is 8 pixels.

SetDrawAnnotations()

virtual void vtkScalarBarActor::SetDrawAnnotations ( vtkTypeBool  )

virtual

Set/get whether text annotations should be rendered or not.

Currently, this only affects rendering when IndexedLookup is true. The default is true.

GetDrawAnnotations()

virtual vtkTypeBool vtkScalarBarActor::GetDrawAnnotations ( )

virtual

Set/get whether text annotations should be rendered or not.

Currently, this only affects rendering when IndexedLookup is true. The default is true.

DrawAnnotationsOn()

virtual void vtkScalarBarActor::DrawAnnotationsOn ( )

virtual

Set/get whether text annotations should be rendered or not.

Currently, this only affects rendering when IndexedLookup is true. The default is true.

DrawAnnotationsOff()

virtual void vtkScalarBarActor::DrawAnnotationsOff ( )

virtual

Set/get whether text annotations should be rendered or not.

Currently, this only affects rendering when IndexedLookup is true. The default is true.

SetDrawNanAnnotation()

virtual void vtkScalarBarActor::SetDrawNanAnnotation ( vtkTypeBool  )

virtual

Set/get whether the NaN annotation should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

GetDrawNanAnnotation()

virtual vtkTypeBool vtkScalarBarActor::GetDrawNanAnnotation ( )

virtual

Set/get whether the NaN annotation should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

DrawNanAnnotationOn()

virtual void vtkScalarBarActor::DrawNanAnnotationOn ( )

virtual

Set/get whether the NaN annotation should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

DrawNanAnnotationOff()

virtual void vtkScalarBarActor::DrawNanAnnotationOff ( )

virtual

Set/get whether the NaN annotation should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

SetDrawBelowRangeSwatch()

virtual void vtkScalarBarActor::SetDrawBelowRangeSwatch ( bool  )

virtual

Set/get whether the Below range swatch should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

GetDrawBelowRangeSwatch()

virtual bool vtkScalarBarActor::GetDrawBelowRangeSwatch ( )

virtual

Set/get whether the Below range swatch should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

DrawBelowRangeSwatchOn()

virtual void vtkScalarBarActor::DrawBelowRangeSwatchOn ( )

virtual

Set/get whether the Below range swatch should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

DrawBelowRangeSwatchOff()

virtual void vtkScalarBarActor::DrawBelowRangeSwatchOff ( )

virtual

Set/get whether the Below range swatch should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

SetBelowRangeAnnotation()

virtual void vtkScalarBarActor::SetBelowRangeAnnotation ( const char *  )

virtual

Set/get the annotation text for "Below Range" values.

GetBelowRangeAnnotation()

virtual char * vtkScalarBarActor::GetBelowRangeAnnotation ( )

virtual

Set/get the annotation text for "Below Range" values.

SetDrawAboveRangeSwatch()

virtual void vtkScalarBarActor::SetDrawAboveRangeSwatch ( bool  )

virtual

Set/get whether the Above range swatch should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

GetDrawAboveRangeSwatch()

virtual bool vtkScalarBarActor::GetDrawAboveRangeSwatch ( )

virtual

Set/get whether the Above range swatch should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

DrawAboveRangeSwatchOn()

virtual void vtkScalarBarActor::DrawAboveRangeSwatchOn ( )

virtual

Set/get whether the Above range swatch should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

DrawAboveRangeSwatchOff()

virtual void vtkScalarBarActor::DrawAboveRangeSwatchOff ( )

virtual

Set/get whether the Above range swatch should be rendered or not.

This only affects rendering when DrawAnnotations is true. The default is false.

SetAboveRangeAnnotation()

virtual void vtkScalarBarActor::SetAboveRangeAnnotation ( const char *  )

virtual

Set/get the annotation text for "Above Range Swatch" values.

GetAboveRangeAnnotation()

virtual char * vtkScalarBarActor::GetAboveRangeAnnotation ( )

virtual

Set/get the annotation text for "Above Range Swatch" values.

SetFixedAnnotationLeaderLineColor()

virtual void vtkScalarBarActor::SetFixedAnnotationLeaderLineColor ( vtkTypeBool  )

virtual

Set/get how leader lines connecting annotations to values should be colored.

When true, leader lines are all the same color (and match the LabelTextProperty color). When false, leader lines take on the color of the value they correspond to. This only affects rendering when DrawAnnotations is true. The default is false.

GetFixedAnnotationLeaderLineColor()

virtual vtkTypeBool vtkScalarBarActor::GetFixedAnnotationLeaderLineColor ( )

virtual

Set/get how leader lines connecting annotations to values should be colored.

When true, leader lines are all the same color (and match the LabelTextProperty color). When false, leader lines take on the color of the value they correspond to. This only affects rendering when DrawAnnotations is true. The default is false.

FixedAnnotationLeaderLineColorOn()

virtual void vtkScalarBarActor::FixedAnnotationLeaderLineColorOn ( )

virtual

Set/get how leader lines connecting annotations to values should be colored.

When true, leader lines are all the same color (and match the LabelTextProperty color). When false, leader lines take on the color of the value they correspond to. This only affects rendering when DrawAnnotations is true. The default is false.

FixedAnnotationLeaderLineColorOff()

virtual void vtkScalarBarActor::FixedAnnotationLeaderLineColorOff ( )

virtual

Set/get how leader lines connecting annotations to values should be colored.

When true, leader lines are all the same color (and match the LabelTextProperty color). When false, leader lines take on the color of the value they correspond to. This only affects rendering when DrawAnnotations is true. The default is false.

SetNanAnnotation()

virtual void vtkScalarBarActor::SetNanAnnotation ( const char *  )

virtual

Set/get the annotation text for "NaN" values.

GetNanAnnotation()

virtual char * vtkScalarBarActor::GetNanAnnotation ( )

virtual

Set/get the annotation text for "NaN" values.

SetAnnotationTextScaling()

virtual void vtkScalarBarActor::SetAnnotationTextScaling ( vtkTypeBool  )

virtual

Set/get whether annotation labels should be scaled with the viewport.

The default value is 0 (no scaling). If non-zero, the vtkTextActor instances used to render annotation labels will have their TextScaleMode set to viewport-based scaling, which nonlinearly scales font size with the viewport size.

GetAnnotationTextScaling()

virtual vtkTypeBool vtkScalarBarActor::GetAnnotationTextScaling ( )

virtual

Set/get whether annotation labels should be scaled with the viewport.

The default value is 0 (no scaling). If non-zero, the vtkTextActor instances used to render annotation labels will have their TextScaleMode set to viewport-based scaling, which nonlinearly scales font size with the viewport size.

AnnotationTextScalingOn()

virtual void vtkScalarBarActor::AnnotationTextScalingOn ( )

virtual

Set/get whether annotation labels should be scaled with the viewport.

The default value is 0 (no scaling). If non-zero, the vtkTextActor instances used to render annotation labels will have their TextScaleMode set to viewport-based scaling, which nonlinearly scales font size with the viewport size.

AnnotationTextScalingOff()

virtual void vtkScalarBarActor::AnnotationTextScalingOff ( )

virtual

Set/get whether annotation labels should be scaled with the viewport.

The default value is 0 (no scaling). If non-zero, the vtkTextActor instances used to render annotation labels will have their TextScaleMode set to viewport-based scaling, which nonlinearly scales font size with the viewport size.

SetDrawBackground()

virtual void vtkScalarBarActor::SetDrawBackground ( vtkTypeBool  )

virtual

Set/Get whether a background should be drawn around the scalar bar.

Default is off.

GetDrawBackground()

virtual vtkTypeBool vtkScalarBarActor::GetDrawBackground ( )

virtual

Set/Get whether a background should be drawn around the scalar bar.

Default is off.

DrawBackgroundOn()

virtual void vtkScalarBarActor::DrawBackgroundOn ( )

virtual

Set/Get whether a background should be drawn around the scalar bar.

Default is off.

DrawBackgroundOff()

virtual void vtkScalarBarActor::DrawBackgroundOff ( )

virtual

Set/Get whether a background should be drawn around the scalar bar.

Default is off.

SetDrawFrame()

virtual void vtkScalarBarActor::SetDrawFrame ( vtkTypeBool  )

virtual

Set/Get whether a frame should be drawn around the scalar bar.

Default is off.

GetDrawFrame()

virtual vtkTypeBool vtkScalarBarActor::GetDrawFrame ( )

virtual

Set/Get whether a frame should be drawn around the scalar bar.

Default is off.

DrawFrameOn()

virtual void vtkScalarBarActor::DrawFrameOn ( )

virtual

Set/Get whether a frame should be drawn around the scalar bar.

Default is off.

DrawFrameOff()

virtual void vtkScalarBarActor::DrawFrameOff ( )

virtual

Set/Get whether a frame should be drawn around the scalar bar.

Default is off.

SetDrawColorBar()

virtual void vtkScalarBarActor::SetDrawColorBar ( vtkTypeBool  )

virtual

Set/Get whether the color bar should be drawn.

If off, only the tickmarks and text will be drawn. Default is on.

GetDrawColorBar()

virtual vtkTypeBool vtkScalarBarActor::GetDrawColorBar ( )

virtual

Set/Get whether the color bar should be drawn.

If off, only the tickmarks and text will be drawn. Default is on.

DrawColorBarOn()

virtual void vtkScalarBarActor::DrawColorBarOn ( )

virtual

Set/Get whether the color bar should be drawn.

If off, only the tickmarks and text will be drawn. Default is on.

DrawColorBarOff()

virtual void vtkScalarBarActor::DrawColorBarOff ( )

virtual

Set/Get whether the color bar should be drawn.

If off, only the tickmarks and text will be drawn. Default is on.

SetDrawTickLabels()

virtual void vtkScalarBarActor::SetDrawTickLabels ( vtkTypeBool  )

virtual

Set/Get whether the tick labels should be drawn.

Default is on.

GetDrawTickLabels()

virtual vtkTypeBool vtkScalarBarActor::GetDrawTickLabels ( )

virtual

Set/Get whether the tick labels should be drawn.

Default is on.

DrawTickLabelsOn()

virtual void vtkScalarBarActor::DrawTickLabelsOn ( )

virtual

Set/Get whether the tick labels should be drawn.

Default is on.

DrawTickLabelsOff()

virtual void vtkScalarBarActor::DrawTickLabelsOff ( )

virtual

Set/Get whether the tick labels should be drawn.

Default is on.

SetBackgroundProperty()

virtual void vtkScalarBarActor::SetBackgroundProperty ( vtkProperty2D *  p )

virtual

Set/Get the background property.

GetBackgroundProperty()

virtual vtkProperty2D * vtkScalarBarActor::GetBackgroundProperty ( )

virtual

Set/Get the background property.

SetFrameProperty()

virtual void vtkScalarBarActor::SetFrameProperty ( vtkProperty2D *  p )

virtual

Set/Get the frame property.

GetFrameProperty()

virtual vtkProperty2D * vtkScalarBarActor::GetFrameProperty ( )

virtual

Set/Get the frame property.

GetTextPad()

virtual int vtkScalarBarActor::GetTextPad ( )

virtual

Set/get the amount of padding around text boxes.

The default is 1 pixel.

SetTextPad()

virtual void vtkScalarBarActor::SetTextPad ( int  )

virtual

Set/get the amount of padding around text boxes.

The default is 1 pixel.

GetVerticalTitleSeparation()

virtual int vtkScalarBarActor::GetVerticalTitleSeparation ( )

virtual

Set/get the margin in pixels, between the title and the bar, when the Orientation is vertical.

The default is 0 pixels.

SetVerticalTitleSeparation()

virtual void vtkScalarBarActor::SetVerticalTitleSeparation ( int  )

virtual

Set/get the margin in pixels, between the title and the bar, when the Orientation is vertical.

The default is 0 pixels.

GetBarRatio()

virtual double vtkScalarBarActor::GetBarRatio ( )

virtual

Set/get the thickness of the color bar relative to the widget frame.

The default is 0.375 and must always be in the range ]0, 1[.

SetBarRatio()

virtual void vtkScalarBarActor::SetBarRatio ( double  )

virtual

Set/get the thickness of the color bar relative to the widget frame.

The default is 0.375 and must always be in the range ]0, 1[.

GetTitleRatio()

virtual double vtkScalarBarActor::GetTitleRatio ( )

virtual

Set/get the ratio of the title height to the tick label height (used only when the Orientation is horizontal).

The default is 0.5, which attempts to make the labels and title the same size. This must be a number in the range ]0, 1[.

SetTitleRatio()

virtual void vtkScalarBarActor::SetTitleRatio ( double  )

virtual

Set/get the ratio of the title height to the tick label height (used only when the Orientation is horizontal).

The default is 0.5, which attempts to make the labels and title the same size. This must be a number in the range ]0, 1[.

SetUnconstrainedFontSize()

virtual void vtkScalarBarActor::SetUnconstrainedFontSize ( bool  )

virtual

Set/Get whether the font size of title and labels is unconstrained.

Default is off. When it is constrained, the size of the scalar bar will constrain the font size. When it is not, the size of the font will always be respected. Using custom labels will force this mode to be on.

GetUnconstrainedFontSize()

virtual bool vtkScalarBarActor::GetUnconstrainedFontSize ( )

virtual

Set/Get whether the font size of title and labels is unconstrained.

Default is off. When it is constrained, the size of the scalar bar will constrain the font size. When it is not, the size of the font will always be respected. Using custom labels will force this mode to be on.

UnconstrainedFontSizeOn()

virtual void vtkScalarBarActor::UnconstrainedFontSizeOn ( )

virtual

Set/Get whether the font size of title and labels is unconstrained.

Default is off. When it is constrained, the size of the scalar bar will constrain the font size. When it is not, the size of the font will always be respected. Using custom labels will force this mode to be on.

UnconstrainedFontSizeOff()

virtual void vtkScalarBarActor::UnconstrainedFontSizeOff ( )

virtual

Set/Get whether the font size of title and labels is unconstrained.

Default is off. When it is constrained, the size of the scalar bar will constrain the font size. When it is not, the size of the font will always be respected. Using custom labels will force this mode to be on.

RebuildLayout()

virtual void vtkScalarBarActor::RebuildLayout ( vtkViewport *  viewport )

protectedvirtual

Called from within RenderOpaqueGeometry when the internal state members need to be updated before rendering.

This method invokes many virtual methods that first lay out the scalar bar and then use the layout to position actors and create datasets used to represent the scalar bar. Specifically, it invokes: FreeLayoutStorage, ComputeFrame, ComputeScalarBarThickness, LayoutNanSwatch, PrepareTitleText, LayoutTitle, ComputeScalarBarLength, LayoutTicks, and LayoutAnnotations to perform the layout step. Then, it invokes ConfigureAnnotations, ConfigureFrame, ConfigureScalarBar, ConfigureTitle, ConfigureTicks, and ConfigureNanSwatch to create and position actors used to render portions of the scalar bar.

By overriding one or more of these virtual methods, subclasses may change the appearance of the scalar bar.

In the layout phase, text actors must have their text properties and input strings updated, but the position of the actors should not be set or relied upon as subsequent layout steps may alter their placement.

RebuildLayoutIfNeeded()

virtual int vtkScalarBarActor::RebuildLayoutIfNeeded ( vtkViewport *  viewport )

protectedvirtual

Calls RebuildLayout if it is needed such as when positions etc have changed.

Return 1 on success zero on error

FreeLayoutStorage()

virtual void vtkScalarBarActor::FreeLayoutStorage ( )

protectedvirtual

Free internal storage used by the previous layout.

ComputeFrame()

virtual void vtkScalarBarActor::ComputeFrame ( )

protectedvirtual

If the scalar bar should be inset into a frame or rendered with a solid background, this method will inset the outermost scalar bar rectangle by a small amount to avoid having the scalar bar illustration overlap any edges.

This method must set the frame coordinates (this->P->Frame).

ComputeScalarBarThickness()

virtual void vtkScalarBarActor::ComputeScalarBarThickness ( )

protectedvirtual

Determine how thick the scalar bar should be (on an axis perpendicular to the direction in which scalar values vary).

This method must set the scalar bar thickness (this->P->ScalarBarBox.Size[0]). It may depend on layout performed by ComputeFrame (i.e., the frame coordinates in this->P->Frame).

ComputeSwatchPad()

virtual void vtkScalarBarActor::ComputeSwatchPad ( )

protectedvirtual

Compute a correct SwatchPad.

LayoutNanSwatch()

virtual void vtkScalarBarActor::LayoutNanSwatch ( )

protectedvirtual

LayoutBelowRangeSwatch()

virtual void vtkScalarBarActor::LayoutBelowRangeSwatch ( )

protectedvirtual

Determine the size of the Below Range if it is to be rendered.

This method must set this->P->BelowSwatchSize and this->P->BelowBox. It may depend on layout performed by ComputeScalarBarThickness.

LayoutAboveRangeSwatch()

virtual void vtkScalarBarActor::LayoutAboveRangeSwatch ( )

protectedvirtual

Determine the size of the Above Range if it is to be rendered.

This method must set this->P->AboveBox. It may depend on layout performed by ComputeScalarBarThickness.

LayoutAboveRangeSwatchPosn()

virtual void vtkScalarBarActor::LayoutAboveRangeSwatchPosn ( )

protectedvirtual

Determine the position of the Above Range if it is to be rendered.

This method must set this->P->AboveRangeSize. It may depend on layout performed by ComputeScalarBarLength.

PrepareTitleText()

virtual void vtkScalarBarActor::PrepareTitleText ( )

protectedvirtual

Set the title actor's input to the latest title (and subtitle) text.

LayoutTitle()

virtual void vtkScalarBarActor::LayoutTitle ( )

protectedvirtual

Determine the position and size of the scalar bar title box.

This method must set this->P->TitleBox It may depend on layout performed by LayoutNanSwatch. If useTickBox is true, it should increase the target area for the label to touch the tick box. It is called in this way when the tick labels are small due to constraints other than the title box.

LayoutForUnconstrainedFont()

virtual void vtkScalarBarActor::LayoutForUnconstrainedFont ( )

protectedvirtual

This method sets the title and tick-box size and position for the UnconstrainedFontSize mode.

ComputeScalarBarLength()

virtual void vtkScalarBarActor::ComputeScalarBarLength ( )

protectedvirtual

Determine how long the scalar bar should be (on an axis parallel to the direction in which scalar values vary).

This method must set this->P->ScalarBarBox.Size[1] and should estimate this->P->ScalarBarBox.Posn. It may depend on layout performed by LayoutTitle.

LayoutTicks()

virtual void vtkScalarBarActor::LayoutTicks ( )

protectedvirtual

Determine the size and placement of any tick marks to be rendered.

This method must set this->P->TickBox. It may depend on layout performed by ComputeScalarBarLength.

The default implementation creates exactly this->NumberOfLabels tick marks, uniformly spaced on a linear or logarithmic scale, or creates them based on the numbers and values this->CustomLabels when this->UseCustomLabels is true.

LayoutAnnotations()

virtual void vtkScalarBarActor::LayoutAnnotations ( )

protectedvirtual

This method must lay out annotation text and leader lines so they do not overlap.

This method must set this->P->AnnotationAnchors. It may depend on layout performed by LayoutTicks.

ConfigureAnnotations()

virtual void vtkScalarBarActor::ConfigureAnnotations ( )

protectedvirtual

Generate/configure the annotation labels using the laid-out geometry.

ConfigureFrame()

virtual void vtkScalarBarActor::ConfigureFrame ( )

protectedvirtual

Generate/configure the representation of the frame from laid-out geometry.

DrawBoxes()

virtual void vtkScalarBarActor::DrawBoxes ( )

protectedvirtual

For debugging, add placement boxes to the frame polydata.

ConfigureScalarBar()

virtual void vtkScalarBarActor::ConfigureScalarBar ( )

protectedvirtual

Generate/configure the scalar bar representation from laid-out geometry.

ConfigureTitle()

virtual void vtkScalarBarActor::ConfigureTitle ( )

protectedvirtual

Generate/configure the title actor using the laid-out geometry.

ConfigureTicks()

virtual void vtkScalarBarActor::ConfigureTicks ( )

protectedvirtual

Generate/configure the tick-mark actors using the laid-out geometry.

ConfigureNanSwatch()

virtual void vtkScalarBarActor::ConfigureNanSwatch ( )

protectedvirtual

Generate/configure the NaN swatch using the laid-out geometry.

Currently the NaN swatch is rendered by the same actor as the scalar bar. This may change in the future.

ConfigureAboveBelowRangeSwatch()

virtual void vtkScalarBarActor::ConfigureAboveBelowRangeSwatch ( bool  above )

protectedvirtual

Generate/configure the above/below range swatch using the laid-out geometry.

EditAnnotations()

virtual void vtkScalarBarActor::EditAnnotations ( )

inlineprotectedvirtual

Subclasses may override this method to alter this->P->Labels, allowing the addition and removal of annotations.

The member maps viewport coordinates along the long axis of the scalar bar to text (which may include MathText; see vtkTextActor). It is a single-valued map, so you must perturb the coordinate if you wish multiple labels to annotate the same position. Each entry in this->P->Labels must have a matching entry in this->P->LabelColors.

Definition at line 841 of file vtkScalarBarActor.h.

SizeTitle()

virtual void vtkScalarBarActor::SizeTitle ( double *  titleSize, int *  size, vtkViewport *  viewport  )

protectedvirtual

Compute the best size for the legend title.

This guarantees that the title will fit within the frame defined by Position and Position2.

MapAnnotationLabels()

int vtkScalarBarActor::MapAnnotationLabels ( vtkScalarsToColors *  lkup, double  start, double  delta, const double *  range  )

protected

Allocate actors for lookup table annotations and position them properly.

PlaceAnnotationsVertically()

int vtkScalarBarActor::PlaceAnnotationsVertically ( double  barX, double  barY, double  barWidth, double  barHeight, double  delta, double  pad  )

protected

This method is called by ConfigureAnnotationLabels when Orientation is VTK_ORIENT_VERTICAL.

PlaceAnnotationsHorizontally()

int vtkScalarBarActor::PlaceAnnotationsHorizontally ( double  barX, double  barY, double  barWidth, double  barHeight, double  delta, double  pad  )

protected

This method is called by ConfigureAnnotationLabels when Orientation is VTK_ORIENT_HORIZONTAL.

Member Data Documentation

MaximumNumberOfColors

int vtkScalarBarActor::MaximumNumberOfColors

protected

User-changeable settings.

Definition at line 870 of file vtkScalarBarActor.h.

NumberOfLabels

int vtkScalarBarActor::NumberOfLabels

protected

User-changeable settings.

Definition at line 871 of file vtkScalarBarActor.h.

NumberOfLabelsBuilt

int vtkScalarBarActor::NumberOfLabelsBuilt

protected

User-changeable settings.

Definition at line 872 of file vtkScalarBarActor.h.

Orientation

int vtkScalarBarActor::Orientation

protected

User-changeable settings.

Definition at line 873 of file vtkScalarBarActor.h.

CustomLabels

vtkDoubleArray* vtkScalarBarActor::CustomLabels = nullptr

protected

User-changeable settings.

Definition at line 874 of file vtkScalarBarActor.h.

UseCustomLabels

bool vtkScalarBarActor::UseCustomLabels = false

protected

User-changeable settings.

Definition at line 875 of file vtkScalarBarActor.h.

DrawBackground

vtkTypeBool vtkScalarBarActor::DrawBackground

protected

User-changeable settings.

Definition at line 876 of file vtkScalarBarActor.h.

DrawFrame

vtkTypeBool vtkScalarBarActor::DrawFrame

protected

User-changeable settings.

Definition at line 877 of file vtkScalarBarActor.h.

DrawColorBar

vtkTypeBool vtkScalarBarActor::DrawColorBar

protected

User-changeable settings.

Definition at line 878 of file vtkScalarBarActor.h.

DrawTickLabels

vtkTypeBool vtkScalarBarActor::DrawTickLabels

protected

User-changeable settings.

Definition at line 879 of file vtkScalarBarActor.h.

DrawAnnotations

vtkTypeBool vtkScalarBarActor::DrawAnnotations

protected

User-changeable settings.

Definition at line 880 of file vtkScalarBarActor.h.

DrawNanAnnotation

vtkTypeBool vtkScalarBarActor::DrawNanAnnotation

protected

User-changeable settings.

Definition at line 881 of file vtkScalarBarActor.h.

AnnotationTextScaling

vtkTypeBool vtkScalarBarActor::AnnotationTextScaling

protected

User-changeable settings.

Definition at line 882 of file vtkScalarBarActor.h.

FixedAnnotationLeaderLineColor

vtkTypeBool vtkScalarBarActor::FixedAnnotationLeaderLineColor

protected

User-changeable settings.

Definition at line 883 of file vtkScalarBarActor.h.

BackgroundProperty

vtkProperty2D* vtkScalarBarActor::BackgroundProperty

protected

User-changeable settings.

Definition at line 884 of file vtkScalarBarActor.h.

FrameProperty

vtkProperty2D* vtkScalarBarActor::FrameProperty

protected

User-changeable settings.

Definition at line 885 of file vtkScalarBarActor.h.

Title

char* vtkScalarBarActor::Title

protected

User-changeable settings.

Definition at line 886 of file vtkScalarBarActor.h.

ComponentTitle

char* vtkScalarBarActor::ComponentTitle

protected

User-changeable settings.

Definition at line 887 of file vtkScalarBarActor.h.

LabelFormat

char* vtkScalarBarActor::LabelFormat

protected

User-changeable settings.

Definition at line 888 of file vtkScalarBarActor.h.

UseOpacity

vtkTypeBool vtkScalarBarActor::UseOpacity

protected

User-changeable settings.

Definition at line 889 of file vtkScalarBarActor.h.

TextureGridWidth

double vtkScalarBarActor::TextureGridWidth

protected

User-changeable settings.

Definition at line 890 of file vtkScalarBarActor.h.

TextPosition

int vtkScalarBarActor::TextPosition

protected

User-changeable settings.

Definition at line 891 of file vtkScalarBarActor.h.

NanAnnotation

char* vtkScalarBarActor::NanAnnotation

protected

User-changeable settings.

Definition at line 892 of file vtkScalarBarActor.h.

BelowRangeAnnotation

char* vtkScalarBarActor::BelowRangeAnnotation

protected

User-changeable settings.

Definition at line 893 of file vtkScalarBarActor.h.

AboveRangeAnnotation

char* vtkScalarBarActor::AboveRangeAnnotation

protected

User-changeable settings.

Definition at line 894 of file vtkScalarBarActor.h.

AnnotationLeaderPadding

double vtkScalarBarActor::AnnotationLeaderPadding

protected

User-changeable settings.

Definition at line 895 of file vtkScalarBarActor.h.

MaximumWidthInPixels

int vtkScalarBarActor::MaximumWidthInPixels

protected

User-changeable settings.

Definition at line 896 of file vtkScalarBarActor.h.

MaximumHeightInPixels

int vtkScalarBarActor::MaximumHeightInPixels

protected

User-changeable settings.

Definition at line 897 of file vtkScalarBarActor.h.

TextPad

int vtkScalarBarActor::TextPad

protected

User-changeable settings.

Definition at line 898 of file vtkScalarBarActor.h.

VerticalTitleSeparation

int vtkScalarBarActor::VerticalTitleSeparation

protected

User-changeable settings.

Definition at line 899 of file vtkScalarBarActor.h.

BarRatio

double vtkScalarBarActor::BarRatio

protected

User-changeable settings.

Definition at line 900 of file vtkScalarBarActor.h.

TitleRatio

double vtkScalarBarActor::TitleRatio

protected

User-changeable settings.

Definition at line 901 of file vtkScalarBarActor.h.

UnconstrainedFontSize

bool vtkScalarBarActor::UnconstrainedFontSize

protected

User-changeable settings.

Definition at line 902 of file vtkScalarBarActor.h.

ForceVerticalTitle

bool vtkScalarBarActor::ForceVerticalTitle

protected

User-changeable settings.

Definition at line 903 of file vtkScalarBarActor.h.

DrawBelowRangeSwatch

bool vtkScalarBarActor::DrawBelowRangeSwatch

protected

User-changeable settings.

Definition at line 905 of file vtkScalarBarActor.h.

DrawAboveRangeSwatch

bool vtkScalarBarActor::DrawAboveRangeSwatch

protected

User-changeable settings.

Definition at line 906 of file vtkScalarBarActor.h.

BuildTime

vtkTimeStamp vtkScalarBarActor::BuildTime

protected

Internal state used for rendering.

Last time internal state changed.

Definition at line 911 of file vtkScalarBarActor.h.

LastSize

int vtkScalarBarActor::LastSize[2]

protected

Projected size in viewport coordinates of last build.

Definition at line 912 of file vtkScalarBarActor.h.

LastOrigin

int vtkScalarBarActor::LastOrigin[2]

protected

Projected origin (viewport coordinates) of last build.

Definition at line 913 of file vtkScalarBarActor.h.

P

vtkScalarBarActorInternal* vtkScalarBarActor::P

protected

Containers shared with subclasses.

Definition at line 915 of file vtkScalarBarActor.h.

LookupTable

vtkScalarsToColors* vtkScalarBarActor::LookupTable

protected

The object this actor illustrates.

Definition at line 917 of file vtkScalarBarActor.h.

OpacityFunction

vtkPiecewiseFunction* vtkScalarBarActor::OpacityFunction

protected

The opacity function if UseOpacity is true.

Definition at line 918 of file vtkScalarBarActor.h.

TitleTextProperty

vtkTextProperty* vtkScalarBarActor::TitleTextProperty

protected

Font for the legend title.

Definition at line 920 of file vtkScalarBarActor.h.

LabelTextProperty

vtkTextProperty* vtkScalarBarActor::LabelTextProperty

protected

Font for tick labels.

Definition at line 921 of file vtkScalarBarActor.h.

AnnotationTextProperty

vtkTextProperty* vtkScalarBarActor::AnnotationTextProperty

protected

Font for annotation labels.

Definition at line 922 of file vtkScalarBarActor.h.

TitleActor

vtkTextActor* vtkScalarBarActor::TitleActor

protected

The legend title text renderer.

Definition at line 923 of file vtkScalarBarActor.h.

ScalarBar

vtkPolyData* vtkScalarBarActor::ScalarBar

protected

Polygon(s) colored by LookupTable.

Definition at line 925 of file vtkScalarBarActor.h.

ScalarBarMapper

vtkPolyDataMapper2D* vtkScalarBarActor::ScalarBarMapper

protected

Mapper for ScalarBar.

Definition at line 926 of file vtkScalarBarActor.h.

ScalarBarActor

vtkActor2D* vtkScalarBarActor::ScalarBarActor

protected

Actor for ScalarBar.

Definition at line 927 of file vtkScalarBarActor.h.

TexturePolyData

vtkPolyData* vtkScalarBarActor::TexturePolyData

protected

Polygon colored when UseOpacity is true.

Definition at line 928 of file vtkScalarBarActor.h.

Texture

vtkTexture* vtkScalarBarActor::Texture

protected

Color data for TexturePolyData.

Definition at line 929 of file vtkScalarBarActor.h.

TextureActor

vtkTexturedActor2D* vtkScalarBarActor::TextureActor

protected

Actor for TexturePolyData.

Definition at line 930 of file vtkScalarBarActor.h.

Background

vtkPolyData* vtkScalarBarActor::Background

protected

Polygon used to fill the background.

Definition at line 932 of file vtkScalarBarActor.h.

BackgroundMapper

vtkPolyDataMapper2D* vtkScalarBarActor::BackgroundMapper

protected

Mapper for Background.

Definition at line 933 of file vtkScalarBarActor.h.

BackgroundActor

vtkActor2D* vtkScalarBarActor::BackgroundActor

protected

Actor for Background.

Definition at line 934 of file vtkScalarBarActor.h.

Frame

vtkPolyData* vtkScalarBarActor::Frame

protected

Polyline used to highlight frame.

Definition at line 936 of file vtkScalarBarActor.h.

FrameMapper

vtkPolyDataMapper2D* vtkScalarBarActor::FrameMapper

protected

Mapper for Frame.

Definition at line 937 of file vtkScalarBarActor.h.

FrameActor

vtkActor2D* vtkScalarBarActor::FrameActor

protected

Actor for Frame.

Definition at line 938 of file vtkScalarBarActor.h.

---

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

• Rendering/Annotation/vtkScalarBarActor.h