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

Custom scalar bar actor for ParaView that uses the Charts API. More...

#include <vtkContext2DScalarBarActor.h>

Inheritance diagram for vtkContext2DScalarBarActor:
Inheritance graph
[legend]
Collaboration diagram for vtkContext2DScalarBarActor:
Collaboration graph
[legend]

Public Types

enum  { PrecedeScalarBar = 0, SucceedScalarBar }
 
enum  OutOfRangeType { BELOW_RANGE = 0, ABOVE_RANGE = 1 }
 
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 SetBackgroundColor (double, double, double, double)
 Set color of background to draw behind the color bar. More...
 
virtual void SetBackgroundColor (double [4])
 
virtual double * GetBackgroundColor ()
 
virtual void GetBackgroundColor (double &, double &, double &, double &)
 
virtual void GetBackgroundColor (double [4])
 
virtual void SetBackgroundPadding (double)
 Set the padding to add to the background rectangle past the contents of the color legend contents. More...
 
virtual double GetBackgroundPadding ()
 
void SetCustomLabel (vtkIdType index, double value)
 Set label for index. More...
 
int RenderOverlay (vtkViewport *viewport) override
 We only render in the overlay for the context scene. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Draw the scalar bar and annotation text to the screen. More...
 
void ReleaseGraphicsResources (vtkWindow *window) override
 Release any graphics resources that are being consumed by this actor. More...
 
virtual bool Paint (vtkContext2D *painter)
 Responsible for actually drawing the scalar bar. More...
 
vtkRectf GetBoundingRect ()
 Get the bounding rectangle of the scalar bar actor contents in display coordinates. More...
 
int GetEstimatedNumberOfAnnotations ()
 Get an estimated number of annotations emulating loosely the algorithm generating the annotations. More...
 
virtual int GetTitleJustification ()
 Set the title justification. More...
 
virtual void SetTitleJustification (int)
 Set the title justification. More...
 
virtual void SetForceHorizontalTitle (bool)
 If this flag is on, the title will be drawn horizontally above the scalar bar. More...
 
virtual bool GetForceHorizontalTitle ()
 If this flag is on, the title will be drawn horizontally above the scalar bar. More...
 
virtual void ForceHorizontalTitleOn ()
 If this flag is on, the title will be drawn horizontally above the scalar bar. More...
 
virtual void ForceHorizontalTitleOff ()
 If this flag is on, the title will be drawn horizontally above the scalar bar. More...
 
virtual void SetScalarBarThickness (int)
 Set the scalar bar thickness. More...
 
virtual int GetScalarBarThickness ()
 Set the scalar bar thickness. More...
 
virtual void SetScalarBarLength (double)
 Set the scalar bar length. More...
 
virtual double GetScalarBarLength ()
 Set the scalar bar length. More...
 
virtual void SetDrawScalarBarOutline (bool)
 Enable drawing an outline around the scalar bar. More...
 
virtual bool GetDrawScalarBarOutline ()
 Enable drawing an outline around the scalar bar. More...
 
virtual void DrawScalarBarOutlineOn ()
 Enable drawing an outline around the scalar bar. More...
 
virtual void DrawScalarBarOutlineOff ()
 Enable drawing an outline around the scalar bar. More...
 
virtual void SetScalarBarOutlineColor (double, double, double)
 Set the RGB color of the scalar bar outline. More...
 
virtual void SetScalarBarOutlineColor (double [3])
 Set the RGB color of the scalar bar outline. More...
 
virtual double * GetScalarBarOutlineColor ()
 Set the RGB color of the scalar bar outline. More...
 
virtual void GetScalarBarOutlineColor (double &, double &, double &)
 Set the RGB color of the scalar bar outline. More...
 
virtual void GetScalarBarOutlineColor (double [3])
 Set the RGB color of the scalar bar outline. More...
 
virtual void SetScalarBarOutlineThickness (int)
 Set the thickness of the scalar bar outline. More...
 
virtual int GetScalarBarOutlineThickness ()
 Set the thickness of the scalar bar outline. More...
 
