CIvfArrow Class Reference

#include <ivf/IvfArrow.h>

Inheritance diagram for CIvfArrow:

List of all members.

Public Member Functions
	CIvfArrow ()
virtual	~CIvfArrow ()
	IvfClassInfo ("CIvfArrow", CIvfComposite)
void	setArrowType (int type)
int	getArrowType ()
void	setSize (double length, double head)
void	getSize (double &length, double &head)
void	setRadius (double head, double tail)
void	setOffset (double offset)
double	getOffset ()
double	getLength ()
void	alignVector (CIvfVec3d *vec)

---

Detailed Description

Arrow shape class

CIvfArrow implements a simple arrow shape consisting of a cone placed on top of a cylinder.

Author:

Jonas Lindemann

Definition at line 47 of file IvfArrow.h.

---

Constructor & Destructor Documentation

CIvfArrow::CIvfArrow (   )

CIvfArrow constructor

virtual CIvfArrow::~CIvfArrow (   )  [virtual]

CIvfArrow destructor

---

Member Function Documentation

void CIvfArrow::alignVector (  CIvfVec3d *  vec  )

Align arrow to a vector. The arrow can be aligned to a specific vector by providing a reference to a CIvfVect3d instance. Parameters: ivfVector  Reference to a CIvfVec3d instance to which the arrow is aligned.

int CIvfArrow::getArrowType (   )

Returns arrow type

double CIvfArrow::getLength (   )

Returns the total length of the arrow. (calculated)

double CIvfArrow::getOffset (   )

Returns the offset value.

void CIvfArrow::getSize (  double &  length, double &  head )

Returns sizes of arrow components.

void CIvfArrow::setArrowType (  int  type  )

Set arrow type Two arrow type can be set. One standard arrow type with one head and a arrow with a double head. Parameters: type  IVF_ARROW_STANDARD standard arrow type (default). IVF_ARROW_DOUBLE arrow with two heads.

void CIvfArrow::setOffset (  double  offset  )

Set offset of arrow center. Default the arrow has its origin in the middle of the arrow. By specifying an offset the origion can be moved along the axis of the arrow. Parameters: offset  Origion offset value.

void CIvfArrow::setRadius (  double  head, double  tail )

Set radius of arrow components. Two radius values are given to specify the thickness of the arrow. Parameters: head  Bottom radius of the cone. tail  Radius of cylinder.

void CIvfArrow::setSize (  double  length, double  head )

Set sizes of arrow components. The arrow size is specified by a total length and and a the length of the head. The length of the cylinder is length - head. Parameters: length  Total length of arrow. head Size of arrow head.

---

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

• ivf/IvfArrow.h

---