TSLArrowTail Class Reference

Detailed Description

TSLArrowTail defines the tail of an arrow.

An arrow tail must, at least, be defined with two coordinates via the setPoints() method. If no other attributes are set, the tail will default to a width of one pixel.

Public Member Functions
double	width () const
void	width (double theWidth)
double	widthRatio () const
void	widthRatio (double ratio)
bool	closed () const
void	closed (bool close)
void	setPoints (const TSLCoordSet &coords)
const TSLCoordSet &	points () const
double	widthGradient () const
	Get the configured width gradient.
void	widthGradient (double gradient)
double	indentRatio () const
	Get the configured indent ratio.
void	indentRatio (double ratio)
void	splineEnabled (bool value)
bool	splineEnabled () const

Protected Member Functions
	TSLArrowTail ()
	~TSLArrowTail ()
	TSLArrowTail (const TSLArrowTail &)
TSLArrowTail &	operator= (const TSLArrowTail &)

Constructor & Destructor Documentation

TSLArrowTail() [1/2]

TSLArrowTail::TSLArrowTail ( )

protected

~TSLArrowTail()

TSLArrowTail::~TSLArrowTail ( )

protected

TSLArrowTail() [2/2]

TSLArrowTail::TSLArrowTail ( const TSLArrowTail & )

protected

Member Function Documentation

closed() [1/2]

bool TSLArrowTail::closed

(

)

const

Get whether a tail with a width is closed.

Returns

true if the tail is closed

closed() [2/2]

void TSLArrowTail::closed

(

bool

close

)

Set whether a tail with a width > 1.0 is closed.

Parameters

true	if the tail will be closed.

indentRatio() [1/2]

double TSLArrowTail::indentRatio

(

)

const

Get the configured indent ratio.

indentRatio() [2/2]

void TSLArrowTail::indentRatio

(

double

ratio

)

Configure an indent ratio. This method allows the tail to have an indented tail end. This allows the indent's size to be relative to the arrow tail width. The indent ratio has an effect only when the tail is closed.

Parameters

ratio

a value greater than zero enables the indent.

operator=()

TSLArrowTail & TSLArrowTail::operator= ( const TSLArrowTail & )

protected

points()

const TSLCoordSet & TSLArrowTail::points

(

)

const

Get the set of coordinates

Returns

the Coordinates of the tail. Should contain at least two coordinates.

setPoints()

void TSLArrowTail::setPoints

(

const TSLCoordSet &

coords

)

Define the coordinates of the tail from the tip all the way to the end of the tail.

Parameters

coords

Coordinates of the tail. Should contain at least two coordinates.

splineEnabled() [1/2]

bool TSLArrowTail::splineEnabled

(

)

const

Gets the current state of whether a spline is used to define the arrow tail instead of straight lines.

Returns

spline enabled - true or false

splineEnabled() [2/2]

void TSLArrowTail::splineEnabled

(

bool

value

)

Allows the user to disable and enable interpolation of the arrowtail. When set to false, the arrowtail uses the raw coordinates input by the user.

Splines are enabled by default.

Parameters

value

Enables/disables spline

width() [1/2]

double TSLArrowTail::width

(

)

const

Get the width of the tail.

Returns

Width

width() [2/2]

void TSLArrowTail::width

(

double

theWidth

)

Set the width of the tail. A width of zero causes the tail to have a width of one pixel.

Parameters

The

new width

widthGradient() [1/2]

double TSLArrowTail::widthGradient

(

)

const

Get the configured width gradient.

widthGradient() [2/2]

void TSLArrowTail::widthGradient

(

double

gradient

)

Configure a width gradient. This method allows the tail to have a gradated width and defines the ratio between start and end widths. If widthGradient is not equal to 1, then startWidth (the width of the tail nearest the front head) equals width, and the end width is the result of width * widthGradient.

1. When widthGradient = 1 then endWidth = startWidth.
2. When widthGradient < 1 then endWidth < startWidth.
3. When widthGradient > 1 then endWidth > startWidth.

   Parameters

   gradient

   The new width gradient.

widthRatio() [1/2]

double TSLArrowTail::widthRatio

(

)

const

Get the configured width ratio.

Returns

Width ratio - typically a value between 0 and 1

widthRatio() [2/2]

void TSLArrowTail::widthRatio

(

double

ratio

)

Configure the width ratio. This method allows the tail to have a width relative to the arrow head size.

Parameters

Width

ratio - typically a value between 0 and 1