vtkAxisActor2D Class Reference
#include <vtkAxisActor2D.h>
Inheritance diagram for vtkAxisActor2D:
[legend]Collaboration diagram for vtkAxisActor2D:
[legend]List of all members.
Detailed Description
Create an axis with tick marks and labels.
vtkAxisActor2D creates an axis with tick marks, labels, and/or a title, depending on the particular instance variable settings. vtkAxisActor2D is a 2D actor; that is, it is drawn on the overlay plane and is not occluded by 3D geometry. To use this class, you typically specify two points defining the start and end points of the line (x-y definition using vtkCoordinate class), the number of labels, and the data range (min,max). You can also control what parts of the axis are visible including the line, the tick marks, the labels, and the title. You can also specify the label format (a printf style format).
This class decides what font size to use and how to locate the labels. It also decides how to create reasonable tick marks and labels. The number of labels and the range of values may not match the number specified, but should be close.
Labels are drawn on the "right" side of the axis. The "right" side is the side of the axis on the right as you move from Position to Position2. The way the labels and title line up with the axis and tick marks depends on whether the line is considered horizontal or vertical.
The vtkActor2D instance variables Position and Position2 are instances of vtkCoordinate. Note that the Position2 is an absolute position in that class (it was by default relative to Position in vtkActor2D).
What this means is that you can specify the axis in a variety of coordinate systems. Also, the axis does not have to be either horizontal or vertical. The tick marks are created so that they are perpendicular to the axis.
Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated to this actor.
- See also:
- vtkCubeAxesActor2D can be used to create axes in world coordinate space.
vtkActor2D vtkTextMapper vtkPolyDataMapper2D vtkScalarBarActor vtkCoordinate vtkTextProperty
- Created by:
-
- CVS contributions (if > 5%):
- Barre, Sebastien (37%)
- Schroeder, Will (31%)
- Martin, Ken (12%)
- Lee, Jeff (9%)
- CVS logs (CVSweb):
.h (/Rendering/vtkAxisActor2D
.h)
.cxx (/Rendering/vtkAxisActor2D
.cxx)
Definition at line 82 of file vtkAxisActor2D.h.
|
Public Types |
typedef vtkActor2D | Superclass |
Public Member Functions |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
void | ReleaseGraphicsResources (vtkWindow *) |
void | ShallowCopy (vtkProp *prop) |
|
virtual vtkCoordinate * | GetPoint1Coordinate () |
virtual void | SetPoint1 (double x[2]) |
virtual void | SetPoint1 (double x, double y) |
virtual double * | GetPoint1 () |
|
virtual vtkCoordinate * | GetPoint2Coordinate () |
virtual void | SetPoint2 (double x[2]) |
virtual void | SetPoint2 (double x, double y) |
virtual double * | GetPoint2 () |
|
virtual void | SetRange (double, double) |
void | SetRange (double[2]) |
virtual double * | GetRange () |
virtual void | GetRange (double data[2]) |
|
virtual void | SetNumberOfLabels (int) |
virtual int | GetNumberOfLabels () |
|
virtual void | SetLabelFormat (const char *) |
virtual char * | GetLabelFormat () |
|
virtual void | SetAdjustLabels (int) |
virtual int | GetAdjustLabels () |
virtual void | AdjustLabelsOn () |
virtual void | AdjustLabelsOff () |
virtual double * | GetAdjustedRange () |
virtual void | GetAdjustedRange (double &_arg1, double &_arg2) |
virtual void | GetAdjustedRange (double _arg[2]) |
virtual int | GetAdjustedNumberOfLabels () |
|
virtual void | SetTitle (const char *) |
virtual char * | GetTitle () |
|
virtual void | SetTitleTextProperty (vtkTextProperty *p) |
virtual vtkTextProperty * | GetTitleTextProperty () |
|
virtual void | SetLabelTextProperty (vtkTextProperty *p) |
virtual vtkTextProperty * | GetLabelTextProperty () |
|
virtual void | SetTickLength (int) |
virtual int | GetTickLength () |
|
virtual void | SetTickOffset (int) |
virtual int | GetTickOffset () |
|
virtual void | SetAxisVisibility (int) |
virtual int | GetAxisVisibility () |
virtual void | AxisVisibilityOn () |
virtual void | AxisVisibilityOff () |
|
virtual void | SetTickVisibility (int) |
virtual int | GetTickVisibility () |
virtual void | TickVisibilityOn () |
virtual void | TickVisibilityOff () |
|
virtual void | SetLabelVisibility (int) |
virtual int | GetLabelVisibility () |
virtual void | LabelVisibilityOn () |
virtual void | LabelVisibilityOff () |
|
virtual void | SetTitleVisibility (int) |
virtual int | GetTitleVisibility () |
virtual void | TitleVisibilityOn () |
virtual void | TitleVisibilityOff () |
|
virtual void | SetFontFactor (double) |
virtual double | GetFontFactor () |
|
virtual void | SetLabelFactor (double) |
virtual double | GetLabelFactor () |
|
int | RenderOverlay (vtkViewport *viewport) |
int | RenderOpaqueGeometry (vtkViewport *viewport) |
int | RenderTranslucentGeometry (vtkViewport *) |
Static Public Member Functions |
int | IsTypeOf (const char *type) |
vtkAxisActor2D * | SafeDownCast (vtkObject *o) |
vtkAxisActor2D * | New () |
|
void | ComputeRange (double inRange[2], double outRange[2], int inNumTicks, int &outNumTicks, double &interval) |
|
int | SetFontSize (vtkViewport *viewport, vtkTextMapper *textMapper, int *targetSize, double factor, int *stringSize) |
int | SetMultipleFontSize (vtkViewport *viewport, vtkTextMapper **textMappers, int nbOfMappers, int *targetSize, double factor, int *stringSize) |
Protected Member Functions |
| vtkAxisActor2D () |
| ~vtkAxisActor2D () |
virtual void | BuildAxis (vtkViewport *viewport) |
virtual void | UpdateAdjustedRange () |
Static Protected Member Functions |
double | ComputeStringOffset (double width, double height, double theta) |
void | SetOffsetPosition (double xTick[3], double theta, int stringHeight, int stringWidth, int offset, vtkActor2D *actor) |
Protected Attributes |
vtkTextProperty * | TitleTextProperty |
vtkTextProperty * | LabelTextProperty |
char * | Title |
double | Range [2] |
int | NumberOfLabels |
char * | LabelFormat |
int | AdjustLabels |
double | FontFactor |
double | LabelFactor |
int | TickLength |
int | TickOffset |
double | AdjustedRange [2] |
int | AdjustedNumberOfLabels |
int | NumberOfLabelsBuilt |
int | AxisVisibility |
int | TickVisibility |
int | LabelVisibility |
int | TitleVisibility |
int | LastPosition [2] |
int | LastPosition2 [2] |
int | LastSize [2] |
int | LastMaxLabelSize [2] |
vtkTextMapper * | TitleMapper |
vtkActor2D * | TitleActor |
vtkTextMapper ** | LabelMappers |
vtkActor2D ** | LabelActors |
vtkPolyData * | Axis |
vtkPolyDataMapper2D * | AxisMapper |
vtkActor2D * | AxisActor |
vtkTimeStamp | AdjustedRangeBuildTime |
vtkTimeStamp | BuildTime |
Member Typedef Documentation
Constructor & Destructor Documentation
vtkAxisActor2D::vtkAxisActor2D |
( |
|
) |
[protected] |
|
Member Function Documentation
virtual const char* vtkAxisActor2D::GetClassName |
( |
|
) |
[virtual] |
|
int vtkAxisActor2D::IsTypeOf |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkActor2D. |
virtual int vtkAxisActor2D::IsA |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkActor2D. |
void vtkAxisActor2D::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 vtkActor2D. |
|
Instantiate object.
Reimplemented from vtkActor2D. |
virtual vtkCoordinate* vtkAxisActor2D::GetPoint1Coordinate |
( |
|
) |
[inline, virtual] |
|
virtual void vtkAxisActor2D::SetPoint1 |
( |
double |
x[2] |
) |
[inline, virtual] |
|
virtual void vtkAxisActor2D::SetPoint1 |
( |
double |
x, |
|
|
double |
y |
|
) |
[inline, virtual] |
|
virtual double* vtkAxisActor2D::GetPoint1 |
( |
|
) |
[inline, virtual] |
|
virtual vtkCoordinate* vtkAxisActor2D::GetPoint2Coordinate |
( |
|
) |
[inline, virtual] |
|
|
Specify the position of the second point defining the axis. Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.
Definition at line 106 of file vtkAxisActor2D.h.
References vtkActor2D::GetPosition2Coordinate(). |
virtual void vtkAxisActor2D::SetPoint2 |
( |
double |
x[2] |
) |
[inline, virtual] |
|
|
Specify the position of the second point defining the axis. Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.
Definition at line 108 of file vtkAxisActor2D.h.
References vtkActor2D::SetPosition2(). |
virtual void vtkAxisActor2D::SetPoint2 |
( |
double |
x, |
|
|
double |
y |
|
) |
[inline, virtual] |
|
|
Specify the position of the second point defining the axis. Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.
Definition at line 109 of file vtkAxisActor2D.h.
References vtkActor2D::SetPosition2(). |
virtual double* vtkAxisActor2D::GetPoint2 |
( |
|
) |
[inline, virtual] |
|
|
Specify the position of the second point defining the axis. Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.
Definition at line 110 of file vtkAxisActor2D.h.
References vtkActor2D::GetPosition2(). |
virtual void vtkAxisActor2D::SetRange |
( |
double |
, |
|
|
double |
|
|
) |
[virtual] |
|
|
Specify the (min,max) axis range. This will be used in the generation of labels, if labels are visible. |
void vtkAxisActor2D::SetRange |
( |
double |
[2] |
) |
|
|
|
Specify the (min,max) axis range. This will be used in the generation of labels, if labels are visible. |
virtual double* vtkAxisActor2D::GetRange |
( |
|
) |
[virtual] |
|
|
Specify the (min,max) axis range. This will be used in the generation of labels, if labels are visible. |
virtual void vtkAxisActor2D::GetRange |
( |
double |
data[2] |
) |
[virtual] |
|
|
Specify the (min,max) axis range. This will be used in the generation of labels, if labels are visible. |
virtual void vtkAxisActor2D::SetNumberOfLabels |
( |
int |
|
) |
[virtual] |
|
|
Set/Get the number of annotation labels to show. |
virtual int vtkAxisActor2D::GetNumberOfLabels |
( |
|
) |
[virtual] |
|
|
Set/Get the number of annotation labels to show. |
virtual void vtkAxisActor2D::SetLabelFormat |
( |
const char * |
|
) |
[virtual] |
|
|
Set/Get the format with which to print the labels on the scalar bar. |
virtual char* vtkAxisActor2D::GetLabelFormat |
( |
|
) |
[virtual] |
|
|
Set/Get the format with which to print the labels on the scalar bar. |
virtual void vtkAxisActor2D::SetAdjustLabels |
( |
int |
|
) |
[virtual] |
|
|
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. |
virtual int vtkAxisActor2D::GetAdjustLabels |
( |
|
) |
[virtual] |
|
|
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. |
virtual void vtkAxisActor2D::AdjustLabelsOn |
( |
|
) |
[virtual] |
|
|
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. |
virtual void vtkAxisActor2D::AdjustLabelsOff |
( |
|
) |
[virtual] |
|
|
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. |
virtual double* vtkAxisActor2D::GetAdjustedRange |
( |
|
) |
[inline, virtual] |
|
|
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.
Definition at line 141 of file vtkAxisActor2D.h. |
virtual void vtkAxisActor2D::GetAdjustedRange |
( |
double & |
_arg1, |
|
|
double & |
_arg2 |
|
) |
[inline, virtual] |
|
|
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.
Definition at line 146 of file vtkAxisActor2D.h. |
virtual void vtkAxisActor2D::GetAdjustedRange |
( |
double |
_arg[2] |
) |
[inline, virtual] |
|
|
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.
Definition at line 152 of file vtkAxisActor2D.h. |
virtual int vtkAxisActor2D::GetAdjustedNumberOfLabels |
( |
|
) |
[inline, virtual] |
|
|
Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels. The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels.
Definition at line 156 of file vtkAxisActor2D.h. |
virtual void vtkAxisActor2D::SetTitle |
( |
const char * |
|
) |
[virtual] |
|
|
Set/Get the title of the scalar bar actor, |
virtual char* vtkAxisActor2D::GetTitle |
( |
|
) |
[virtual] |
|
|
Set/Get the title of the scalar bar actor, |
virtual void vtkAxisActor2D::SetTitleTextProperty |
( |
vtkTextProperty * |
p |
) |
[virtual] |
|
|
Set/Get the title text property. |
virtual vtkTextProperty* vtkAxisActor2D::GetTitleTextProperty |
( |
|
) |
[virtual] |
|
|
Set/Get the title text property. |
virtual void vtkAxisActor2D::SetLabelTextProperty |
( |
vtkTextProperty * |
p |
) |
[virtual] |
|
|
Set/Get the labels text property. |
virtual vtkTextProperty* vtkAxisActor2D::GetLabelTextProperty |
( |
|
) |
[virtual] |
|
|
Set/Get the labels text property. |
virtual void vtkAxisActor2D::SetTickLength |
( |
int |
|
) |
[virtual] |
|
|
Set/Get the length of the tick marks (expressed in pixels or display coordinates). |
virtual int vtkAxisActor2D::GetTickLength |
( |
|
) |
[virtual] |
|
|
Set/Get the length of the tick marks (expressed in pixels or display coordinates). |
virtual void vtkAxisActor2D::SetTickOffset |
( |
int |
|
) |
[virtual] |
|
|
Set/Get the offset of the labels (expressed in pixels or display coordinates). The offset is the distance of labels from tick marks or other objects. |
virtual int vtkAxisActor2D::GetTickOffset |
( |
|
) |
[virtual] |
|
|
Set/Get the offset of the labels (expressed in pixels or display coordinates). The offset is the distance of labels from tick marks or other objects. |
virtual void vtkAxisActor2D::SetAxisVisibility |
( |
int |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis line. |
virtual int vtkAxisActor2D::GetAxisVisibility |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis line. |
virtual void vtkAxisActor2D::AxisVisibilityOn |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis line. |
virtual void vtkAxisActor2D::AxisVisibilityOff |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis line. |
virtual void vtkAxisActor2D::SetTickVisibility |
( |
int |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis tick marks. |
virtual int vtkAxisActor2D::GetTickVisibility |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis tick marks. |
virtual void vtkAxisActor2D::TickVisibilityOn |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis tick marks. |
virtual void vtkAxisActor2D::TickVisibilityOff |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis tick marks. |
virtual void vtkAxisActor2D::SetLabelVisibility |
( |
int |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis labels. |
virtual int vtkAxisActor2D::GetLabelVisibility |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis labels. |
virtual void vtkAxisActor2D::LabelVisibilityOn |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis labels. |
virtual void vtkAxisActor2D::LabelVisibilityOff |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis labels. |
virtual void vtkAxisActor2D::SetTitleVisibility |
( |
int |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis title. |
virtual int vtkAxisActor2D::GetTitleVisibility |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis title. |
virtual void vtkAxisActor2D::TitleVisibilityOn |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis title. |
virtual void vtkAxisActor2D::TitleVisibilityOff |
( |
|
) |
[virtual] |
|
|
Set/Get visibility of the axis title. |
virtual void vtkAxisActor2D::SetFontFactor |
( |
double |
|
) |
[virtual] |
|
|
Set/Get the factor that controls the overall size of the fonts used to label and title the axes. This ivar used in conjunction with the LabelFactor can be used to control font sizes. |
virtual double vtkAxisActor2D::GetFontFactor |
( |
|
) |
[virtual] |
|
|
Set/Get the factor that controls the overall size of the fonts used to label and title the axes. This ivar used in conjunction with the LabelFactor can be used to control font sizes. |
virtual void vtkAxisActor2D::SetLabelFactor |
( |
double |
|
) |
[virtual] |
|
|
Set/Get the factor that controls the relative size of the axis labels to the axis title. |
virtual double vtkAxisActor2D::GetLabelFactor |
( |
|
) |
[virtual] |
|
|
Set/Get the factor that controls the relative size of the axis labels to the axis title. |
int vtkAxisActor2D::RenderOverlay |
( |
vtkViewport * |
viewport |
) |
[virtual] |
|
int vtkAxisActor2D::RenderOpaqueGeometry |
( |
vtkViewport * |
viewport |
) |
[virtual] |
|
int vtkAxisActor2D::RenderTranslucentGeometry |
( |
vtkViewport * |
|
) |
[inline, virtual] |
|
void vtkAxisActor2D::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 vtkActor2D. |
void vtkAxisActor2D::ComputeRange |
( |
double |
inRange[2], |
|
|
double |
outRange[2], |
|
|
int |
inNumTicks, |
|
|
int & |
outNumTicks, |
|
|
double & |
interval |
|
) |
[static] |
|
|
This method computes the range of the axis given an input range. It also computes the number of tick marks given a suggested number. (The number of tick marks includes end ticks as well.) The number of tick marks computed (in conjunction with the output range) will yield "nice" tick values. For example, if the input range is (0.25,96.7) and the number of ticks requested is 10, the output range will be (0,100) with the number of computed ticks to 11 to yield tick values of (0,10,20,...,100). |
int vtkAxisActor2D::SetFontSize |
( |
vtkViewport * |
viewport, |
|
|
vtkTextMapper * |
textMapper, |
|
|
int * |
targetSize, |
|
|
double |
factor, |
|
|
int * |
stringSize |
|
) |
[static] |
|
|
General method to computes font size from a representative size on the viewport (given by size[2]). The method returns the font size (in points) and the string height/width (in pixels). It also sets the font size of the instance of vtkTextMapper provided. The factor is used when you're trying to create text of different size-factor (it is usually = 1 but you can adjust the font size by making factor larger or smaller). |
int vtkAxisActor2D::SetMultipleFontSize |
( |
vtkViewport * |
viewport, |
|
|
vtkTextMapper ** |
textMappers, |
|
|
int |
nbOfMappers, |
|
|
int * |
targetSize, |
|
|
double |
factor, |
|
|
int * |
stringSize |
|
) |
[static] |
|
|
General method to computes font size from a representative size on the viewport (given by size[2]). The method returns the font size (in points) and the string height/width (in pixels). It also sets the font size of the instance of vtkTextMapper provided. The factor is used when you're trying to create text of different size-factor (it is usually = 1 but you can adjust the font size by making factor larger or smaller). |
void vtkAxisActor2D::ShallowCopy |
( |
vtkProp * |
prop |
) |
[virtual] |
|
|
Shallow copy of an axis actor. Overloads the virtual vtkProp method.
Reimplemented from vtkActor2D. |
virtual void vtkAxisActor2D::BuildAxis |
( |
vtkViewport * |
viewport |
) |
[protected, virtual] |
|
double vtkAxisActor2D::ComputeStringOffset |
( |
double |
width, |
|
|
double |
height, |
|
|
double |
theta |
|
) |
[static, protected] |
|
void vtkAxisActor2D::SetOffsetPosition |
( |
double |
xTick[3], |
|
|
double |
theta, |
|
|
int |
stringHeight, |
|
|
int |
stringWidth, |
|
|
int |
offset, |
|
|
vtkActor2D * |
actor |
|
) |
[static, protected] |
|
virtual void vtkAxisActor2D::UpdateAdjustedRange |
( |
|
) |
[protected, virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file: