DDraceNetwork Docs
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CBackground Class Reference

#include <background.h>

Inheritance diagram for CBackground:
[legend]
Collaboration diagram for CBackground:
[legend]

Public Member Functions

 CBackground (int MapType=CMapLayers::TYPE_BACKGROUND_FORCE, bool OnlineOnly=true)
 
virtual ~CBackground ()
 
virtual int Sizeof () const override
 
virtual void OnInit () override
 
virtual void OnMapLoad () override
 
virtual void OnRender () override
 
void LoadBackground ()
 
const char * MapName () const
 
- Public Member Functions inherited from CMapLayers
 CMapLayers (int Type, bool OnlineOnly=true)
 
virtual ~CMapLayers ()
 
virtual int Sizeof () const override
 
virtual void OnInit () override
 
virtual void OnRender () override
 
virtual void OnMapLoad () override
 
- Public Member Functions inherited from CComponent
virtual ~CComponent ()
 
virtual int Sizeof () const =0
 
class CGameClient * GameClient () const
 
class IClient * Client () const
 
virtual void OnStateChange (int NewState, int OldState)
 
virtual void OnConsoleInit ()
 
virtual void OnInit ()
 
virtual void OnShutdown ()
 
virtual void OnReset ()
 
virtual void OnWindowResize ()
 
virtual void OnRefreshSkins ()
 
virtual void OnRender ()
 
virtual void OnNewSnapshot ()
 
virtual void OnRelease ()
 
virtual void OnMapLoad ()
 
virtual void OnMessage (int Msg, void *pRawMsg)
 
virtual bool OnCursorMove (float x, float y, IInput::ECursorType CursorType)
 
virtual bool OnInput (const IInput::CEvent &Event)
 

Protected Member Functions

virtual CBackgroundEngineMap * CreateBGMap ()
 
- Protected Member Functions inherited from CMapLayers
virtual bool CanRenderMenuBackground ()
 
- Protected Member Functions inherited from CComponent
class IKernel * Kernel () const
 
class IEngine * Engine () const
 
class IGraphics * Graphics () const
 
class ITextRender * TextRender () const
 
class IInput * Input () const
 
class IStorage * Storage () const
 
class CUi * Ui () const
 
class ISound * Sound () const
 
class CRenderTools * RenderTools () const
 
class IConfigManager * ConfigManager () const
 
class CConfig * Config () const
 
class IConsole * Console () const
 
class IDemoPlayer * DemoPlayer () const
 
class IDemoRecorder * DemoRecorder (int Recorder) const
 
class IFavorites * Favorites () const
 
class IServerBrowser * ServerBrowser () const
 
class CLayers * Layers () const
 
class CCollision * Collision () const
 
int64_t time () const
 
float LocalTime () const
 
class IHttp * Http () const
 

Protected Attributes

IEngineMap * m_pMap
 
bool m_Loaded
 
char m_aMapName [MAX_MAP_LENGTH]
 
CBackgroundEngineMap * m_pBackgroundMap
 
CLayers * m_pBackgroundLayers
 
CMapImages * m_pBackgroundImages
 
- Protected Attributes inherited from CComponent
CGameClient * m_pClient
 

Additional Inherited Members

- Public Types inherited from CMapLayers
enum  {
  TYPE_BACKGROUND = 0 , TYPE_BACKGROUND_FORCE , TYPE_FOREGROUND , TYPE_FULL_DESIGN ,
  TYPE_ALL = -1
}
 
- Static Public Member Functions inherited from CMapLayers
static void EnvelopeEval (int TimeOffsetMillis, int Env, ColorRGBA &Result, size_t Channels, void *pUser)
 

Constructor & Destructor Documentation

◆ CBackground()

CBackground::CBackground ( int  MapType = CMapLayers::TYPE_BACKGROUND_FORCE,
bool  OnlineOnly = true 
)

◆ ~CBackground()

CBackground::~CBackground ( )
virtual

Member Function Documentation

◆ CreateBGMap()

CBackgroundEngineMap * CBackground::CreateBGMap ( )
protectedvirtual

Reimplemented in CMenuBackground.

◆ LoadBackground()

void CBackground::LoadBackground ( )

◆ MapName()

const char * CBackground::MapName ( ) const
inline

◆ OnInit()

void CBackground::OnInit ( )
overridevirtual

Called to let the components run initialization code.

Reimplemented from CMapLayers.

Reimplemented in CMenuBackground.

◆ OnMapLoad()

void CBackground::OnMapLoad ( )
overridevirtual

Called on map load.

Reimplemented from CMapLayers.

Reimplemented in CMenuBackground.

◆ OnRender()

void CBackground::OnRender ( )
overridevirtual

Called when the component should get rendered.

The render order depends on the component insertion order.

Reimplemented from CMapLayers.

Reimplemented in CMenuBackground.

◆ Sizeof()

virtual int CBackground::Sizeof ( ) const
inlineoverridevirtual

Gets the size of the non-abstract component.

Reimplemented from CMapLayers.

Reimplemented in CMenuBackground.

Member Data Documentation

◆ m_aMapName

char CBackground::m_aMapName[MAX_MAP_LENGTH]
protected

◆ m_Loaded

bool CBackground::m_Loaded
protected

◆ m_pBackgroundImages

CMapImages* CBackground::m_pBackgroundImages
protected

◆ m_pBackgroundLayers

CLayers* CBackground::m_pBackgroundLayers
protected

◆ m_pBackgroundMap

CBackgroundEngineMap* CBackground::m_pBackgroundMap
protected

◆ m_pMap

IEngineMap* CBackground::m_pMap
protected
The documentation for this class was generated from the following files: