A scalar bar with labels of fixed font. More...

#include <vtkPVScalarBarActor.h>

Inheritance diagram for vtkPVScalarBarActor:

Collaboration diagram for vtkPVScalarBarActor:

[legend]

Public Types
typedef vtkScalarBarActor	Superclass

Public Types inherited from vtkScalarBarActor
typedef vtkActor2D	Superclass

Public Types inherited from vtkActor2D
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	AddValueLabelIfUnoccluded (double value, double pos, double diff)
	Add value as annotation label on scalar bar at the given position. More...

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor. More...

int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Overridden to sync internal variables with renderer state. More...

int	RenderOverlay (vtkViewport *viewport) override
	Draw the scalar bar and annotation text to the screen. More...


virtual double	GetAspectRatio ()
	The bar aspect ratio (length/width). More...

virtual void	SetAspectRatio (double)
	The bar aspect ratio (length/width). More...


virtual int	GetAutomaticLabelFormat ()
	If true (the default), the printf format used for the labels will be automatically generated to make the numbers best fit within the widget. More...

virtual void	SetAutomaticLabelFormat (int)
	If true (the default), the printf format used for the labels will be automatically generated to make the numbers best fit within the widget. More...

virtual void	AutomaticLabelFormatOn ()
	If true (the default), the printf format used for the labels will be automatically generated to make the numbers best fit within the widget. More...

virtual void	AutomaticLabelFormatOff ()
	If true (the default), the printf format used for the labels will be automatically generated to make the numbers best fit within the widget. More...


virtual int	GetDrawTickMarks ()
	If true (the default), tick marks will be drawn. More...

virtual void	SetDrawTickMarks (int)
	If true (the default), tick marks will be drawn. More...

virtual void	DrawTickMarksOn ()
	If true (the default), tick marks will be drawn. More...

virtual void	DrawTickMarksOff ()
	If true (the default), tick marks will be drawn. More...


virtual int	GetDrawSubTickMarks ()
	If true (the default), sub-tick marks will be drawn. More...

virtual void	SetDrawSubTickMarks (int)
	If true (the default), sub-tick marks will be drawn. More...

virtual void	DrawSubTickMarksOn ()
	If true (the default), sub-tick marks will be drawn. More...

virtual void	DrawSubTickMarksOff ()
	If true (the default), sub-tick marks will be drawn. More...


virtual int	GetAddRangeLabels ()
	Set whether the range endpoints (minimum and maximum) are added as labels alongside other value labels. More...

virtual void	SetAddRangeLabels (int)
	Set whether the range endpoints (minimum and maximum) are added as labels alongside other value labels. More...

virtual void	AddRangeLabelsOn ()
	Set whether the range endpoints (minimum and maximum) are added as labels alongside other value labels. More...

virtual void	AddRangeLabelsOff ()
	Set whether the range endpoints (minimum and maximum) are added as labels alongside other value labels. More...


virtual void	SetAutomaticAnnotations (int)
	Set whether annotions are automatically created according the number of discrete colors. More...

virtual int	GetAutomaticAnnotations ()
	Set whether annotions are automatically created according the number of discrete colors. More...

virtual void	AutomaticAnnotationsOn ()
	Set whether annotions are automatically created according the number of discrete colors. More...

virtual void	AutomaticAnnotationsOff ()
	Set whether annotions are automatically created according the number of discrete colors. More...


virtual char *	GetRangeLabelFormat ()
	Set the C-style format string for the range labels. More...

virtual void	SetRangeLabelFormat (const char *)
	Set the C-style format string for the range labels. More...


virtual int	GetTitleJustification ()
	Set the title justification. More...

virtual void	SetTitleJustification (int)
	Set the title justification. More...


virtual int	GetAddRangeAnnotations ()
	Set whether the scalar data range endpoints (minimum and maximum) are added as annotations. More...

virtual void	SetAddRangeAnnotations (int)
	Set whether the scalar data range endpoints (minimum and maximum) are added as annotations. More...

virtual void	AddRangeAnnotationsOn ()
	Set whether the scalar data range endpoints (minimum and maximum) are added as annotations. More...

virtual void	AddRangeAnnotationsOff ()
	Set whether the scalar data range endpoints (minimum and maximum) are added as annotations. More...

Public Member Functions inherited from vtkScalarBarActor
vtkScalarBarActor *	NewInstance () const

virtual int	HasTranslucentPolygonalGeometry ()

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

