VisuTwin Canvas
C++ 3D Engine — Metal Backend
Loading...
Searching...
No Matches
visutwin::canvas::ElementComponent Class Reference

#include <framework/components/element/elementComponent.h>

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

Public Member Functions

const Vector4 & anchor () const
void clearTextDirty ()
const Color & color () const
 ElementComponent (IComponentSystem *system, Entity *entity)
FontResource * fontResource () const
int fontSize () const
float height () const
ElementHorizontalAlign horizontalAlign () const
void initializeComponentData () override
const Vector4 & margin () const
float opacity () const
const Vector2 & pivot () const
void setAnchor (const Vector4 &value)
void setColor (const Color &value)
void setFontResource (FontResource *value)
void setFontSize (const int value)
void setHeight (const float value)
void setHorizontalAlign (const ElementHorizontalAlign value)
void setMargin (const Vector4 &value)
void setOpacity (const float value)
void setPivot (const Vector2 &value)
void setText (const std::string &value)
void setType (const ElementType value)
void setUseInput (const bool value)
void setWidth (const float value)
void setWrapLines (const bool value)
const std::string & text () const
bool textDirty () const
ElementType type () const
bool useInput () const
float width () const
bool wrapLines () const
 ~ElementComponent () override
Public Member Functions inherited from visutwin::canvas::Component
virtual void cloneFrom (const Component *source)
 Component (IComponentSystem *system, Entity *entity)
virtual bool enabled () const
Entity * entity () const
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

Static Public Member Functions

static const std::vector< ElementComponent * > & instances ()

Additional Inherited Members

Protected Member Functions inherited from visutwin::canvas::Component
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 inherited from visutwin::canvas::Component
bool _enabled = true
Entity * _entity

Detailed Description

Definition at line 30 of file elementComponent.h.

Constructor & Destructor Documentation

◆ ElementComponent()

visutwin::canvas::ElementComponent::ElementComponent ( IComponentSystem * system,
Entity * entity )

◆ ~ElementComponent()

visutwin::canvas::ElementComponent::~ElementComponent ( )
override

Definition at line 15 of file elementComponent.cpp.

Member Function Documentation

◆ anchor()

const Vector4 & visutwin::canvas::ElementComponent::anchor ( ) const
inline

Definition at line 46 of file elementComponent.h.

◆ clearTextDirty()

void visutwin::canvas::ElementComponent::clearTextDirty ( )
inline

Definition at line 83 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ color()

const Color & visutwin::canvas::ElementComponent::color ( ) const
inline

◆ fontResource()

FontResource * visutwin::canvas::ElementComponent::fontResource ( ) const
inline

Definition at line 70 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ fontSize()

int visutwin::canvas::ElementComponent::fontSize ( ) const
inline

Definition at line 64 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ height()

float visutwin::canvas::ElementComponent::height ( ) const
inline

Definition at line 55 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ horizontalAlign()

ElementHorizontalAlign visutwin::canvas::ElementComponent::horizontalAlign ( ) const
inline

Definition at line 73 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ initializeComponentData()

void visutwin::canvas::ElementComponent::initializeComponentData ( )
inlineoverridevirtual

Implements visutwin::canvas::Component.

Definition at line 36 of file elementComponent.h.

◆ instances()

const std::vector< ElementComponent * > & visutwin::canvas::ElementComponent::instances ( )
inlinestatic

◆ margin()

const Vector4 & visutwin::canvas::ElementComponent::margin ( ) const
inline

Definition at line 49 of file elementComponent.h.

◆ opacity()

float visutwin::canvas::ElementComponent::opacity ( ) const
inline

◆ pivot()

const Vector2 & visutwin::canvas::ElementComponent::pivot ( ) const
inline

Definition at line 43 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ setAnchor()

void visutwin::canvas::ElementComponent::setAnchor ( const Vector4 & value)
inline

Definition at line 47 of file elementComponent.h.

◆ setColor()

void visutwin::canvas::ElementComponent::setColor ( const Color & value)
inline

Definition at line 62 of file elementComponent.h.

◆ setFontResource()

void visutwin::canvas::ElementComponent::setFontResource ( FontResource * value)
inline

Definition at line 71 of file elementComponent.h.

◆ setFontSize()

void visutwin::canvas::ElementComponent::setFontSize ( const int value)
inline

Definition at line 65 of file elementComponent.h.

◆ setHeight()

void visutwin::canvas::ElementComponent::setHeight ( const float value)
inline

Definition at line 56 of file elementComponent.h.

◆ setHorizontalAlign()

void visutwin::canvas::ElementComponent::setHorizontalAlign ( const ElementHorizontalAlign value)
inline

Definition at line 74 of file elementComponent.h.

◆ setMargin()

void visutwin::canvas::ElementComponent::setMargin ( const Vector4 & value)
inline

Definition at line 50 of file elementComponent.h.

◆ setOpacity()

void visutwin::canvas::ElementComponent::setOpacity ( const float value)
inline

Definition at line 59 of file elementComponent.h.

◆ setPivot()

void visutwin::canvas::ElementComponent::setPivot ( const Vector2 & value)
inline

Definition at line 44 of file elementComponent.h.

◆ setText()

void visutwin::canvas::ElementComponent::setText ( const std::string & value)
inline

Definition at line 68 of file elementComponent.h.

◆ setType()

void visutwin::canvas::ElementComponent::setType ( const ElementType value)
inline

Definition at line 41 of file elementComponent.h.

◆ setUseInput()

void visutwin::canvas::ElementComponent::setUseInput ( const bool value)
inline

Definition at line 80 of file elementComponent.h.

◆ setWidth()

void visutwin::canvas::ElementComponent::setWidth ( const float value)
inline

Definition at line 53 of file elementComponent.h.

◆ setWrapLines()

void visutwin::canvas::ElementComponent::setWrapLines ( const bool value)
inline

Definition at line 77 of file elementComponent.h.

◆ text()

const std::string & visutwin::canvas::ElementComponent::text ( ) const
inline

Definition at line 67 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ textDirty()

bool visutwin::canvas::ElementComponent::textDirty ( ) const
inline

Definition at line 82 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ type()

ElementType visutwin::canvas::ElementComponent::type ( ) const
inline

◆ useInput()

bool visutwin::canvas::ElementComponent::useInput ( ) const
inline

◆ width()

float visutwin::canvas::ElementComponent::width ( ) const
inline

Definition at line 52 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ wrapLines()

bool visutwin::canvas::ElementComponent::wrapLines ( ) const
inline

Definition at line 76 of file elementComponent.h.

Referenced by visutwin::canvas::ElementInput::syncTextElements().


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