vtkAxisActor2D Class Reference

Create an axis with tick marks and labels. More...

#include <vtkAxisActor2D.h>

Inheritance diagram for vtkAxisActor2D:

Collaboration diagram for vtkAxisActor2D:

Public Types
typedef vtkActor2D	Superclass
Public Types inherited from vtkActor2D
typedef vtkProp	Superclass
Public Types inherited from vtkProp
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkAxisActor2D *	NewInstance () const
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	SetRulerMode (int)
virtual int	GetRulerMode ()
virtual void	RulerModeOn ()
virtual void	RulerModeOff ()
virtual void	SetRulerDistance (double)
virtual double	GetRulerDistance ()
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 ()
Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent)
vtkActor2D *	NewInstance () const
vtkProperty2D *	GetProperty ()
virtual void	SetProperty (vtkProperty2D *)
void	SetDisplayPosition (int, int)
virtual unsigned long	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)
Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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 unsigned long	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
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
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 *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAxisActor2D *	SafeDownCast (vtkObjectBase *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)
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 int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAxisActor2D ()
	~vtkAxisActor2D ()
virtual void	BuildAxis (vtkViewport *viewport)
virtual void	UpdateAdjustedRange ()
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 ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
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 &)

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	RulerMode
double	RulerDistance
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
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

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

Tests:

vtkAxisActor2D (Tests)

Definition at line 73 of file vtkAxisActor2D.h.

Member Typedef Documentation

typedef vtkActor2D vtkAxisActor2D::Superclass

Definition at line 76 of file vtkAxisActor2D.h.

Constructor & Destructor Documentation

vtkAxisActor2D::vtkAxisActor2D ( )

protected

vtkAxisActor2D::~vtkAxisActor2D ( )

protected

Member Function Documentation

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

static

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

static vtkAxisActor2D* vtkAxisActor2D::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkAxisActor2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

vtkAxisActor2D* vtkAxisActor2D::NewInstance

(

)

const

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 vtkObject.

static vtkAxisActor2D* vtkAxisActor2D::New ( )

static

Instantiate object.

virtual vtkCoordinate* vtkAxisActor2D::GetPoint1Coordinate ( )

inlinevirtual

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 void vtkAxisActor2D::SetPoint1 ( double  x[2] )

inlinevirtual

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

Definition at line 87 of file vtkAxisActor2D.h.

virtual void vtkAxisActor2D::SetPoint1 ( double  x, double  y  )

inlinevirtual

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

Definition at line 88 of file vtkAxisActor2D.h.

virtual double* vtkAxisActor2D::GetPoint1 ( )

inlinevirtual

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

Definition at line 89 of file vtkAxisActor2D.h.

virtual vtkCoordinate* vtkAxisActor2D::GetPoint2Coordinate ( )

inlinevirtual

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::SetPoint2 ( double  x[2] )

inlinevirtual

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

virtual void vtkAxisActor2D::SetPoint2 ( double  x, double  y  )

inlinevirtual

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

virtual double* vtkAxisActor2D::GetPoint2 ( )

inlinevirtual

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 101 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::SetRulerMode ( int  )

virtual

Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing. If enabled, the distance between major ticks is controlled by the RulerDistance ivar.

virtual int vtkAxisActor2D::GetRulerMode ( )

virtual

Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing. If enabled, the distance between major ticks is controlled by the RulerDistance ivar.

virtual void vtkAxisActor2D::RulerModeOn ( )

virtual

Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing. If enabled, the distance between major ticks is controlled by the RulerDistance ivar.

virtual void vtkAxisActor2D::RulerModeOff ( )

virtual

Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing. If enabled, the distance between major ticks is controlled by the RulerDistance ivar.

virtual void vtkAxisActor2D::SetRulerDistance ( double  )

virtual

Specify the RulerDistance which indicates the spacing of the major ticks. This ivar only has effect when the RulerMode is on.

virtual double vtkAxisActor2D::GetRulerDistance ( )

virtual

Specify the RulerDistance which indicates the spacing of the major ticks. This ivar only has effect when the RulerMode is on.

virtual void vtkAxisActor2D::SetNumberOfLabels ( int  )

virtual

Set/Get the number of annotation labels to show. This also controls the number of major ticks shown. Note that this ivar only holds meaning if the RulerMode is off.

