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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkScalarBarActor *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	HasTranslucentPolygonalGeometry ()
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual void	GetScalarBarRect (int rect[4], vtkViewport *viewport)
void	ShallowCopy (vtkProp *prop)
int	RenderOpaqueGeometry (vtkViewport *viewport)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
int	RenderOverlay (vtkViewport *viewport)
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	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	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	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)
Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent)
vtkActor2D *	NewInstance () const
vtkProperty2D *	GetProperty ()
virtual void	SetProperty (vtkProperty2D *)
void	SetDisplayPosition (int, int)
virtual unsigned long	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)
Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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 unsigned long	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
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
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 int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkScalarBarActor ()
	~vtkScalarBarActor ()
virtual void	RebuildLayout (vtkViewport *viewport)
virtual void	FreeLayoutStorage ()
virtual void	ComputeFrame ()
virtual void	ComputeScalarBarThickness ()
virtual void	LayoutNanSwatch ()
virtual void	PrepareTitleText ()
virtual void	LayoutTitle ()
virtual void	ComputeScalarBarLength ()
virtual void	LayoutTicks ()
virtual void	LayoutAnnotations ()
virtual void	ConfigureAnnotations ()
virtual void	ConfigureFrame ()
virtual void	DrawBoxes ()
virtual void	ConfigureScalarBar ()
virtual void	ConfigureTitle ()
virtual void	ConfigureTicks ()
virtual void	ConfigureNanSwatch ()
virtual void	EditAnnotations ()
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)
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 ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	MaximumNumberOfColors
	User-changeable settings. More...
int	NumberOfLabels
	User-changeable settings. More...
int	NumberOfLabelsBuilt
	User-changeable settings. More...
int	Orientation
	User-changeable settings. More...
int	DrawBackground
	User-changeable settings. More...
int	DrawFrame
	User-changeable settings. More...
int	DrawColorBar
	User-changeable settings. More...
int	DrawTickLabels
	User-changeable settings. More...
int	DrawAnnotations
	User-changeable settings. More...
int	DrawNanAnnotation
	User-changeable settings. More...
int	AnnotationTextScaling
	User-changeable settings. More...
int	FixedAnnotationLeaderLineColor
	User-changeable settings. More...
vtkProperty2D *	BackgroundProperty
	User-changeable settings. More...
vtkProperty2D *	FrameProperty
	User-changeable settings. More...
char *	Title
	User-changeable settings. More...
char *	ComponentTitle
	User-changeable settings. More...
char *	LabelFormat
	User-changeable settings. More...
int	UseOpacity
	User-changeable settings. More...
double	TextureGridWidth
	User-changeable settings. More...
int	TextPosition
	User-changeable settings. More...
char *	NanAnnotation
	User-changeable settings. More...
double	AnnotationLeaderPadding
	User-changeable settings. More...
int	MaximumWidthInPixels
	User-changeable settings. More...
int	MaximumHeightInPixels
	User-changeable settings. More...
int	TextPad
	User-changeable settings. More...
int	VerticalTitleSeparation
	User-changeable settings. More...
double	BarRatio
	User-changeable settings. More...
double	TitleRatio
	User-changeable settings. More...
vtkTimeStamp	BuildTime
	Internal state used for rendering. More...
int	LastSize [2]
	Projected size in viewport coordinates of last build. More...
int	LastOrigin [2]
	Projected origin (viewport coordinates) of last build. More...
vtkScalarBarActorInternal *	P
	Containers shared with subclasses. More...
vtkScalarsToColors *	LookupTable
	The object this actor illustrates. More...
vtkTextProperty *	TitleTextProperty
	Font for the legend title. More...
vtkTextProperty *	LabelTextProperty
	Font for tick+annotation labels. More...
vtkTextActor *	TitleActor
	The legend title text renderer. More...
vtkPolyData *	ScalarBar
	Polygon(s) colored by LookupTable. More...
vtkPolyDataMapper2D *	ScalarBarMapper
	Mapper for ScalarBar. More...
vtkActor2D *	ScalarBarActor
	Actor for ScalarBar. More...
vtkPolyData *	TexturePolyData
	Polygon colored when UseOpacity is true. More...
vtkTexture *	Texture
	Color data for TexturePolyData. More...
vtkTexturedActor2D *	TextureActor
	Actor for TexturePolyData. More...
vtkPolyData *	Background
	Polygon used to fill the background. More...
vtkPolyDataMapper2D *	BackgroundMapper
	Mapper for Background. More...
vtkActor2D *	BackgroundActor
	Actor for Background. More...
vtkPolyData *	Frame
	Polyline used to highlight frame. More...
vtkPolyDataMapper2D *	FrameMapper
	Mapper for Frame. More...
vtkActor2D *	FrameActor
	Actor for Frame. More...
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

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

Tests:

vtkScalarBarActor (Tests)

Definition at line 79 of file vtkScalarBarActor.h.

Member Typedef Documentation

typedef vtkActor2D vtkScalarBarActor::Superclass

Definition at line 82 of file vtkScalarBarActor.h.

Member Enumeration Documentation

anonymous enum

Enumerator
PrecedeScalarBar
SucceedScalarBar

Definition at line 199 of file vtkScalarBarActor.h.

Constructor & Destructor Documentation

vtkScalarBarActor::vtkScalarBarActor ( )

protected

vtkScalarBarActor::~vtkScalarBarActor ( )

protected

Member Function Documentation

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

static

virtual int 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.

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

static

virtual vtkObjectBase* vtkScalarBarActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

vtkScalarBarActor* vtkScalarBarActor::NewInstance

(

)

const

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

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.

int vtkScalarBarActor::RenderOpaqueGeometry ( vtkViewport *  viewport )

virtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

virtual int vtkScalarBarActor::RenderTranslucentPolygonalGeometry ( vtkViewport *  )

inlinevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

Definition at line 93 of file vtkScalarBarActor.h.

int vtkScalarBarActor::RenderOverlay ( vtkViewport *  viewport )

virtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

virtual int vtkScalarBarActor::HasTranslucentPolygonalGeometry ( )

virtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkActor2D.

virtual void vtkScalarBarActor::ReleaseGraphicsResources ( vtkWindow *  )

virtual

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.

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}

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.

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.

virtual void vtkScalarBarActor::SetUseOpacity ( int  )

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]

virtual int 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]

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]

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]

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.

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.

virtual void vtkScalarBarActor::SetNumberOfLabels ( int  )

virtual

Set/Get the number of tick labels to show.

virtual int vtkScalarBarActor::GetNumberOfLabels ( )

virtual

Set/Get the number of tick labels to show.

virtual void vtkScalarBarActor::SetOrientation ( int  )

virtual

Control the orientation of the scalar bar.

virtual int vtkScalarBarActor::GetOrientation ( )

virtual

Control the orientation of the scalar bar.

void vtkScalarBarActor::SetOrientationToHorizontal ( )

inline

Control the orientation of the scalar bar.

Definition at line 148 of file vtkScalarBarActor.h.

void vtkScalarBarActor::SetOrientationToVertical ( )

inline

Control the orientation of the scalar bar.

Definition at line 150 of file vtkScalarBarActor.h.

virtual void vtkScalarBarActor::SetTitleTextProperty ( vtkTextProperty *  p )

virtual

Set/Get the title text property.

virtual vtkTextProperty* vtkScalarBarActor::GetTitleTextProperty ( )

virtual

Set/Get the title text property.

virtual void vtkScalarBarActor::SetLabelTextProperty ( vtkTextProperty *  p )

virtual

Set/Get the labels text property.

virtual vtkTextProperty* vtkScalarBarActor::GetLabelTextProperty ( )

virtual

Set/Get the labels text property.

virtual void vtkScalarBarActor::SetLabelFormat ( const char *  )

virtual

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

virtual char* vtkScalarBarActor::GetLabelFormat ( )

virtual

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

virtual void vtkScalarBarActor::SetTitle ( const char *  )

virtual

Set/Get the title of the scalar bar actor,

virtual char* vtkScalarBarActor::GetTitle ( )

virtual

Set/Get the title of the scalar bar actor,

virtual void vtkScalarBarActor::SetComponentTitle ( const char *  )

virtual

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

virtual char* vtkScalarBarActor::GetComponentTitle ( )

virtual

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

void vtkScalarBarActor::ShallowCopy ( vtkProp *  prop )

virtual

Shallow copy of a scalar bar actor. Overloads the virtual vtkProp method.

Reimplemented from vtkActor2D.

virtual void vtkScalarBarActor::SetTextureGridWidth ( double  )

virtual

Set the width of the texture grid. Used only if UseOpacity is ON.

virtual double vtkScalarBarActor::GetTextureGridWidth ( )

virtual

Set the width of the texture grid. Used only if UseOpacity is ON.

virtual vtkTexturedActor2D* vtkScalarBarActor::GetTextureActor ( )

virtual

Get the texture actor.. you may want to change some properties on it

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.

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.

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 211 of file vtkScalarBarActor.h.

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 213 of file vtkScalarBarActor.h.

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.

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.

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.

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.

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.

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.

virtual void vtkScalarBarActor::SetDrawAnnotations ( int  )

virtual

Set/get whether text annotations should be rendered or not. Currently, this only affects rendering when IndexedLookup is true. The default is true.

virtual int 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.

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.

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.

virtual void vtkScalarBarActor::SetDrawNanAnnotation ( int  )

virtual

Set/get whether the NaN annotation should be rendered or not. This only affects rendering when DrawAnnotations is true. The default is false.

virtual int 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.

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.

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.

virtual void vtkScalarBarActor::SetFixedAnnotationLeaderLineColor ( int  )

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.

virtual int 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.

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.

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.

virtual void vtkScalarBarActor::SetNanAnnotation ( const char *  )

virtual

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

virtual char* vtkScalarBarActor::GetNanAnnotation ( )

virtual

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

virtual void vtkScalarBarActor::SetAnnotationTextScaling ( int  )

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.

virtual int 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.

virtual void vtkScalarBarActor::SetDrawBackground ( int  )

virtual

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

virtual int vtkScalarBarActor::GetDrawBackground ( )

virtual

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

virtual void vtkScalarBarActor::DrawBackgroundOn ( )

virtual

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

virtual void vtkScalarBarActor::DrawBackgroundOff ( )

virtual

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

virtual void vtkScalarBarActor::SetDrawFrame ( int  )

virtual

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

virtual int vtkScalarBarActor::GetDrawFrame ( )

virtual

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

virtual void vtkScalarBarActor::DrawFrameOn ( )

virtual

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

virtual void vtkScalarBarActor::DrawFrameOff ( )

virtual

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

virtual void vtkScalarBarActor::SetDrawColorBar ( int  )

virtual

Set/Get whether the color bar should be drawn. If off, only the tickmarks and text will be drawn. Default is on.

virtual int 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.

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.

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.

virtual void vtkScalarBarActor::SetDrawTickLabels ( int  )

virtual

Set/Get whether the tick labels should be drawn. Default is on.

virtual int vtkScalarBarActor::GetDrawTickLabels ( )

virtual

Set/Get whether the tick labels should be drawn. Default is on.

virtual void vtkScalarBarActor::DrawTickLabelsOn ( )

virtual

Set/Get whether the tick labels should be drawn. Default is on.

virtual void vtkScalarBarActor::DrawTickLabelsOff ( )

virtual

Set/Get whether the tick labels should be drawn. Default is on.

virtual void vtkScalarBarActor::SetBackgroundProperty ( vtkProperty2D *  p )

virtual

Set/Get the background property.

virtual vtkProperty2D* vtkScalarBarActor::GetBackgroundProperty ( )

virtual

Set/Get the background property.

virtual void vtkScalarBarActor::SetFrameProperty ( vtkProperty2D *  p )

virtual

Set/Get the frame property.

virtual vtkProperty2D* vtkScalarBarActor::GetFrameProperty ( )

virtual

Set/Get the frame property.

virtual int vtkScalarBarActor::GetTextPad ( )

virtual

Set/get the amount of padding around text boxes. The default is 1 pixel.

virtual void vtkScalarBarActor::SetTextPad ( int  )

virtual

Set/get the amount of padding around text boxes. The default is 1 pixel.

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.

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.

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

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

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

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

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.

virtual void vtkScalarBarActor::FreeLayoutStorage ( )

protectedvirtual

Free internal storage used by the previous layout.

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

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

virtual void vtkScalarBarActor::LayoutNanSwatch ( )

protectedvirtual

Determine the size of the NaN swatch if it is to be rendered. This method must set this->P->NanSwatchSize and this->P->NanBox. It may depend on layout performed by ComputeScalarBarThickness.

virtual void vtkScalarBarActor::PrepareTitleText ( )

protectedvirtual

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

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.

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.

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.

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.

virtual void vtkScalarBarActor::ConfigureAnnotations ( )

protectedvirtual

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

virtual void vtkScalarBarActor::ConfigureFrame ( )

protectedvirtual

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

virtual void vtkScalarBarActor::DrawBoxes ( )

protectedvirtual

For debugging, add placement boxes to the frame polydata.

virtual void vtkScalarBarActor::ConfigureScalarBar ( )

protectedvirtual

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

virtual void vtkScalarBarActor::ConfigureTitle ( )

protectedvirtual

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

virtual void vtkScalarBarActor::ConfigureTicks ( )

protectedvirtual

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

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.

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 460 of file vtkScalarBarActor.h.

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.

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

protected

Allocate actors for lookup table annotations and position them properly.

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.

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

int vtkScalarBarActor::MaximumNumberOfColors

protected

User-changeable settings.

Definition at line 490 of file vtkScalarBarActor.h.

int vtkScalarBarActor::NumberOfLabels

protected

User-changeable settings.

Definition at line 491 of file vtkScalarBarActor.h.

int vtkScalarBarActor::NumberOfLabelsBuilt

protected

User-changeable settings.

Definition at line 492 of file vtkScalarBarActor.h.

int vtkScalarBarActor::Orientation

protected

User-changeable settings.

Definition at line 493 of file vtkScalarBarActor.h.

int vtkScalarBarActor::DrawBackground

protected

User-changeable settings.

Definition at line 494 of file vtkScalarBarActor.h.

int vtkScalarBarActor::DrawFrame

protected

User-changeable settings.

Definition at line 495 of file vtkScalarBarActor.h.

int vtkScalarBarActor::DrawColorBar

protected

User-changeable settings.

Definition at line 496 of file vtkScalarBarActor.h.

int vtkScalarBarActor::DrawTickLabels

protected

User-changeable settings.

Definition at line 497 of file vtkScalarBarActor.h.

int vtkScalarBarActor::DrawAnnotations

protected

User-changeable settings.

Definition at line 498 of file vtkScalarBarActor.h.

int vtkScalarBarActor::DrawNanAnnotation

protected

User-changeable settings.

Definition at line 499 of file vtkScalarBarActor.h.

int vtkScalarBarActor::AnnotationTextScaling

protected

User-changeable settings.

Definition at line 500 of file vtkScalarBarActor.h.

int vtkScalarBarActor::FixedAnnotationLeaderLineColor

protected

User-changeable settings.

Definition at line 501 of file vtkScalarBarActor.h.

vtkProperty2D* vtkScalarBarActor::BackgroundProperty

protected

User-changeable settings.

Definition at line 502 of file vtkScalarBarActor.h.

vtkProperty2D* vtkScalarBarActor::FrameProperty

protected

User-changeable settings.

Definition at line 503 of file vtkScalarBarActor.h.

char* vtkScalarBarActor::Title

protected

User-changeable settings.

Definition at line 504 of file vtkScalarBarActor.h.

char* vtkScalarBarActor::ComponentTitle

protected

User-changeable settings.

Definition at line 505 of file vtkScalarBarActor.h.

char* vtkScalarBarActor::LabelFormat

protected

User-changeable settings.

Definition at line 506 of file vtkScalarBarActor.h.

int vtkScalarBarActor::UseOpacity

protected

User-changeable settings.

Definition at line 507 of file vtkScalarBarActor.h.

double vtkScalarBarActor::TextureGridWidth

protected

User-changeable settings.

Definition at line 508 of file vtkScalarBarActor.h.

int vtkScalarBarActor::TextPosition

protected

User-changeable settings.

Definition at line 509 of file vtkScalarBarActor.h.

char* vtkScalarBarActor::NanAnnotation

protected

User-changeable settings.

Definition at line 510 of file vtkScalarBarActor.h.

double vtkScalarBarActor::AnnotationLeaderPadding

protected

User-changeable settings.

Definition at line 511 of file vtkScalarBarActor.h.

