Component handling animation of multiple Poses of an Animation Resource. More...
#include <AnimationComponent.h>
Inheritance diagram for Cogs::Core::AnimationComponent:
Static Public Member Functions | |
| static void | registerType () |
 Static Public Member Functions inherited from Cogs::ComponentModel::Component | |
| static COGSFOUNDATION_API void | registerType () |
| Register the Component type in the global type database. | |
| static COGSFOUNDATION_API Reflection::TypeId | getComponentTypeId (const StringView &name) |
| Get the type id of the component type with the given name. | |
Public Attributes | |
| AnimationHandle | animation |
| Animation resource handle. | |
| int | clipIndex = 0 |
| Active index of the Animation Clips. -1 = freeze Animation. | |
| float | timeFactor = 1.0f |
| Animation Time Scale factor. | |
| float | timeOffset = 0.0f |
| Animation time offset in seconds. | |
| ComponentModel::ComponentHandle | master |
| Internal handle of Master when animating. Handled by AnimationSystem. | |
Additional Inherited Members | |
| Public Member Functions inherited from Cogs::ComponentModel::Component | |
| class Entity * | getContainer () const |
| Get the container currently owning this component instance. | |
| void | setContainer (class Entity *container) |
| Set the container owning this component instance. | |
| template<typename ComponentType > | |
| ComponentType * | getComponent () const |
| COGSFOUNDATION_API Component * | getComponent (const Reflection::Name &name) const |
| COGSFOUNDATION_API Component * | getComponent (const Reflection::TypeId &id) const |
| template<typename ComponentType > | |
| ComponentHandle | getComponentHandle () const |
| COGSFOUNDATION_API ComponentHandle | getComponentHandle (const Reflection::Name &name) const |
| COGSFOUNDATION_API ComponentHandle | getComponentHandle (const Reflection::TypeId &id) const |
| void | setActive () |
| Sets the component to the ComponentFlags::Active state. | |
| bool | isActive () const |
| Gets if the component is currently set to the ComponentFlags::Active state. | |
| void | setChanged () |
| Sets the component to the ComponentFlags::Changed state with carry. | |
| void | setChangedTransient () |
| Sets the component to the ComponentFlags::Changed state without carry. | |
| void | setFieldChanged (const Reflection::FieldId fieldId) |
| Sets the component to the ComponentFlags::Changed state without carry. | |
| template<typename ClassType , typename FieldType > | |
| void | setFieldChanged (FieldType ClassType::*field) |
| Sets a flag indicating that the given field has changed. | |
| void | setFieldChangedTransient (const Reflection::FieldId fieldId) |
| Sets the component to the ComponentFlags::Changed state without carry. | |
| bool | hasChanged () const |
| bool | hasAnyfieldChanged () const |
| Gets if any fields have been changed. | |
| bool | hasFieldChanged (const Reflection::FieldId fieldId) const |
| Gets if the field with the given id on this component instance has changed. | |
| template<typename ClassType , typename FieldType > | |
| bool | hasFieldChanged (FieldType ClassType::*field) const |
| Gets if the given field has changed. | |
| void | resetCarryChanged () |
| Reset the CarryChanged flag. Called at start of redraw. See ComponentFlags::CarryChanged. | |
| void | resetChanged () |
| Resets the changed state of the component, respecting any carry state set. | |
| template<typename ClassType , typename FieldType > | |
| Reflection::FieldId | getFieldId (FieldType ClassType::*field) const |
| Gets field ID of the given field. | |
| void | resetFieldsChanged () |
| Resets the state of all changed field flags. | |
| void | resetFieldChanged (const Reflection::FieldId fieldId) |
| Resets the changed state of the given fieldId. | |
| template<typename ClassType , typename FieldType > | |
| void | resetFieldChanged (FieldType ClassType::*field) |
| Resets the changed state of the given field. | |
| constexpr void | setFlags (const uint32_t flags) |
| Override all flags of the Component, setting the given flags. | |
| constexpr void | setFlag (const uint32_t flag) |
| Set the given flags. Does not override the currently set flags. | |
| constexpr void | unsetFlag (const uint32_t flag) |
| Unset the given flag. Does not remove the status of other than the given flags. | |
| constexpr bool | isSet (const uint32_t flag) const |
| Checks if the given flag is set. Requires exact bit match if test of several bits. | |
| constexpr void | setTypeId (const Reflection::TypeId typeId) |
| Set the Reflection::TypeId of the component. | |
| constexpr Reflection::TypeId | getTypeId () const |
| Get the Reflection::TypeId of the component. | |
| COGSFOUNDATION_API const Reflection::Type & | getType () const |
| Get the full Reflection::Type of the component. | |
| constexpr void | setIndex (const ComponentIndex index) |
| Set the components pool index. For internal use only. | |
| constexpr ComponentIndex | getIndex () const |
| Get the components pool index. For internal use only. | |
| constexpr void | setGeneration (uint16_t generation) |
| Sets the component generation. | |
| constexpr uint16_t | getGeneration () const |
| Gets the component generation. | |
| size_t | hash (size_t hashValue=Cogs::hash()) const |
| Calculates a hash of this component's members. | |
Detailed Description
Component handling animation of multiple Poses of an Animation Resource.
This component is normally not member of any entity, but is auto-created when loading 3D models with built-in Animation.
Definition at line 16 of file AnimationComponent.h.
Member Function Documentation
◆ registerType()
|
static |
Definition at line 7 of file AnimationComponent.cpp.
Member Data Documentation
◆ animation
| AnimationHandle Cogs::Core::AnimationComponent::animation |
Animation resource handle.
Definition at line 19 of file AnimationComponent.h.
◆ clipIndex
| int Cogs::Core::AnimationComponent::clipIndex = 0 |
Active index of the Animation Clips. -1 = freeze Animation.
Definition at line 22 of file AnimationComponent.h.
◆ master
| ComponentModel::ComponentHandle Cogs::Core::AnimationComponent::master |
Internal handle of Master when animating. Handled by AnimationSystem.
Definition at line 30 of file AnimationComponent.h.
Referenced by Cogs::Core::AnimationSystem::update().
◆ timeFactor
| float Cogs::Core::AnimationComponent::timeFactor = 1.0f |
Definition at line 25 of file AnimationComponent.h.
◆ timeOffset
| float Cogs::Core::AnimationComponent::timeOffset = 0.0f |
Animation time offset in seconds.
Definition at line 27 of file AnimationComponent.h.
The documentation for this struct was generated from the following files:
- Source/Components/Core/AnimationComponent.h
- Source/Components/Core/AnimationComponent.cpp