virtual void SetReverseLegend (bool)
 Set whether the scalar bar is reversed ie from high to low instead of from low to high. More...
 
virtual bool GetReverseLegend ()
 Set whether the scalar bar is reversed ie from high to low instead of from low to high. More...
 
virtual void ReverseLegendOn ()
 Set whether the scalar bar is reversed ie from high to low instead of from low to high. More...
 
virtual void ReverseLegendOff ()
 Set whether the scalar bar is reversed ie from high to low instead of from low to high. 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 void SetAddRangeLabels (int)
 Set/get whether to add range labels or not. More...
 
virtual int GetAddRangeLabels ()
 Set/get whether to add range labels or not. 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 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...
 
virtual void SetDrawTickMarks (bool)
 Set/get whether tick marks should be drawn. More...
 
virtual bool GetDrawTickMarks ()
 Set/get whether tick marks should be drawn. More...
 
virtual void SetRangeLabelFormat (const char *)
 Printf format for range labels. More...
 
virtual char * GetRangeLabelFormat ()
 Printf format for range labels. More...
 
virtual void SetDataRangeLabelFormat (const char *)
 Printf format for range labels. More...
 
virtual char * GetDataRangeLabelFormat ()
 Printf format for range labels. More...
 
void SetNumberOfCustomLabels (vtkIdType numLabels)
 Set number of custom labels. More...
 
vtkIdType GetNumberOfCustomLabels ()
 Set number of custom labels. More...
 
virtual void SetDrawDataRange (bool)
 If true, the ranges of the arrays linked to the scalar bar are displayed in the widget. More...
 
virtual bool GetDrawDataRange ()
 If true, the ranges of the arrays linked to the scalar bar are displayed in the widget. More...
 
virtual void DrawDataRangeOn ()
 If true, the ranges of the arrays linked to the scalar bar are displayed in the widget. More...
 
virtual void DrawDataRangeOff ()
 If true, the ranges of the arrays linked to the scalar bar are displayed in the widget. More...
 
virtual void SetDataRangeMin (double)
 Set/Get the minimum value of arrays linked to this scalar bar actor. More...
 
virtual double GetDataRangeMin ()
 Set/Get the minimum value of arrays linked to this scalar bar actor. More...
 
virtual void SetDataRangeMax (double)
 Set/Get the maximum value of arrays linked to this scalar bar actor. More...
 
virtual double GetDataRangeMax ()
 Set/Get the maximum value of arrays linked to this scalar bar actor. 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 vtkContext2DScalarBarActor * SafeDownCast (vtkObject *o)
 
static vtkContext2DScalarBarActor * 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

 vtkContext2DScalarBarActor ()
 
 ~vtkContext2DScalarBarActor () override
 
- 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 ComputeScalarBarThickness ()
 
virtual void ComputeSwatchPad ()
 
virtual void LayoutNanSwatch ()
 
virtual void LayoutBelowRangeSwatch ()
 
virtual void LayoutAboveRangeSwatch ()
 
virtual void LayoutAboveRangeSwatchPosn ()
 
virtual void PrepareTitleText ()
 
virtual void LayoutTitle ()
 
virtual void LayoutForUnconstrainedFont ()
 
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 ConfigureAboveBelowRangeSwatch (bool above)
 
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)
 
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

bool DrawDataRange
 Flag to show the range on the scalar bar. More...
 
int VerticalOffset = 0
 Offset applied to scalar bar when DrawDataRange is true. More...
 
double DataRangeMin = 0
 Range to be displayed. More...
 
double DataRangeMax = 0
 Range to be displayed. 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

Custom scalar bar actor for ParaView that uses the Charts API.

.SECTION Description

vtkContext2DScalarBarActor is a custom scalar bar actor that uses the Charts API for drawing calls. As the scalar bar actor is inherently 2D, the Charts API offers a comparatively simpler way of implementing features in the scalar bar actor than using vtkPolyData primitives.

Definition at line 37 of file vtkContext2DScalarBarActor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkScalarBarActor vtkContext2DScalarBarActor::Superclass

