Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CCmpWaterManager Class Referencefinal
Inheritance diagram for CCmpWaterManager:
Inheritance graph
[legend]
Collaboration diagram for CCmpWaterManager:
Collaboration graph
[legend]

Public Member Functions

int GetComponentTypeId () const override
 
void Init (const CParamNode &paramNode) override
 
void Deinit () override
 
void Serialize (ISerializer &serialize) override
 
void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize) override
 
void HandleMessage (const CMessage &msg, bool global) override
 
void RecomputeWaterData () override
 Recompute all the water information (foam...) More...
 
void SetWaterLevel (entity_pos_t h) override
 Set the height of the water level, as a constant value across the whole map. More...
 
entity_pos_t GetWaterLevel (entity_pos_t x, entity_pos_t z) const override
 Get the current water level at the given point. More...
 
float GetExactWaterLevel (float x, float z) const override
 Get the current water level at the given point. More...
 
virtual void RecomputeWaterData ()=0
 Recompute all the water information (foam...) More...
 
virtual void SetWaterLevel (entity_pos_t h)=0
 Set the height of the water level, as a constant value across the whole map. More...
 
virtual entity_pos_t GetWaterLevel (entity_pos_t x, entity_pos_t z) const =0
 Get the current water level at the given point. More...
 
virtual float GetExactWaterLevel (float x, float z) const =0
 Get the current water level at the given point. More...
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
virtual void Init (const CParamNode &paramNode)=0
 
virtual void Deinit ()=0
 
virtual void HandleMessage (const CMessage &msg, bool global)
 
CEntityHandle GetEntityHandle () const
 
void SetEntityHandle (CEntityHandle ent)
 
entity_id_t GetEntityId () const
 
CEntityHandle GetSystemEntity () const
 
const CSimContext & GetSimContext () const
 
void SetSimContext (const CSimContext &context)
 
virtual void Serialize (ISerializer &serialize)=0
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0
 
virtual bool NewJSObject (const ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
 Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...
 
virtual JS::Value GetJSInstance () const
 
virtual int GetComponentTypeId () const =0
 

Static Public Member Functions

static void ClassInit (CComponentManager &componentManager)
 
static IComponent * Allocate (const ScriptInterface &, JS::HandleValue)
 
static void Deallocate (IComponent *cmp)
 
static std::string GetSchema ()
 
- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static void RegisterComponentType (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
 
static void RegisterComponentTypeScriptWrapper (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
 
static u8 GetSerializationVersion ()
 

Public Attributes

entity_pos_t m_WaterHeight
 

Additional Inherited Members

- Public Types inherited from IComponent
using AllocFunc = IComponent *(*)(const ScriptInterface &scriptInterface, JS::HandleValue ctor)
 
using DeallocFunc = void(*)(IComponent *)
 

Member Function Documentation

◆ Allocate()

static IComponent * CCmpWaterManager::Allocate ( const ScriptInterface &  ,
JS::HandleValue   
)
inlinestatic

◆ ClassInit()

static void CCmpWaterManager::ClassInit ( CComponentManager &  componentManager)
inlinestatic

◆ Deallocate()

static void CCmpWaterManager::Deallocate ( IComponent *  cmp)
inlinestatic

◆ Deinit()

void CCmpWaterManager::Deinit ( )
inlineoverridevirtual

Implements IComponent.

◆ Deserialize()

void CCmpWaterManager::Deserialize ( const CParamNode &  paramNode,
IDeserializer &  deserialize 
)
inlineoverridevirtual

Implements IComponent.

◆ GetComponentTypeId()

int CCmpWaterManager::GetComponentTypeId ( ) const
inlineoverridevirtual

Implements IComponent.

◆ GetExactWaterLevel()

float CCmpWaterManager::GetExactWaterLevel ( float  x,
float  z 
) const
inlineoverridevirtual

Get the current water level at the given point.

Implements ICmpWaterManager.

◆ GetSchema()

static std::string CCmpWaterManager::GetSchema ( )
inlinestatic

◆ GetWaterLevel()

entity_pos_t CCmpWaterManager::GetWaterLevel ( entity_pos_t  x,
entity_pos_t  z 
) const
inlineoverridevirtual

Get the current water level at the given point.

Implements ICmpWaterManager.

◆ HandleMessage()

void CCmpWaterManager::HandleMessage ( const CMessage &  msg,
bool  global 
)
inlineoverridevirtual

Reimplemented from IComponent.

◆ Init()

void CCmpWaterManager::Init ( const CParamNode &  paramNode)
inlineoverridevirtual

Implements IComponent.

◆ RecomputeWaterData()

void CCmpWaterManager::RecomputeWaterData ( )
inlineoverridevirtual

Recompute all the water information (foam...)

Implements ICmpWaterManager.

◆ Serialize()

void CCmpWaterManager::Serialize ( ISerializer &  serialize)
inlineoverridevirtual

Implements IComponent.

◆ SetWaterLevel()

void CCmpWaterManager::SetWaterLevel ( entity_pos_t  h)
inlineoverridevirtual

Set the height of the water level, as a constant value across the whole map.

Implements ICmpWaterManager.

Member Data Documentation

◆ m_WaterHeight

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