C#Code
C#Code
Public Member Functions | Properties | Private Attributes
Libraries._3D.Offset3DObj Class Reference

List of all members.

Public Member Functions

 Offset3DObj (BaseObj3D obj)
void SetPos (Vector3 pos)
void SetScale (Vector3 scale)
void SetScaleOffset (bool scaleOffset)
void SetOffset (Vector3 offset)
Vector3 GetOffset ()
void Update (int timePassed)
void Render (GraphicsDevice device)
 Offset3DObj (BaseObj3D obj)
void SetPos (Vector3 pos)
void SetOffset (Vector3 offset)
void Update (int timePassed)
void Render (GraphicsDevice device)

Properties

BaseObj3D Object [get, set]

Private Attributes

Vector3 m_pos
 Last position the object was set to. Needed because of scaling the offset needs the original position.
Vector3 m_offset
bool m_scaleOffset
 Whether the scaling component should be applied to the offset. Value is true if it should, false if not.
BaseObj3D m_obj
 Store the object we will be controlling the position for.

Detailed Description

Class to store a 3D object and set its position with a offset.


Constructor & Destructor Documentation

Libraries._3D.Offset3DObj.Offset3DObj ( BaseObj3D  obj)

Default constructor.

obj - Object to offset.
Libraries._3D.Offset3DObj.Offset3DObj ( BaseObj3D  obj)

Member Function Documentation

Vector3 Libraries._3D.Offset3DObj.GetOffset ( )

Get the offset applied.

Return:
Value is the offset applied to the object.

void Libraries._3D.Offset3DObj.Render ( GraphicsDevice  device)

Render the object.

device - Graphics device to render with.
void Libraries._3D.Offset3DObj.Render ( GraphicsDevice  device)

Render the object.

device - Graphics device to render with.
void Libraries._3D.Offset3DObj.SetOffset ( Vector3  offset)

Set the offset to use when setting the object position.

offset - Offset to store. Not applied until the model position gets set.
void Libraries._3D.Offset3DObj.SetOffset ( Vector3  offset)

Set the offset to use when setting the object position.

offset - Offset to store. Not applied until the model position gets set.
void Libraries._3D.Offset3DObj.SetPos ( Vector3  pos)

Set the object to be at the given position with the stored offset.

pos - Position to store.
void Libraries._3D.Offset3DObj.SetPos ( Vector3  pos)

Set the object to be at the given position with the stored offset.

void Libraries._3D.Offset3DObj.SetScale ( Vector3  scale)

Set the object to have the given scale.

scale - Scale to store.
void Libraries._3D.Offset3DObj.SetScaleOffset ( bool  scaleOffset)

Set weither the offset is scaled by the model scale when scaling or position are set.

scaleOffset - Value is true if the offset will get scaled, false if not.
void Libraries._3D.Offset3DObj.Update ( int  timePassed)

Update the object with the time passed.

timePassed - How much time to account for with the update.
void Libraries._3D.Offset3DObj.Update ( int  timePassed)

Update the object with the time passed.

timePassed - How much time to account for with the update.

Member Data Documentation

Store the object we will be controlling the position for.

Last position the object was set to. Needed because of scaling the offset needs the original position.

Whether the scaling component should be applied to the offset. Value is true if it should, false if not.


Property Documentation

BaseObj3D Libraries::_3D.Offset3DObj::Object [get, set]

Getter/Setter for the object.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties