Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
LaserUpdate Class Reference

#include <LaserUpdate.h>

Inherits ClientUpdateModule.

Public Member Functions

 LaserUpdate (Thing *thing, const ModuleData *moduleData)
 
void initLaser (const Object *parent, const Object *target, const Coord3D *startPos, const Coord3D *endPos, AsciiString parentBoneName, Int sizeDeltaFrames=0)
 
void setDecayFrames (UnsignedInt decayFrames)
 
const Coord3D * getStartPos ()
 
const Coord3D * getEndPos ()
 
Real getCurrentLaserRadius () const
 
void setDirty (Bool dirty)
 
Bool isDirty ()
 
Real getWidthScale () const
 
virtual void clientUpdate ()
 
- Public Member Functions inherited from ClientUpdateModule
 ClientUpdateModule (Thing *thing, const ModuleData *moduleData)
 
- Public Member Functions inherited from DrawableModule
 DrawableModule (Thing *thing, const ModuleData *moduleData)
 < this abstract class needs memory pool hooks
 
- Public Member Functions inherited from Module
 Module (const ModuleData *moduleData)
 < this abstract class needs memory pool hooks
 
virtual NameKeyType getModuleNameKey () const =0
 
NameKeyType getModuleTagNameKey () const
 
virtual void onObjectCreated ()
 
virtual void onDrawableBoundToObject ()
 
virtual void preloadAssets (TimeOfDay timeOfDay)
 preload any assets we might have for this time of day
 
virtual void onDelete (void)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 
- Public Member Functions inherited from Snapshot
 Snapshot (void)
 
 ~Snapshot (void)
 

Protected Member Functions

void updateStartPos ()
 figures out and sets startPos
 
void updateEndPos ()
 figures out and sets endPos
 
- Protected Member Functions inherited from DrawableModule
Drawable * getDrawable ()
 
const Drawable * getDrawable () const
 
virtual void crc (Xfer *xfer)
 
virtual void xfer (Xfer *xfer)
 
virtual void loadPostProcess (void)
 
- Protected Member Functions inherited from Module
const ModuleData * getModuleData () const
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPool * getObjectMemoryPool ()=0
 

Protected Attributes

Coord3D m_startPos
 
Coord3D m_endPos
 
DrawableID m_parentID
 
DrawableID m_targetID
 
Bool m_dirty
 
ParticleSystemID m_particleSystemID
 
ParticleSystemID m_targetParticleSystemID
 
Bool m_widening
 
Bool m_decaying
 
UnsignedInt m_widenStartFrame
 
UnsignedInt m_widenFinishFrame
 
Real m_currentWidthScalar
 
UnsignedInt m_decayStartFrame
 
UnsignedInt m_decayFinishFrame
 
AsciiString m_parentBoneName
 

Additional Inherited Members

- Static Public Member Functions inherited from ClientUpdateModule
static ModuleType getModuleType ()
 
static Int getInterfaceMask ()
 
- Static Public Member Functions inherited from Module
static ModuleData * friend_newModuleData (INI *ini)
 

Detailed Description

The default update module

Definition at line 66 of file LaserUpdate.h.

Constructor & Destructor Documentation

◆ LaserUpdate()

LaserUpdate::LaserUpdate ( Thing * thing,
const ModuleData * moduleData )

Definition at line 76 of file LaserUpdate.cpp.

Member Function Documentation

◆ clientUpdate()

void LaserUpdate::clientUpdate ( void )
virtual

The update callback.

Implements ClientUpdateModule.

Definition at line 200 of file LaserUpdate.cpp.

◆ getCurrentLaserRadius()

Real LaserUpdate::getCurrentLaserRadius ( ) const

Definition at line 396 of file LaserUpdate.cpp.

◆ getEndPos()

const Coord3D * LaserUpdate::getEndPos ( )
inline

Definition at line 82 of file LaserUpdate.h.

◆ getStartPos()

const Coord3D * LaserUpdate::getStartPos ( )
inline

Definition at line 81 of file LaserUpdate.h.

◆ getWidthScale()

Real LaserUpdate::getWidthScale ( ) const
inline

Definition at line 89 of file LaserUpdate.h.

◆ initLaser()

void LaserUpdate::initLaser ( const Object * parent,
const Object * target,
const Coord3D * startPos,
const Coord3D * endPos,
AsciiString parentBoneName,
Int sizeDeltaFrames = 0 )

Definition at line 247 of file LaserUpdate.cpp.

◆ isDirty()

Bool LaserUpdate::isDirty ( )
inline

Definition at line 87 of file LaserUpdate.h.

◆ setDecayFrames()

void LaserUpdate::setDecayFrames ( UnsignedInt decayFrames)

Definition at line 234 of file LaserUpdate.cpp.

◆ setDirty()

void LaserUpdate::setDirty ( Bool dirty)
inline

Definition at line 86 of file LaserUpdate.h.

◆ updateEndPos()

void LaserUpdate::updateEndPos ( )
protected

figures out and sets endPos

Definition at line 158 of file LaserUpdate.cpp.

◆ updateStartPos()

void LaserUpdate::updateStartPos ( )
protected

figures out and sets startPos

Definition at line 111 of file LaserUpdate.cpp.

Member Data Documentation

◆ m_currentWidthScalar

Real LaserUpdate::m_currentWidthScalar
protected

Definition at line 112 of file LaserUpdate.h.

◆ m_decayFinishFrame

UnsignedInt LaserUpdate::m_decayFinishFrame
protected

Definition at line 114 of file LaserUpdate.h.

◆ m_decaying

Bool LaserUpdate::m_decaying
protected

Definition at line 109 of file LaserUpdate.h.

◆ m_decayStartFrame

UnsignedInt LaserUpdate::m_decayStartFrame
protected

Definition at line 113 of file LaserUpdate.h.

◆ m_dirty

Bool LaserUpdate::m_dirty
protected

Definition at line 105 of file LaserUpdate.h.

◆ m_endPos

Coord3D LaserUpdate::m_endPos
protected

Definition at line 100 of file LaserUpdate.h.

◆ m_parentBoneName

AsciiString LaserUpdate::m_parentBoneName
protected

Definition at line 115 of file LaserUpdate.h.

◆ m_parentID

DrawableID LaserUpdate::m_parentID
protected

Definition at line 102 of file LaserUpdate.h.

◆ m_particleSystemID

ParticleSystemID LaserUpdate::m_particleSystemID
protected

Definition at line 106 of file LaserUpdate.h.

◆ m_startPos

Coord3D LaserUpdate::m_startPos
protected

Definition at line 99 of file LaserUpdate.h.

◆ m_targetID

DrawableID LaserUpdate::m_targetID
protected

Definition at line 103 of file LaserUpdate.h.

◆ m_targetParticleSystemID

ParticleSystemID LaserUpdate::m_targetParticleSystemID
protected

Definition at line 107 of file LaserUpdate.h.

◆ m_widenFinishFrame

UnsignedInt LaserUpdate::m_widenFinishFrame
protected

Definition at line 111 of file LaserUpdate.h.

◆ m_widening

Bool LaserUpdate::m_widening
protected

Definition at line 108 of file LaserUpdate.h.

◆ m_widenStartFrame

UnsignedInt LaserUpdate::m_widenStartFrame
protected

Definition at line 110 of file LaserUpdate.h.

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