Definition at line 40 of file vtkContext2DScalarBarActor.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
PrecedeScalarBar 
SucceedScalarBar 

Definition at line 63 of file vtkContext2DScalarBarActor.h.

◆ OutOfRangeType

enum vtkContext2DScalarBarActor::OutOfRangeType
Enumerator
BELOW_RANGE 
ABOVE_RANGE 

Definition at line 69 of file vtkContext2DScalarBarActor.h.

Constructor & Destructor Documentation

◆ vtkContext2DScalarBarActor()

vtkContext2DScalarBarActor::vtkContext2DScalarBarActor ( )
protected

◆ ~vtkContext2DScalarBarActor()

vtkContext2DScalarBarActor::~vtkContext2DScalarBarActor ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkContext2DScalarBarActor::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkScalarBarActor.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkContext2DScalarBarActor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkScalarBarActor.

◆ New()

static vtkContext2DScalarBarActor* vtkContext2DScalarBarActor::New ( )
static

◆ GetTitleJustification()

virtual int vtkContext2DScalarBarActor::GetTitleJustification ( )
virtual

Set the title justification.

Valid values are VTK_TEXT_LEFT, VTK_TEXT_CENTERED, and VTK_TEXT_RIGHT.

◆ SetTitleJustification()

virtual void vtkContext2DScalarBarActor::SetTitleJustification ( int  )
virtual

Set the title justification.

Valid values are VTK_TEXT_LEFT, VTK_TEXT_CENTERED, and VTK_TEXT_RIGHT.

◆ SetForceHorizontalTitle()

virtual void vtkContext2DScalarBarActor::SetForceHorizontalTitle ( bool  )
virtual

If this flag is on, the title will be drawn horizontally above the scalar bar.

Off by default.

◆ GetForceHorizontalTitle()

virtual bool vtkContext2DScalarBarActor::GetForceHorizontalTitle ( )
virtual

If this flag is on, the title will be drawn horizontally above the scalar bar.

Off by default.

◆ ForceHorizontalTitleOn()

virtual void vtkContext2DScalarBarActor::ForceHorizontalTitleOn ( )
virtual

If this flag is on, the title will be drawn horizontally above the scalar bar.

Off by default.

◆ ForceHorizontalTitleOff()

virtual void vtkContext2DScalarBarActor::ForceHorizontalTitleOff ( )
virtual

If this flag is on, the title will be drawn horizontally above the scalar bar.

Off by default.

◆ SetScalarBarThickness()

virtual void vtkContext2DScalarBarActor::SetScalarBarThickness ( int  )
virtual

Set the scalar bar thickness.

When the orientation is VTK_ORIENT_VERTICAL, this sets the scalar bar width. When the orientation is VTK_ORIENT_HORIZONTAL, this sets the scalar bar height. Specified in points akin to font size.

◆ GetScalarBarThickness()

virtual int vtkContext2DScalarBarActor::GetScalarBarThickness ( )
virtual

Set the scalar bar thickness.

When the orientation is VTK_ORIENT_VERTICAL, this sets the scalar bar width. When the orientation is VTK_ORIENT_HORIZONTAL, this sets the scalar bar height. Specified in points akin to font size.

◆ SetScalarBarLength()

virtual void vtkContext2DScalarBarActor::SetScalarBarLength ( double  )
virtual

Set the scalar bar length.

When the orientation is VTK_ORIENT_VERTICAL, this sets the scalar bar height. When the orientation is VTK_ORIENT_HORIZONTAL, this sets the scalar bar width. Specified in normalized viewport coordinates, meaning the value is the fractional span of the viewport's width or height in the range [0, 1], depending on orientation.

◆ GetScalarBarLength()

virtual double vtkContext2DScalarBarActor::GetScalarBarLength ( )
virtual

Set the scalar bar length.

When the orientation is VTK_ORIENT_VERTICAL, this sets the scalar bar height. When the orientation is VTK_ORIENT_HORIZONTAL, this sets the scalar bar width. Specified in normalized viewport coordinates, meaning the value is the fractional span of the viewport's width or height in the range [0, 1], depending on orientation.

