ScreenLog Class Reference

#include <ScreenLog.h>

Inheritance diagram for ScreenLog:

Collaboration diagram for ScreenLog:

Public Member Functions
void	Draw2D () override
	Draws this Drawable's 2D KSprites. User should override this method as necessary.
Public Member Functions inherited from GameObject
	GameObject ()
	GameObject (const GameObject &)=delete
GameObject &	operator= (const GameObject &)=delete
virtual	~GameObject ()
virtual void	EnterScene ()
	Processes necessary for entering the Scene. Users should override as necessary and put X-able registration calls here, as well as any additional setup that is done per-entry.
virtual void	ExitScene ()
	Processes necessary for exiting the Scene. Users should override as necessary and put X-able deregistration calls here, as well as any additional cleanup that is done per-exit.
void	SubmitSceneEntry ()
	Submit scene entry to the currently active Scene.
void	SubmitSceneExit ()
	Submit scene exit to the currently active Scene.
Public Member Functions inherited from Updatable
	Updatable ()
	Updatable (const Updatable &)=delete
Updatable &	operator= (const Updatable &)=delete
virtual	~Updatable ()
virtual void	Update ()
	Updates this Updatable. User should override this method as necessary.
void	SubmitRegistration ()
	Submit update registration to the currently active Scene.
void	SubmitDeregistration ()
	Submit update deregistration from the currently active Scene.
Public Member Functions inherited from Drawable
	Drawable ()
	Drawable (const Drawable &)=delete
Drawable &	operator= (const Drawable &)=delete
virtual	~Drawable ()
virtual void	Draw ()
	Draws this Drawable's 3D GraphicsObjects. User should override this method as necessary.
virtual void	Draw2D ()
	Draws this Drawable's 2D KSprites. User should override this method as necessary.
void	SubmitRegistration ()
	Submit draw registration to the currently active Scene.
void	SubmitDeregistration ()
	Submit draw deregistration from the currently active Scene.
Public Member Functions inherited from Inputable
	Inputable ()
	Inputable (const Inputable &)=delete
Inputable &	operator= (const Inputable &)=delete
virtual	~Inputable ()
virtual void	KeyPressed (AZUL_KEY k)
	Callback for KeyPressed event on a keyboard key. To be overridden by the user.
virtual void	KeyReleased (AZUL_KEY k)
	Callback for KeyReleased event on a keyboard key. To be overridden by the user.
virtual void	KeyPressed (AZUL_MOUSE m)
	Callback for KeyPressed event on a mouse button. To be overridden by the user.
virtual void	KeyReleased (AZUL_MOUSE m)
	Callback for KeyReleased event on a mouse button. To be overridden by the user.
void	SubmitRegistration (AZUL_KEY k, KeyEvent ev)
	Submit input registration for the specified AZUL_KEY and KeyEvent to the currently active Scene.
void	SubmitDeregistration (AZUL_KEY k, KeyEvent ev)
	Submit input deregistration for the specified AZUL_KEY and KeyEvent from the currently active Scene.
void	SubmitRegistration (AZUL_MOUSE m, KeyEvent ev)
	Submit input registration for the specified AZUL_MOUSE and KeyEvent to the currently active Scene.
void	SubmitDeregistration (AZUL_MOUSE m, KeyEvent ev)
	Submit input deregistration for the specified AZUL_MOUSE and KeyEvent from the currently active Scene.
Public Member Functions inherited from Collidable
	Collidable ()
	Collidable (const Collidable &)=delete
Collidable &	operator= (const Collidable &)=delete
virtual	~Collidable ()
void	SubmitRegistration ()
	Submit collision registration to the currently active Scene.
void	SubmitDeregistration ()
	Submit collision deregistration from the currently active Scene.

Static Public Member Functions
static void	ConnectToScene ()
	Connects ScreenLog to the active scene.
static void	DisconnectFromScene ()
	Disconnects ScreenLog from the active scene.
static void	Write (const char *message,...)
	Writes a message to the ScreenLog.

Private Member Functions
void	EnterScene () override
	Processes necessary for entering the Scene. Users should override as necessary and put X-able registration calls here, as well as any additional setup that is done per-entry.
