Tes::Shapes::Arrow Class Reference

Defines an arrow shape for remote rendering. More...

Inheritance diagram for Tes::Shapes::Arrow:

List of all members.

Public Member Functions
	Arrow (uint id, Vector3 origin, Vector3 dir, float length, float radius)
	Construct an arrow shape.
	Arrow (uint id, Vector3 origin, Vector3 endPoint, float radius)
	Construct an arrow shape.
	Arrow (uint id=0u, ushort category=0)
	Construct an arrow shape at the origin.
	Arrow (uint id, ushort category, Vector3 origin, Vector3 dir, float length, float radius)
	Construct an arrow shape.
	Arrow (uint id, ushort category, Vector3 origin, Vector3 endPoint, float radius)
	Construct an arrow shape.
override object	Clone ()
	Clone this shape.
Public Attributes
const float	DefaultLength = 1.0f
	Default length when not otherwise specified.
const float	DefaultRadius = 0.025f
	Default radius when not otherwise specified.
Static Public Attributes
static Vector3	DefaultDirection = Vector3.AxisZ
	The default direction when rendering with an identity quaternion rotation.
Properties
float	Radius [get, set]
	Access the arrow cylinder radius.
float	Length [get, set]
	Access the arrow length.
Vector3	Direction [get, set]
	Access the arrow direction (unit vector).

---

Detailed Description

Defines an arrow shape for remote rendering.

---

Constructor & Destructor Documentation

Tes::Shapes::Arrow::Arrow	(	uint	id,
		Vector3	origin,
		Vector3	dir,
		float	length,
		float	radius
	)		[inline]

Construct an arrow shape.

Parameters:

id	ID of the shape. Zero for transient.
origin	Position of the arrow base.
dir	Unit vector away from the origin .
length	Length of the arrow along dir .
radius	Arrow radius.

Tes::Shapes::Arrow::Arrow	(	uint	id,
		Vector3	origin,
		Vector3	endPoint,
		float	radius
	)		[inline]

Construct an arrow shape.

Parameters:

id	ID of the shape. Zero for transient.
origin	Position of the arrow base.
endPoint	Position of the arrow tip.
radius	Arrow radius.

Tes::Shapes::Arrow::Arrow	(	uint	id = 0u,
		ushort	category = 0
	)		[inline]

Construct an arrow shape at the origin.

Parameters:

id	ID of the shape. Zero for transient.
category	Category to which the shape belongs.

Tes::Shapes::Arrow::Arrow	(	uint	id,
		ushort	category,
		Vector3	origin,
		Vector3	dir,
		float	length,
		float	radius
	)		[inline]

Construct an arrow shape.

Parameters:

id	ID of the shape. Zero for transient.
category	Category to which the shape belongs.
origin	Position of the arrow base.
dir	Unit vector away from the origin .
length	Length of the arrow along dir .
radius	Arrow radius.

Tes::Shapes::Arrow::Arrow	(	uint	id,
		ushort	category,
		Vector3	origin,
		Vector3	endPoint,
		float	radius
	)		[inline]

Construct an arrow shape.

Parameters:

id	ID of the shape. Zero for transient.
category	Category to which the shape belongs.
origin	Position of the arrow base.
endPoint	Position of the arrow tip.
radius	Arrow radius.

---

Member Function Documentation

override object Tes::Shapes::Arrow::Clone

(

)

[inline, virtual]

Clone this shape.

Returns:

A deep copy of this object.

Reimplemented from Tes::Shapes::Shape.

---

Property Documentation

float Tes::Shapes::Arrow::Radius [get, set]

Access the arrow cylinder radius.

The arrow head widens by about 25%.

---

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

• 3esCore/Shapes/Arrow.cs