Enumerations

Animation/Keyframe Animation/Events

Brief descriptions

Enumerations
nau::animation::FrameEventType	Enumerates event activation types.
nau::animation::FrameEventActivationDirection	Enumerates directions of playback that triggers the event.
nau::animation::FrameEventControl	Enumerates frame event control flags.

Detailed information

animation::FrameEventType

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

enum class nau::animation::FrameEventType

Enumerates event activation types.

Values:

enumerator OneTime

Event remains active only for a single frame after it has been triggered.

enumerator Start

Event remains active until it is deactivated manually (see FrameEventType::Stop) or the playback reaches the last frame.

enumerator Stop

This used to deactivate previously triggered event.

---

animation::FrameEventActivationDirection

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

enum class nau::animation::FrameEventActivationDirection

Enumerates directions of playback that triggers the event.

Values:

enumerator Forward

enumerator Backward

enumerator Any

---

animation::FrameEventControl

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

enum class nau::animation::FrameEventControl : uint8_t

Enumerates frame event control flags.

Values:

enumerator IsActive

Indicates whether the event will fire the associated action when triggered.

enumerator IsPinned

Events become inactive once they are triggered, unless they are pinned. You have to deactivate pinned events manually.