iARulerActor Class Reference

An actor for visualizing a ruler in the slicer. More...

#include <iARulerActor.h>

Inheritance diagram for iARulerActor:

Collaboration diagram for iARulerActor:

Public Types
enum	AttributeLocation { DISTANCE =0 , XY_COORDINATES =1 }

Public Member Functions
void	AllAnnotationsOff ()
void	AllAnnotationsOn ()
	Convenience method that turns all the axes and the legend scale.
void	AllAxesOff ()
void	AllAxesOn ()
	Convenience method that turns all the axes either on or off.
virtual void	BuildRepresentation (vtkViewport *viewport)
	Standard methods supporting the rendering process.
void	GetActors2D (vtkPropCollection *) override
void	PrintSelf (ostream &os, vtkIndent indent) override
void	ReleaseGraphicsResources (vtkWindow *) override
int	RenderOpaqueGeometry (vtkViewport *) override
int	RenderOverlay (vtkViewport *) override
void	SetLabelModeToDistance ()
void	SetLabelModeToXYCoordinates ()
void	SetPosition (double *coord)
void	SetSize (double *coord)
	vtkBooleanMacro (BottomAxisVisibility, int)
	vtkBooleanMacro (LeftAxisVisibility, int)
	vtkGetMacro (BottomAxisVisibility, int)
	vtkGetMacro (BottomBorderOffset, int)
	vtkGetMacro (CornerOffsetFactor, double)
	vtkGetMacro (LabelMode, int)
	vtkGetMacro (LeftAxisVisibility, int)
	vtkGetMacro (LeftBorderOffset, int)
	vtkGetMacro (RightBorderOffset, int)
	vtkGetMacro (TopBorderOffset, int)
	vtkGetObjectMacro (BottomAxis, vtkAxisActor2D)
	vtkGetObjectMacro (LeftAxis, vtkAxisActor2D)
	These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation.
	vtkSetClampMacro (BottomBorderOffset, int, 5, VTK_INT_MAX)
	Set/Get the offset of the bottom axis from the border.
	vtkSetClampMacro (CornerOffsetFactor, double, 1.0, 10.0)
	Get/Set the corner offset.
	vtkSetClampMacro (LabelMode, int, DISTANCE, XY_COORDINATES)
	Specify the mode for labeling the scale axes.
	vtkSetClampMacro (LeftBorderOffset, int, 5, VTK_INT_MAX)
	Set/Get the offset of the left axis from the border.
	vtkSetClampMacro (RightBorderOffset, int, 5, VTK_INT_MAX)
	Set/Get the offset of the right axis from the border.
	vtkSetClampMacro (TopBorderOffset, int, 5, VTK_INT_MAX)
	Set/Get the offset of the top axis from the border.
	vtkSetMacro (BottomAxisVisibility, int)
	vtkSetMacro (LeftAxisVisibility, int)
	Set/Get the flags that control which of the four axes to display (top, bottom, left and right).
	vtkTypeMacro (iARulerActor, vtkProp)
	Standard methods for the class.

Static Public Member Functions
static iARulerActor *	New ()
	Instantiate the class.

Protected Member Functions
	iARulerActor ()
	~iARulerActor ()

Protected Attributes
int	AxisOffset
int	BottomBorderOffset
vtkTimeStamp	BuildTime
double	CornerOffsetFactor
int	LabelMode
int	LeftBorderOffset
vtkCoordinate *	PositionCoordinate
vtkCoordinate *	ReferenceCoordinate
int	RightBorderOffset
vtkCoordinate *	SizeCoordinate
int	TopBorderOffset
vtkAxisActor2D *	LeftAxis
vtkAxisActor2D *	BottomAxis
int	LeftAxisVisibility
	Control the display of the axes.
int	BottomAxisVisibility

Detailed Description

An actor for visualizing a ruler in the slicer.

Displays either a vertical or horizontal ruler using a vtkAxisActor2D, depending on the aspect ratio of the widget.

Member Enumeration Documentation

AttributeLocation

enum iARulerActor::AttributeLocation

Enumerator
DISTANCE
XY_COORDINATES

Constructor & Destructor Documentation

iARulerActor()

iARulerActor::iARulerActor ( )

protected

~iARulerActor()

iARulerActor::~iARulerActor ( )

protected

Member Function Documentation

AllAnnotationsOff()

void iARulerActor::AllAnnotationsOff

(

)

AllAnnotationsOn()

void iARulerActor::AllAnnotationsOn

(

)

Convenience method that turns all the axes and the legend scale.

AllAxesOff()

void iARulerActor::AllAxesOff

(

)

AllAxesOn()

void iARulerActor::AllAxesOn

(

)

Convenience method that turns all the axes either on or off.

BuildRepresentation()

void iARulerActor::BuildRepresentation ( vtkViewport * viewport )

virtual

Standard methods supporting the rendering process.

GetActors2D()

void iARulerActor::GetActors2D ( vtkPropCollection * pc )

override

New()

static iARulerActor * iARulerActor::New ( )

static

Instantiate the class.

PrintSelf()

void iARulerActor::PrintSelf ( ostream & os, vtkIndent indent )

override

ReleaseGraphicsResources()

void iARulerActor::ReleaseGraphicsResources ( vtkWindow * w )

override

RenderOpaqueGeometry()

int iARulerActor::RenderOpaqueGeometry ( vtkViewport * viewport )

override

RenderOverlay()

int iARulerActor::RenderOverlay ( vtkViewport * viewport )

override

SetLabelModeToDistance()

void iARulerActor::SetLabelModeToDistance ( )

inline

SetLabelModeToXYCoordinates()

void iARulerActor::SetLabelModeToXYCoordinates ( )

inline

SetPosition()

void iARulerActor::SetPosition

(

double *

coord

)

SetSize()

void iARulerActor::SetSize

(

double *

coord

)

vtkBooleanMacro() [1/2]

iARulerActor::vtkBooleanMacro	(	BottomAxisVisibility	,
		int	)

vtkBooleanMacro() [2/2]

iARulerActor::vtkBooleanMacro	(	LeftAxisVisibility	,
		int	)

vtkGetMacro() [1/8]

iARulerActor::vtkGetMacro	(	BottomAxisVisibility	,
		int	)

vtkGetMacro() [2/8]

iARulerActor::vtkGetMacro	(	BottomBorderOffset	,
		int	)

vtkGetMacro() [3/8]

iARulerActor::vtkGetMacro	(	CornerOffsetFactor	,
		double	)

vtkGetMacro() [4/8]

iARulerActor::vtkGetMacro	(	LabelMode	,
		int	)

vtkGetMacro() [5/8]

iARulerActor::vtkGetMacro	(	LeftAxisVisibility	,
		int	)

vtkGetMacro() [6/8]

iARulerActor::vtkGetMacro	(	LeftBorderOffset	,
		int	)

vtkGetMacro() [7/8]

iARulerActor::vtkGetMacro	(	RightBorderOffset	,
		int	)

vtkGetMacro() [8/8]

iARulerActor::vtkGetMacro	(	TopBorderOffset	,
		int	)

vtkGetObjectMacro() [1/2]

iARulerActor::vtkGetObjectMacro	(	BottomAxis	,
		vtkAxisActor2D	)

vtkGetObjectMacro() [2/2]

iARulerActor::vtkGetObjectMacro	(	LeftAxis	,
		vtkAxisActor2D	)

These are methods to retrieve the vtkAxisActors used to represent the four axes that form this representation.

Users may retrieve and then modify these axes to control their appearance.

vtkSetClampMacro() [1/6]

iARulerActor::vtkSetClampMacro	(	BottomBorderOffset	,
		int	,
		5	,
		VTK_INT_MAX	)

Set/Get the offset of the bottom axis from the border.

This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

vtkSetClampMacro() [2/6]

iARulerActor::vtkSetClampMacro	(	CornerOffsetFactor	,
		double	,
		1.	0,
		10.	0 )

Get/Set the corner offset.

This is the offset factor used to offset the axes at the corners. Default value is 2.0.

vtkSetClampMacro() [3/6]

iARulerActor::vtkSetClampMacro	(	LabelMode	,
		int	,
		DISTANCE	,
		XY_COORDINATES	)

Specify the mode for labeling the scale axes.

By default, the axes are labeled with the distance between points (centered at a distance of 0.0). Alternatively if you know that the view is down the z-axis; the axes can be labeled with x-y coordinate values.

vtkSetClampMacro() [4/6]

iARulerActor::vtkSetClampMacro	(	LeftBorderOffset	,
		int	,
		5	,
		VTK_INT_MAX	)

Set/Get the offset of the left axis from the border.

This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

vtkSetClampMacro() [5/6]

iARulerActor::vtkSetClampMacro	(	RightBorderOffset	,
		int	,
		5	,
		VTK_INT_MAX	)

Set/Get the offset of the right axis from the border.

This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 50.

vtkSetClampMacro() [6/6]

iARulerActor::vtkSetClampMacro	(	TopBorderOffset	,
		int	,
		5	,
		VTK_INT_MAX	)

Set/Get the offset of the top axis from the border.

This number is expressed in pixels, and represents the approximate distance of the axes from the sides of the renderer. The default is 30.

vtkSetMacro() [1/2]

iARulerActor::vtkSetMacro	(	BottomAxisVisibility	,
		int	)

vtkSetMacro() [2/2]

iARulerActor::vtkSetMacro	(	LeftAxisVisibility	,
		int	)

Set/Get the flags that control which of the four axes to display (top, bottom, left and right).

By default, all the axes are displayed.

vtkTypeMacro()

iARulerActor::vtkTypeMacro	(	iARulerActor	,
		vtkProp	)

Standard methods for the class.

Member Data Documentation

AxisOffset

int iARulerActor::AxisOffset

protected

BottomAxis

vtkAxisActor2D* iARulerActor::BottomAxis

protected

BottomAxisVisibility

int iARulerActor::BottomAxisVisibility

protected

BottomBorderOffset

int iARulerActor::BottomBorderOffset

protected

BuildTime

vtkTimeStamp iARulerActor::BuildTime

protected

CornerOffsetFactor

double iARulerActor::CornerOffsetFactor

protected

LabelMode

int iARulerActor::LabelMode

protected

LeftAxis

vtkAxisActor2D* iARulerActor::LeftAxis

protected

vertical (left) / horizontal (bottom) axis; only one of the two is shown at a time, depending on the widget's aspect ratio

LeftAxisVisibility

int iARulerActor::LeftAxisVisibility

protected

Control the display of the axes.

LeftBorderOffset

int iARulerActor::LeftBorderOffset

protected

PositionCoordinate

vtkCoordinate* iARulerActor::PositionCoordinate

protected

ReferenceCoordinate

vtkCoordinate* iARulerActor::ReferenceCoordinate

protected

RightBorderOffset

int iARulerActor::RightBorderOffset

protected

SizeCoordinate

vtkCoordinate* iARulerActor::SizeCoordinate

protected

TopBorderOffset

int iARulerActor::TopBorderOffset

protected

---

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

• libs/slicer/iARulerActor.h
• libs/slicer/iARulerActor.cpp