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

Definition at line 69 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)
virtual int	HasTranslucentPolygonalGeometry ()
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	SetNumberOfMinorTicks (int)
virtual int	GetNumberOfMinorTicks ()

virtual void	SetMinorTickLength (int)
virtual int	GetMinorTickLength ()

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	SetTitlePosition (double)
virtual double	GetTitlePosition ()

virtual void	SetFontFactor (double)
virtual double	GetFontFactor ()

virtual void	SetLabelFactor (double)
virtual double	GetLabelFactor ()

int	RenderOverlay (vtkViewport *viewport)
int	RenderOpaqueGeometry (vtkViewport *viewport)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual void	SetSizeFontRelativeToAxis (int)
virtual int	GetSizeFontRelativeToAxis ()
virtual void	SizeFontRelativeToAxisOn ()
virtual void	SizeFontRelativeToAxisOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAxisActor2D *	SafeDownCast (vtkObject *o)
static vtkAxisActor2D *	New ()

static void	ComputeRange (double inRange[2], double outRange[2], int inNumTicks, int &outNumTicks, double &interval)

static 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
static double	ComputeStringOffset (double width, double height, double theta)
static 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]
double	TitlePosition
int	NumberOfLabels
char *	LabelFormat
int	AdjustLabels
double	FontFactor
double	LabelFactor
int	TickLength
int	MinorTickLength
int	TickOffset
int	NumberOfMinorTicks
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]
int	SizeFontRelativeToAxis
vtkTextMapper *	TitleMapper
vtkActor2D *	TitleActor
vtkTextMapper **	LabelMappers
vtkActor2D **	LabelActors
vtkPolyData *	Axis
vtkPolyDataMapper2D *	AxisMapper
vtkActor2D *	AxisActor
vtkTimeStamp	AdjustedRangeBuildTime
vtkTimeStamp	BuildTime

Member Typedef Documentation

typedef vtkActor2D vtkAxisActor2D::Superclass

Reimplemented from vtkActor2D.

Definition at line 72 of file vtkAxisActor2D.h.

Constructor & Destructor Documentation

vtkAxisActor2D::vtkAxisActor2D ( ) [protected]

vtkAxisActor2D::~vtkAxisActor2D ( ) [protected]

Member Function Documentation

virtual const char* vtkAxisActor2D::GetClassName ( ) [virtual]

Reimplemented from vtkActor2D.

static int vtkAxisActor2D::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

virtual int vtkAxisActor2D::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

static vtkAxisActor2D* vtkAxisActor2D::SafeDownCast ( vtkObject * o ) [static]

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.

static vtkAxisActor2D* vtkAxisActor2D::New ( ) [static]

Instantiate object.

Reimplemented from vtkActor2D.

virtual vtkCoordinate* vtkAxisActor2D::GetPoint1Coordinate ( ) [inline, virtual]

Specify the position of the first point defining the axis. Note: backward compatibility only, use vtkActor2D's Position instead.

Definition at line 81 of file vtkAxisActor2D.h.

virtual void vtkAxisActor2D::SetPoint1 ( double x[2] ) [inline, virtual]

Specify the position of the first point defining the axis. Note: backward compatibility only, use vtkActor2D's Position instead.

Definition at line 83 of file vtkAxisActor2D.h.

virtual void vtkAxisActor2D::SetPoint1	(	double	x,
		double	y
	)			`[inline, virtual]`

Specify the position of the first point defining the axis. Note: backward compatibility only, use vtkActor2D's Position instead.

Definition at line 84 of file vtkAxisActor2D.h.

virtual double* vtkAxisActor2D::GetPoint1 ( ) [inline, virtual]

Specify the position of the first point defining the axis. Note: backward compatibility only, use vtkActor2D's Position instead.

Definition at line 85 of file vtkAxisActor2D.h.

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 93 of file vtkAxisActor2D.h.

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 95 of file vtkAxisActor2D.h.

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 96 of file vtkAxisActor2D.h.

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 97 of file vtkAxisActor2D.h.

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]