int vtkScalarBarActor::MaximumWidthInPixels

protected

User-changeable settings.

Definition at line 512 of file vtkScalarBarActor.h.

int vtkScalarBarActor::MaximumHeightInPixels

protected

User-changeable settings.

Definition at line 513 of file vtkScalarBarActor.h.

int vtkScalarBarActor::TextPad

protected

User-changeable settings.

Definition at line 514 of file vtkScalarBarActor.h.

int vtkScalarBarActor::VerticalTitleSeparation

protected

User-changeable settings.

Definition at line 515 of file vtkScalarBarActor.h.

double vtkScalarBarActor::BarRatio

protected

User-changeable settings.

Definition at line 516 of file vtkScalarBarActor.h.

double vtkScalarBarActor::TitleRatio

protected

User-changeable settings.

Definition at line 517 of file vtkScalarBarActor.h.

vtkTimeStamp vtkScalarBarActor::BuildTime

protected

Internal state used for rendering.

Last time internal state changed.

Definition at line 522 of file vtkScalarBarActor.h.

int vtkScalarBarActor::LastSize[2]

protected

Projected size in viewport coordinates of last build.

Definition at line 523 of file vtkScalarBarActor.h.

int vtkScalarBarActor::LastOrigin[2]

protected

Projected origin (viewport coordinates) of last build.

Definition at line 524 of file vtkScalarBarActor.h.

vtkScalarBarActorInternal* vtkScalarBarActor::P

protected

Containers shared with subclasses.

Definition at line 526 of file vtkScalarBarActor.h.

vtkScalarsToColors* vtkScalarBarActor::LookupTable

protected

The object this actor illustrates.

Definition at line 528 of file vtkScalarBarActor.h.

vtkTextProperty* vtkScalarBarActor::TitleTextProperty

protected

Font for the legend title.

Definition at line 530 of file vtkScalarBarActor.h.

vtkTextProperty* vtkScalarBarActor::LabelTextProperty

protected

Font for tick+annotation labels.

Definition at line 531 of file vtkScalarBarActor.h.

vtkTextActor* vtkScalarBarActor::TitleActor

protected

The legend title text renderer.

Definition at line 532 of file vtkScalarBarActor.h.

vtkPolyData* vtkScalarBarActor::ScalarBar

protected

Polygon(s) colored by LookupTable.

Definition at line 534 of file vtkScalarBarActor.h.

vtkPolyDataMapper2D* vtkScalarBarActor::ScalarBarMapper

protected

Mapper for ScalarBar.

Definition at line 535 of file vtkScalarBarActor.h.

vtkActor2D* vtkScalarBarActor::ScalarBarActor

protected

Actor for ScalarBar.

Definition at line 536 of file vtkScalarBarActor.h.

vtkPolyData* vtkScalarBarActor::TexturePolyData

protected

Polygon colored when UseOpacity is true.

Definition at line 537 of file vtkScalarBarActor.h.

vtkTexture* vtkScalarBarActor::Texture

protected

Color data for TexturePolyData.

Definition at line 538 of file vtkScalarBarActor.h.

vtkTexturedActor2D* vtkScalarBarActor::TextureActor

protected

Actor for TexturePolyData.

Definition at line 539 of file vtkScalarBarActor.h.

vtkPolyData* vtkScalarBarActor::Background

protected

Polygon used to fill the background.

Definition at line 541 of file vtkScalarBarActor.h.

vtkPolyDataMapper2D* vtkScalarBarActor::BackgroundMapper

protected

Mapper for Background.

Definition at line 542 of file vtkScalarBarActor.h.

vtkActor2D* vtkScalarBarActor::BackgroundActor

protected

Actor for Background.

Definition at line 543 of file vtkScalarBarActor.h.

vtkPolyData* vtkScalarBarActor::Frame

protected

Polyline used to highlight frame.

Definition at line 545 of file vtkScalarBarActor.h.

vtkPolyDataMapper2D* vtkScalarBarActor::FrameMapper

protected

Mapper for Frame.

Definition at line 546 of file vtkScalarBarActor.h.

vtkActor2D* vtkScalarBarActor::FrameActor

protected

Actor for Frame.

Definition at line 547 of file vtkScalarBarActor.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Annotation/vtkScalarBarActor.h