torque Torque Game Engine Documentation
TGE Version 1.5.2
Torque Home   Class Hierarchy   Data Structures   Namespaces   Namespace Members   File List   Globals

Sun Class Reference

#include <sun.h>

Inheritance diagram for Sun:

Inheritance graph
[legend]

Public Types

enum  NetMaskBits { UpdateMask = BIT(0) }

Public Member Functions

 Sun ()
bool onAdd ()
 Called when the object is added to the sim.
void registerLights (LightManager *lm, bool lightingScene)
 Called to register the object's lights, if any, with the LightManager.
void inspectPostApply ()
 Called after any property of the object is changed in the world editor.
U32 packUpdate (NetConnection *conn, U32 mask, BitStream *stream)
 Instructs this object to pack its state for transfer over the network.
void unpackUpdate (NetConnection *conn, BitStream *stream)
 Instructs this object to read state data previously packed with packUpdate.
 DECLARE_CONOBJECT (Sun)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Data Fields

F32 mSunAzimuth
F32 mSunElevation

Private Types

typedef NetObject Parent

Private Member Functions

void conformLight ()

Private Attributes

LightInfo mLight
LightInfo mRegisteredLight

Member Typedef Documentation

typedef NetObject Sun::Parent [private]

Reimplemented from NetObject.

Member Enumeration Documentation

enum Sun::NetMaskBits

Enumerator:
UpdateMask 

Constructor & Destructor Documentation

Sun::Sun (  ) 

Member Function Documentation

void Sun::conformLight (  )  [private]

bool Sun::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from NetObject.

void Sun::registerLights ( LightManager *  lm,
bool  lightingScene 
) [virtual]

Called to register the object's lights, if any, with the LightManager.

Parameters:
lm LightManager to put lights into.
lightingScene True if we're currently calculating lighting information.

Reimplemented from SimObject.

void Sun::inspectPostApply (  )  [virtual]

Called after any property of the object is changed in the world editor.

See also:
inspectPreApply

Reimplemented from SimObject.

static void Sun::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from NetObject.

U32 Sun::packUpdate ( NetConnection *  conn,
U32  mask,
BitStream *  stream 
) [virtual]

Instructs this object to pack its state for transfer over the network.

Parameters:
conn Net connection being used
mask Mask indicating fields to transmit.
stream Bitstream to pack data to
Returns:
Any bits which were not dealt with. The value is stored by the networking system. Don't set bits you weren't passed.

Reimplemented from NetObject.

void Sun::unpackUpdate ( NetConnection *  conn,
BitStream *  stream 
) [virtual]

Instructs this object to read state data previously packed with packUpdate.

Parameters:
conn Net connection being used
stream stream to read from

Reimplemented from NetObject.

Sun::DECLARE_CONOBJECT ( Sun   ) 

Field Documentation

LightInfo Sun::mLight [private]

LightInfo Sun::mRegisteredLight [private]

F32 Sun::mSunAzimuth

F32 Sun::mSunElevation



All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen
© GarageGames.com Home Back to Top