Inheritance diagram for Cogs::Core::CinematicCameraComponent:
Static Public Member Functions | |
| static void | registerType () |
| Register the type in the type system. | |
 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 | |
| std::vector< glm::vec3 > | interestPointPosition |
| It is assumed that the arrays are of equal length (ALWAYS), otherwise component will just bail out of the update cycle and do nothing. | |
| std::vector< glm::quat > | interestPointRotation |
| Rotation of the Camera. | |
| std::vector< float > | interestPointTimeToReach |
| Interpolation time to reach point[i]. | |
| std::vector< float > | interestPointWaitingTime |
| Waiting Time before interpolating towards point[++i]. | |
| std::vector< CameraEasingMode > | interestPointEasingMode |
| Easing Mode between points[–i] and points[i]. | |
| bool | isCinematicPlaying = false |
| Wether this sequence is listed to play or not. | |
| bool | loop = false |
| Wether this sequence is marked to loop endlessly. | |
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
Definition at line 62 of file CinematicCameraComponent.h.
Member Function Documentation
◆ registerType()
|
static |
Register the type in the type system.
Definition at line 8 of file CinematicCameraComponent.cpp.
References interestPointEasingMode, interestPointPosition, interestPointRotation, interestPointTimeToReach, interestPointWaitingTime, isCinematicPlaying, and loop.
Referenced by Cogs::Core::CinematicCamera::CinematicCameraExtension::initializeStatic().
Member Data Documentation
◆ interestPointEasingMode
| std::vector<CameraEasingMode> Cogs::Core::CinematicCameraComponent::interestPointEasingMode |
Easing Mode between points[–i] and points[i].
Definition at line 86 of file CinematicCameraComponent.h.
Referenced by registerType().
◆ interestPointPosition
| std::vector<glm::vec3> Cogs::Core::CinematicCameraComponent::interestPointPosition |
It is assumed that the arrays are of equal length (ALWAYS), otherwise component will just bail out of the update cycle and do nothing.
Position of the Camera
Definition at line 74 of file CinematicCameraComponent.h.
Referenced by registerType().
◆ interestPointRotation
| std::vector<glm::quat> Cogs::Core::CinematicCameraComponent::interestPointRotation |
Rotation of the Camera.
Definition at line 77 of file CinematicCameraComponent.h.
Referenced by registerType().
◆ interestPointTimeToReach
| std::vector<float> Cogs::Core::CinematicCameraComponent::interestPointTimeToReach |
Interpolation time to reach point[i].
Definition at line 80 of file CinematicCameraComponent.h.
Referenced by registerType().
◆ interestPointWaitingTime
| std::vector<float> Cogs::Core::CinematicCameraComponent::interestPointWaitingTime |
Waiting Time before interpolating towards point[++i].
Definition at line 83 of file CinematicCameraComponent.h.
Referenced by registerType().
◆ isCinematicPlaying
| bool Cogs::Core::CinematicCameraComponent::isCinematicPlaying = false |
Wether this sequence is listed to play or not.
Definition at line 89 of file CinematicCameraComponent.h.
Referenced by registerType().
◆ loop
| bool Cogs::Core::CinematicCameraComponent::loop = false |
Wether this sequence is marked to loop endlessly.
Definition at line 92 of file CinematicCameraComponent.h.
Referenced by registerType().
The documentation for this class was generated from the following files:
- Extensions/CinematicCamera/Source/CinematicCameraComponent.h
- Extensions/CinematicCamera/Source/CinematicCameraComponent.cpp
