VisuTwin Canvas
C++ 3D Engine — Metal Backend
Loading...
Searching...
No Matches
visutwin::canvas::Component Class Referenceabstract
Framework » ECS

Base class for ECS components that attach functionality to entities. More...

#include <framework/components/component.h>

Inheritance diagram for visutwin::canvas::Component:
[legend]

Public Member Functions

virtual void cloneFrom (const Component *source)
 Component (IComponentSystem *system, Entity *entity)
virtual bool enabled () const
Entity * entity () const
virtual void initializeComponentData ()=0
virtual void onDisable ()
virtual void onEnable ()
virtual void onPostStateChange ()
virtual void setEnabled (bool value)
IComponentSystem * system () const
virtual ~Component ()=default
Public Member Functions inherited from visutwin::canvas::EventHandler
template<typename... Args>
EventHandler * fire (const std::string &name, Args &&... args)
bool hasEvent (const std::string &name) const
void initEventHandler ()
template<typename Callback>
requires (!std::is_same_v<std::decay_t<Callback>, HandleEventCallback>)
EventHandler * off (const std::string &name, Callback &&callback, void *scope=nullptr)
EventHandler * off (const std::string &name="", const HandleEventCallback &callback=HandleEventCallback(), void *scope=nullptr)
EventHandler * offByHandle (EventHandle *handle)
template<typename Callback>
requires (!std::is_same_v<std::decay_t<Callback>, HandleEventCallback>)
EventHandle * on (const std::string &name, Callback &&callback, void *scope=nullptr)
EventHandle * on (const std::string &name, HandleEventCallback callback, void *scope=nullptr)
template<typename Callback>
requires (!std::is_same_v<std::decay_t<Callback>, HandleEventCallback>)
EventHandle * once (const std::string &name, Callback &&callback, void *scope=nullptr)
EventHandle * once (const std::string &name, HandleEventCallback callback, void *scope=nullptr)
virtual ~EventHandler ()=default

Protected Member Functions

virtual void onSetEnabled (bool oldValue, bool newValue)
Protected Member Functions inherited from visutwin::canvas::EventHandler
EventHandle * addCallback (const std::string &name, HandleEventCallback callback, void *scope=nullptr, bool once=false)

Protected Attributes

bool _enabled = true
Entity * _entity

Detailed Description

Base class for ECS components that attach functionality to entities.

Components are created and managed by their owning ComponentSystem<T>. Each component has lifecycle hooks (onEnable, onDisable, onPostStateChange) and can be cloned when an Entity is duplicated. Component lookup on Entity is O(1) via a type-ID map.

Definition at line 39 of file component.h.

Constructor & Destructor Documentation

◆ Component()

visutwin::canvas::Component::Component ( IComponentSystem * system,
Entity * entity )
explicit

Definition at line 12 of file component.cpp.

References _entity, entity(), and system().

Referenced by visutwin::canvas::AnimationComponent::AnimationComponent(), visutwin::canvas::ButtonComponent::ButtonComponent(), visutwin::canvas::CameraComponent::CameraComponent(), cloneFrom(), visutwin::canvas::LightComponent::cloneFrom(), visutwin::canvas::RenderComponent::cloneFrom(), visutwin::canvas::CollisionComponent::CollisionComponent(), visutwin::canvas::ElementComponent::ElementComponent(), visutwin::canvas::LightComponent::LightComponent(), visutwin::canvas::RenderComponent::RenderComponent(), visutwin::canvas::RigidBodyComponent::RigidBodyComponent(), visutwin::canvas::ScreenComponent::ScreenComponent(), and visutwin::canvas::ScriptComponent::ScriptComponent().

◆ ~Component()

virtual visutwin::canvas::Component::~Component ( )
virtualdefault

Member Function Documentation

◆ cloneFrom()

virtual void visutwin::canvas::Component::cloneFrom ( const Component * source)
inlinevirtual

Copy component data from a source component during Entity::clone(). — each system copies its properties. Subclasses override to copy their specific properties.

Reimplemented in visutwin::canvas::LightComponent, and visutwin::canvas::RenderComponent.

Definition at line 69 of file component.h.

References Component().

◆ enabled()

virtual bool visutwin::canvas::Component::enabled ( ) const
inlinevirtual

Definition at line 49 of file component.h.

References _enabled.

Referenced by visutwin::canvas::AnimationComponent::onSetAnimations(), visutwin::canvas::AnimationComponent::play(), visutwin::canvas::ElementInput::renderElements(), visutwin::canvas::CameraComponent::requestSceneColorMap(), visutwin::canvas::CameraComponent::requestSceneDepthMap(), visutwin::canvas::CameraComponent::setDofEnabled(), visutwin::canvas::CameraComponent::setSsaoEnabled(), visutwin::canvas::CameraComponent::setTaaEnabled(), visutwin::canvas::shouldRenderShadowRenderComponent(), and visutwin::canvas::ElementInput::syncTextElements().

◆ entity()

Entity * visutwin::canvas::Component::entity ( ) const

