#include <Engine/Scene/ItemEntry.hpp>

Collaboration diagram for Ra::Engine::Scene::ItemEntry:

Public Member Functions
	ItemEntry ()=default
	Create an invalid entry.

	ItemEntry (Entity ent, Component comp=nullptr, Ra::Core::Utils::Index ro=Ra::Core::Utils::Index::Invalid())

bool	operator== (const ItemEntry &rhs) const
	Compare two items.

bool	isValid () const
	Returns true if the item represents any valid object.

bool	isSelectable () const
	Returns true if the item can be selected.

bool	isEntityNode () const
	Returns true if the item represents an entity.

bool	isComponentNode () const
	Returns true if the item represents a component.

bool	isRoNode () const
	Returns true if the item represents a render object.

void	checkConsistency () const
	Debug checks.

Public Attributes
Entity *	m_entity { nullptr }
	The entity represented by the item, or owning the object represented.

Component *	m_component { nullptr }

Ra::Core::Utils::Index	m_roIndex {}
	RO index of the represented object.

Detailed Description

This represent a handle for an entity, component or render object. There are 4 possible states for this object :

All members are invalid -> No object.
Entity pointer valid, all others invalid -> Entity
Entity and component pointers valid, RO index invalid -> Component
Entity, component and RO index valid : -> RO

Definition at line 24 of file ItemEntry.hpp.

Constructor & Destructor Documentation

◆ ItemEntry()

Ra::Engine::Scene::ItemEntry::ItemEntry	(	Entity *	ent,
		Component *	comp = nullptr,
		Ra::Core::Utils::Index	ro = Ra::Core::Utils::Index::Invalid() )

inlineexplicit

Create an entry. ItemEntry(entity) creates an entity entry. ItemEntry(entity, component) creates a component entry ItemEntry(entity, component, RO) creates a render object entity.

Definition at line 32 of file ItemEntry.hpp.

Member Function Documentation

◆ checkConsistency()

void Ra::Engine::Scene::ItemEntry::checkConsistency ( ) const

inline

Debug checks.

Definition at line 94 of file ItemEntry.hpp.

◆ isComponentNode()

bool Ra::Engine::Scene::ItemEntry::isComponentNode ( ) const

inline

Returns true if the item represents a component.

Definition at line 84 of file ItemEntry.hpp.