void	ExitScene () override
	Processes necessary for exiting the Scene. Users should override as necessary and put X-able deregistration calls here, as well as any additional cleanup that is done per-exit.
	ScreenLog ()
	ScreenLog (const ScreenLog &)=delete
ScreenLog &	operator= (const ScreenLog &)=delete
	~ScreenLog ()

Static Private Member Functions
static ScreenLog *	Instance ()
static void	Free ()
static void	Clear ()
static void	UpdateTextDisplay ()

Private Attributes
std::string	m_text
SpriteString *	p_textDisplay

Static Private Attributes
static char	debugBuf [256]
static ScreenLog *	p_instance

Friends
class	ScreenLogAttorney

Additional Inherited Members
Public Types inherited from Inputable
using	RegistrationID = std::pair< InputKey, KeyEvent >
using	RegDataMap = std::map< RegistrationID, RegistrationData >
using	RegDataMapPair = std::pair< RegistrationID, RegistrationData >
Public Types inherited from Collidable
enum class	VOLUME_TYPE { BSPHERE , AABB }
Protected Member Functions inherited from Collidable
const CollisionVolume &	GetCollisionVolume ()
	Gets a const reference to the Collidable's BSphere.
void	SetColliderModel (Model *m, VOLUME_TYPE volumeType)
	Sets the Collidable's collider model.
void	UpdateCollisionData (const Matrix &m)
	Updates the collision data using the transform m.
template<typename C >
void	SetCollidableGroup ()
	Sets collidable group.

Constructor & Destructor Documentation

ScreenLog() [1/2]

ScreenLog::ScreenLog ( )

private

ScreenLog() [2/2]

ScreenLog::ScreenLog ( const ScreenLog &  )

privatedelete

~ScreenLog()

ScreenLog::~ScreenLog ( )

private

Member Function Documentation

Clear()

void ScreenLog::Clear ( )

staticprivate

ConnectToScene()

void ScreenLog::ConnectToScene ( )

static

Connects ScreenLog to the active scene.

Haru, 3/19/2023.

DisconnectFromScene()

void ScreenLog::DisconnectFromScene ( )

static

Disconnects ScreenLog from the active scene.

Haru, 3/19/2023.

Draw2D()

void ScreenLog::Draw2D ( )

overridevirtual

Draws this Drawable's 2D KSprites. User should override this method as necessary.

Haru, 3/8/2023.

Reimplemented from Drawable.

EnterScene()

void ScreenLog::EnterScene ( )

overrideprivatevirtual

Processes necessary for entering the Scene. Users should override as necessary and put X-able registration calls here, as well as any additional setup that is done per-entry.

Haru, 3/8/2023.

Reimplemented from GameObject.

ExitScene()

void ScreenLog::ExitScene ( )

overrideprivatevirtual

Processes necessary for exiting the Scene. Users should override as necessary and put X-able deregistration calls here, as well as any additional cleanup that is done per-exit.

Haru, 3/8/2023.

Reimplemented from GameObject.

Free()

void ScreenLog::Free ( )

staticprivate

Instance()

ScreenLog * ScreenLog::Instance ( )

staticprivate

operator=()

ScreenLog & ScreenLog::operator= ( const ScreenLog &  )

privatedelete

UpdateTextDisplay()

void ScreenLog::UpdateTextDisplay ( )

staticprivate

Write()

void ScreenLog::Write ( const char *  message,   ...  )

static

Writes a message to the ScreenLog.

Haru, 3/19/2023.

Parameters

message	The message.
...	Variable arguments providing additional information.

Friends And Related Function Documentation

ScreenLogAttorney

friend class ScreenLogAttorney

friend

Member Data Documentation

debugBuf

char ScreenLog::debugBuf

staticprivate

m_text

std::string ScreenLog::m_text

private

p_instance

ScreenLog * ScreenLog::p_instance

staticprivate

p_textDisplay

SpriteString* ScreenLog::p_textDisplay

private

---

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

• ScreenLog.h
• ScreenLog.cpp