Nymph Game Engine: Component Class Reference

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages

Base Class for all components. More...

#include <component.h>

Inheritance diagram for Component:

Public Member Functions
	Component ()
	Component constructor. More...

virtual void	onStart ()=0
	Called when the engine starts and when a new scene is loaded. More...

virtual bool	onUpdate (const double delta)=0
	Called every engine loop. More...

virtual void	onDestroy ()=0
	Called when the engine is shutting down. More...

void	setTransform (std::shared_ptr< Transform > transform)
	Sets the transform. More...

std::shared_ptr< Transform >	getTransform () const noexcept
	Gets the transform. More...

void	setActive (const bool active) noexcept
	Sets the component active or inactive. More...

bool	isActive () const noexcept
	Determines if active. More...

unsigned int	getId () const noexcept
	Gets the identifier. More...

virtual std::string	to_string () const noexcept
	Returns a string representation of the object. More...

virtual std::string	className () const noexcept
	Returns a string representing the class name. More...

virtual unsigned long long	getValueForSorting () const =0
	Gets the value for sorting. More...

bool	operator< (Component &other) noexcept
	Operator < using getValueForSorting. More...

virtual void	onNotifyNow (std::shared_ptr< Events::Event > event) override
	When receiving an event that is immediate, onNotifyNow is used. It acts as an interrupt to make sure the object is notified before another engine loop. This is pure virtual and is implemented on a case by case basis in derived classes. More...

virtual void	handleQueuedEvent (std::shared_ptr< Events::Event > event) override
	HandleQueuedEvent allows derived classes to define behaviour for when queuedEvents are received. More...

virtual void	log (el::base::type::ostream_t &os) const override

virtual	~Component ()
	Destroys the object. More...

Public Member Functions inherited from Events::Subject
virtual	~Subject ()=default

virtual void	notify (std::shared_ptr< Event > event)
	notify is used to tell observers of an event. More...

virtual void	notifyNow (std::shared_ptr< Event > event)
	notifyNow is used to tell observers of an event as an interrupt. More...

virtual void	addObserver (std::shared_ptr< Observer > observer)
	Adds an observer. More...

virtual void	removeObserver (std::shared_ptr< Observer > observer)
	Removes an observer. More...

Public Member Functions inherited from Events::Observer
virtual	~Observer ()

void	onNotify (std::shared_ptr< Event > event)
	When receiving an event that is non-immediate, onNotify is used. The event is added to the event queue that is processed when processEventQueue is called. More...

void	processEventQueue ()
	This should be called once ever loop for every Observer to properly use queued events. More...

Protected Attributes
std::weak_ptr< Entity >	entity

std::shared_ptr< Transform >	transform

bool	active

unsigned int	id

Static Protected Attributes
static unsigned int	next_id = 0

Friends
class	ComponentManager

class	Entity

Additional Inherited Members
Protected Member Functions inherited from Events::Observer
std::shared_ptr< Event >	getEvent ()

bool	eventsWaiting () const noexcept

Detailed Description

Base Class for all components.

Constructor & Destructor Documentation

Component::Component ( )

Component constructor.

References next_id, and transform.

virtual Component::~Component ( )

inlinevirtual

Destroys the object.

Member Function Documentation

std::string Component::className ( ) const

virtualnoexcept

Returns a string representing the class name.

Returns: The class name

Reimplemented in Game::SpriteMovement, Graphics::Renderable, Graphics::Light, Graphics::Camera, Graphics::UI::Element, Graphics::TileAnimator< StateType >, Graphics::UI::Text, Graphics::UI::TextArea, Graphics::UI::WrappableText, Graphics::UI::TextField, Graphics::UI::Button, Graphics::UI::Area, and Graphics::UI::QuitButton.

Referenced by generated::getComponentModule(), and to_string().

unsigned int Component::getId ( ) const

noexcept

Gets the identifier.

Returns: The identifier.

References id.

Referenced by generated::getComponentModule(), Graphics::Camera::getValueForSorting(), Graphics::Light::getValueForSorting(), Graphics::TileAnimator< StateType >::getValueForSorting(), Game::SpriteMovement::getValueForSorting(), and to_string().

std::shared_ptr< Transform > Component::getTransform ( ) const

noexcept

virtual unsigned long long Component::getValueForSorting ( ) const

pure virtual

Gets the value for sorting.

Returns: The value for sorting.

Implemented in Game::SpriteMovement, Graphics::Renderable, Graphics::TileAnimator< StateType >, Graphics::Light, Graphics::Camera, Graphics::UI::Element, Graphics::UI::Text, Sound::SoundInstance, and Physics::CollisionData.

Referenced by to_string().

void Component::handleQueuedEvent ( std::shared_ptr< Events::Event > event )

overridevirtual

HandleQueuedEvent allows derived classes to define behaviour for when queuedEvents are received.

Parameters

[in] event The event

Implements Events::Observer.

Reimplemented in Game::SpriteMovement, Graphics::Renderable, Graphics::TileAnimator< StateType >, Graphics::Camera, Graphics::UI::Element, Graphics::UI::Text, Graphics::UI::WrappableText, Graphics::UI::TextArea, Graphics::UI::TextField, Graphics::UI::Area, Graphics::UI::Button, and Sound::SoundInstance.

References entity, Events::SET_ACTIVE, Events::SET_ENTITY_ACTIVE, and setActive().

Referenced by Graphics::UI::Text::handleQueuedEvent(), Graphics::Camera::handleQueuedEvent(), Graphics::TileAnimator< StateType >::handleQueuedEvent(), Graphics::Renderable::handleQueuedEvent(), Game::SpriteMovement::handleQueuedEvent(), and onNotifyNow().

bool Component::isActive ( ) const

noexcept

Determines if active.

Returns: True if active, False otherwise.

References active.

Referenced by generated::getComponentModule(), Graphics::UI::Element::handleQueuedEvent(), Graphics::UI::TextField::onKeyDown(), Graphics::UI::WrappableText::onUpdate(), Graphics::UI::Text::onUpdate(), Graphics::Renderable::onUpdate(), and to_string().

void Component::log ( el::base::type::ostream_t & os ) const

overridevirtual

Reimplemented in Game::SpriteMovement, Graphics::TileAnimator< StateType >, Graphics::Renderable, Graphics::UI::Element, Graphics::Camera, Graphics::Light, Graphics::UI::Text, Graphics::UI::WrappableText, Graphics::UI::TextArea, Graphics::UI::TextField, Graphics::UI::Area, Graphics::UI::Button, and Physics::CollisionData.

References to_string().

Referenced by Graphics::Camera::log(), and Graphics::TileAnimator< StateType >::log().

virtual void Component::onDestroy ( )

pure virtual

Called when the engine is shutting down.

Implemented in Game::SpriteMovement, Graphics::Renderable, Graphics::TileAnimator< StateType >, Graphics::UI::Element, Graphics::UI::Text, Graphics::UI::WrappableText, Graphics::UI::TextField, Graphics::UI::TextArea, Graphics::Camera, Graphics::UI::Area, Graphics::Light, Sound::SoundInstance, and Physics::CollisionData.

void Component::onNotifyNow ( std::shared_ptr< Events::Event > event )

overridevirtual

When receiving an event that is immediate, onNotifyNow is used. It acts as an interrupt to make sure the object is notified before another engine loop. This is pure virtual and is implemented on a case by case basis in derived classes.

Parameters

[in] event The event

Implements Events::Observer.