56 #ifndef vtkScalarBarActor_h
57 #define vtkScalarBarActor_h
61 #include "vtkRenderingAnnotationModule.h"
63 VTK_ABI_NAMESPACE_BEGIN
76 #define VTK_ORIENT_HORIZONTAL 0
77 #define VTK_ORIENT_VERTICAL 1
151 vtkGetMacro(MaximumNumberOfColors,
int);
158 vtkSetClampMacro(NumberOfLabels,
int, 0, 64);
159 vtkGetMacro(NumberOfLabels,
int);
175 vtkGetMacro(UseCustomLabels,
bool);
176 vtkSetMacro(UseCustomLabels,
bool);
177 vtkBooleanMacro(UseCustomLabels,
bool);
185 vtkGetMacro(Orientation,
int);
219 vtkSetStringMacro(LabelFormat);
220 vtkGetStringMacro(LabelFormat);
227 vtkSetStringMacro(Title);
228 vtkGetStringMacro(Title);
235 vtkSetStringMacro(ComponentTitle);
236 vtkGetStringMacro(ComponentTitle);
248 vtkSetMacro(TextureGridWidth,
double);
249 vtkGetMacro(TextureGridWidth,
double);
261 PrecedeScalarBar = 0,
274 vtkSetClampMacro(TextPosition,
int, PrecedeScalarBar, SucceedScalarBar);
275 vtkGetMacro(TextPosition,
int);
294 vtkSetMacro(MaximumWidthInPixels,
int);
295 vtkGetMacro(MaximumWidthInPixels,
int);
296 vtkSetMacro(MaximumHeightInPixels,
int);
297 vtkGetMacro(MaximumHeightInPixels,
int);
306 vtkSetMacro(AnnotationLeaderPadding,
double);
307 vtkGetMacro(AnnotationLeaderPadding,
double);
338 vtkSetMacro(DrawBelowRangeSwatch,
bool);
339 vtkGetMacro(DrawBelowRangeSwatch,
bool);
340 vtkBooleanMacro(DrawBelowRangeSwatch,
bool);
347 vtkSetStringMacro(BelowRangeAnnotation);
348 vtkGetStringMacro(BelowRangeAnnotation);
357 vtkSetMacro(DrawAboveRangeSwatch,
bool);
358 vtkGetMacro(DrawAboveRangeSwatch,
bool);
359 vtkBooleanMacro(DrawAboveRangeSwatch,
bool);
366 vtkSetStringMacro(AboveRangeAnnotation);
367 vtkGetStringMacro(AboveRangeAnnotation);
387 vtkSetStringMacro(NanAnnotation);
388 vtkGetStringMacro(NanAnnotation);
465 vtkGetMacro(TextPad,
int);
466 vtkSetMacro(TextPad,
int);
475 vtkGetMacro(VerticalTitleSeparation,
int);
476 vtkSetMacro(VerticalTitleSeparation,
int);
484 vtkGetMacro(BarRatio,
double);
485 vtkSetClampMacro(BarRatio,
double, 0., 1.);
495 vtkGetMacro(TitleRatio,
double);
496 vtkSetClampMacro(TitleRatio,
double, 0., 1.);
506 vtkSetMacro(UnconstrainedFontSize,
bool);
507 vtkGetMacro(UnconstrainedFontSize,
bool);
508 vtkBooleanMacro(UnconstrainedFontSize,
bool);
733 double barX,
double barY,
double barWidth,
double barHeight,
double delta,
double pad);
739 double barX,
double barY,
double barWidth,
double barHeight,
double delta,
double pad);
748 bool UseCustomLabels =
false;
817 VTK_ABI_NAMESPACE_END
a actor that draws 2D data
Some derived classes for the different colors commonly used.
dynamic, self-adjusting array of double
a simple class to control print indentation
draw vtkPolyData onto the image plane
concrete dataset represents vertices, lines, polygons, and triangle strips
abstract superclass for all actors, volumes and annotations
represent surface properties of a 2D image
Internal state for the scalar bar actor shared with subclasses.
Create a scalar bar with labels.
virtual void LayoutNanSwatch()
vtkPolyData * Background
Polygon used to fill the background.
vtkTypeBool DrawFrame
User-changeable settings.
int RenderOverlay(vtkViewport *viewport) override
Draw the scalar bar and annotation text to the screen.
virtual void ComputeScalarBarThickness()
Determine how thick the scalar bar should be (on an axis perpendicular to the direction in which scal...
vtkTypeBool AnnotationTextScaling
User-changeable settings.
virtual void SetAnnotationTextProperty(vtkTextProperty *p)
Set/Get the annotation text property.
virtual void FreeLayoutStorage()
Free internal storage used by the previous layout.
virtual void ConfigureAnnotations()
Generate/configure the annotation labels using the laid-out geometry.
static vtkScalarBarActor * New()
Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label format, no title,...
char * LabelFormat
User-changeable settings.
virtual void ComputeFrame()
If the scalar bar should be inset into a frame or rendered with a solid background,...
vtkTypeBool DrawBackground
User-changeable settings.
virtual void ComputeSwatchPad()
Compute a correct SwatchPad.
int RenderOpaqueGeometry(vtkViewport *viewport) override
Draw the scalar bar and annotation text to the screen.
vtkTextActor * TitleActor
The legend title text renderer.
~vtkScalarBarActor() override
int Orientation
User-changeable settings.
virtual void LayoutTitle()
Determine the position and size of the scalar bar title box.
char * BelowRangeAnnotation
User-changeable settings.
vtkProperty2D * BackgroundProperty
User-changeable settings.
virtual void ConfigureNanSwatch()
Generate/configure the NaN swatch using the laid-out geometry.
void SetOrientationToVertical()
Control the orientation of the scalar bar.
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
int MaximumNumberOfColors
User-changeable settings.
vtkTextProperty * AnnotationTextProperty
Font for annotation labels.
vtkTexturedActor2D * TextureActor
Actor for TexturePolyData.
virtual void LayoutBelowRangeSwatch()
Determine the size of the Below Range if it is to be rendered.
int NumberOfLabels
User-changeable settings.
double BarRatio
User-changeable settings.
void SetOrientationToHorizontal()
Control the orientation of the scalar bar.
vtkPolyData * Frame
Polyline used to highlight frame.
int PlaceAnnotationsVertically(double barX, double barY, double barWidth, double barHeight, double delta, double pad)
This method is called by ConfigureAnnotationLabels when Orientation is VTK_ORIENT_VERTICAL.
vtkPolyData * ScalarBar
Polygon(s) colored by LookupTable.
virtual void ConfigureTicks()
Generate/configure the tick-mark actors using the laid-out geometry.
vtkPolyDataMapper2D * FrameMapper
Mapper for Frame.
virtual void LayoutAnnotations()
This method must lay out annotation text and leader lines so they do not overlap.
virtual void RebuildLayout(vtkViewport *viewport)
Called from within RenderOpaqueGeometry when the internal state members need to be updated before ren...
int MapAnnotationLabels(vtkScalarsToColors *lkup, double start, double delta, const double *range)
Allocate actors for lookup table annotations and position them properly.
int TextPosition
User-changeable settings.
int MaximumHeightInPixels
User-changeable settings.
int VerticalTitleSeparation
User-changeable settings.
double AnnotationLeaderPadding
User-changeable settings.
bool UnconstrainedFontSize
User-changeable settings.
vtkTextProperty * TitleTextProperty
Font for the legend title.
virtual int RebuildLayoutIfNeeded(vtkViewport *viewport)
Calls RebuildLayout if it is needed such as when positions etc have changed.
int TextPad
User-changeable settings.
vtkActor2D * FrameActor
Actor for Frame.
vtkProperty2D * FrameProperty
User-changeable settings.
vtkPolyData * TexturePolyData
Polygon colored when UseOpacity is true.
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
Draw the scalar bar and annotation text to the screen.
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
virtual void SetTextPositionToPrecedeScalarBar()
Should the title and tick marks precede the scalar bar or succeed it? This is measured along the view...
virtual void SetTextPositionToSucceedScalarBar()
Should the title and tick marks precede the scalar bar or succeed it? This is measured along the view...
char * Title
User-changeable settings.
vtkTypeBool UseOpacity
User-changeable settings.
bool DrawBelowRangeSwatch
User-changeable settings.
virtual void LayoutAboveRangeSwatchPosn()
Determine the position of the Above Range if it is to be rendered.
virtual void EditAnnotations()
Subclasses may override this method to alter this->P->Labels, allowing the addition and removal of an...
vtkActor2D * BackgroundActor
Actor for Background.
virtual void DrawBoxes()
For debugging, add placement boxes to the frame polydata.
virtual void SetLookupTable(vtkScalarsToColors *)
Set/Get the lookup table to use.
char * AboveRangeAnnotation
User-changeable settings.
vtkTextProperty * LabelTextProperty
Font for tick labels.
vtkTypeBool DrawTickLabels
User-changeable settings.
virtual void ConfigureFrame()
Generate/configure the representation of the frame from laid-out geometry.
virtual void SetCustomLabels(vtkDoubleArray *labels)
Set/Get the fixed locations to use.
vtkTypeBool FixedAnnotationLeaderLineColor
User-changeable settings.
vtkTypeBool DrawColorBar
User-changeable settings.
char * NanAnnotation
User-changeable settings.
vtkPolyDataMapper2D * BackgroundMapper
Mapper for Background.
virtual void SetTitleTextProperty(vtkTextProperty *p)
Set/Get the title text property.
virtual void GetScalarBarRect(int rect[4], vtkViewport *viewport)
Fills rect with the dimensions of the scalar bar in viewport coordinates.
virtual void SizeTitle(double *titleSize, int *size, vtkViewport *viewport)
Compute the best size for the legend title.
virtual void ConfigureAboveBelowRangeSwatch(bool above)
Generate/configure the above/below range swatch using the laid-out geometry.
int PlaceAnnotationsHorizontally(double barX, double barY, double barWidth, double barHeight, double delta, double pad)
This method is called by ConfigureAnnotationLabels when Orientation is VTK_ORIENT_HORIZONTAL.
vtkTypeBool DrawNanAnnotation
User-changeable settings.
virtual void ConfigureScalarBar()
Generate/configure the scalar bar representation from laid-out geometry.
virtual void ComputeScalarBarLength()
Determine how long the scalar bar should be (on an axis parallel to the direction in which scalar val...
virtual void ConfigureTitle()
Generate/configure the title actor using the laid-out geometry.
void ShallowCopy(vtkProp *prop) override
Shallow copy of a scalar bar actor.
char * ComponentTitle
User-changeable settings.
vtkPolyDataMapper2D * ScalarBarMapper
Mapper for ScalarBar.
vtkTexture * Texture
Color data for TexturePolyData.
vtkTypeBool DrawAnnotations
User-changeable settings.
vtkScalarBarActorInternal * P
Containers shared with subclasses.
vtkActor2D * ScalarBarActor
Actor for ScalarBar.
virtual void SetBackgroundProperty(vtkProperty2D *p)
Set/Get the background property.
double TitleRatio
User-changeable settings.
virtual void PrepareTitleText()
Set the title actor's input to the latest title (and subtitle) text.
double TextureGridWidth
User-changeable settings.
vtkTimeStamp BuildTime
Internal state used for rendering.
virtual void LayoutAboveRangeSwatch()
Determine the size of the Above Range if it is to be rendered.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetFrameProperty(vtkProperty2D *p)
Set/Get the frame property.
bool DrawAboveRangeSwatch
User-changeable settings.
int MaximumWidthInPixels
User-changeable settings.
int NumberOfLabelsBuilt
User-changeable settings.
virtual void LayoutForUnconstrainedFont()
This method sets the title and tick-box size and position for the UnconstrainedFontSize mode.
vtkScalarsToColors * LookupTable
The object this actor illustrates.
virtual void LayoutTicks()
Determine the size and placement of any tick marks to be rendered.
virtual void SetLabelTextProperty(vtkTextProperty *p)
Set/Get the labels text property.
Superclass for mapping scalar values to colors.
An actor that displays text.
represent text properties.
handles properties associated with a texture map
actor that draws 2D data with texture support
record modification and/or execution time
abstract specification for Viewports
window superclass for vtkRenderWindow
#define VTK_ORIENT_VERTICAL
#define VTK_ORIENT_HORIZONTAL