vtkAxis Class Reference
#include <vtkAxis.h>
List of all members.
Detailed Description
takes care of drawing 2D axes
The vtkAxis is drawn in screen coordinates. It is usually one of the last elements of a chart to be drawn. It renders the axis label, tick marks and tick labels.
- Tests:
- vtkAxis (Tests)
Definition at line 44 of file vtkAxis.h.
|
Public Types |
| typedef vtkContextItem | Superclass |
|
| enum | {
LEFT = 0,
BOTTOM,
RIGHT,
TOP,
PARALLEL
} |
|
| enum | { STANDARD = 0,
SCIENTIFIC,
MIXED
} |
|
| enum | { AUTO = 0,
FIXED,
CUSTOM
} |
Public Member Functions |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | SetMinimum (double minimum) |
| virtual void | SetMaximum (double maximum) |
| virtual void | SetRange (double minimum, double maximum) |
| virtual void | SetMinimumLimit (double lowest) |
| virtual void | SetMaximumLimit (double highest) |
| virtual void | Update () |
| virtual bool | Paint (vtkContext2D *painter) |
| virtual void | AutoScale () |
| virtual void | RecalculateTickSpacing () |
| virtual vtkDoubleArray * | GetTickPositions () |
| virtual void | SetTickPositions (vtkDoubleArray *positions) |
| virtual vtkFloatArray * | GetTickScenePositions () |
| virtual vtkStringArray * | GetTickLabels () |
| virtual void | SetTickLabels (vtkStringArray *labels) |
| vtkRectf | GetBoundingRect (vtkContext2D *painter) |
|
| virtual void | SetPosition (int position) |
| virtual int | GetPosition () |
|
| void | SetPoint1 (const vtkVector2f &pos) |
| void | SetPoint1 (float x, float y) |
|
| virtual float * | GetPoint1 () |
| virtual void | GetPoint1 (float &, float &) |
| virtual void | GetPoint1 (float[2]) |
| vtkVector2f | GetPosition1 () |
|
| void | SetPoint2 (const vtkVector2f &pos) |
| void | SetPoint2 (float x, float y) |
|
| virtual float * | GetPoint2 () |
| virtual void | GetPoint2 (float &, float &) |
| virtual void | GetPoint2 (float[2]) |
| vtkVector2f | GetPosition2 () |
|
| virtual void | SetNumberOfTicks (int) |
|
| virtual int | GetNumberOfTicks () |
|
| virtual vtkTextProperty * | GetLabelProperties () |
|
| virtual double | GetMinimum () |
|
| virtual double | GetMaximum () |
|
| virtual double | GetMinimumLimit () |
|
| virtual double | GetMaximumLimit () |
|
| virtual void | SetTitle (const vtkStdString &title) |
| virtual vtkStdString | GetTitle () |
|
| virtual vtkTextProperty * | GetTitleProperties () |
|
| virtual void | SetLogScale (bool) |
| virtual bool | GetLogScale () |
|
| virtual void | SetGridVisible (bool) |
| virtual bool | GetGridVisible () |
|
| virtual void | SetLabelsVisible (bool) |
| virtual bool | GetLabelsVisible () |
|
| virtual void | SetPrecision (int precision) |
| virtual int | GetPrecision () |
|
| virtual void | SetNotation (int notation) |
| virtual int | GetNotation () |
|
| virtual void | SetBehavior (int) |
| virtual int | GetBehavior () |
|
| virtual vtkPen * | GetPen () |
|
| virtual vtkPen * | GetGridPen () |
Static Public Member Functions |
| static int | IsTypeOf (const char *type) |
| static vtkAxis * | SafeDownCast (vtkObject *o) |
| static vtkAxis * | New () |
Protected Member Functions |
| | vtkAxis () |
| | ~vtkAxis () |
| void | GenerateTickLabels (double min, double max) |
| void | GenerateTickLabels () |
| double | CalculateNiceMinMax (double &min, double &max) |
| double | NiceNumber (double number, bool roundUp) |
|
| double | LogScaleTickMark (double number, bool roundUp, bool &niceValue, int &order) |
|
| void | GenerateLogScaleTickMarks (int order, double min=1.0, double max=9.0, bool detailLabels=true) |
Protected Attributes |
| int | Position |
| float * | Point1 |
| float * | Point2 |
| vtkVector2f | Position1 |
| vtkVector2f | Position2 |
| double | TickInterval |
| int | NumberOfTicks |
| vtkTextProperty * | LabelProperties |
| double | Minimum |
| double | Maximum |
| double | MinimumLimit |
| double | MaximumLimit |
| vtkStdString | Title |
| vtkTextProperty * | TitleProperties |
| bool | LogScale |
| bool | GridVisible |
| bool | LabelsVisible |
| int | Precision |
| int | Notation |
| int | Behavior |
| float | MaxLabel [2] |
| vtkPen * | Pen |
| vtkPen * | GridPen |
| vtkSmartPointer< vtkDoubleArray > | TickPositions |
| vtkSmartPointer< vtkFloatArray > | TickScenePositions |
| vtkSmartPointer< vtkStringArray > | TickLabels |
| bool | UsingNiceMinMax |
| bool | TickMarksDirty |
| bool | Resized |
| bool | LogScaleReasonable |
| vtkTimeStamp | BuildTime |
Member Typedef Documentation
Member Enumeration Documentation
Enumeration of the axis locations in a conventional XY chart. Other layouts are possible.
- Enumerator:
-
| LEFT |
|
| BOTTOM |
|
| RIGHT |
|
| TOP |
|
| PARALLEL |
|
Definition at line 53 of file vtkAxis.h.
Enumeration of the axis notations available.
- Enumerator:
-
| STANDARD |
|
| SCIENTIFIC |
|
| MIXED |
|
Definition at line 189 of file vtkAxis.h.
Enumeration of the axis behaviors.
- Enumerator:
-
Definition at line 205 of file vtkAxis.h.
Constructor & Destructor Documentation
| vtkAxis::vtkAxis |
( |
|
) |
[protected] |
| vtkAxis::~vtkAxis |
( |
|
) |
[protected] |
Member Function Documentation
| virtual const char* vtkAxis::GetClassName |
( |
|
) |
[virtual] |
| static int vtkAxis::IsTypeOf |
( |
const char * |
name |
) |
[static] |
Return 1 if this class type 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 vtkContextItem.
| virtual int vtkAxis::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 vtkContextItem.
| virtual void vtkAxis::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 vtkContextItem.
| static vtkAxis* vtkAxis::New |
( |
|
) |
[static] |
Creates a 2D Chart object.
Reimplemented from vtkObject.
| virtual void vtkAxis::SetPosition |
( |
int |
position |
) |
[virtual] |
Get/set the position of the axis (LEFT, BOTTOM, RIGHT, TOP, PARALLEL).
| virtual int vtkAxis::GetPosition |
( |
|
) |
[virtual] |
Get/set the position of the axis (LEFT, BOTTOM, RIGHT, TOP, PARALLEL).
Set point 1 of the axis (in pixels), this is usually the origin.
| void vtkAxis::SetPoint1 |
( |
float |
x, |
|
|
float |
y | |
|
) |
| | |
Set point 1 of the axis (in pixels), this is usually the origin.
| virtual float* vtkAxis::GetPoint1 |
( |
|
) |
[virtual] |
Get point 1 of the axis (in pixels), this is usually the origin.
| virtual void vtkAxis::GetPoint1 |
( |
float & |
, |
|
|
float & |
| |
|
) |
| | [virtual] |
Get point 1 of the axis (in pixels), this is usually the origin.
| virtual void vtkAxis::GetPoint1 |
( |
float |
[2] |
) |
[virtual] |
Get point 1 of the axis (in pixels), this is usually the origin.
Get point 1 of the axis (in pixels), this is usually the origin.
Set point 2 of the axis (in pixels), this is usually the terminus.
| void vtkAxis::SetPoint2 |
( |
float |
x, |
|
|
float |
y | |
|
) |
| | |
Set point 2 of the axis (in pixels), this is usually the terminus.
| virtual float* vtkAxis::GetPoint2 |
( |
|
) |
[virtual] |
Get point 2 of the axis (in pixels), this is usually the terminus.
| virtual void vtkAxis::GetPoint2 |
( |
float & |
, |
|
|
float & |
| |
|
) |
| | [virtual] |
Get point 2 of the axis (in pixels), this is usually the terminus.
| virtual void vtkAxis::GetPoint2 |
( |
float |
[2] |
) |
[virtual] |
Get point 2 of the axis (in pixels), this is usually the terminus.
Get point 2 of the axis (in pixels), this is usually the terminus.
| virtual void vtkAxis::SetNumberOfTicks |
( |
int |
|
) |
[virtual] |
Set the number of tick marks for this axis. Default is -1, which leads to automatic calculation of nicely spaced tick marks.
| virtual int vtkAxis::GetNumberOfTicks |
( |
|
) |
[virtual] |
Get the number of tick marks for this axis.
Get the vtkTextProperty that governs how the axis lables are displayed. Note that the alignment properties are not used.
| virtual void vtkAxis::SetMinimum |
( |
double |
minimum |
) |
[virtual] |
Set the logical minimum value of the axis, in plot coordinates.
| virtual double vtkAxis::GetMinimum |
( |
|
) |
[virtual] |
Get the logical minimum value of the axis, in plot coordinates.
| virtual void vtkAxis::SetMaximum |
( |
double |
maximum |
) |
[virtual] |
Set the logical maximum value of the axis, in plot coordinates.
| virtual double vtkAxis::GetMaximum |
( |
|
) |
[virtual] |
Get the logical maximum value of the axis, in plot coordinates.
| virtual void vtkAxis::SetRange |
( |
double |
minimum, |
|
|
double |
maximum | |
|
) |
| | [virtual] |
Get the logical range of the axis, in plot coordinates.
| virtual void vtkAxis::SetMinimumLimit |
( |
double |
lowest |
) |
[virtual] |
Set the logical lowest possible value for Minimum, in plot coordinates.
| virtual double vtkAxis::GetMinimumLimit |
( |
|
) |
[virtual] |
Get the logical lowest possible value for Minimum, in plot coordinates.
| virtual void vtkAxis::SetMaximumLimit |
( |
double |
highest |
) |
[virtual] |
Set the logical highest possible value for Maximum, in plot coordinates.
| virtual double vtkAxis::GetMaximumLimit |
( |
|
) |
[virtual] |
Get the logical highest possible value for Maximum, in plot coordinates.
| virtual void vtkAxis::SetTitle |
( |
const vtkStdString & |
title |
) |
[virtual] |
Get/set the title text of the axis.
Get/set the title text of the axis.
| virtual void vtkAxis::SetLogScale |
( |
bool |
|
) |
[virtual] |
Get/set whether the axis should use a log scale, default is false.
| virtual bool vtkAxis::GetLogScale |
( |
|
) |
[virtual] |
Get/set whether the axis should use a log scale, default is false.
| virtual void vtkAxis::SetGridVisible |
( |
bool |
|
) |
[virtual] |
Get/set whether the axis grid lines should be drawn, default is true.
| virtual bool vtkAxis::GetGridVisible |
( |
|
) |
[virtual] |
Get/set whether the axis grid lines should be drawn, default is true.
| virtual void vtkAxis::SetLabelsVisible |
( |
bool |
|
) |
[virtual] |
Get/set whether the axis labels should be visible.
| virtual bool vtkAxis::GetLabelsVisible |
( |
|
) |
[virtual] |
Get/set whether the axis labels should be visible.
| virtual void vtkAxis::SetPrecision |
( |
int |
precision |
) |
[virtual] |
Get/set the numerical precision to use, default is 2.
| virtual int vtkAxis::GetPrecision |
( |
|
) |
[virtual] |
Get/set the numerical precision to use, default is 2.
| virtual void vtkAxis::SetNotation |
( |
int |
notation |
) |
[virtual] |
Get/set the numerical notation, standard, scientific or mixed (0, 1, 2).
| virtual int vtkAxis::GetNotation |
( |
|
) |
[virtual] |
Get/set the numerical notation, standard, scientific or mixed (0, 1, 2).
| virtual void vtkAxis::SetBehavior |
( |
int |
|
) |
[virtual] |
Get/set the behavior of the axis (auto, fixed, custom). Default is 0 (auto).
| virtual int vtkAxis::GetBehavior |
( |
|
) |
[virtual] |
Get/set the behavior of the axis (auto, fixed, custom). Default is 0 (auto).
| virtual vtkPen* vtkAxis::GetPen |
( |
|
) |
[virtual] |
Get a pointer to the vtkPen object that controls the way this axis is drawn.
| virtual vtkPen* vtkAxis::GetGridPen |
( |
|
) |
[virtual] |
Get a pointer to the vtkPen object that controls the way this axis is drawn.
| virtual void vtkAxis::Update |
( |
|
) |
[virtual] |
Update the geometry of the axis. Takes care of setting up the tick mark locations etc. Should be called by the scene before rendering.
Reimplemented from vtkAbstractContextItem.
| virtual bool vtkAxis::Paint |
( |
vtkContext2D * |
painter |
) |
[virtual] |
Paint event for the axis, called whenever the axis needs to be drawn.
Reimplemented from vtkAbstractContextItem.
| virtual void vtkAxis::AutoScale |
( |
|
) |
[virtual] |
Use this function to autoscale the axes after setting the minimum and maximum values. This will cause the axes to select the nicest numbers that enclose the minimum and maximum values, and to select an appropriate number of tick marks.
| virtual void vtkAxis::RecalculateTickSpacing |
( |
|
) |
[virtual] |
Recalculate the spacing of the tick marks - typically useful to do after scaling the axis.
An array with the positions of the tick marks along the axis line. The positions are specified in the plot coordinates of the axis.
| virtual void vtkAxis::SetTickPositions |
( |
vtkDoubleArray * |
positions |
) |
[virtual] |
Set the tick positions (in plot coordinates).
| virtual vtkFloatArray* vtkAxis::GetTickScenePositions |
( |
|
) |
[virtual] |
An array with the positions of the tick marks along the axis line. The positions are specified in scene coordinates.
A string array containing the tick labels for the axis.
| virtual void vtkAxis::SetTickLabels |
( |
vtkStringArray * |
labels |
) |
[virtual] |
Set the tick labels for the axis.
Request the space the axes require to be drawn. This is returned as a vtkRectf, with the corner being the offset from Point1, and the width/ height being the total width/height required by the axis. In order to ensure the numbers are correct, Update() should be called on the axis.
| void vtkAxis::GenerateTickLabels |
( |
double |
min, |
|
|
double |
max | |
|
) |
| | [protected] |
Calculate and assign nice labels/logical label positions.
| void vtkAxis::GenerateTickLabels |
( |
|
) |
[protected] |
Generate tick labels from the supplied double array of tick positions.
| double vtkAxis::CalculateNiceMinMax |
( |
double & |
min, |
|
|
double & |
max | |
|
) |
| | [protected] |
Calculate the next "nicest" numbers above and below the current minimum.
- Returns:
- the "nice" spacing of the numbers.
| double vtkAxis::NiceNumber |
( |
double |
number, |
|
|
bool |
roundUp | |
|
) |
| | [protected] |
Return a "nice number", often defined as 1, 2 or 5. If roundUp is true then the nice number will be rounded up, false it is rounded down. The supplied number should be between 0.0 and 9.9.
| double vtkAxis::LogScaleTickMark |
( |
double |
number, |
|
|
bool |
roundUp, |
|
|
bool & |
niceValue, |
|
|
int & |
order | |
|
) |
| | [protected] |
Return a tick mark for a logarithmic axis. If roundUp is true then the upper tick mark is returned. Otherwise the lower tick mark is returned. Tick marks will be: ... 0.1 0.2 .. 0.9 1 2 .. 9 10 20 .. 90 100 ... Parameter nicevalue will be set to true if tick mark is in: ... 0.1 0.2 0.5 1 2 5 10 20 50 100 ... Parameter order is set to the detected order of magnitude of the number.
| void vtkAxis::GenerateLogScaleTickMarks |
( |
int |
order, |
|
|
double |
min = 1.0, |
|
|
double |
max = 9.0, |
|
|
bool |
detailLabels = true | |
|
) |
| | [protected] |
Generate tick marks for logarithmic scale for specific order of magnitude. Mark generation is limited by parameters min and max. Tick marks will be: ... 0.1 0.2 .. 0.9 1 2 .. 9 10 20 .. 90 100 ... Tick labels will be: ... 0.1 0.2 0.5 1 2 5 10 20 50 100 ... If Parameter detaillabels is disabled tick labels will be: ... 0.1 1 10 100 ... If min/max is not in between 1.0 and 9.0 defaults will be used. If min and max do not differ 1 defaults will be used.
Member Data Documentation
This object stores the vtkPen that controls how the axis is drawn.
Definition at line 342 of file vtkAxis.h.
This object stores the vtkPen that controls how the grid lines are drawn.
Definition at line 346 of file vtkAxis.h.
Position of tick marks in screen coordinates
Definition at line 349 of file vtkAxis.h.
Position of tick marks in screen coordinates
Definition at line 352 of file vtkAxis.h.
The labels for the tick marks
Definition at line 355 of file vtkAxis.h.
Hint as to whether a nice min/max was set, otherwise labels may not be present at the top/bottom of the axis.
Definition at line 359 of file vtkAxis.h.
Mark the tick labels as dirty when the min/max value is changed.
Definition at line 362 of file vtkAxis.h.
Flag to indicate that the axis has been resized.
Definition at line 365 of file vtkAxis.h.
Hint as to whether a logarithmic scale is reasonable or not.
Definition at line 368 of file vtkAxis.h.
The point cache is marked dirty until it has been initialized.
Definition at line 371 of file vtkAxis.h.
The documentation for this class was generated from the following file:
