Tes::Shapes::Capsule Class Reference

Defines a capsule shape for remote rendering. More...

Inheritance diagram for Tes::Shapes::Capsule:

List of all members.

Public Member Functions
	Capsule (uint id, Vector3 origin, Vector3 up, float length, float radius)
	Create a new capsule.
	Capsule (uint id, Vector3 startPoint, Vector3 endPoint, float radius)
	Create a new capsule.
	Capsule (uint id=0u, ushort category=0)
	Create a new capsule.
	Capsule (uint id, ushort category, Vector3 origin, Vector3 up, float length, float radius)
	Create a new capsule.
	Capsule (uint id, ushort category, Vector3 startPoint, Vector3 endPoint, float radius)
	Create a new capsule.
override object	Clone ()
	Clone this shape.
Public Attributes
const float	DefaultLength = 1.0f
	Default length when not otherwise specified.
const float	DefaultRadius = 0.25f
	Default radius when not otherwise specified.
Static Public Attributes
static Vector3	DefaultUp = Vector3.AxisZ
	The default major axis when rendering with an identity quaternion rotation.
Properties
float	Radius [get, set]
	Access the capsule radius.
float	Length [get, set]
	Access the capsule length.
Vector3	Centre [get, set]
	The capsule centre.
Vector3	Up [get, set]
	The primary axis.

---

Detailed Description

Defines a capsule shape for remote rendering.

A capsule is two hemispheres connected by a cylinder.

---

Constructor & Destructor Documentation

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

Create a new capsule.

Parameters:

id	The shape ID. Zero for transient shapes.
origin	The centre of the shape.
up	The major axis.
length	The length of the cylindrical component.
radius	The shape radius.

Tes::Shapes::Capsule::Capsule	(	uint	id,
		Vector3	startPoint,
		Vector3	endPoint,
		float	radius
	)		[inline]

Create a new capsule.

Parameters:

id	The shape ID. Zero for transient shapes.
startPoint	The first point of the primary axis.
endPoint	The second point of the primary axis.
radius	The shape radius.

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

Create a new capsule.

Parameters:

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

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

Create a new capsule.

Parameters:

id	The shape ID. Zero for transient shapes.
category	Category to which the shape belongs.
origin	The centre of the shape.
up	The major axis.
length	The length of the cylindrical component.
radius	The shape radius.

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

Create a new capsule.

Parameters:

id	The shape ID. Zero for transient shapes.
category	Category to which the shape belongs.
startPoint	The first point of the primary axis.
endPoint	The second point of the primary axis.
radius	The shape radius.

---

Member Function Documentation

override object Tes::Shapes::Capsule::Clone

(

)

[inline, virtual]

Clone this shape.

Returns:

A deep copy of this object.

Reimplemented from Tes::Shapes::Shape.

---

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

• 3esCore/Shapes/Capsule.cs