ToyMaker::SceneHierarchyData Struct Reference

Component representing hierarchical information related to this entity. More...

#include <scene_components.hpp>

Static Public Member Functions
static std::string	getComponentTypeName ()
	Gets the component type string associated with this object.

Public Attributes
EntityID	mParent { kMaxEntities }
	The entityID of this entity's parent.
EntityID	mSibling { kMaxEntities }
	The entityID of this entity's next sibling.
EntityID	mChild { kMaxEntities }
	The first child of this entity.

Detailed Description

Component representing hierarchical information related to this entity.

Necessary because quite often systems will not/should not have direct access to the SceneSystem.

See also

ECSWorld::registerComponentTypes()

Member Function Documentation

getComponentTypeName()

static std::string ToyMaker::SceneHierarchyData::getComponentTypeName ( )

inlinestatic

Gets the component type string associated with this object.

Returns

std::string This object's component type string.

Member Data Documentation

mChild

EntityID ToyMaker::SceneHierarchyData::mChild { kMaxEntities }

The first child of this entity.

Set to kMaxEntities if this entity is a leaf node and has no children.

mParent

EntityID ToyMaker::SceneHierarchyData::mParent { kMaxEntities }

The entityID of this entity's parent.

Set to kMaxEntities when this entity has no parent (eg., an entity not in the scene, or the root entity of the scene tree).

mSibling

EntityID ToyMaker::SceneHierarchyData::mSibling { kMaxEntities }

The entityID of this entity's next sibling.

Set to kMaxEntities when this entity has no next sibling.

---

The documentation for this struct was generated from the following file:

• src/engine/scene_components.hpp