Objects3D.Coordinate Class Reference

Container for a single 3-dimensional point (X, Y, Z). More...

List of all members.

Public Member Functions

delegate void OnChangedHandler (Coordinate ACoordinate, float AOldX, float AOldY, float AOldZ)
 Coordinate ()
 Coordinate (float AX, float AY, float AZ)
byte[] GetBytes ()
 Method returning binary representation of Coordinate instance.
bool SetBytes (byte[] ABytes, int AOffset)
 Method setting binary representation of Coordinate instance.
bool Assign (float AX, float AY, float AZ)
 Assigns the fields of the current instance the passed values.
bool Assign (Coordinate ACoordinate)
 Assigns the fields of the current instance the values of the passed instance.
bool Equals (float AX, float AY, float AZ)
 Checks whether the values of the current instance math then passed values.
bool Equals (Coordinate ACoordinate)
 Checks whether the values of the current instance math then values of the passed instance.
bool Rotate (float AX, float AY, float AZ, bool APositive)
 Rotates the coordinate values around the center point.
bool Rotate (Coordinate ACoordinate, bool APositive)
 Rotates the coordinate values around the center point.
bool Scale (float AX, float AY, float AZ, float AMultiplier, bool APositive)
 Scales the coordinate values.
bool Scale (Coordinate ACoordinate, float AMultiplier, bool APositive)
 Scales the coordinate values.
bool Translate (float AX, float AY, float AZ, bool APositive)
 Translates the coordinate.
bool Translate (Coordinate ACoordinate, bool APositive)
 Translates the coordinate.

Static Public Member Functions

static float DegToRad (float AAngle)
 Method returning radian measure value of passed degree angle.
static float RadToDeg (float AAngle)
 Method returning degree value of passed radian measure angle.

Protected Member Functions

virtual void RaiseOnAssigned (float AOldX, float AOldY, float AOldZ)
 Wrapper for the call of event FOnAssigned().

Protected Attributes

float FX
float FY
float FZ

Properties

static int ByteSize [get]
 Property containing the length of the binary representation of Coordinate.
OnChangedHandler OnAssigned [get, set]
 Wrapper around field FOnAssigned().
float X [get, set]
 Property containing the X-value.
float Y [get, set]
 Property containing the Y-value.
float Z [get, set]
 Property containing the Z-value.

Events

OnChangedHandler FOnAssigned


Detailed Description

Container for a single 3-dimensional point (X, Y, Z).

Author:
Kevin Niehage

Definition at line 20 of file Coordinate.cs.


Constructor & Destructor Documentation

Objects3D.Coordinate.Coordinate (  ) 

Objects3D.Coordinate.Coordinate ( float  AX,
float  AY,
float  AZ 
)


Member Function Documentation

delegate void Objects3D.Coordinate.OnChangedHandler ( Coordinate  ACoordinate,
float  AOldX,
float  AOldY,
float  AOldZ 
)

virtual void Objects3D.Coordinate.RaiseOnAssigned ( float  AOldX,
float  AOldY,
float  AOldZ 
) [protected, virtual]

Wrapper for the call of event FOnAssigned().

RaiseOnAssigned

Author:
Kevin Niehage
Parameters:
[in] AOldX contains the old value of the property X
[in] AOldY contains the old value of the property Y
[in] AOldZ contains the old value of the property Z

Definition at line 41 of file Coordinate.cs.

References Objects3D.Coordinate.FOnAssigned.

Referenced by Objects3D.Coordinate.Assign().

byte [] Objects3D.Coordinate.GetBytes (  ) 

Method returning binary representation of Coordinate instance.

GetBytes

Author:
Kevin Niehage
Returns:
binary representation of Coordinate instance

Definition at line 167 of file Coordinate.cs.

References Objects3D.Coordinate.ByteSize, Objects3D.Coordinate.FX, Objects3D.Coordinate.FY, and Objects3D.Coordinate.FZ.

Referenced by Objects3D.ServerCube.GetBytes(), Objects3D.Player.GetBytes(), Objects3D.Cube.GetBytes(), and Objects3D.Controller.GetBytes().

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

Method setting binary representation of Coordinate 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 194 of file Coordinate.cs.

References Objects3D.Coordinate.Assign(), and Objects3D.Coordinate.ByteSize.

Referenced by Objects3D.ServerCube.SetBytes(), Objects3D.Player.SetBytes(), Objects3D.Cube.SetBytes(), and Objects3D.Controller.SetBytes().

bool Objects3D.Coordinate.Assign ( float  AX,
float  AY,
float  AZ 
)

Assigns the fields of the current instance the passed values.

Assign

Author:
Kevin Niehage
Parameters:
[in] X coordinate value
[in] Y coordinate value
[in] Z coordinate value
Returns:
indicator if method worked correctly

Definition at line 223 of file Coordinate.cs.

References Objects3D.Coordinate.FX, Objects3D.Coordinate.FY, Objects3D.Coordinate.FZ, and Objects3D.Coordinate.RaiseOnAssigned().

Referenced by Objects3D.ServerCube.Assign(), Objects3D.Player.Assign(), Objects3D.Cube.Assign(), Objects3D.Coordinate.Assign(), Objects3D.Controller.Assign(), and Objects3D.Coordinate.SetBytes().

bool Objects3D.Coordinate.Assign ( Coordinate  ACoordinate  ) 

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

Assign

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

Definition at line 249 of file Coordinate.cs.

References Objects3D.Coordinate.Assign(), Objects3D.Coordinate.X, Objects3D.Coordinate.Y, and Objects3D.Coordinate.Z.

bool Objects3D.Coordinate.Equals ( float  AX,
float  AY,
float  AZ 
)

Checks whether the values of the current instance math then passed values.

Equals

Author:
Kevin Niehage
Parameters:
[in] X coordinate value
[in] Y coordinate value
[in] Z coordinate value
Returns:
indicator if values are equal

Definition at line 274 of file Coordinate.cs.

References Objects3D.Coordinate.FX, Objects3D.Coordinate.FY, and Objects3D.Coordinate.FZ.

Referenced by Objects3D.Coordinate.Equals(), Objects3D.Cube.OnAssignedPos(), Objects3D.Cube.OnAssignedRot(), and Objects3D.Cube.OnAssignedScale().

bool Objects3D.Coordinate.Equals ( Coordinate  ACoordinate  ) 

Checks whether the values of the current instance math then values of the passed instance.

Equals

Author:
Kevin Niehage
Parameters:
[in] coordinate instance
Returns:
indicator if values are equal

Definition at line 290 of file Coordinate.cs.

References Objects3D.Coordinate.Equals(), Objects3D.Coordinate.X, Objects3D.Coordinate.Y, and Objects3D.Coordinate.Z.

bool Objects3D.Coordinate.Rotate ( float  AX,
float  AY,
float  AZ,
bool  APositive 
)

Rotates the coordinate values around the center point.

Rotate

Author:
Kevin Niehage
Parameters:
[in] X rotate angle
[in] Y rotate angle
[in] Z rotate angle
[in] value for reverting the rotation
Returns:
indicator if method worked correctly

Definition at line 316 of file Coordinate.cs.

References Objects3D.Coordinate.FX, Objects3D.Coordinate.FY, and Objects3D.Coordinate.FZ.

Referenced by Objects3D.Coordinate.Rotate().

bool Objects3D.Coordinate.Rotate ( Coordinate  ACoordinate,
bool  APositive 
)

Rotates the coordinate values around the center point.

Rotate

Author:
Kevin Niehage
Parameters:
[in] coordinate instance
[in] value for reverting the rotation
Returns:
indicator if method worked correctly

Definition at line 392 of file Coordinate.cs.

References Objects3D.Coordinate.Rotate(), Objects3D.Coordinate.X, Objects3D.Coordinate.Y, and Objects3D.Coordinate.Z.

