Tes::Shapes::PointCloudShape Class Reference

A Shape which renders a set of points as in a point cloud. More...

Inheritance diagram for Tes::Shapes::PointCloudShape:

List of all members.

Public Member Functions
	PointCloudShape (MeshResource cloud, uint id=0, ushort category=0, byte pointSize=0)
	Create a new point cloud shape.
uint	Index (uint at)
	Access one of the explicitly set index values.
void	SetIndices (uint[] indices)
	Sets an array of explicit indices used to limit the points displayed.
override bool	WriteCreate (PacketBuffer packet)
	Writes the standard create message plus the number of indices used to restrict cloud viewing (if any - UInt32).
override int	WriteData (PacketBuffer packet, ref uint progressMarker)
	Overridden to write the point cloud indices.
override object	Clone ()
	Clone this shape.
Protected Member Functions
void	OnClone (PointCloudShape copy)
	Actions to perform on cloning.
Properties
MeshResource	PointCloud [get, set]
	The point cloud resource.
byte	PointSize [get, set]
	Point render size request.
uint	IndexCount [get]
	The number of explicit indices provided.
override IEnumerable< Resource >	Resources [get]
	Enumerate the shape's resources.

---

Detailed Description

A Shape which renders a set of points as in a point cloud.

The points are contained in a MeshResource (e.g., PointCloud) and may be shared between PointCloudShape shapes. The mesh resource should have a MeshResource.DrawType of Tes.Net.MeshDrawType.Points, or the behaviour may be undefined.

The PointCloudShape shape supports the view into the MeshResource by having its own set of indices (see SetIndices(uint[])).

---

Constructor & Destructor Documentation

Tes::Shapes::PointCloudShape::PointCloudShape	(	MeshResource	cloud,
		uint	id = 0,
		ushort	category = 0,
		byte	pointSize = 0
	)		[inline]

Create a new point cloud shape.

Parameters:

cloud	The cloud mesh resource.
id	The shape ID. Zero for transient.
category	Category to which the shape belongs.
pointSize	Point size override. Zero for default.

---

Member Function Documentation

override object Tes::Shapes::PointCloudShape::Clone

(

)

[inline, virtual]

Clone this shape.

Returns:

A deep copy of this object.

Reimplemented from Tes::Shapes::Shape.

uint Tes::Shapes::PointCloudShape::Index

(

uint

at

)

[inline]

Access one of the explicitly set index values.

See also:

SetIndices(uint[])

Exceptions:

NullReferenceException

Thrown when indices are not set.

void Tes::Shapes::PointCloudShape::OnClone

(

PointCloudShape

copy

)

[inline, protected]

Actions to perform on cloning.

Parameters:

copy	The cloned object.

Clones the indices if any.

void Tes::Shapes::PointCloudShape::SetIndices

(

uint[]

indices

)

[inline]

Sets an array of explicit indices used to limit the points displayed.

Parameters:

indices

The index array referencing the points to display.

By default, the entire point cloud resource is rendered. By assigning indices, the displayed points are limited to those referenced in the given array.

override bool Tes::Shapes::PointCloudShape::WriteCreate

(

PacketBuffer

packet

)

[inline, virtual]

Writes the standard create message plus the number of indices used to restrict cloud viewing (if any - UInt32).

Parameters:

packet

The packet to write to.

Returns:

True on success.

Reimplemented from Tes::Shapes::Shape.

override int Tes::Shapes::PointCloudShape::WriteData	(	PacketBuffer	packet,
		ref uint	progressMarker
	)		[inline, virtual]

Overridden to write the point cloud indices.

Parameters:

packet	Packet to write to.
progressMarker	Number of indices written so far.

Returns:

0 when complete, 1 to call again.

Reimplemented from Tes::Shapes::Shape.

---

Property Documentation

uint Tes::Shapes::PointCloudShape::IndexCount [get]

The number of explicit indices provided.

See also:

SetIndices(uint[])

byte Tes::Shapes::PointCloudShape::PointSize [get, set]

Point render size request.

Zero for the default.

---

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

• PointCloudShape.cs