Base class for all logic components that can be attached to an actor. Provides access to the scene, tick functionality, and lifecycle events. More...

#include <LogicComponent.h>

Inheritance diagram for Engine::Components::Logic:

Collaboration diagram for Engine::Components::Logic:

Public Member Functions
	Logic (Entities::Scene *owningScene)
	Constructs a logic component owned by a scene.
	Logic (const Entities::SpawnContext &context)
	Constructs a logic component from spawn context data.
virtual	~Logic ()=default
	Destroys the logic component.
virtual std::string	getComponentName () const
	Gets the component type name for debugging/UI.
virtual bool	drawImGui ()
	Draws component-specific ImGui inspector controls.
virtual bool	drawImGuiName ()
	Used to alter the name of the entity in the outliner.
virtual void	beginPlay ()
	Called when the component is added to the scene or the game starts.
virtual void	tick (double deltaTime)
	Called every frame if ticking is enabled.
virtual void	endPlay ()
	Called when the component is removed or the game ends.
bool	hasBegunPlay () const
	Checks whether beginPlay() has been called without a matching endPlay().
bool	canTick () const
	Checks if the component is currently set to tick.
void	setCanTick (bool enable)
	Enables or disables ticking for this component.
Entities::Entity *	getOwningEntity () const
	Gets the entity this component belongs to.

Static Public Attributes
static constexpr bool	IsUnique = false
	Defines whether multiple instances of this component can exist on the same entity. Defaults to false (multiple allowed). Override in derived classes with static constexpr bool IsUnique = true; if needed.
static constexpr const char *	ComponentName = "Logic"
	Fallback component type name. Derived classes may override getComponentName() for custom labels.

Protected Member Functions
Entities::Scene *	getScene () const
	Gets the scene this component belongs to.
Core::SceneManager *	getSceneManager () const
	Helper to get the SceneManager from the owning scene.

Private Member Functions
void	setOwningEntity (Entities::Entity *entity)
	Sets the owning entity. Called by Entity::addComponent().

Private Attributes
Entities::Scene *	scene_ = nullptr
Entities::Entity *	owningEntity_ = nullptr
bool	tickEnabled = false
bool	hasBegunPlay_ = false

Detailed Description

Base class for all logic components that can be attached to an actor. Provides access to the scene, tick functionality, and lifecycle events.

Definition at line 24 of file LogicComponent.h.

Constructor & Destructor Documentation

◆ Logic() [1/2]

Engine::Components::Logic::Logic ( Entities::Scene * owningScene )

explicit

Constructs a logic component owned by a scene.

Parameters

owningScene Scene that owns this component.

Referenced by Engine::Components::Mesh::ownsCollisionChild().

Here is the caller graph for this function:

◆ Logic() [2/2]

Engine::Components::Logic::Logic ( const Entities::SpawnContext & context )

explicit

Constructs a logic component from spawn context data.

Parameters

context Spawn context containing the owning scene.

◆ ~Logic()

virtual Engine::Components::Logic::~Logic ( )

virtualdefault

Destroys the logic component.

Member Function Documentation

◆ beginPlay()

virtual void Engine::Components::Logic::beginPlay ( )

virtual

Called when the component is added to the scene or the game starts.

Reimplemented in Engine::Components::Camera, Engine::Components::Collision, Engine::Components::DirectionalLight, Engine::Components::Mesh, Engine::Components::PhysicsBody, Engine::Components::VrGlider, Engine::Components::VrMovement, Engine::Components::WidgetComponent, Engine::Components::WindTrail, and Engine::Components::WorldUiSurfaceComponent.

◆ canTick()

bool Engine::Components::Logic::canTick ( ) const

nodiscard

Checks if the component is currently set to tick.

Returns: true if ticking is enabled.

◆ drawImGui()

virtual bool Engine::Components::Logic::drawImGui ( )

virtual

Draws component-specific ImGui inspector controls.

Returns: true if the component drew its own inspector UI.

Reimplemented in Engine::Components::Camera, Engine::Components::Collision, Engine::Components::Mesh, Engine::Components::PhysicsBody, and Engine::Components::VrGlider.

◆ drawImGuiName()

virtual bool Engine::Components::Logic::drawImGuiName ( )

virtual

Used to alter the name of the entity in the outliner.

Returns: true if the component drew its own inspector UI.

◆ endPlay()

virtual void Engine::Components::Logic::endPlay ( )

virtual

Called when the component is removed or the game ends.

Reimplemented in Engine::Components::Camera, Engine::Components::CollidableMesh, Engine::Components::Collision, Engine::Components::DirectionalLight, Engine::Components::Mesh, Engine::Components::PhysicsBody, Engine::Components::VrGlider, Engine::Components::VrMovement, Engine::Components::WidgetComponent, and Engine::Components::WindTrail.

◆ getComponentName()

virtual std::string Engine::Components::Logic::getComponentName ( ) const

nodiscardvirtual

Gets the component type name for debugging/UI.

Returns: The component display name.

Reimplemented in Engine::Components::DirectionalLight, Engine::Components::VrGlider, and Engine::Components::WidgetComponent.

◆ getOwningEntity()

Entities::Entity * Engine::Components::Logic::getOwningEntity ( ) const

nodiscard

Gets the entity this component belongs to.

Returns: Pointer to the owning Entity.

◆ getScene()

Entities::Scene * Engine::Components::Logic::getScene ( ) const

nodiscardprotected

Gets the scene this component belongs to.

Returns: Pointer to the owning Scene.

◆ getSceneManager()

Core::SceneManager * Engine::Components::Logic::getSceneManager ( ) const

nodiscardprotected

Helper to get the SceneManager from the owning scene.

Returns: Pointer to the SceneManager.

◆ hasBegunPlay()

bool Engine::Components::Logic::hasBegunPlay ( ) const

nodiscard

Checks whether beginPlay() has been called without a matching endPlay().

Returns: true while the component is in play.

◆ setCanTick()

void Engine::Components::Logic::setCanTick ( bool enable )

Enables or disables ticking for this component.

Parameters

enable True to enable ticking, false to disable.

◆ setOwningEntity()

void Engine::Components::Logic::setOwningEntity ( Entities::Entity * entity )

private

Sets the owning entity. Called by Entity::addComponent().

Parameters

entity Pointer to the owning entity.

◆ tick()

virtual void Engine::Components::Logic::tick ( double deltaTime )

virtual

Called every frame if ticking is enabled.

Parameters

deltaTime Time elapsed since last frame.

Reimplemented in Engine::Components::Camera, Engine::Components::VrCamera, Engine::Components::VrGlider, Engine::Components::VrMovement, and Engine::Components::WorldUiSurfaceComponent.

Member Data Documentation

◆ ComponentName

const char* Engine::Components::Logic::ComponentName = "Logic"

staticconstexpr

Fallback component type name. Derived classes may override getComponentName() for custom labels.

Definition at line 38 of file LogicComponent.h.

◆ hasBegunPlay_

bool Engine::Components::Logic::hasBegunPlay_ = false

private

Definition at line 140 of file LogicComponent.h.

◆ IsUnique

bool Engine::Components::Logic::IsUnique = false

staticconstexpr

Defines whether multiple instances of this component can exist on the same entity. Defaults to false (multiple allowed). Override in derived classes with static constexpr bool IsUnique = true; if needed.

Definition at line 32 of file LogicComponent.h.

◆ owningEntity_

Entities::Entity* Engine::Components::Logic::owningEntity_ = nullptr

private

Definition at line 138 of file LogicComponent.h.

◆ scene_

Entities::Scene* Engine::Components::Logic::scene_ = nullptr

private

Definition at line 137 of file LogicComponent.h.

◆ tickEnabled

bool Engine::Components::Logic::tickEnabled = false

private

Definition at line 139 of file LogicComponent.h.

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

/workspace/magerbeton/gl3-vulkan/code/Engine/include/Engine/Component/LogicComponent.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Logic() [1/2]

◆ Logic() [2/2]

◆ ~Logic()

Member Function Documentation

◆ beginPlay()

◆ canTick()

◆ drawImGui()

◆ drawImGuiName()

◆ endPlay()

◆ getComponentName()

◆ getOwningEntity()

◆ getScene()

◆ getSceneManager()

◆ hasBegunPlay()

◆ setCanTick()

◆ setOwningEntity()

◆ tick()

Member Data Documentation

◆ ComponentName

◆ hasBegunPlay_

◆ IsUnique

◆ owningEntity_

◆ scene_

◆ tickEnabled