Definition at line 16 of file component.cpp.

References _entity.

Referenced by visutwin::canvas::AnimationComponent::AnimationComponent(), visutwin::canvas::ButtonComponent::ButtonComponent(), visutwin::canvas::CameraComponent::CameraComponent(), visutwin::canvas::RigidBodyComponent::collision(), visutwin::canvas::CollisionComponent::CollisionComponent(), Component(), visutwin::canvas::ElementComponent::ElementComponent(), visutwin::canvas::ElementInput::handleMouseButtonDown(), visutwin::canvas::LightComponent::LightComponent(), visutwin::canvas::RenderComponent::RenderComponent(), visutwin::canvas::ElementInput::renderElements(), visutwin::canvas::RigidBodyComponent::RigidBodyComponent(), visutwin::canvas::ScreenComponent::ScreenComponent(), visutwin::canvas::ScriptComponent::ScriptComponent(), visutwin::canvas::ButtonComponent::setImageEntity(), visutwin::canvas::shouldRenderShadowRenderComponent(), visutwin::canvas::ElementInput::syncTextElements(), and visutwin::canvas::CollisionComponent::worldBounds().

◆ initializeComponentData()

virtual void visutwin::canvas::Component::initializeComponentData ( )
pure virtual

Implemented in visutwin::canvas::AnimationComponent, visutwin::canvas::ButtonComponent, visutwin::canvas::CameraComponent, visutwin::canvas::CollisionComponent, visutwin::canvas::ElementComponent, visutwin::canvas::LightComponent, visutwin::canvas::RenderComponent, visutwin::canvas::RigidBodyComponent, visutwin::canvas::ScreenComponent, and visutwin::canvas::ScriptComponent.

◆ onDisable()

virtual void visutwin::canvas::Component::onDisable ( )
inlinevirtual

Definition at line 59 of file component.h.

Referenced by onSetEnabled().

◆ onEnable()

virtual void visutwin::canvas::Component::onEnable ( )
inlinevirtual

Reimplemented in visutwin::canvas::AnimationComponent.

Definition at line 56 of file component.h.

Referenced by visutwin::canvas::AnimationComponent::onEnable(), and onSetEnabled().

◆ onPostStateChange()

virtual void visutwin::canvas::Component::onPostStateChange ( )
inlinevirtual

Definition at line 62 of file component.h.

◆ onSetEnabled()

void visutwin::canvas::Component::onSetEnabled ( bool oldValue,
bool newValue )
protectedvirtual

Definition at line 28 of file component.cpp.

References _entity, onDisable(), and onEnable().

Referenced by setEnabled().

◆ setEnabled()

void visutwin::canvas::Component::setEnabled ( bool value)
virtual

Reimplemented in visutwin::canvas::ScriptComponent.

Definition at line 21 of file component.cpp.

References _enabled, and onSetEnabled().

Referenced by visutwin::canvas::LightComponent::cloneFrom(), visutwin::canvas::RenderComponent::cloneFrom(), and visutwin::canvas::ScriptComponent::setEnabled().

◆ system()

IComponentSystem * visutwin::canvas::Component::system ( ) const
inline

Definition at line 47 of file component.h.

Referenced by visutwin::canvas::AnimationComponent::AnimationComponent(), visutwin::canvas::ButtonComponent::ButtonComponent(), visutwin::canvas::CameraComponent::CameraComponent(), visutwin::canvas::CollisionComponent::CollisionComponent(), Component(), visutwin::canvas::ElementComponent::ElementComponent(), visutwin::canvas::LightComponent::LightComponent(), visutwin::canvas::RenderComponent::RenderComponent(), visutwin::canvas::CameraComponent::requestSceneColorMap(), visutwin::canvas::CameraComponent::requestSceneDepthMap(), visutwin::canvas::RigidBodyComponent::RigidBodyComponent(), visutwin::canvas::ScreenComponent::ScreenComponent(), and visutwin::canvas::ScriptComponent::ScriptComponent().

Member Data Documentation

◆ _enabled

bool visutwin::canvas::Component::_enabled = true
protected

Definition at line 77 of file component.h.

Referenced by enabled(), visutwin::canvas::ScriptComponent::fixedUpdateScripts(), visutwin::canvas::ScriptComponent::postUpdateScripts(), setEnabled(), visutwin::canvas::ScriptComponent::setEnabled(), and visutwin::canvas::ScriptComponent::updateScripts().

◆ _entity

Entity* visutwin::canvas::Component::_entity
protected

Definition at line 76 of file component.h.

Referenced by visutwin::canvas::RenderComponent::cloneFrom(), Component(), visutwin::canvas::ScriptComponent::create(), visutwin::canvas::LightComponent::direction(), entity(), visutwin::canvas::CameraComponent::initializeComponentData(), visutwin::canvas::AnimationComponent::onSetAnimations(), onSetEnabled(), visutwin::canvas::AnimationComponent::play(), and visutwin::canvas::LightComponent::position().

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