Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
W3DTracerDraw Class Reference

#include <W3DTracerDraw.h>

Inherits DrawModule, and TracerDrawInterface.

Public Member Functions

 W3DTracerDraw (Thing *thing, const ModuleData *moduleData)
 
virtual void doDrawModule (const Matrix3D *transformMtx)
 
virtual void setShadowsEnabled (Bool enable)
 
virtual void releaseShadows (void)
 frees all shadow resources used by this module - used by Options screen.
 
virtual void allocateShadows (void)
 we don't care about preserving temporary shadows.
 
virtual void setFullyObscuredByShroud (Bool fullyObscured)
 we don't care about preserving temporary shadows.
 
virtual void reactToTransformChange (const Matrix3D *oldMtx, const Coord3D *oldPos, Real oldAngle)
 
virtual void reactToGeometryChange ()
 
virtual void setTracerParms (Real speed, Real length, Real width, const RGBColor &color, Real initialOpacity)
 
virtual TracerDrawInterfacegetTracerDrawInterface ()
 
virtual const TracerDrawInterfacegetTracerDrawInterface () const
 
- Public Member Functions inherited from DrawModule
 DrawModule (Thing *thing, const ModuleData *moduleData)
 
virtual void setTerrainDecal (TerrainDecalType type)
 
virtual void setTerrainDecalSize (Real x, Real y)
 
virtual void setTerrainDecalOpacity (Real o)
 
virtual Bool isVisible () const
 for limiting tree sway, etc to visible objects
 
virtual Bool isLaser () const
 
virtual ObjectDrawInterfacegetObjectDrawInterface ()
 
virtual const ObjectDrawInterfacegetObjectDrawInterface () const
 
virtual DebrisDrawInterfacegetDebrisDrawInterface ()
 
virtual const DebrisDrawInterfacegetDebrisDrawInterface () const
 
virtual RopeDrawInterfacegetRopeDrawInterface ()
 
virtual const RopeDrawInterfacegetRopeDrawInterface () const
 
virtual LaserDrawInterfacegetLaserDrawInterface ()
 
virtual const LaserDrawInterfacegetLaserDrawInterface () 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)
 

Protected Attributes

Line3DClassm_theTracer
 the tracer render object in the W3D scene
 
Real m_length
 length of tracer
 
Real m_width
 width of tracer
 
RGBColor m_color
 color of tracer
 
Real m_speedInDistPerFrame
 speed of tracer (in dist/frame)
 
Real m_opacity
 opacity of the tracer
 

Additional Inherited Members

- Static Public Member Functions inherited from DrawModule
static ModuleType getModuleType ()
 
static Int getInterfaceMask ()
 
- Static Public Member Functions inherited from Module
static ModuleDatafriend_newModuleData (INI *ini)
 
- Protected Member Functions inherited from DrawableModule
DrawablegetDrawable ()
 
const DrawablegetDrawable () const
 
virtual void crc (Xfer *xfer)
 
virtual void xfer (Xfer *xfer)
 
virtual void loadPostProcess (void)
 
- Protected Member Functions inherited from Module
const ModuleDatagetModuleData () const
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPoolgetObjectMemoryPool ()=0
 

Detailed Description

W3D tracer draw

Definition at line 42 of file W3DTracerDraw.h.

Constructor & Destructor Documentation

◆ W3DTracerDraw()

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

Definition at line 56 of file W3DTracerDraw.cpp.

Member Function Documentation

◆ allocateShadows()

virtual void W3DTracerDraw::allocateShadows ( void )
inlinevirtual

we don't care about preserving temporary shadows.

Implements DrawModule.

Definition at line 56 of file W3DTracerDraw.h.

◆ doDrawModule()

void W3DTracerDraw::doDrawModule ( const Matrix3D * transformMtx)
virtual

Implements DrawModule.

Definition at line 115 of file W3DTracerDraw.cpp.

◆ getTracerDrawInterface() [1/2]

virtual TracerDrawInterface * W3DTracerDraw::getTracerDrawInterface ( )
inlinevirtual

Reimplemented from DrawModule.

Definition at line 63 of file W3DTracerDraw.h.

◆ getTracerDrawInterface() [2/2]

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

Reimplemented from DrawModule.

Definition at line 64 of file W3DTracerDraw.h.

◆ reactToGeometryChange()

virtual void W3DTracerDraw::reactToGeometryChange ( )
inlinevirtual

Implements DrawModule.

Definition at line 59 of file W3DTracerDraw.h.

◆ reactToTransformChange()

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

Implements DrawModule.

Definition at line 105 of file W3DTracerDraw.cpp.

◆ releaseShadows()

virtual void W3DTracerDraw::releaseShadows ( void )
inlinevirtual

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

Implements DrawModule.

Definition at line 55 of file W3DTracerDraw.h.

◆ setFullyObscuredByShroud()

virtual void W3DTracerDraw::setFullyObscuredByShroud ( Bool fullyObscured)
inlinevirtual

we don't care about preserving temporary shadows.

Implements DrawModule.

Definition at line 57 of file W3DTracerDraw.h.

◆ setShadowsEnabled()

virtual void W3DTracerDraw::setShadowsEnabled ( Bool enable)
inlinevirtual

Implements DrawModule.

Definition at line 54 of file W3DTracerDraw.h.

◆ setTracerParms()

void W3DTracerDraw::setTracerParms ( Real speed,
Real length,
Real width,
const RGBColor & color,
Real initialOpacity )
virtual

Implements TracerDrawInterface.

Definition at line 73 of file W3DTracerDraw.cpp.

Member Data Documentation

◆ m_color

RGBColor W3DTracerDraw::m_color
protected

color of tracer

Definition at line 71 of file W3DTracerDraw.h.

◆ m_length

Real W3DTracerDraw::m_length
protected

length of tracer

Definition at line 69 of file W3DTracerDraw.h.

◆ m_opacity

Real W3DTracerDraw::m_opacity
protected

opacity of the tracer

Definition at line 73 of file W3DTracerDraw.h.

◆ m_speedInDistPerFrame

Real W3DTracerDraw::m_speedInDistPerFrame
protected

speed of tracer (in dist/frame)

Definition at line 72 of file W3DTracerDraw.h.

◆ m_theTracer

Line3DClass* W3DTracerDraw::m_theTracer
protected

the tracer render object in the W3D scene

Definition at line 68 of file W3DTracerDraw.h.

◆ m_width

Real W3DTracerDraw::m_width
protected

width of tracer

Definition at line 70 of file W3DTracerDraw.h.


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