void	ShallowCopy (vtkProp *prop)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual void	SetLookupTable (vtkScalarsToColors *)

virtual vtkScalarsToColors *	GetLookupTable ()

virtual void	SetUseOpacity (int)

virtual int	GetUseOpacity ()

virtual void	UseOpacityOn ()

virtual void	UseOpacityOff ()

virtual void	SetMaximumNumberOfColors (int)

virtual int	GetMaximumNumberOfColors ()

virtual void	SetNumberOfLabels (int)

virtual int	GetNumberOfLabels ()

virtual void	SetOrientation (int)

virtual int	GetOrientation ()

void	SetOrientationToHorizontal ()

void	SetOrientationToVertical ()

virtual void	SetTitleTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetTitleTextProperty ()

virtual void	SetLabelTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetLabelTextProperty ()

virtual void	SetAnnotationTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetAnnotationTextProperty ()

virtual void	SetLabelFormat (const char *)

virtual char *	GetLabelFormat ()

virtual void	SetTitle (const char *)

virtual char *	GetTitle ()

virtual void	SetComponentTitle (const char *)

virtual char *	GetComponentTitle ()

virtual void	SetTextureGridWidth (double)

virtual double	GetTextureGridWidth ()

virtual vtkTexturedActor2D *	GetTextureActor ()

virtual void	SetTextPosition (int)

virtual int	GetTextPosition ()

virtual void	SetTextPositionToPrecedeScalarBar ()

virtual void	SetTextPositionToSucceedScalarBar ()

virtual void	SetMaximumWidthInPixels (int)

virtual int	GetMaximumWidthInPixels ()

virtual void	SetMaximumHeightInPixels (int)

virtual int	GetMaximumHeightInPixels ()

virtual void	SetAnnotationLeaderPadding (double)

virtual double	GetAnnotationLeaderPadding ()

virtual void	SetDrawAnnotations (int)

virtual int	GetDrawAnnotations ()

virtual void	DrawAnnotationsOn ()

virtual void	DrawAnnotationsOff ()

virtual void	SetDrawNanAnnotation (int)

virtual int	GetDrawNanAnnotation ()

virtual void	DrawNanAnnotationOn ()

virtual void	DrawNanAnnotationOff ()

virtual void	SetDrawBelowRangeSwatch (bool)

virtual bool	GetDrawBelowRangeSwatch ()

virtual void	DrawBelowRangeSwatchOn ()

virtual void	DrawBelowRangeSwatchOff ()

virtual void	SetBelowRangeAnnotation (const char *)

virtual char *	GetBelowRangeAnnotation ()

virtual void	SetDrawAboveRangeSwatch (bool)

virtual bool	GetDrawAboveRangeSwatch ()

virtual void	DrawAboveRangeSwatchOn ()

virtual void	DrawAboveRangeSwatchOff ()

virtual void	SetAboveRangeAnnotation (const char *)

virtual char *	GetAboveRangeAnnotation ()

virtual void	SetFixedAnnotationLeaderLineColor (int)

virtual int	GetFixedAnnotationLeaderLineColor ()

virtual void	FixedAnnotationLeaderLineColorOn ()

virtual void	FixedAnnotationLeaderLineColorOff ()

virtual void	SetNanAnnotation (const char *)

virtual char *	GetNanAnnotation ()

virtual void	SetAnnotationTextScaling (int)

virtual int	GetAnnotationTextScaling ()

virtual void	AnnotationTextScalingOn ()

virtual void	AnnotationTextScalingOff ()

virtual void	SetDrawBackground (int)

virtual int	GetDrawBackground ()

virtual void	DrawBackgroundOn ()

virtual void	DrawBackgroundOff ()

virtual void	SetDrawFrame (int)

virtual int	GetDrawFrame ()

virtual void	DrawFrameOn ()

virtual void	DrawFrameOff ()

virtual void	SetDrawColorBar (int)

virtual int	GetDrawColorBar ()

virtual void	DrawColorBarOn ()

virtual void	DrawColorBarOff ()

virtual void	SetDrawTickLabels (int)

virtual int	GetDrawTickLabels ()

virtual void	DrawTickLabelsOn ()

virtual void	DrawTickLabelsOff ()

virtual void	SetBackgroundProperty (vtkProperty2D *p)

virtual vtkProperty2D *	GetBackgroundProperty ()

