Classes¶

Animation/Keyframe Animation/Events

Brief descriptions¶

Structures
`nau::animation::events::FrameEventData`
`nau::animation::FrameEventInfo`	Encapsualates frame event data.
Classes
`nau::animation::FrameEvent`	Encapsulates frame event parameters.

Detailed information¶

animation::events::FrameEventData¶

engine/core/modules/animation/include/nau/animation/data/events.h

struct FrameEventData¶

Public Members

trackName

eventId eastl::string trackName

eastl::string eventId¶

animation::FrameEventInfo¶

engine/core/modules/animation/include/nau/animation/playback/animation.h

struct FrameEventInfo¶

Encapsualates frame event data.

Public Members

eastl::string id¶

FrameEventControlFlag flags = {}¶

animation::FrameEvent¶

engine/core/modules/animation/include/nau/animation/data/frame_event.h

class FrameEvent¶

Encapsulates frame event parameters.

Public Functions

FrameEvent() = default¶: Desfault constructor.

inline FrameEvent(const char *id, FrameEventType type = FrameEventType::OneTime, FrameEventActivationDirection activationDirection = FrameEventActivationDirection::Forward)¶

Initialization constructor,.

Parameters:

id – [in] Identifier of the event. See m_id.
type – [in] Event activation type.
activationDirection – [in] Direction of playback that triggers the event.

inline const eastl::string &getId() const¶

Retrieves the frame event identifier.

Returns:: Identifier of the event.

inline void setId(const char *id)¶

Assigns the identifier to the event.

Parameters:: id – [in] Identifier to assign.

inline FrameEventType getEventType() const¶

Retrieves the event activation type.

Returns:: Event activation type.

inline void setEventType(FrameEventType value)¶

Sets activation type for the event.

@pram [in] value Type to assign.

inline FrameEventActivationDirection getActivationDirection() const¶

Retrieves the event activation direction.

Returns:: Event activation direction.

inline void setActivationDirection(FrameEventActivationDirection value)¶

Sets activation direction for the event.

Parameters:: value – [in] Direction to assign.

Private Members

eastl::string m_id¶: String identifier of the event.

Note

Both event of type FrameEventType::Stop and a pinned event (FrameEventType::Start) it deactivates have to have equal identifiers

FrameEventType m_eventType = FrameEventType::OneTime ¶

FrameEventActivationDirection m_activationDirection = FrameEventActivationDirection::Forward ¶