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 | Static Public Member Functions | List of all members
DrawModule Class Referenceabstract

#include <DrawModule.h>

Inherits DrawableModule.

Inherited by W3DDebrisDraw, W3DDefaultDraw, W3DLaserDraw, W3DModelDraw, W3DProjectileStreamDraw, W3DPropDraw, W3DRopeDraw, W3DTracerDraw, and W3DTreeDraw.

Public Member Functions

 DrawModule (Thing *thing, const ModuleData *moduleData)
 
virtual void doDrawModule (const Matrix3D *transformMtx)=0
 
virtual void setShadowsEnabled (Bool enable)=0
 
virtual void releaseShadows (void)=0
 frees all shadow resources used by this module - used by Options screen.
 
virtual void allocateShadows (void)=0
 create shadow resources if not already present. Used by Options screen.
 
virtual void setTerrainDecal (TerrainDecalType type)
 
virtual void setTerrainDecalSize (Real x, Real y)
 
virtual void setTerrainDecalOpacity (Real o)
 
virtual void setFullyObscuredByShroud (Bool fullyObscured)=0
 
virtual Bool isVisible () const
 for limiting tree sway, etc to visible objects
 
virtual void reactToTransformChange (const Matrix3D *oldMtx, const Coord3D *oldPos, Real oldAngle)=0
 
virtual void reactToGeometryChange ()=0
 
virtual Bool isLaser () const
 
virtual ObjectDrawInterface * getObjectDrawInterface ()
 
virtual const ObjectDrawInterface * getObjectDrawInterface () const
 
virtual DebrisDrawInterface * getDebrisDrawInterface ()
 
virtual const DebrisDrawInterface * getDebrisDrawInterface () const
 
virtual TracerDrawInterface * getTracerDrawInterface ()
 
virtual const TracerDrawInterface * getTracerDrawInterface () const
 
virtual RopeDrawInterface * getRopeDrawInterface ()
 
virtual const RopeDrawInterface * getRopeDrawInterface () const
 
virtual LaserDrawInterface * getLaserDrawInterface ()
 
virtual const LaserDrawInterface * getLaserDrawInterface () const
 
- 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)
 

Static Public Member Functions

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

Additional Inherited Members

- 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
 

Detailed Description

Definition at line 63 of file DrawModule.h.

Constructor & Destructor Documentation

◆ DrawModule()

DrawModule::DrawModule ( Thing * thing,
const ModuleData * moduleData )
inline

Definition at line 115 of file DrawModule.h.

Member Function Documentation

◆ allocateShadows()

virtual void DrawModule::allocateShadows ( void )
pure virtual

create shadow resources if not already present. Used by Options screen.

Implemented in W3DDebrisDraw, W3DDefaultDraw, W3DLaserDraw, W3DModelDraw, W3DProjectileStreamDraw, W3DPropDraw, W3DRopeDraw, W3DTracerDraw, and W3DTreeDraw.

◆ doDrawModule()

virtual void DrawModule::doDrawModule ( const Matrix3D * transformMtx)
pure virtual

Implemented in W3DDebrisDraw, W3DDefaultDraw, W3DDependencyModelDraw, W3DLaserDraw, W3DModelDraw, W3DOverlordAircraftDraw, W3DOverlordTankDraw, W3DOverlordTruckDraw, W3DPoliceCarDraw, W3DProjectileStreamDraw, W3DPropDraw, W3DRopeDraw, W3DScienceModelDraw, W3DTankDraw, W3DTankTruckDraw, W3DTracerDraw, W3DTreeDraw, and W3DTruckDraw.

◆ getDebrisDrawInterface() [1/2]

virtual DebrisDrawInterface * DrawModule::getDebrisDrawInterface ( )
inlinevirtual

Reimplemented in W3DDebrisDraw.

Definition at line 102 of file DrawModule.h.

◆ getDebrisDrawInterface() [2/2]

virtual const DebrisDrawInterface * DrawModule::getDebrisDrawInterface ( ) const
inlinevirtual

Reimplemented in W3DDebrisDraw.

Definition at line 103 of file DrawModule.h.

◆ getInterfaceMask()

static Int DrawModule::getInterfaceMask ( )
inlinestatic

Definition at line 73 of file DrawModule.h.

◆ getLaserDrawInterface() [1/2]

virtual LaserDrawInterface * DrawModule::getLaserDrawInterface ( )
inlinevirtual

Reimplemented in W3DLaserDraw.

Definition at line 111 of file DrawModule.h.

◆ getLaserDrawInterface() [2/2]

virtual const LaserDrawInterface * DrawModule::getLaserDrawInterface ( ) const
inlinevirtual

Reimplemented in W3DLaserDraw.

Definition at line 112 of file DrawModule.h.

◆ getModuleType()

static ModuleType DrawModule::getModuleType ( )
inlinestatic