virtual void	SetFrameProperty (vtkProperty2D *p)

virtual vtkProperty2D *	GetFrameProperty ()

virtual int	GetTextPad ()

virtual void	SetTextPad (int)

virtual int	GetVerticalTitleSeparation ()

virtual void	SetVerticalTitleSeparation (int)

virtual double	GetBarRatio ()

virtual void	SetBarRatio (double)

virtual double	GetTitleRatio ()

virtual void	SetTitleRatio (double)

virtual void	SetUnconstrainedFontSize (bool)

virtual bool	GetUnconstrainedFontSize ()

virtual void	UnconstrainedFontSizeOn ()

virtual void	UnconstrainedFontSizeOff ()

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual void	SetLookupTable (vtkScalarsToColors *)

virtual vtkScalarsToColors *	GetLookupTable ()

virtual void	SetUseOpacity (int)

virtual int	GetUseOpacity ()

virtual void	UseOpacityOn ()

virtual void	UseOpacityOff ()

virtual void	SetMaximumNumberOfColors (int)

virtual int	GetMaximumNumberOfColors ()

virtual void	SetNumberOfLabels (int)

virtual int	GetNumberOfLabels ()

virtual void	SetOrientation (int)

virtual int	GetOrientation ()

void	SetOrientationToHorizontal ()

void	SetOrientationToVertical ()

virtual void	SetTitleTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetTitleTextProperty ()

virtual void	SetLabelTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetLabelTextProperty ()

virtual void	SetAnnotationTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetAnnotationTextProperty ()

virtual void	SetLabelFormat (const char *)

virtual char *	GetLabelFormat ()

virtual void	SetTitle (const char *)

virtual char *	GetTitle ()

virtual void	SetComponentTitle (const char *)

virtual char *	GetComponentTitle ()

virtual void	SetTextureGridWidth (double)

virtual double	GetTextureGridWidth ()

virtual vtkTexturedActor2D *	GetTextureActor ()

virtual void	SetTextPosition (int)

virtual int	GetTextPosition ()

virtual void	SetTextPositionToPrecedeScalarBar ()

virtual void	SetTextPositionToSucceedScalarBar ()

virtual void	SetMaximumWidthInPixels (int)

virtual int	GetMaximumWidthInPixels ()

virtual void	SetMaximumHeightInPixels (int)

virtual int	GetMaximumHeightInPixels ()

virtual void	SetAnnotationLeaderPadding (double)

virtual double	GetAnnotationLeaderPadding ()

virtual void	SetDrawAnnotations (int)

virtual int	GetDrawAnnotations ()

virtual void	DrawAnnotationsOn ()

virtual void	DrawAnnotationsOff ()

virtual void	SetDrawNanAnnotation (int)

virtual int	GetDrawNanAnnotation ()

virtual void	DrawNanAnnotationOn ()

virtual void	DrawNanAnnotationOff ()

virtual void	SetDrawBelowRangeSwatch (bool)

virtual bool	GetDrawBelowRangeSwatch ()

virtual void	DrawBelowRangeSwatchOn ()

virtual void	DrawBelowRangeSwatchOff ()

virtual void	SetBelowRangeAnnotation (const char *)

virtual char *	GetBelowRangeAnnotation ()

virtual void	SetDrawAboveRangeSwatch (bool)

virtual bool	GetDrawAboveRangeSwatch ()

virtual void	DrawAboveRangeSwatchOn ()

virtual void	DrawAboveRangeSwatchOff ()

virtual void	SetAboveRangeAnnotation (const char *)

virtual char *	GetAboveRangeAnnotation ()

virtual void	SetFixedAnnotationLeaderLineColor (int)

virtual int	GetFixedAnnotationLeaderLineColor ()

virtual void	FixedAnnotationLeaderLineColorOn ()

virtual void	FixedAnnotationLeaderLineColorOff ()

virtual void	SetNanAnnotation (const char *)

virtual char *	GetNanAnnotation ()

virtual void	SetAnnotationTextScaling (int)

virtual int	GetAnnotationTextScaling ()

virtual void	AnnotationTextScalingOn ()

virtual void	AnnotationTextScalingOff ()

virtual void	SetDrawBackground (int)

virtual int	GetDrawBackground ()

virtual void	DrawBackgroundOn ()

virtual void	DrawBackgroundOff ()

virtual void	SetDrawFrame (int)

virtual int	GetDrawFrame ()

virtual void	DrawFrameOn ()

virtual void	DrawFrameOff ()

virtual void	SetDrawColorBar (int)

virtual int	GetDrawColorBar ()

virtual void	DrawColorBarOn ()

virtual void	DrawColorBarOff ()

virtual void	SetDrawTickLabels (int)

virtual int	GetDrawTickLabels ()

virtual void	DrawTickLabelsOn ()

virtual void	DrawTickLabelsOff ()

virtual void	SetBackgroundProperty (vtkProperty2D *p)

virtual vtkProperty2D *	GetBackgroundProperty ()

virtual void	SetFrameProperty (vtkProperty2D *p)

virtual vtkProperty2D *	GetFrameProperty ()

virtual int	GetTextPad ()

virtual void	SetTextPad (int)

virtual int	GetVerticalTitleSeparation ()

virtual void	SetVerticalTitleSeparation (int)

virtual double	GetBarRatio ()

virtual void	SetBarRatio (double)

virtual double	GetTitleRatio ()

virtual void	SetTitleRatio (double)

virtual void	SetUnconstrainedFontSize (bool)

virtual bool	GetUnconstrainedFontSize ()

virtual void	UnconstrainedFontSizeOn ()

virtual void	UnconstrainedFontSizeOff ()

Public Member Functions inherited from vtkActor2D
vtkActor2D *	NewInstance () const

vtkProperty2D *	GetProperty ()

virtual void	SetProperty (vtkProperty2D *)

void	SetDisplayPosition (int, int)

virtual vtkMTimeType	GetMTime ()

virtual void	GetActors2D (vtkPropCollection *pc)

virtual void	SetMapper (vtkMapper2D *mapper)

virtual vtkMapper2D *	GetMapper ()

virtual void	SetLayerNumber (int)

virtual int	GetLayerNumber ()

virtual vtkCoordinate *	GetPositionCoordinate ()

virtual void	SetPosition (float x[2])

virtual void	SetPosition (float x, float y)

virtual float *	GetPosition ()

virtual vtkCoordinate *	GetPosition2Coordinate ()

virtual void	SetPosition2 (float x[2])

virtual void	SetPosition2 (float x, float y)

virtual float *	GetPosition2 ()

void	SetWidth (double w)

double	GetWidth ()

void	SetHeight (double h)

double	GetHeight ()

virtual vtkCoordinate *	GetActualPositionCoordinate (void)

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)

virtual void	SetMapper (vtkMapper2D *mapper)

virtual vtkMapper2D *	GetMapper ()

virtual void	SetLayerNumber (int)

virtual int	GetLayerNumber ()

virtual vtkCoordinate *	GetPositionCoordinate ()

virtual void	SetPosition (float x[2])

virtual void	SetPosition (float x, float y)

virtual float *	GetPosition ()

virtual vtkCoordinate *	GetPosition2Coordinate ()

virtual void	SetPosition2 (float x[2])

virtual void	SetPosition2 (float x, float y)

virtual float *	GetPosition2 ()

void	SetWidth (double w)

double	GetWidth ()

void	SetHeight (double h)

double	GetHeight ()

virtual vtkCoordinate *	GetActualPositionCoordinate (void)

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

virtual void	Pick ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual vtkMTimeType	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual double *	GetBounds ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