virtual int vtkAxisActor2D::GetNumberOfLabels ( )

virtual

Set/Get the number of annotation labels to show. This also controls the number of major ticks shown. Note that this ivar only holds meaning if the RulerMode is off.

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. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

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. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

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. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

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. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

virtual double* vtkAxisActor2D::GetAdjustedRange ( )

inlinevirtual

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. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

Definition at line 151 of file vtkAxisActor2D.h.

virtual void vtkAxisActor2D::GetAdjustedRange ( double &  _arg1, double &  _arg2  )

inlinevirtual

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. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

Definition at line 156 of file vtkAxisActor2D.h.

virtual void vtkAxisActor2D::GetAdjustedRange ( double  _arg[2] )

inlinevirtual

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. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

Definition at line 162 of file vtkAxisActor2D.h.

virtual int vtkAxisActor2D::GetAdjustedNumberOfLabels ( )

inlinevirtual

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. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

Definition at line 166 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::SetNumberOfMinorTicks ( int  )

virtual

Number of minor ticks to be displayed between each tick. Default is 0.

virtual int vtkAxisActor2D::GetNumberOfMinorTicks ( )

virtual

Number of minor ticks to be displayed between each tick. Default is 0.

virtual void vtkAxisActor2D::SetMinorTickLength ( int  )

virtual

Set/Get the length of the minor tick marks (expressed in pixels or display coordinates).

virtual int vtkAxisActor2D::GetMinorTickLength ( )

virtual

Set/Get the length of the minor 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::SetTitlePosition ( double  )

virtual

Set/Get position of the axis title. 0 is at the start of the axis whereas 1 is at the end.

virtual double vtkAxisActor2D::GetTitlePosition ( )

virtual

Set/Get position of the axis title. 0 is at the start of the axis whereas 1 is at the end.

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

Draw the axis.

Reimplemented from vtkActor2D.

int vtkAxisActor2D::RenderOpaqueGeometry ( vtkViewport *  viewport )

virtual

Draw the axis.

Reimplemented from vtkActor2D.

virtual int vtkAxisActor2D::RenderTranslucentPolygonalGeometry ( vtkViewport *  )

inlinevirtual

Draw the axis.

Reimplemented from vtkActor2D.

Definition at line 274 of file vtkAxisActor2D.h.

virtual int vtkAxisActor2D::HasTranslucentPolygonalGeometry ( )

virtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkActor2D.

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.

static 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).

static 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).

virtual void vtkAxisActor2D::SetSizeFontRelativeToAxis ( int  )

virtual

Specify whether to size the fonts relative to the viewport or relative to length of the axis. By default, fonts are resized relative to the axis.

virtual int vtkAxisActor2D::GetSizeFontRelativeToAxis ( )

virtual

Specify whether to size the fonts relative to the viewport or relative to length of the axis. By default, fonts are resized relative to the axis.

virtual void vtkAxisActor2D::SizeFontRelativeToAxisOn ( )

virtual

Specify whether to size the fonts relative to the viewport or relative to length of the axis. By default, fonts are resized relative to the axis.

virtual void vtkAxisActor2D::SizeFontRelativeToAxisOff ( )

virtual

Specify whether to size the fonts relative to the viewport or relative to length of the axis. By default, fonts are resized relative to the axis.

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 )

protectedvirtual

static double vtkAxisActor2D::ComputeStringOffset ( double  width, double  height, double  theta  )

staticprotected

static void vtkAxisActor2D::SetOffsetPosition ( double  xTick[3], double  theta, int  stringHeight, int  stringWidth, int  offset, vtkActor2D *  actor  )

staticprotected

virtual void vtkAxisActor2D::UpdateAdjustedRange ( )

protectedvirtual

Member Data Documentation

vtkTextProperty* vtkAxisActor2D::TitleTextProperty

protected

Definition at line 333 of file vtkAxisActor2D.h.

vtkTextProperty* vtkAxisActor2D::LabelTextProperty

protected

Definition at line 334 of file vtkAxisActor2D.h.

char* vtkAxisActor2D::Title

protected

Definition at line 336 of file vtkAxisActor2D.h.

double vtkAxisActor2D::Range[2]

protected