◆ SetDrawScalarBarOutline()

virtual void vtkContext2DScalarBarActor::SetDrawScalarBarOutline ( bool  )
virtual

Enable drawing an outline around the scalar bar.

◆ GetDrawScalarBarOutline()

virtual bool vtkContext2DScalarBarActor::GetDrawScalarBarOutline ( )
virtual

Enable drawing an outline around the scalar bar.

◆ DrawScalarBarOutlineOn()

virtual void vtkContext2DScalarBarActor::DrawScalarBarOutlineOn ( )
virtual

Enable drawing an outline around the scalar bar.

◆ DrawScalarBarOutlineOff()

virtual void vtkContext2DScalarBarActor::DrawScalarBarOutlineOff ( )
virtual

Enable drawing an outline around the scalar bar.

◆ SetScalarBarOutlineColor() [1/2]

virtual void vtkContext2DScalarBarActor::SetScalarBarOutlineColor ( double  ,
double  ,
double   
)
virtual

Set the RGB color of the scalar bar outline.

◆ SetScalarBarOutlineColor() [2/2]

virtual void vtkContext2DScalarBarActor::SetScalarBarOutlineColor ( double  [3])
virtual

Set the RGB color of the scalar bar outline.

◆ GetScalarBarOutlineColor() [1/3]

virtual double* vtkContext2DScalarBarActor::GetScalarBarOutlineColor ( )
virtual

Set the RGB color of the scalar bar outline.

◆ GetScalarBarOutlineColor() [2/3]

virtual void vtkContext2DScalarBarActor::GetScalarBarOutlineColor ( double &  ,
double &  ,
double &   
)
virtual

Set the RGB color of the scalar bar outline.

◆ GetScalarBarOutlineColor() [3/3]

virtual void vtkContext2DScalarBarActor::GetScalarBarOutlineColor ( double  [3])
virtual

Set the RGB color of the scalar bar outline.

◆ SetScalarBarOutlineThickness()

virtual void vtkContext2DScalarBarActor::SetScalarBarOutlineThickness ( int  )
virtual

Set the thickness of the scalar bar outline.

◆ GetScalarBarOutlineThickness()

virtual int vtkContext2DScalarBarActor::GetScalarBarOutlineThickness ( )
virtual

Set the thickness of the scalar bar outline.

◆ SetBackgroundColor() [1/2]

virtual void vtkContext2DScalarBarActor::SetBackgroundColor ( double  ,
double  ,
double  ,
double   
)
virtual

Set color of background to draw behind the color bar.

First three components, specify RGB color components, opacity is the fourth element.

◆ SetBackgroundColor() [2/2]

virtual void vtkContext2DScalarBarActor::SetBackgroundColor ( double  [4])
virtual

◆ GetBackgroundColor() [1/3]

virtual double* vtkContext2DScalarBarActor::GetBackgroundColor ( )
virtual

◆ GetBackgroundColor() [2/3]

virtual void vtkContext2DScalarBarActor::GetBackgroundColor ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

◆ GetBackgroundColor() [3/3]

virtual void vtkContext2DScalarBarActor::GetBackgroundColor ( double  [4])
virtual

◆ SetBackgroundPadding()

virtual void vtkContext2DScalarBarActor::SetBackgroundPadding ( double  )
virtual

Set the padding to add to the background rectangle past the contents of the color legend contents.

◆ GetBackgroundPadding()

virtual double vtkContext2DScalarBarActor::GetBackgroundPadding ( )
virtual

◆ SetReverseLegend()

virtual void vtkContext2DScalarBarActor::SetReverseLegend ( bool  )
virtual

Set whether the scalar bar is reversed ie from high to low instead of from low to high.

Default is false;

◆ GetReverseLegend()

virtual bool vtkContext2DScalarBarActor::GetReverseLegend ( )
virtual

Set whether the scalar bar is reversed ie from high to low instead of from low to high.

Default is false;

◆ ReverseLegendOn()

virtual void vtkContext2DScalarBarActor::ReverseLegendOn ( )
virtual

Set whether the scalar bar is reversed ie from high to low instead of from low to high.

Default is false;

◆ ReverseLegendOff()

virtual void vtkContext2DScalarBarActor::ReverseLegendOff ( )
virtual

Set whether the scalar bar is reversed ie from high to low instead of from low to high.

Default is false;

◆ GetAutomaticLabelFormat()

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

◆ SetAddRangeLabels()

virtual void vtkContext2DScalarBarActor::SetAddRangeLabels ( int  )
virtual

Set/get whether to add range labels or not.

These are labels that have the minimum/maximum values of the scalar bar range.

◆ GetAddRangeLabels()

virtual int vtkContext2DScalarBarActor::GetAddRangeLabels ( )
virtual

Set/get whether to add range labels or not.

These are labels that have the minimum/maximum values of the scalar bar range.

◆ SetAutomaticAnnotations()

virtual void vtkContext2DScalarBarActor::SetAutomaticAnnotations ( int  )
virtual

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

Default is FALSE;

◆ GetAutomaticAnnotations()

virtual int vtkContext2DScalarBarActor::GetAutomaticAnnotations ( )
virtual

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

Default is FALSE;

◆ AutomaticAnnotationsOn()

virtual void vtkContext2DScalarBarActor::AutomaticAnnotationsOn ( )
virtual

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

Default is FALSE;

◆ AutomaticAnnotationsOff()

virtual void vtkContext2DScalarBarActor::AutomaticAnnotationsOff ( )
virtual

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

Default is FALSE;

◆ GetAddRangeAnnotations()

virtual int vtkContext2DScalarBarActor::GetAddRangeAnnotations ( )
virtual

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

◆ SetAddRangeAnnotations()

virtual void vtkContext2DScalarBarActor::SetAddRangeAnnotations ( int  )
virtual

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

◆ AddRangeAnnotationsOn()

virtual void vtkContext2DScalarBarActor::AddRangeAnnotationsOn ( )
virtual

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

◆ AddRangeAnnotationsOff()

virtual void vtkContext2DScalarBarActor::AddRangeAnnotationsOff ( )
virtual

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

◆ SetDrawTickMarks()

virtual void vtkContext2DScalarBarActor::SetDrawTickMarks ( bool  )
virtual

Set/get whether tick marks should be drawn.

◆ GetDrawTickMarks()

virtual bool vtkContext2DScalarBarActor::GetDrawTickMarks ( )
virtual

Set/get whether tick marks should be drawn.

◆ SetRangeLabelFormat()

virtual void vtkContext2DScalarBarActor::SetRangeLabelFormat ( const char *  )
virtual

Printf format for range labels.

◆ GetRangeLabelFormat()

virtual char* vtkContext2DScalarBarActor::GetRangeLabelFormat ( )
virtual

Printf format for range labels.

◆ SetDataRangeLabelFormat()

virtual void vtkContext2DScalarBarActor::SetDataRangeLabelFormat ( const char *  )
virtual

Printf format for range labels.

◆ GetDataRangeLabelFormat()

virtual char* vtkContext2DScalarBarActor::GetDataRangeLabelFormat ( )
virtual

Printf format for range labels.

◆ SetNumberOfCustomLabels()

void vtkContext2DScalarBarActor::SetNumberOfCustomLabels ( vtkIdType  numLabels)

Set number of custom labels.

◆ GetNumberOfCustomLabels()

vtkIdType vtkContext2DScalarBarActor::GetNumberOfCustomLabels ( )

Set number of custom labels.

◆ SetCustomLabel()

void vtkContext2DScalarBarActor::SetCustomLabel ( vtkIdType  index,
double  value 
)

Set label for index.

◆ RenderOverlay()

int vtkContext2DScalarBarActor::RenderOverlay ( vtkViewport *  viewport)
overridevirtual

We only render in the overlay for the context scene.

Reimplemented from vtkScalarBarActor.

◆ RenderOpaqueGeometry()

int vtkContext2DScalarBarActor::RenderOpaqueGeometry ( vtkViewport *  viewport)
overridevirtual

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkScalarBarActor.

◆ ReleaseGraphicsResources()

void vtkContext2DScalarBarActor::ReleaseGraphicsResources ( vtkWindow *  window)
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.

◆ Paint()

virtual bool vtkContext2DScalarBarActor::Paint ( vtkContext2D *  painter)
virtual

Responsible for actually drawing the scalar bar.

◆ GetBoundingRect()

vtkRectf vtkContext2DScalarBarActor::GetBoundingRect ( )

Get the bounding rectangle of the scalar bar actor contents in display coordinates.

◆ GetEstimatedNumberOfAnnotations()

int vtkContext2DScalarBarActor::GetEstimatedNumberOfAnnotations ( )

Get an estimated number of annotations emulating loosely the algorithm generating the annotations.

The actual number of annotations can be slightly lower than the return of this method when using automatic annotations.

◆ SetDrawDataRange()

virtual void vtkContext2DScalarBarActor::SetDrawDataRange ( bool  )
virtual

If true, the ranges of the arrays linked to the scalar bar are displayed in the widget.

By default, it is set to false.

◆ GetDrawDataRange()

virtual bool vtkContext2DScalarBarActor::GetDrawDataRange ( )
virtual

If true, the ranges of the arrays linked to the scalar bar are displayed in the widget.

By default, it is set to false.

◆ DrawDataRangeOn()

virtual void vtkContext2DScalarBarActor::DrawDataRangeOn ( )
virtual

If true, the ranges of the arrays linked to the scalar bar are displayed in the widget.

By default, it is set to false.

◆ DrawDataRangeOff()

virtual void vtkContext2DScalarBarActor::DrawDataRangeOff ( )
virtual

If true, the ranges of the arrays linked to the scalar bar are displayed in the widget.

By default, it is set to false.

◆ SetDataRangeMin()

virtual void vtkContext2DScalarBarActor::SetDataRangeMin ( double  )
virtual

Set/Get the minimum value of arrays linked to this scalar bar actor.

This value can be set to a minimum value that is not the same as the LUT range and is displayed in the color legend when "DrawDataRange" is set to true.

◆ GetDataRangeMin()

virtual double vtkContext2DScalarBarActor::GetDataRangeMin ( )
virtual

Set/Get the minimum value of arrays linked to this scalar bar actor.

This value can be set to a minimum value that is not the same as the LUT range and is displayed in the color legend when "DrawDataRange" is set to true.

◆ SetDataRangeMax()

virtual void vtkContext2DScalarBarActor::SetDataRangeMax ( double  )
virtual

Set/Get the maximum value of arrays linked to this scalar bar actor.

This value can be set to a minimum value that is not the same as the LUT range and is displayed in the color legend when "DrawDataRange" is set to true.

◆ GetDataRangeMax()

virtual double vtkContext2DScalarBarActor::GetDataRangeMax ( )
virtual

Set/Get the maximum value of arrays linked to this scalar bar actor.

This value can be set to a minimum value that is not the same as the LUT range and is displayed in the color legend when "DrawDataRange" is set to true.

Member Data Documentation

◆ DrawDataRange

bool vtkContext2DScalarBarActor::DrawDataRange
protected

Flag to show the range on the scalar bar.

Definition at line 302 of file vtkContext2DScalarBarActor.h.

◆ DataRangeMin

double vtkContext2DScalarBarActor::DataRangeMin = 0
protected

Range to be displayed.

Definition at line 308 of file vtkContext2DScalarBarActor.h.

◆ DataRangeMax

double vtkContext2DScalarBarActor::DataRangeMax = 0
protected

Range to be displayed.

Definition at line 309 of file vtkContext2DScalarBarActor.h.

◆ VerticalOffset

int vtkContext2DScalarBarActor::VerticalOffset = 0
protected

Offset applied to scalar bar when DrawDataRange is true.

Definition at line 315 of file vtkContext2DScalarBarActor.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13 on Thu Mar 28 2024