Vesper::Entity Class Reference

Represents an entity in a scene. More...

#include <Entity.h>

Public Member Functions
	Entity ()=default
	Entity (entt::entity handle, Scene *scene)
	Constructs an Entity with the given handle and scene.
	Entity (const Entity &other)=default
	Copy constructor for Entity.
template<typename T>
bool	HasComponent () const
template<typename T, typename... Args>
T &	AddComponent (Args &&... args)
template<typename T, typename... Args>
T &	AddOrReplaceComponent (Args &&... args)
template<typename T>
T &	GetComponent ()
template<typename T, typename... Args>
T &	GetOrAddComponent (Args &&... args)
template<typename T>
void	RemoveComponent ()
const UUID &	GetID ()
const std::string &	GetName ()
	operator bool () const
	operator entt::entity () const
	operator uint32_t () const
bool	operator== (const Entity &other) const
bool	operator!= (const Entity &other) const

Private Attributes
entt::entity	m_EntityID {entt::null}
	The unique identifier of the entity within the scene.
Scene *	m_Scene = nullptr
	Pointer to the scene that contains the entity.

Detailed Description

Represents an entity in a scene.

Contains a handle to an entity (entt::entity) in a scene and provides methods to manipulate its components.

Constructor & Destructor Documentation

Entity() [1/3]

Vesper::Entity::Entity ( )

default

Entity() [2/3]

Vesper::Entity::Entity	(	entt::entity	handle,
		Scene *	scene )

Constructs an Entity with the given handle and scene.

Parameters

handle	The handle to the entity.
scene	The scene to which the entity belongs.

        : m_EntityID(handle), m_Scene(scene)
    {
    }

References Entity(), and m_Scene.

Referenced by Entity().

Entity() [3/3]

Vesper::Entity::Entity ( const Entity & other )

default

Copy constructor for Entity.

Member Function Documentation

AddComponent()

template<typename T, typename... Args>

T & Vesper::Entity::AddComponent ( Args &&... args )

inline

Adds a component of type T to the entity with the provided arguments Otherwise, asserts if the entity already has the component.

Template Parameters

T	The type of component to add.
Args	The types of arguments to forward to the component's constructor.

Parameters

args	The arguments to forward to the component's constructor.

Returns

A reference to the newly added component.

        {
            VZ_CORE_ASSERT(!HasComponent<T>(), "Entity already has component!");
            T& component = m_Scene->m_Registry.emplace<T>(m_EntityID, std::forward<Args>(args)...);
            m_Scene->OnComponentAdded<T>(*this, component);
            return component;
        }

AddOrReplaceComponent()

template<typename T, typename... Args>

T & Vesper::Entity::AddOrReplaceComponent ( Args &&... args )

inline

Adds or replaces a component of type T to the entity with the provided arguments.

Template Parameters

T	The type of component to add or replace.
Args	The types of arguments to forward to the component's constructor.

Parameters

args	The arguments to forward to the component's constructor.

Returns

A reference to the newly added or replaced component.

        {
            return m_Scene->m_Registry.emplace_or_replace<T>(m_EntityID, std::forward<Args>(args)...);
        }

GetComponent()

template<typename T>

T & Vesper::Entity::GetComponent ( )

inline

Retrieves a reference to the component of type T attached to the entity if it exists. Otherwise, asserts.

Template Parameters

T	The type of component to retrieve.

Returns

A reference to the component.

        {
            VZ_CORE_ASSERT(HasComponent<T>(), "Entity does not have component!");
            return m_Scene->m_Registry.get<T>(m_EntityID);
        }

GetID()

const UUID & Vesper::Entity::GetID ( )

inline

Retrieves a const reference to the UUID of the entity.

Returns

A const reference to the UUID of the entity.

        {
            return GetComponent<UUIDComponent>().ID;
        }

GetName()

const std::string & Vesper::Entity::GetName ( )

inline

Retrieves a const reference to the name of the entity.

Returns

A const reference to the name of the entity.

        {
            return GetComponent<NameComponent>().Name;
        }

GetOrAddComponent()

template<typename T, typename... Args>

T & Vesper::Entity::GetOrAddComponent ( Args &&... args )

inline

Retrieves a reference to the component of type T attached to the entity if it exists. Otherwise, adds the component with the provided arguments and returns it.

Template Parameters

T	The type of component to add.
Args	The types of arguments to forward to the component's constructor.

Parameters

args	The arguments to forward to the component's constructor.

Returns

A reference to the newly added component.

        {
            if (HasComponent<T>())
                return GetComponent<T>();
            else
                return AddComponent<T>(std::forward<Args>(args)...);
        }

HasComponent()

template<typename T>

bool Vesper::Entity::HasComponent ( ) const

inline

Checks if the entity has a component of type T.

Template Parameters

T	The type of component to check for.

Returns

true if the entity has the component, false otherwise.

        {
            return m_Scene->m_Registry.all_of<T>(m_EntityID);
        }

operator bool()

Vesper::Entity::operator bool ( ) const

inline

{ return m_EntityID != entt::null; }

operator entt::entity()

Vesper::Entity::operator entt::entity ( ) const

inline

{ return m_EntityID; }

operator uint32_t()

Vesper::Entity::operator uint32_t ( ) const

inline

{ return (uint32_t)m_EntityID; }

operator!=()

bool Vesper::Entity::operator!= ( const Entity & other ) const

inline

{   return !(*this == other);   }

operator==()

bool Vesper::Entity::operator== ( const Entity & other ) const

inline

{   return m_EntityID == other.m_EntityID && m_Scene == other.m_Scene;  }

RemoveComponent()

template<typename T>

void Vesper::Entity::RemoveComponent ( )

inline

Removes the component of type T from the entity if it exists. Otherwise, asserts.

Template Parameters

T	The type of component to remove.

        {
            VZ_CORE_ASSERT(HasComponent<T>(), "Entity does not have component!");
            m_Scene->m_Registry.remove<T>(m_EntityID);
        }

Member Data Documentation

m_EntityID

entt::entity Vesper::Entity::m_EntityID {entt::null}

private

The unique identifier of the entity within the scene.

{entt::null};

m_Scene

Scene* Vesper::Entity::m_Scene = nullptr

private

Pointer to the scene that contains the entity.

Referenced by Entity().

---

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

• Vesper/src/Vesper/Scene/Entity.h
• Vesper/src/Vesper/Scene/Entity.cpp