Physics::CollisionData Class Reference

#include <collision_data.h>

Inheritance diagram for Physics::CollisionData:

Public Member Functions
	CollisionData ()=delete
	CollisionData (const unsigned int map_width, const unsigned int map_height)
void	setIndexCollidable (const unsigned int x, const unsigned int y, const unsigned int collide_level)
int	getCollideLevel (const int x, const int y)
unsigned int	getWidth () const noexcept
unsigned int	getHeight () const noexcept
virtual void	onStart () override
	Called when the engine starts and when a new scene is loaded. More...
virtual bool	onUpdate (const double delta) override
	Called every engine loop. More...
virtual void	onDestroy () override
	Called when the engine is shutting down. More...
virtual unsigned long long	getValueForSorting () const override
	Gets the value for sorting. More...
virtual std::string	to_string () const noexceptoverride
	Returns a string representation of the object. More...
virtual void	log (el::base::type::ostream_t &os) const override
Public Member Functions inherited from Component
	Component ()
	Component constructor. 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	className () const noexcept
	Returns a string representing the class name. 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	~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...

Additional Inherited Members
Protected Member Functions inherited from Events::Observer
std::shared_ptr< Event >	getEvent ()
bool	eventsWaiting () const noexcept
Protected Attributes inherited from Component
std::weak_ptr< Entity >	entity
std::shared_ptr< Transform >	transform
bool	active
unsigned int	id
Static Protected Attributes inherited from Component
static unsigned int	next_id = 0

Constructor & Destructor Documentation

Physics::CollisionData::CollisionData ( )

delete

Physics::CollisionData::CollisionData	(	const unsigned int	map_width,
		const unsigned int	map_height
	)

Member Function Documentation

int Physics::CollisionData::getCollideLevel	(	const int	x,
		const int	y
	)

unsigned int Physics::CollisionData::getHeight ( ) const

noexcept

unsigned long long Physics::CollisionData::getValueForSorting ( ) const

overridevirtual

Gets the value for sorting.

Returns

The value for sorting.

Implements Component.

unsigned int Physics::CollisionData::getWidth ( ) const

noexcept

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

overridevirtual

Reimplemented from Component.

References to_string().

void Physics::CollisionData::onDestroy ( )

overridevirtual

Called when the engine is shutting down.

Implements Component.

void Physics::CollisionData::onStart ( )

overridevirtual

Called when the engine starts and when a new scene is loaded.

Implements Component.

bool Physics::CollisionData::onUpdate ( const double  delta )

overridevirtual

Called every engine loop.

Parameters

[in]

delta

The delta

Returns

true if active

Implements Component.

void Physics::CollisionData::setIndexCollidable	(	const unsigned int	x,
		const unsigned int	y,
		const unsigned int	collide_level
	)

std::string Physics::CollisionData::to_string ( ) const

overridevirtualnoexcept

Returns a string representation of the object.

Returns

String representation of the object.

Reimplemented from Component.

Referenced by log().

---

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

• src/physics/collision_data.h
• src/physics/collision_data.cpp