Class Component¶
Defined in File component.h
Nested Relationships¶
Nested Types¶
Inheritance Relationships¶
Derived Types¶
public AudioComponent
(Class AudioComponent)public AudioListenerComponent
(Class AudioListenerComponent)public CameraComponent
(Class CameraComponent)public CollisionComponent
(Class CollisionComponent)public DirectionalLightComponent
(Class DirectionalLightComponent)public FogComponent
(Class FogComponent)public ParticleEffectComponent
(Class ParticleEffectComponent)public PlayerController
(Class PlayerController)public PointLightComponent
(Class PointLightComponent)public RenderableComponent
(Class RenderableComponent)public RenderUIComponent
(Class RenderUIComponent)public SkyComponent
(Class SkyComponent)public SpotLightComponent
(Class SpotLightComponent)public TransformAnimationComponent
(Class TransformAnimationComponent)public TransformComponent
(Class TransformComponent)public UIComponent
(Class UIComponent)
Class Documentation¶
-
class
Component
¶ An ECS style interface of a collection of data that helps implement a behaviour. Also allows operations on that data.
Subclassed by AudioComponent, AudioListenerComponent, CameraComponent, CollisionComponent, DirectionalLightComponent, FogComponent, ParticleEffectComponent, PlayerController, PointLightComponent, RenderableComponent, RenderUIComponent, SkyComponent, SpotLightComponent, TransformAnimationComponent, TransformComponent, UIComponent
Public Functions
-
virtual
~Component
()¶
-
void
registerDependency
(Dependable *dependable)¶ Only use to register dependency through a Dependency object.
-
const Vector<Dependable *> &
getDependencies
() const¶
-
bool
resolveDependencies
()¶ Establish inter-component links after all components have been added on the owner entity. Return true if successful.
-
virtual bool
setupData
()¶ Perform setting up internal data needed from other components after they have been added to the owning entity.
-
virtual bool
setupEntities
()¶ Perform setting up operations which are possible only after all entities have been set up.
-
virtual void
onRemove
()¶ Perform operations prior to detachment from owning entity and destruction.
-
virtual ComponentID
getComponentID
() const = 0¶
-
virtual const char *
getName
() const = 0¶
-
virtual JSON::json
getJSON
() const¶ Get JSON representation of the component data needed to re-construct component from memory.
-
virtual void
draw
()¶ Expose the component data with ImGui.
-
struct
Category
¶
-
virtual