Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
Public Member Functions | List of all members
ICmpRallyPointRenderer Class Referenceabstract

Rally Point. More...

#include <ICmpRallyPointRenderer.h>

Inheritance diagram for ICmpRallyPointRenderer:
Inheritance graph
[legend]
Collaboration diagram for ICmpRallyPointRenderer:
Collaboration graph
[legend]

Public Member Functions

virtual void SetDisplayed (bool displayed)=0
 Sets whether the rally point marker and line should be displayed. More...
 
virtual void SetPosition (const CFixedVector2D &position)=0
 Sets the position at which the rally point marker should be displayed. More...
 
virtual void UpdatePosition (u32 rallyPointId, const CFixedVector2D &position)=0
 Updates the position of one given rally point marker. More...
 
virtual void AddPosition_wrapper (const CFixedVector2D &position)=0
 Add another position at which a marker should be displayed, connected to the previous one. More...
 
virtual void Reset ()=0
 Reset the positions of this rally point marker. More...
 
virtual bool IsSet () const =0
 Returns true if at least one display rally point is set. More...
 
virtual void UpdateColor ()=0
 Updates the line color. 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
 

Additional Inherited Members

- Public Types inherited from IComponent
using AllocFunc = IComponent *(*)(const ScriptInterface &scriptInterface, JS::HandleValue ctor)
 
using DeallocFunc = void(*)(IComponent *)
 
- 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 ()
 

Detailed Description

Rally Point.

Holds the position of a unit's rally points, and renders them to screen.

Member Function Documentation

◆ AddPosition_wrapper()

virtual void ICmpRallyPointRenderer::AddPosition_wrapper ( const CFixedVector2D &  position)
pure virtual

Add another position at which a marker should be displayed, connected to the previous one.

Implemented in CCmpRallyPointRenderer.

◆ IsSet()

virtual bool ICmpRallyPointRenderer::IsSet ( ) const
pure virtual

Returns true if at least one display rally point is set.

Implemented in CCmpRallyPointRenderer.

◆ Reset()

virtual void ICmpRallyPointRenderer::Reset ( )
pure virtual

Reset the positions of this rally point marker.

Implemented in CCmpRallyPointRenderer.

◆ SetDisplayed()

virtual void ICmpRallyPointRenderer::SetDisplayed ( bool  displayed)
pure virtual

Sets whether the rally point marker and line should be displayed.

Implemented in CCmpRallyPointRenderer.

◆ SetPosition()

virtual void ICmpRallyPointRenderer::SetPosition ( const CFixedVector2D &  position)
pure virtual

Sets the position at which the rally point marker should be displayed.

Discards all previous positions

Implemented in CCmpRallyPointRenderer.

◆ UpdateColor()

virtual void ICmpRallyPointRenderer::UpdateColor ( )
pure virtual

Updates the line color.

Implemented in CCmpRallyPointRenderer.

◆ UpdatePosition()

virtual void ICmpRallyPointRenderer::UpdatePosition ( u32  rallyPointId,
const CFixedVector2D &  position 
)
pure virtual

Updates the position of one given rally point marker.

Implemented in CCmpRallyPointRenderer.

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