Action Behaviors
Contents List
- Animation Action Behaviors
- Control Action Behaviors
- Custom
- Gesture Action Behaviors
- Property Action Behaviors
- Scroll Action Behaviors
- Streaming Action Behaviors
- Transition Action Behaviors
-
Set Culture
Animation Action Behaviors
- Configure and Play Animation
Configure and Play Animation
Description
Starts, stops, pauses, resumes animations and offers additional properties for configuration. Also sends AnimationEvents with the state of the animation. These Events can be received by an AnimationStateCondition.
Common Properties
| Property Name | Type | Description |
|---|---|---|
| Animation | Candera::Animation::AnimationPlayer | The animation that should be controlled. |
| Action | CgiStudioControl::AnimationAction::Enum | Action that shall be executed on the animation: Start, Stop, Pause, Resume, Speedup, Finish, Change. |
| Direction | CgiStudioControl::AnimationDirection::Enum | Playback direction of the animation. |
| Speed | FeatStd::Float | Playback speed of the animation. |
Advanced Properties
| Property Name | Type | Description |
|---|---|---|
| RepeatMode | CgiStudioControl::RepeatMode::Enum | Defines how the animation shall be repeated. |
| RepeatCount | CgiStudioControl::RepeatCount::Enum | Count of replays. If set to 0 the animation loops till it gets stopped. |
| EventDispatchStrategy | CgiStudioControl::EventDispatchStrategyType::Enum | The way the event gets sent. |
| DedicatedBehavior | Candera::Behavior* | A dedicated behavior that will receive the animation event. |
| FinishTime | Candera::Animation::WorldTimeType | Finish time in milliseconds. |
| IncreasedSpeed | FeatStd::Float | Increased playback speed of the animation. If set and Play is executed again during playback, animation will speed up (can be used only once per animation!). Zero means immediate position seek. |
| IncreasedSpeedRevertMargin | Candera::Animation::WorldTimeType | Defines trailing part of animation (in milliseconds) that will be played at normal speed again. If not set, speedup will last until the end of animation. |
| SequenceStartTime | Candera::Animation::SequenceTimeType | The start point of the animation. [ms] |
| SequenceDurationTime | Candera::Animation::SequenceTimeType | The duration of the animation. [ms] |
Control Action Behaviors