Objects3D.Controller Class Reference

Container for all the user input that is sent to the server. More...

List of all members.

Public Member Functions

 Controller ()
bool GetKeyState (ControllerKey AControllerKey)
 Method returning the key state of a key.
void SetKeyState (ControllerKey AControllerKey, bool AValue)
 Method setting the key state of a key.
byte[] GetBytes ()
 Method returning binary representation of Controller instance.
bool SetBytes (byte[] ABytes, int AOffset)
 Method setting binary representation of Controller instance.
bool Assign (Controller AController)
 Assigns the fields of the current instance the values of the passed instance.

Protected Attributes

byte FID = 0
Coordinate FRotation
byte[] FStates

Properties

static int ByteSize [get]
 Property containing the length of the binary representation of Controller.
byte ID [get, set]
 Property containing the player ID.
Coordinate Rotation [get, set]
 Property containing the current rotation of the player.


Detailed Description

Container for all the user input that is sent to the server.

Author:
Kevin Niehage

Definition at line 40 of file Controller.cs.


Constructor & Destructor Documentation

Objects3D.Controller.Controller (  ) 


Member Function Documentation

bool Objects3D.Controller.GetKeyState ( ControllerKey  AControllerKey  ) 

Method returning the key state of a key.

GetKeyState

Author:
Kevin Niehage
Parameters:
[in] key representer
Returns:
indicator of the state of the passed key

Definition at line 83 of file Controller.cs.

References Objects3D.Controller.FStates.

Referenced by Objects3D.Controller.Assign().

void Objects3D.Controller.SetKeyState ( ControllerKey  AControllerKey,
bool  AValue 
)

Method setting the key state of a key.

SetKeyState

Author:
Kevin Niehage
Parameters:
[in] key representer
[in] key state

Definition at line 98 of file Controller.cs.

References Objects3D.Controller.FStates.

Referenced by Objects3D.Controller.Assign().

byte [] Objects3D.Controller.GetBytes (  ) 

Method returning binary representation of Controller instance.

GetBytes

Author:
Kevin Niehage
Returns:
binary representation of Controller instance

Definition at line 162 of file Controller.cs.

References Objects3D.Controller.ByteSize, Objects3D.Controller.FID, Objects3D.Controller.FRotation, Objects3D.Controller.FStates, and Objects3D.Coordinate.GetBytes().

Referenced by Objects3D.Network.GetController().

bool Objects3D.Controller.SetBytes ( byte[]  ABytes,
int  AOffset 
)

Method setting binary representation of Controller instance.

SetBytes

Author:
Kevin Niehage
Parameters:
[in] ABytes array of byte containing the binary representation
[in] AOffset value defining from which position of the array the binary representation is to be read
Returns:
indicator if method worked correctly

Definition at line 189 of file Controller.cs.

References Objects3D.Controller.ByteSize, Objects3D.Controller.FID, Objects3D.Controller.FRotation, Objects3D.Controller.FStates, and Objects3D.Coordinate.SetBytes().

bool Objects3D.Controller.Assign ( Controller  AController  ) 

Assigns the fields of the current instance the values of the passed instance.

Assign

Author:
Kevin Niehage
Parameters:
[in] controller instance
Returns:
indicator if method worked correctly

Definition at line 222 of file Controller.cs.

References Objects3D.Coordinate.Assign(), Objects3D.Controller.FRotation, Objects3D.Controller.GetKeyState(), Objects3D.Controller.ID, Objects3D.Controller.Rotation, and Objects3D.Controller.SetKeyState().


Member Data Documentation

byte Objects3D.Controller.FID = 0 [protected]

byte [] Objects3D.Controller.FStates [protected]


Property Documentation

Objects3D.Controller::ByteSize [static, get]

Property containing the length of the binary representation of Controller.

Author:
Kevin Niehage

Definition at line 65 of file Controller.cs.

Referenced by Objects3D.Controller.GetBytes(), and Objects3D.Controller.SetBytes().

Objects3D.Controller::ID [get, set]

Property containing the player ID.

Author:
Kevin Niehage

Definition at line 121 of file Controller.cs.

Referenced by Objects3D.Controller.Assign(), Cubes3D.ClientHandler.ClientHandler(), and Cubes3D.ServerHandler.StartServerReceiver().

Objects3D.Controller::Rotation [get, set]

Property containing the current rotation of the player.

Author:
Kevin Niehage

Definition at line 141 of file Controller.cs.

Referenced by Objects3D.Controller.Assign().


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

Generated on Fri Nov 14 09:05:11 2008 for Cubesł by  doxygen 1.5.6