TSLArrowHead Class Reference

Detailed Description

TSLArrowHead defines the head of an arrow.

The most basic arrow head consists of two lines (arms) that extend out from the tip of the arrow.

An arrow head must, at least, be defined with the coordinate defining the end of one arm via a call to armEnd(TSLCoord). The end of the other arm is calculated automatically.

Public Member Functions
bool	closed () const
void	closed (bool value)
TSLCoord	armEnd () const
void	armEnd (const TSLCoord &ptn)
void	polygonal (bool isPolygonal)
bool	polygonal () const
TSLArrowHead *	enclosingArrowHead (float sizeRatio=1.2)

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

Constructor & Destructor Documentation

TSLArrowHead() [1/2]

TSLArrowHead::TSLArrowHead ( )

protected

~TSLArrowHead()

TSLArrowHead::~TSLArrowHead ( )

protected

TSLArrowHead() [2/2]

TSLArrowHead::TSLArrowHead ( const TSLArrowHead & )

protected

Member Function Documentation

armEnd() [1/2]

TSLCoord TSLArrowHead::armEnd

(

)

const

Get the known end of the arrow head's arms.

Returns

Coordinate location of end of one arm.

armEnd() [2/2]

void TSLArrowHead::armEnd

(

const TSLCoord &

ptn

)

Set the known end of the arrow head's arms. The end of the other arm is calculated automatically.

Parameters

ptn	Coordinate location of end of one arm.

closed() [1/2]

bool TSLArrowHead::closed

(

)

const

Returns the current closed state of the arrow head.

Returns

closed state

closed() [2/2]

void TSLArrowHead::closed

(

bool

value

)

Sets whether the arrow head closes off or not. If the arrow head is closed, a line will join the two arm ends.

Parameters

Closed

state of the arrow head

enclosingArrowHead()

TSLArrowHead * TSLArrowHead::enclosingArrowHead

(

float

sizeRatio = 1.2

)

Gets or creates an arrow head that encloses this arrow head. By default, an enclosing arrow head will be open.

The application may modify the returned object but must not delete it. The TSLArrow object retains ownership of this object.

Parameters

sizeRatio

Controls how large the enclosing arrow head is in relation to the enclosed arrow head. There is no upper limit or lower limit, but a value between 1.2 and 2 is sensible.

Returns

The enclosing arrow head.

operator=()

TSLArrowHead & TSLArrowHead::operator= ( const TSLArrowHead & )

protected

polygonal() [1/2]

bool TSLArrowHead::polygonal

(

)

const

Returns true if the arrow head is polygonal.

Returns

Polygonal state of the arrow head

polygonal() [2/2]

void TSLArrowHead::polygonal

(

bool

isPolygonal

)

Specifies whether the arrow head is polygonal or not. A polygonal arrow head resembles a teepee, with the inner triangle

• the entrance to the teepee - sharing points with either side of the front of the arrow's tail.

Parameters

Polygonal

state of the arrow head