Tes::Handlers::CameraHandler Class Reference

Maintains camera objects which may be used to view the scene. More...

Inheritance diagram for Tes::Handlers::CameraHandler:

List of all members.

Classes
class	CameraInfo
	Details of the camera settings. More...
Public Member Functions
	CameraHandler (CategoryCheckDelegate categoryCheck)
	Constructor initialising the persistent and transient caches.
override void	BeginFrame (uint frameNumber, bool maintainTransient)
	Empty.
override void	EndFrame (uint frameNumber)
	Empty.
override void	Initialise (GameObject root, GameObject serverRoot, MaterialLibrary materials)
	Initialise the shape handler by initialising the shape scene root and fetching the default materials.
override void	Reset ()
	Clear all current objects.
override Error	ReadMessage (PacketBuffer packet, BinaryReader reader)
	The primary message handling function.
override Error	Serialise (BinaryWriter writer, ref SerialiseInfo info)
	Serialises the currently active objects in for playback from file.
override void	OnCategoryChange (ushort categoryId, bool active)
	Empty.
Properties
int	ActiveCameraID [get, set]
	Get/set the active camera ID [-1, 255].
bool	AllowRemoteCameraSettings [get, set]
	Allow the remote camera settings to set the local near clip and far clip and field of view settings?
CameraInfo	ActiveCamera [get]
	Query details of the active camera.
IEnumerable< int >	AvailableCameraIDs [get]
	Lists the available camera IDs.
CameraInfo	this[int id] [get]
	Index into the camera handler to information about the camera matching id .
override string	Name [get]
	Handler name.
override ushort	RoutingID [get]
	Routing ID.
GameObject	Root [get]
	Defines the scene root for all objects of this shape type.

---

Detailed Description

Maintains camera objects which may be used to view the scene.

Camera objects represent predetermined views into the scene. A camera object is really just a reference transform which the scene camera may optionally follow.

Camera objects are implicitly created when a message with a new camera ID arrives. A camera object is never destroyed and may only be updated with a new message.

---

Member Function Documentation

override void Tes::Handlers::CameraHandler::BeginFrame	(	uint	frameNumber,
		bool	maintainTransient
	)		[inline, virtual]

Empty.

Parameters:

frameNumber
maintainTransient

Reimplemented from Tes::Runtime::MessageHandler.

override void Tes::Handlers::CameraHandler::EndFrame

(

uint

frameNumber

)

[inline, virtual]

Empty.

Parameters:

frameNumber

Reimplemented from Tes::Runtime::MessageHandler.

override void Tes::Handlers::CameraHandler::Initialise	(	GameObject	root,
		GameObject	serverRoot,
		MaterialLibrary	materials
	)		[inline, virtual]

Initialise the shape handler by initialising the shape scene root and fetching the default materials.

Parameters:

root	The 3rd Eye Scene root object.
serverRoot	The server scene root (transformed into the server reference frame).
materials	Material library from which to resolve materials.

Reimplemented from Tes::Runtime::MessageHandler.

override void Tes::Handlers::CameraHandler::OnCategoryChange	(	ushort	categoryId,
		bool	active
	)		[inline, virtual]

Empty.

Parameters:

categoryId
active

Implements Tes::Runtime::MessageHandler.

override Error Tes::Handlers::CameraHandler::ReadMessage	(	PacketBuffer	packet,
		BinaryReader	reader
	)		[inline, virtual]

The primary message handling function.

Parameters:

packet
reader

Returns:

Implements Tes::Runtime::MessageHandler.

override Error Tes::Handlers::CameraHandler::Serialise	(	BinaryWriter	writer,
		ref SerialiseInfo	info
	)		[inline, virtual]

Serialises the currently active objects in for playback from file.

Parameters:

writer	The write to serialise to.
info	Statistics

Returns:

An error code on failure.

Implements Tes::Runtime::MessageHandler.

---

Property Documentation

int Tes::Handlers::CameraHandler::ActiveCameraID [get, set]

Get/set the active camera ID [-1, 255].

Setting -1 restores the free fly camera mode as does setting an unknown camera ID.

bool Tes::Handlers::CameraHandler::AllowRemoteCameraSettings [get, set]

Allow the remote camera settings to set the local near clip and far clip and field of view settings?

GameObject Tes::Handlers::CameraHandler::Root [get]

Defines the scene root for all objects of this shape type.

The root for objects of this shape.

CameraInfo Tes::Handlers::CameraHandler::this[int id] [get]

Index into the camera handler to information about the camera matching id .

Parameters:

id	ID for the camera of interest.

Information about the requested camera or null if the ID is invalid.

---

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

• CameraHandler.cs