bool Objects3D.Coordinate.Scale ( float  AX,
float  AY,
float  AZ,
float  AMultiplier,
bool  APositive 
)

Scales the coordinate values.

Scale

Author:
Kevin Niehage
Parameters:
[in] X scaling value
[in] Y scaling value
[in] Z scaling value
[in] multiplier for scaling values
[in] value for reverting the scaling
Returns:
indicator if method worked correctly

Definition at line 419 of file Coordinate.cs.

References Objects3D.Coordinate.FX, Objects3D.Coordinate.FY, and Objects3D.Coordinate.FZ.

Referenced by Objects3D.Coordinate.Scale().

bool Objects3D.Coordinate.Scale ( Coordinate  ACoordinate,
float  AMultiplier,
bool  APositive 
)

Scales the coordinate values.

Scale

Author:
Kevin Niehage
Parameters:
[in] coordinate instance
[in] multiplier for scaling values
[in] value for reverting the scaling
Returns:
indicator if method worked correctly

Definition at line 459 of file Coordinate.cs.

References Objects3D.Coordinate.Scale(), Objects3D.Coordinate.X, Objects3D.Coordinate.Y, and Objects3D.Coordinate.Z.

bool Objects3D.Coordinate.Translate ( float  AX,
float  AY,
float  AZ,
bool  APositive 
)

Translates the coordinate.

Translate

Author:
Kevin Niehage
Parameters:
[in] X translation value
[in] Y translation value
[in] Z translation value
[in] value for reverting the translation
Returns:
indicator if method worked correctly

Definition at line 485 of file Coordinate.cs.

References Objects3D.Coordinate.FX, Objects3D.Coordinate.FY, and Objects3D.Coordinate.FZ.

Referenced by Objects3D.Coordinate.Translate().

bool Objects3D.Coordinate.Translate ( Coordinate  ACoordinate,
bool  APositive 
)

Translates the coordinate.

Translate

Author:
Kevin Niehage
Parameters:
[in] coordinate instance
[in] value for reverting the translation
Returns:
indicator if method worked correctly

Definition at line 515 of file Coordinate.cs.

References Objects3D.Coordinate.Translate(), Objects3D.Coordinate.X, Objects3D.Coordinate.Y, and Objects3D.Coordinate.Z.

static float Objects3D.Coordinate.DegToRad ( float  AAngle  )  [static]

Method returning radian measure value of passed degree angle.

DegToRad

Author:
Kevin Niehage
Parameters:
[in] AAngle angle in degree
Returns:
angle in radian measure

Definition at line 538 of file Coordinate.cs.

static float Objects3D.Coordinate.RadToDeg ( float  AAngle  )  [static]

Method returning degree value of passed radian measure angle.

RadToDeg

Author:
Kevin Niehage
Parameters:
[in] AAngle angle in radian measure
Returns:
angle in degree

Definition at line 554 of file Coordinate.cs.


Member Data Documentation

float Objects3D.Coordinate.FX [protected]

float Objects3D.Coordinate.FY [protected]

float Objects3D.Coordinate.FZ [protected]


Property Documentation

Objects3D.Coordinate::ByteSize [static, get]

Property containing the length of the binary representation of Coordinate.

Author:
Kevin Niehage

Definition at line 71 of file Coordinate.cs.

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

Objects3D.Coordinate::OnAssigned [get, set]

Wrapper around field FOnAssigned().

Author:
Kevin Niehage

Definition at line 86 of file Coordinate.cs.

Referenced by Objects3D.Cube.Cube().

Objects3D.Coordinate::X [get, set]

Objects3D.Coordinate::Y [get, set]

Objects3D.Coordinate::Z [get, set]


Event Documentation

OnChangedHandler Objects3D.Coordinate.FOnAssigned [protected]

Definition at line 22 of file Coordinate.cs.

Referenced by Objects3D.Coordinate.RaiseOnAssigned().


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

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