ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVScalarBarActor Class Reference

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

#include <vtkPVScalarBarActor.h>

Inherits vtkScalarBarActor.

Public Types

typedef vtkScalarBarActor Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void AddValueLabelIfUnoccluded (double value, double pos, double diff)
 Add value as annotation label on scalar bar at the given position. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this actor. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport)
 Overridden to sync internal variables with renderer state. More...
 
virtual int RenderOverlay (vtkViewport *viewport)
 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...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVScalarBarActorSafeDownCast (vtkObject *o)
 
static vtkPVScalarBarActorNew ()
 

Protected Member Functions

 vtkPVScalarBarActor ()
 
 ~vtkPVScalarBarActor ()
 
virtual void EditAnnotations ()
 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...
 
virtual void PrepareTitleText ()
 These methods override the subclass implementation. More...
 
virtual void ComputeScalarBarThickness ()
 These methods override the subclass implementation. More...
 
virtual void LayoutTitle ()
 These methods override the subclass implementation. More...
 
virtual void ComputeScalarBarLength ()
 These methods override the subclass implementation. More...
 
virtual void LayoutTicks ()
 These methods override the subclass implementation. More...
 
virtual void ConfigureAnnotations ()
 These methods override the subclass implementation. More...
 
virtual void ConfigureTitle ()
 These methods override the subclass implementation. More...
 
virtual void ConfigureTicks ()
 These methods override the subclass implementation. More...
 

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

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 48 of file vtkPVScalarBarActor.h.

Member Typedef Documentation

§ Superclass

typedef vtkScalarBarActor vtkPVScalarBarActor::Superclass

Definition at line 51 of file vtkPVScalarBarActor.h.

Constructor & Destructor Documentation

§ vtkPVScalarBarActor()

vtkPVScalarBarActor::vtkPVScalarBarActor ( )
protected

§ ~vtkPVScalarBarActor()

vtkPVScalarBarActor::~vtkPVScalarBarActor ( )
protected

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

§ SafeDownCast()

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

§ PrintSelf()

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

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

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

§ RenderOpaqueGeometry()

int vtkPVScalarBarActor::RenderOpaqueGeometry ( vtkViewport *  viewport)

Overridden to sync internal variables with renderer state.

§ RenderOverlay()

virtual int vtkPVScalarBarActor::RenderOverlay ( vtkViewport *  viewport)
virtual

Draw the scalar bar and annotation text to the screen.

§ PrepareTitleText()

virtual void vtkPVScalarBarActor::PrepareTitleText ( )
protectedvirtual

These methods override the subclass implementation.

§ ComputeScalarBarThickness()

virtual void vtkPVScalarBarActor::ComputeScalarBarThickness ( )
protectedvirtual

These methods override the subclass implementation.

§ LayoutTitle()

virtual void vtkPVScalarBarActor::LayoutTitle ( )
protectedvirtual

These methods override the subclass implementation.

§ ComputeScalarBarLength()

virtual void vtkPVScalarBarActor::ComputeScalarBarLength ( )
protectedvirtual

These methods override the subclass implementation.

§ LayoutTicks()

virtual void vtkPVScalarBarActor::LayoutTicks ( )
protectedvirtual

These methods override the subclass implementation.

§ ConfigureAnnotations()

virtual void vtkPVScalarBarActor::ConfigureAnnotations ( )
protectedvirtual

These methods override the subclass implementation.

§ ConfigureTitle()

virtual void vtkPVScalarBarActor::ConfigureTitle ( )
protectedvirtual

These methods override the subclass implementation.

§ ConfigureTicks()

virtual void vtkPVScalarBarActor::ConfigureTicks ( )
protectedvirtual

These methods override the subclass implementation.

§ EditAnnotations()

virtual void vtkPVScalarBarActor::EditAnnotations ( )
protectedvirtual

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

This overrides the subclass implementation.

§ BuildScalarBarTexture()

virtual void vtkPVScalarBarActor::BuildScalarBarTexture ( )
protectedvirtual

Set up the ScalarBar, ScalarBarMapper, and ScalarBarActor based on the current position and orientation of this actor.

virtual void PositionScalarBar(const int propSize[2], vtkViewport *viewport); Set up the texture used to render the scalar bar.

§ CreateLabel()

virtual int vtkPVScalarBarActor::CreateLabel ( double  value,
int  minDigits,
int  targetWidth,
int  targetHeight,
vtkViewport *  viewport 
)
protectedvirtual

A convenience function for creating one of the labels.

A text mapper and associated actor are added to LabelMappers and LabelActors respectively. The index to the newly created entries is returned.

Member Data Documentation

§ AspectRatio

double vtkPVScalarBarActor::AspectRatio
protected

Definition at line 206 of file vtkPVScalarBarActor.h.

§ AutomaticLabelFormat

int vtkPVScalarBarActor::AutomaticLabelFormat
protected

Definition at line 207 of file vtkPVScalarBarActor.h.

§ DrawTickMarks

int vtkPVScalarBarActor::DrawTickMarks
protected

Definition at line 208 of file vtkPVScalarBarActor.h.

§ DrawSubTickMarks

int vtkPVScalarBarActor::DrawSubTickMarks
protected

Definition at line 209 of file vtkPVScalarBarActor.h.

§ AddRangeLabels

int vtkPVScalarBarActor::AddRangeLabels
protected

Definition at line 210 of file vtkPVScalarBarActor.h.

§ AutomaticAnnotations

int vtkPVScalarBarActor::AutomaticAnnotations
protected

Flag indicating whether automatic annotations are computed and shown.

Definition at line 215 of file vtkPVScalarBarActor.h.

§ RangeLabelFormat

char* vtkPVScalarBarActor::RangeLabelFormat
protected

Definition at line 217 of file vtkPVScalarBarActor.h.

§ ScalarBarTexture

vtkTexture* vtkPVScalarBarActor::ScalarBarTexture
protected

Definition at line 219 of file vtkPVScalarBarActor.h.

§ TickMarks

vtkPolyData* vtkPVScalarBarActor::TickMarks
protected

Definition at line 220 of file vtkPVScalarBarActor.h.

§ TickMarksMapper

vtkPolyDataMapper2D* vtkPVScalarBarActor::TickMarksMapper
protected

Definition at line 221 of file vtkPVScalarBarActor.h.

§ TickMarksActor

vtkActor2D* vtkPVScalarBarActor::TickMarksActor
protected

Definition at line 222 of file vtkPVScalarBarActor.h.

§ TickLayoutHelper

vtkNew<vtkAxis> vtkPVScalarBarActor::TickLayoutHelper
protected

These are used to calculate the tick spacing.

Definition at line 228 of file vtkPVScalarBarActor.h.

§ TickLayoutHelperScene

vtkNew<vtkContextScene> vtkPVScalarBarActor::TickLayoutHelperScene
protected

These are used to calculate the tick spacing.

Definition at line 229 of file vtkPVScalarBarActor.h.

§ LabelSpace

int vtkPVScalarBarActor::LabelSpace
protected

Space, in pixels, between the labels and the bar itself.

Currently set in PositionTitle.

Definition at line 236 of file vtkPVScalarBarActor.h.

§ TitleJustification

int vtkPVScalarBarActor::TitleJustification
protected

The justification/alignment of the title.

Definition at line 241 of file vtkPVScalarBarActor.h.

§ AddRangeAnnotations

int vtkPVScalarBarActor::AddRangeAnnotations
protected

Flag to add minimum and maximum as annotations.

Definition at line 246 of file vtkPVScalarBarActor.h.


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