virtual void	GetActors (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual vtkMTimeType	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual double *	GetBounds ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkPVScalarBarActor *	SafeDownCast (vtkObject *o)

static vtkPVScalarBarActor *	New ()

Static Public Member Functions inherited from vtkScalarBarActor
static int	IsTypeOf (const char *type)

static vtkScalarBarActor *	SafeDownCast (vtkObjectBase *o)

static vtkScalarBarActor *	New ()

Static Public Member Functions inherited from vtkActor2D
static int	IsTypeOf (const char *type)

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVScalarBarActor ()

	~vtkPVScalarBarActor () override

void	EditAnnotations () override
	Annotate the min/max values on the scalar bar (in interval/ratio mode). More...

virtual void	BuildScalarBarTexture ()
	Set up the ScalarBar, ScalarBarMapper, and ScalarBarActor based on the current position and orientation of this actor. More...

virtual int	CreateLabel (double value, int minDigits, int targetWidth, int targetHeight, vtkViewport *viewport)
	A convenience function for creating one of the labels. More...


void	PrepareTitleText () override
	These methods override the subclass implementation. More...

void	ComputeScalarBarThickness () override
	These methods override the subclass implementation. More...

void	LayoutTitle () override
	These methods override the subclass implementation. More...

void	ComputeScalarBarLength () override
	These methods override the subclass implementation. More...

void	LayoutTicks () override
	These methods override the subclass implementation. More...

void	ConfigureAnnotations () override
	These methods override the subclass implementation. More...

void	ConfigureTitle () override
	These methods override the subclass implementation. More...

void	ConfigureTicks () override
	These methods override the subclass implementation. More...

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

	vtkScalarBarActor ()

	~vtkScalarBarActor ()

virtual void	RebuildLayout (vtkViewport *viewport)

virtual int	RebuildLayoutIfNeeded (vtkViewport *viewport)

virtual void	FreeLayoutStorage ()

virtual void	ComputeFrame ()

virtual void	ComputeSwatchPad ()

virtual void	LayoutNanSwatch ()

virtual void	LayoutBelowRangeSwatch ()

virtual void	LayoutAboveRangeSwatch ()

virtual void	LayoutAboveRangeSwatchPosn ()

virtual void	LayoutForUnconstrainedFont ()

virtual void	LayoutAnnotations ()

virtual void	ConfigureFrame ()

virtual void	DrawBoxes ()

virtual void	ConfigureScalarBar ()

virtual void	ConfigureNanSwatch ()

virtual void	ConfigureAboveBelowRangeSwatch (bool above)

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

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

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

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

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

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

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

Protected Member Functions inherited from vtkActor2D
	vtkActor2D ()

	~vtkActor2D ()

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	AspectRatio

int	AutomaticLabelFormat

int	DrawTickMarks

int	DrawSubTickMarks

int	AddRangeLabels

int	AutomaticAnnotations
	Flag indicating whether automatic annotations are computed and shown. More...

char *	RangeLabelFormat

vtkTexture *	ScalarBarTexture

vtkPolyData *	TickMarks

vtkPolyDataMapper2D *	TickMarksMapper

vtkActor2D *	TickMarksActor

int	LabelSpace
	Space, in pixels, between the labels and the bar itself. More...

int	TitleJustification
	The justification/alignment of the title. More...

int	AddRangeAnnotations
	Flag to add minimum and maximum as annotations. More...


vtkNew< vtkAxis >	TickLayoutHelper
	These are used to calculate the tick spacing. More...

vtkNew< vtkContextScene >	TickLayoutHelperScene
	These are used to calculate the tick spacing. More...

Protected Attributes inherited from vtkScalarBarActor
int	MaximumNumberOfColors

int	NumberOfLabels

int	NumberOfLabelsBuilt

int	Orientation

int	DrawBackground

int	DrawFrame

int	DrawColorBar

int	DrawTickLabels

int	DrawAnnotations

int	DrawNanAnnotation

int	AnnotationTextScaling

int	FixedAnnotationLeaderLineColor

vtkProperty2D *	BackgroundProperty

vtkProperty2D *	FrameProperty

char *	Title

char *	ComponentTitle

char *	LabelFormat

int	UseOpacity

double	TextureGridWidth

int	TextPosition

char *	NanAnnotation

char *	BelowRangeAnnotation

char *	AboveRangeAnnotation

double	AnnotationLeaderPadding

int	MaximumWidthInPixels

int	MaximumHeightInPixels

int	TextPad

int	VerticalTitleSeparation

double	BarRatio

double	TitleRatio

bool	UnconstrainedFontSize

bool	DrawBelowRangeSwatch

bool	DrawAboveRangeSwatch

vtkTimeStamp	BuildTime

int	LastSize [2]

int	LastOrigin [2]

vtkScalarBarActorInternal *	P

vtkScalarsToColors *	LookupTable

vtkTextProperty *	TitleTextProperty

vtkTextProperty *	LabelTextProperty

vtkTextProperty *	AnnotationTextProperty

vtkTextActor *	TitleActor

vtkPolyData *	ScalarBar

vtkPolyDataMapper2D *	ScalarBarMapper

vtkActor2D *	ScalarBarActor

vtkPolyData *	TexturePolyData

vtkTexture *	Texture

vtkTexturedActor2D *	TextureActor

vtkPolyData *	Background

vtkPolyDataMapper2D *	BackgroundMapper

vtkActor2D *	BackgroundActor

vtkPolyData *	Frame

vtkPolyDataMapper2D *	FrameMapper

vtkActor2D *	FrameActor

Protected Attributes inherited from vtkActor2D
vtkMapper2D *	Mapper

int	LayerNumber

vtkProperty2D *	Property

vtkCoordinate *	PositionCoordinate

vtkCoordinate *	Position2Coordinate

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkScalarBarActor
	PrecedeScalarBar

	SucceedScalarBar

Detailed Description

A scalar bar with labels of fixed font.

vtkPVScalarBarActor has basically the same functionality as vtkScalarBarActor except that the fonts are set to a fixed size and tick labels vary in precision before their size is adjusted to meet geometric constraints. These changes make it easier to control in ParaView.

Definition at line 31 of file vtkPVScalarBarActor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkScalarBarActor vtkPVScalarBarActor::Superclass

Definition at line 34 of file vtkPVScalarBarActor.h.

Constructor & Destructor Documentation

◆ vtkPVScalarBarActor()

vtkPVScalarBarActor::vtkPVScalarBarActor ( )

protected

◆ ~vtkPVScalarBarActor()

vtkPVScalarBarActor::~vtkPVScalarBarActor ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVScalarBarActor::GetClassName ( )

virtual

◆ IsTypeOf()

static int vtkPVScalarBarActor::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkPVScalarBarActor::IsA ( const char * type )

virtual

Reimplemented from vtkScalarBarActor.

◆ SafeDownCast()

static vtkPVScalarBarActor* vtkPVScalarBarActor::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkScalarBarActor.

◆ New()

static vtkPVScalarBarActor* vtkPVScalarBarActor::New ( )

static

◆ GetAspectRatio()

virtual double vtkPVScalarBarActor::GetAspectRatio ( )

virtual

The bar aspect ratio (length/width).

Defaults to 20. Note that this the aspect ratio of the color bar only, not including labels.

◆ SetAspectRatio()

virtual void vtkPVScalarBarActor::SetAspectRatio ( double )

virtual

The bar aspect ratio (length/width).

Defaults to 20. Note that this the aspect ratio of the color bar only, not including labels.

◆ GetAutomaticLabelFormat()

virtual int vtkPVScalarBarActor::GetAutomaticLabelFormat ( )

virtual

If true (the default), the printf format used for the labels will be automatically generated to make the numbers best fit within the widget.

If false, the LabelFormat ivar will be used.

◆ SetAutomaticLabelFormat()

virtual void vtkPVScalarBarActor::SetAutomaticLabelFormat ( int )

virtual

If true (the default), the printf format used for the labels will be automatically generated to make the numbers best fit within the widget.

If false, the LabelFormat ivar will be used.

◆ AutomaticLabelFormatOn()

virtual void vtkPVScalarBarActor::AutomaticLabelFormatOn ( )

virtual

If true (the default), the printf format used for the labels will be automatically generated to make the numbers best fit within the widget.

If false, the LabelFormat ivar will be used.

◆ AutomaticLabelFormatOff()

virtual void vtkPVScalarBarActor::AutomaticLabelFormatOff ( )

virtual

If true (the default), the printf format used for the labels will be automatically generated to make the numbers best fit within the widget.

If false, the LabelFormat ivar will be used.

◆ GetDrawTickMarks()

virtual int vtkPVScalarBarActor::GetDrawTickMarks ( )

virtual

If true (the default), tick marks will be drawn.

◆ SetDrawTickMarks()

virtual void vtkPVScalarBarActor::SetDrawTickMarks ( int )

virtual

If true (the default), tick marks will be drawn.

◆ DrawTickMarksOn()

virtual void vtkPVScalarBarActor::DrawTickMarksOn ( )

virtual

If true (the default), tick marks will be drawn.

◆ DrawTickMarksOff()

virtual void vtkPVScalarBarActor::DrawTickMarksOff ( )

virtual

If true (the default), tick marks will be drawn.

◆ GetDrawSubTickMarks()

virtual int vtkPVScalarBarActor::GetDrawSubTickMarks ( )

virtual

If true (the default), sub-tick marks will be drawn.

◆ SetDrawSubTickMarks()

virtual void vtkPVScalarBarActor::SetDrawSubTickMarks ( int )

virtual

If true (the default), sub-tick marks will be drawn.

◆ DrawSubTickMarksOn()

virtual void vtkPVScalarBarActor::DrawSubTickMarksOn ( )

virtual

If true (the default), sub-tick marks will be drawn.

◆ DrawSubTickMarksOff()

virtual void vtkPVScalarBarActor::DrawSubTickMarksOff ( )

virtual

If true (the default), sub-tick marks will be drawn.

◆ GetAddRangeLabels()

virtual int vtkPVScalarBarActor::GetAddRangeLabels ( )

virtual

Set whether the range endpoints (minimum and maximum) are added as labels alongside other value labels.

◆ SetAddRangeLabels()

virtual void vtkPVScalarBarActor::SetAddRangeLabels ( int )

virtual

Set whether the range endpoints (minimum and maximum) are added as labels alongside other value labels.

◆ AddRangeLabelsOn()

virtual void vtkPVScalarBarActor::AddRangeLabelsOn ( )

virtual

Set whether the range endpoints (minimum and maximum) are added as labels alongside other value labels.

◆ AddRangeLabelsOff()

virtual void vtkPVScalarBarActor::AddRangeLabelsOff ( )

virtual

Set whether the range endpoints (minimum and maximum) are added as labels alongside other value labels.

◆ SetAutomaticAnnotations()

virtual void vtkPVScalarBarActor::SetAutomaticAnnotations ( int )

virtual

Set whether annotions are automatically created according the number of discrete colors.

Default is FALSE;

◆ GetAutomaticAnnotations()

virtual int vtkPVScalarBarActor::GetAutomaticAnnotations ( )

virtual

Set whether annotions are automatically created according the number of discrete colors.

Default is FALSE;

◆ AutomaticAnnotationsOn()

virtual void vtkPVScalarBarActor::AutomaticAnnotationsOn ( )

virtual

Set whether annotions are automatically created according the number of discrete colors.

Default is FALSE;

◆ AutomaticAnnotationsOff()

virtual void vtkPVScalarBarActor::AutomaticAnnotationsOff ( )

virtual

Set whether annotions are automatically created according the number of discrete colors.

Default is FALSE;

◆ GetRangeLabelFormat()

virtual char* vtkPVScalarBarActor::GetRangeLabelFormat ( )

virtual

Set the C-style format string for the range labels.

◆ SetRangeLabelFormat()

virtual void vtkPVScalarBarActor::SetRangeLabelFormat ( const char * )

virtual

Set the C-style format string for the range labels.

◆ AddValueLabelIfUnoccluded()

virtual void vtkPVScalarBarActor::AddValueLabelIfUnoccluded	(	double	value,
		double	pos,
		double	diff
	)

virtual

Add value as annotation label on scalar bar at the given position.

◆ GetTitleJustification()

virtual int vtkPVScalarBarActor::GetTitleJustification ( )

virtual

Set the title justification.

Valid values are VTK_TEXT_LEFT, VTK_TEXT_CENTERED, and VTK_TEXT_RIGHT.

◆ SetTitleJustification()

virtual void vtkPVScalarBarActor::SetTitleJustification ( int )

virtual

Set the title justification.

Valid values are VTK_TEXT_LEFT, VTK_TEXT_CENTERED, and VTK_TEXT_RIGHT.

◆ GetAddRangeAnnotations()

virtual int vtkPVScalarBarActor::GetAddRangeAnnotations ( )

virtual

Set whether the scalar data range endpoints (minimum and maximum) are added as annotations.

◆ SetAddRangeAnnotations()

virtual void vtkPVScalarBarActor::SetAddRangeAnnotations ( int )

virtual

Set whether the scalar data range endpoints (minimum and maximum) are added as annotations.

◆ AddRangeAnnotationsOn()

virtual void vtkPVScalarBarActor::AddRangeAnnotationsOn ( )

virtual

Set whether the scalar data range endpoints (minimum and maximum) are added as annotations.

◆ AddRangeAnnotationsOff()

virtual void vtkPVScalarBarActor::AddRangeAnnotationsOff ( )

virtual

Set whether the scalar data range endpoints (minimum and maximum) are added as annotations.

◆ ReleaseGraphicsResources()

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

◆ RenderOpaqueGeometry()

int vtkPVScalarBarActor::RenderOpaqueGeometry ( vtkViewport * viewport )

overridevirtual

Overridden to sync internal variables with renderer state.

Reimplemented from vtkScalarBarActor.

◆ RenderOverlay()

int vtkPVScalarBarActor::RenderOverlay ( vtkViewport * viewport )

overridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkScalarBarActor.