Tes::Shapes::Plane Class Reference

Defines plane shape for remote rendering. More...

Inheritance diagram for Tes::Shapes::Plane:

List of all members.

Public Member Functions
	Plane (uint id, Vector3 position, Vector3 normal, float scale=1.0f, float normalLength=1.0f)
	Construct a plane shape.
	Plane (uint id=0u, ushort category=0)
	Construct a plane shape.
	Plane (uint id, ushort category, Vector3 position, Vector3 normal, float scale=1.0f, float normalLength=1.0f)
	Construct a plane shape.
override object	Clone ()
	Clone this shape.
Static Public Attributes
static Vector3	DefaultNormal = Vector3.AxisZ
	The default plane orientation by normal.
Properties
new float	Scale [get, set]
	Access the plane quad scale.
float	NormalLength [get, set]
	Access the plane normal visualisation length.
Vector3	Normal [get, set]
	Access the plane normal.

---

Detailed Description

Defines plane shape for remote rendering.

The "plane" is represented by a small quadrilateral at the requested position and a representation of the plane normal.

---

Constructor & Destructor Documentation

Tes::Shapes::Plane::Plane	(	uint	id,
		Vector3	position,
		Vector3	normal,
		float	scale = 1.0f,
		float	normalLength = 1.0f
	)		[inline]

Construct a plane shape.

Parameters:

id	The shape ID. Zero for transient shapes.
position	Defines the centre of the plane patch.
normal	The plane normal.
scale	Defines the size of the plane quad.
normalLength	Render length for the normal.

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

Construct a plane shape.

Parameters:

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

Tes::Shapes::Plane::Plane	(	uint	id,
		ushort	category,
		Vector3	position,
		Vector3	normal,
		float	scale = 1.0f,
		float	normalLength = 1.0f
	)		[inline]

Construct a plane shape.

Parameters:

id	The shape ID. Zero for transient shapes.
category	Category to which the shape belongs.
position	Defines the centre of the plane patch.
normal	The plane normal.
scale	Defines the size of the plane quad.
normalLength	Render length for the normal.

---

Member Function Documentation

override object Tes::Shapes::Plane::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/Plane.cs