Definition at line 337 of file vtkAxisActor2D.h.

double vtkAxisActor2D::TitlePosition

protected

Definition at line 338 of file vtkAxisActor2D.h.

int vtkAxisActor2D::RulerMode

protected

Definition at line 339 of file vtkAxisActor2D.h.

double vtkAxisActor2D::RulerDistance

protected

Definition at line 340 of file vtkAxisActor2D.h.

int vtkAxisActor2D::NumberOfLabels

protected

Definition at line 341 of file vtkAxisActor2D.h.

char* vtkAxisActor2D::LabelFormat

protected

Definition at line 342 of file vtkAxisActor2D.h.

int vtkAxisActor2D::AdjustLabels

protected

Definition at line 343 of file vtkAxisActor2D.h.

double vtkAxisActor2D::FontFactor

protected

Definition at line 344 of file vtkAxisActor2D.h.

double vtkAxisActor2D::LabelFactor

protected

Definition at line 345 of file vtkAxisActor2D.h.

int vtkAxisActor2D::TickLength

protected

Definition at line 346 of file vtkAxisActor2D.h.

int vtkAxisActor2D::MinorTickLength

protected

Definition at line 347 of file vtkAxisActor2D.h.

int vtkAxisActor2D::TickOffset

protected

Definition at line 348 of file vtkAxisActor2D.h.

int vtkAxisActor2D::NumberOfMinorTicks

protected

Definition at line 349 of file vtkAxisActor2D.h.

double vtkAxisActor2D::AdjustedRange[2]

protected

Definition at line 351 of file vtkAxisActor2D.h.

int vtkAxisActor2D::AdjustedNumberOfLabels

protected

Definition at line 352 of file vtkAxisActor2D.h.

int vtkAxisActor2D::NumberOfLabelsBuilt

protected

Definition at line 353 of file vtkAxisActor2D.h.

int vtkAxisActor2D::AxisVisibility

protected

Definition at line 355 of file vtkAxisActor2D.h.

int vtkAxisActor2D::TickVisibility

protected

Definition at line 356 of file vtkAxisActor2D.h.

int vtkAxisActor2D::LabelVisibility

protected

Definition at line 357 of file vtkAxisActor2D.h.

int vtkAxisActor2D::TitleVisibility

protected

Definition at line 358 of file vtkAxisActor2D.h.

int vtkAxisActor2D::LastPosition[2]

protected

Definition at line 360 of file vtkAxisActor2D.h.

int vtkAxisActor2D::LastPosition2[2]

protected

Definition at line 361 of file vtkAxisActor2D.h.

int vtkAxisActor2D::LastSize[2]

protected

Definition at line 363 of file vtkAxisActor2D.h.

int vtkAxisActor2D::LastMaxLabelSize[2]

protected

Definition at line 364 of file vtkAxisActor2D.h.

int vtkAxisActor2D::SizeFontRelativeToAxis

protected

Definition at line 366 of file vtkAxisActor2D.h.

vtkTextMapper* vtkAxisActor2D::TitleMapper

protected

Definition at line 375 of file vtkAxisActor2D.h.

vtkActor2D* vtkAxisActor2D::TitleActor

protected

Definition at line 376 of file vtkAxisActor2D.h.

vtkTextMapper** vtkAxisActor2D::LabelMappers

protected

Definition at line 378 of file vtkAxisActor2D.h.

vtkActor2D** vtkAxisActor2D::LabelActors

protected

Definition at line 379 of file vtkAxisActor2D.h.

vtkPolyData* vtkAxisActor2D::Axis

protected

Definition at line 381 of file vtkAxisActor2D.h.

vtkPolyDataMapper2D* vtkAxisActor2D::AxisMapper

protected

Definition at line 382 of file vtkAxisActor2D.h.

vtkActor2D* vtkAxisActor2D::AxisActor

protected

Definition at line 383 of file vtkAxisActor2D.h.

vtkTimeStamp vtkAxisActor2D::AdjustedRangeBuildTime

protected

Definition at line 385 of file vtkAxisActor2D.h.

vtkTimeStamp vtkAxisActor2D::BuildTime

protected

Definition at line 386 of file vtkAxisActor2D.h.

---

The documentation for this class was generated from the following file:

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Annotation/vtkAxisActor2D.h