Definition at line 72 of file DrawModule.h.

◆ getObjectDrawInterface() [1/2]

virtual ObjectDrawInterface * DrawModule::getObjectDrawInterface ( )
inlinevirtual

Reimplemented in W3DModelDraw.

Definition at line 99 of file DrawModule.h.

◆ getObjectDrawInterface() [2/2]

virtual const ObjectDrawInterface * DrawModule::getObjectDrawInterface ( ) const
inlinevirtual

Reimplemented in W3DModelDraw.

Definition at line 100 of file DrawModule.h.

◆ getRopeDrawInterface() [1/2]

virtual RopeDrawInterface * DrawModule::getRopeDrawInterface ( )
inlinevirtual

Reimplemented in W3DRopeDraw.

Definition at line 108 of file DrawModule.h.

◆ getRopeDrawInterface() [2/2]

virtual const RopeDrawInterface * DrawModule::getRopeDrawInterface ( ) const
inlinevirtual

Reimplemented in W3DRopeDraw.

Definition at line 109 of file DrawModule.h.

◆ getTracerDrawInterface() [1/2]

virtual TracerDrawInterface * DrawModule::getTracerDrawInterface ( )
inlinevirtual

Reimplemented in W3DTracerDraw.

Definition at line 105 of file DrawModule.h.

◆ getTracerDrawInterface() [2/2]

virtual const TracerDrawInterface * DrawModule::getTracerDrawInterface ( ) const
inlinevirtual

Reimplemented in W3DTracerDraw.

Definition at line 106 of file DrawModule.h.

◆ isLaser()

virtual Bool DrawModule::isLaser ( ) const
inlinevirtual

Reimplemented in W3DLaserDraw.

Definition at line 96 of file DrawModule.h.

◆ isVisible()

virtual Bool DrawModule::isVisible ( ) const
inlinevirtual

for limiting tree sway, etc to visible objects

Reimplemented in W3DModelDraw.

Definition at line 91 of file DrawModule.h.

◆ reactToGeometryChange()

virtual void DrawModule::reactToGeometryChange ( )
pure virtual

Implemented in W3DDebrisDraw, W3DDefaultDraw, W3DLaserDraw, W3DModelDraw, W3DProjectileStreamDraw, W3DPropDraw, W3DRopeDraw, W3DSupplyDraw, W3DTankTruckDraw, W3DTracerDraw, W3DTreeDraw, and W3DTruckDraw.

◆ reactToTransformChange()

virtual void DrawModule::reactToTransformChange ( const Matrix3D * oldMtx,
const Coord3D * oldPos,
Real oldAngle )
pure virtual

Implemented in W3DDebrisDraw, W3DDefaultDraw, W3DLaserDraw, W3DModelDraw, W3DProjectileStreamDraw, W3DPropDraw, W3DRopeDraw, W3DTracerDraw, and W3DTreeDraw.

◆ releaseShadows()

virtual void DrawModule::releaseShadows ( void )
pure virtual

frees all shadow resources used by this module - used by Options screen.

Implemented in W3DDebrisDraw, W3DDefaultDraw, W3DLaserDraw, W3DModelDraw, W3DProjectileStreamDraw, W3DPropDraw, W3DRopeDraw, W3DTracerDraw, and W3DTreeDraw.

◆ setFullyObscuredByShroud()

virtual void DrawModule::setFullyObscuredByShroud ( Bool fullyObscured)
pure virtual

Implemented in W3DDebrisDraw, W3DDefaultDraw, W3DLaserDraw, W3DModelDraw, W3DProjectileStreamDraw, W3DPropDraw, W3DRopeDraw, W3DTankDraw, W3DTankTruckDraw, W3DTracerDraw, W3DTreeDraw, and W3DTruckDraw.

◆ setShadowsEnabled()

virtual void DrawModule::setShadowsEnabled ( Bool enable)
pure virtual

Implemented in W3DDebrisDraw, W3DDefaultDraw, W3DLaserDraw, W3DModelDraw, W3DProjectileStreamDraw, W3DPropDraw, W3DRopeDraw, W3DTracerDraw, and W3DTreeDraw.

◆ setTerrainDecal()

virtual void DrawModule::setTerrainDecal ( TerrainDecalType type)
inlinevirtual

Reimplemented in W3DModelDraw.

Definition at line 85 of file DrawModule.h.

◆ setTerrainDecalOpacity()

virtual void DrawModule::setTerrainDecalOpacity ( Real o)
inlinevirtual

Reimplemented in W3DModelDraw.

Definition at line 87 of file DrawModule.h.

◆ setTerrainDecalSize()

virtual void DrawModule::setTerrainDecalSize ( Real x,
Real y )
inlinevirtual

Reimplemented in W3DModelDraw.

Definition at line 86 of file DrawModule.h.

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