A scalar bar with labels of fixed font. More...
#include <vtkPVScalarBarActor.h>
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. Adjustments to the scalar bar happen solely on the bar itself. There are other slight differences in how the size of the scalar bar is determined to make it easier to control in ParaView.
Definition at line 43 of file vtkPVScalarBarActor.h.
Constructor & Destructor Documentation
| vtkPVScalarBarActor::vtkPVScalarBarActor | ( | ) | [protected] |
| vtkPVScalarBarActor::~vtkPVScalarBarActor | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkPVScalarBarActor::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkScalarBarActor.
| static int vtkPVScalarBarActor::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkScalarBarActor.
| virtual int vtkPVScalarBarActor::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkScalarBarActor.
| static vtkPVScalarBarActor* vtkPVScalarBarActor::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkScalarBarActor.
| virtual void vtkPVScalarBarActor::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkScalarBarActor.
| static vtkPVScalarBarActor* vtkPVScalarBarActor::New | ( | ) | [static] |
Reimplemented from vtkScalarBarActor.
| virtual int vtkPVScalarBarActor::RenderOpaqueGeometry | ( | vtkViewport * | viewport | ) | [virtual] |
Draw the scalar bar and annotation text to the screen.
Reimplemented from vtkScalarBarActor.
| virtual int vtkPVScalarBarActor::RenderOverlay | ( | vtkViewport * | viewport | ) | [virtual] |
Draw the scalar bar and annotation text to the screen.
Reimplemented from vtkScalarBarActor.
| virtual double vtkPVScalarBarActor::GetAspectRatio | ( | ) | [virtual] |
The bar aspect ratio (length/width). Defaults to 20. Note that this the aspect ration of the color bar only, not including labels.
| virtual void vtkPVScalarBarActor::SetAspectRatio | ( | double | ) | [virtual] |
The bar aspect ratio (length/width). Defaults to 20. Note that this the aspect ration of the color bar only, not including labels.
| 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.
| 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.
| 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.
| 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.
| 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.
Reimplemented from vtkScalarBarActor.
| virtual void vtkPVScalarBarActor::AllocateAndPositionLabels | ( | int * | propSize, |
| vtkViewport * | viewport | ||
| ) | [protected, virtual] |
Allocate and position all the labels (stored in LabelMappers and LabelActors).
| virtual void vtkPVScalarBarActor::PositionTitle | ( | const int | propSize[2], |
| vtkViewport * | viewport | ||
| ) | [protected, virtual] |
Determines the size and position of the title and sets the mapper and actor to place it there.
| virtual void vtkPVScalarBarActor::PositionScalarBar | ( | const int | propSize[2], |
| vtkViewport * | viewport | ||
| ) | [protected, virtual] |
Set up the ScalarBar, ScalarBarMapper, and ScalarBarActor based on the current position and orientation of this actor.
| virtual void vtkPVScalarBarActor::BuildScalarBarTexture | ( | ) | [protected, virtual] |
Set up the texture used to render the scalar bar.
| virtual int vtkPVScalarBarActor::CreateLabel | ( | double | value, |
| int | targetWidth, | ||
| int | targetHeight, | ||
| vtkViewport * | viewport | ||
| ) | [protected, virtual] |
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.
| virtual std::vector<double> vtkPVScalarBarActor::LinearTickMarks | ( | const double | range[2], |
| int | maxTicks, | ||
| bool | intOnly = false |
||
| ) | [protected, virtual] |
Given a data range, finds locations for tick marks that will have "friendly" labels (that is, can be represented with less units of precision).
| virtual std::vector<double> vtkPVScalarBarActor::LogTickMarks | ( | const double | range[2], |
| int | maxTicks | ||
| ) | [protected, virtual] |
Given a data range, finds locations for tick marks that will have "friendly" labels (that is, can be represented with less units of precision).
Member Data Documentation
double vtkPVScalarBarActor::AspectRatio [protected] |
Definition at line 81 of file vtkPVScalarBarActor.h.
int vtkPVScalarBarActor::AutomaticLabelFormat [protected] |
Definition at line 83 of file vtkPVScalarBarActor.h.
std::vector<vtkSmartPointer<vtkTextMapper> > vtkPVScalarBarActor::LabelMappers [protected] |
These replace the TextMappers and TextActors fields because they are a lot easier to work with.
Definition at line 89 of file vtkPVScalarBarActor.h.
std::vector<vtkSmartPointer<vtkActor2D> > vtkPVScalarBarActor::LabelActors [protected] |
These replace the TextMappers and TextActors fields because they are a lot easier to work with.
Definition at line 90 of file vtkPVScalarBarActor.h.
vtkTexture* vtkPVScalarBarActor::ScalarBarTexture [protected] |
Definition at line 130 of file vtkPVScalarBarActor.h.
vtkPolyData* vtkPVScalarBarActor::TickMarks [protected] |
Definition at line 132 of file vtkPVScalarBarActor.h.
vtkPolyDataMapper2D* vtkPVScalarBarActor::TickMarksMapper [protected] |
Definition at line 133 of file vtkPVScalarBarActor.h.
vtkActor2D* vtkPVScalarBarActor::TickMarksActor [protected] |
Definition at line 134 of file vtkPVScalarBarActor.h.
int vtkPVScalarBarActor::TitleSpace [protected] |
Space, in pixels, between the title and the rest of the bar. Currently set in PositionTitle.
Definition at line 138 of file vtkPVScalarBarActor.h.
int vtkPVScalarBarActor::BarWidth [protected] |
The width and height of the bar in pixels. Currently set in AllocateAndPositionLabels.
Definition at line 142 of file vtkPVScalarBarActor.h.
int vtkPVScalarBarActor::BarHeight [protected] |
The width and height of the bar in pixels. Currently set in AllocateAndPositionLabels.
Definition at line 143 of file vtkPVScalarBarActor.h.
int vtkPVScalarBarActor::LabelSpace [protected] |
Space, in pixels, between the labels and the bar itself. Currently set in PositionTitle.
Definition at line 147 of file vtkPVScalarBarActor.h.
int vtkPVScalarBarActor::LabelHeight [protected] |
The space in pixels given to the hieght of the labels.
Definition at line 149 of file vtkPVScalarBarActor.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/VTKExtensions/vtkPVScalarBarActor.h
