A strip group is where the Strip are stored. For each strip group, you will be creating a specific type have to be specified. Once specified all Strip added to the group behaviors will be derived from this type.

As an example, of a strip group is created with the type kDirector (which deals with Camera) all Strip added to the group will be of that type and allow you to change Camera during the Sequence.

Static Variables

Name	Description
`folder`	Parent StripFolder where the StripGroup is maintained.
Declaration StripFolder *folder
`strip_count`	Total amount of Strip contained in the active StripGroup.
Declaration unsigned char strip_count
`data`	Access the StripGroupData properties for the active StripGroupType.
Declaration StripGroupData data
`playback_time`	Internal playback time of the active StripGroup.
Declaration float playback_time
`playback_loop`	Number of times the StripGroup have been looped.
Declaration float playback_loop
`uid`	Unique id to identify the StripGroup globally.
Declaration unsigned int uid

Variables

Name Description

extrapolation Control the StripGroup Extrapolation method when the last Strip of the group finished playing.

Declaration

Extrapolation extrapolation

name Unique name to identify the StripGroup inside its parent StripFolder.

Declaration

char *name

color A color to visually identify the Strip contained in the active StripGroup inside the Sequence Editor.

Declaration

vec3 color

mute Mute the active StripGroup playback.

Declaration

bool mute

Note: The StripGroup will be still be updated; however all Strip contained in the group will have no impact on the Sequence.

locked Set the StripGroup as read-only inside the Sequence Editor prohibiting any changes to made on the Strip it contains.

Declaration

bool locked

flags Bit mask of current options applied on the StripGroup.

Declaration

int flags

Cap	Value	Description
`GRP_FLAG_OPEN`	`bit.lshift(1,0)`	Flag to open/close the StripGroup inside the editor.
`GRP_FLAG_MUTE`	`bit.lshift(1,1)`	Continue updating the StripGroup prevent it to have any influence on the active Sequence.
`GRP_FLAG_LOCKED`	`bit.lshift(1,2)`	Lock/unlock the StripGroup; when locked no further changes can be made on the Strip locations.

Functions

Name	Description
`AddStrip`	Add a new Strip to the active StripGroup.
Declaration Strip AddStrip( const char name ) Parameters `name`: Specify a name to identify the new Strip. Return Value Reference to the newly created Strip.
`GetScene`	Helper function that retrieve the underlying Scene Asset where the StripGroup belongs to.
Declaration Scene GetScene( void ) Return Value* A valid Scene reference.
`GetAnimation`	Helper to retrieve the Animation reference where the active StripGroup is maintained.
Declaration Animation GetAnimation( void ) Return Value* Reference to the Animation where the current StripGroup belongs.
`GetStrip`	Retrieve the reference of an existing Strip using its name as key.
Declaration Strip GetStrip( const char name ) Parameters `name`: Name of the Strip to retrieve. Return Value `nil` if no Strip contained in the active StripGroup match the name received by the function; else return the Strip reference.
`GetStripAt`	Retrive a specific Strip reference using its index as key.
Declaration Strip GetStripAt( unsigned short index ) Parameters* `index`: Index of the Strip reference to retrieve. Return Value `nil` if the index is out of bounds; else return the reference of the Strip pointed by index.
`GetStripIndex`	Helper to retrieve the index of a Strip maintained by the active StripGroup.
Declaration int GetStripIndex( Strip strip ) Parameters* `strip`: Reference of the StripGroup to remove. Return Value `-1` if the Strip reference received in parameter is invalid; else return the index of the Strip.
`SetStripIndex`	Manually change the internal index of an existing Strip maintained by the active StripGroup.
Declaration bool SetStripIndex( Strip strip, unsigned short index ) Parameters* `strip`: Reference of the Strip to move. `index`: The new index of the Strip. Return Value `true` on success; `false` if the `index` provided is invalid or if the `strip` reference is not a Strip does not belongs to the active StripGroup.
`RemoveStrip`	Remove a Strip reference from the current StripGroup.
Declaration bool RemoveStrip( Strip strip ) Parameters* `strip`: Reference of the Strip to remove. Return Value `true` if the reference have been removed successfully; `false` if the Strip reference is invalid.
`AddStripSection`	Remove a Strip from the active StripGroup by index.
Declaration bool RemoveStripAt( int index ) Parameters `index`: Index of the Strip to remove. Return Value `true` if the Strip at index have been removed successfully; `false` if the index is out of bounds.
`IsSelected`	Helper function that return is all Strip in the active StripGroup are selected.
Declaration bool IsSelected( void ) Return Value `true` if all Strip are selected; else return `false`.
`IsRangeSelected`	Helper that return how many Strip range are selected.
Declaration unsigned short IsRangeSelected( void ) Return Value The amount of Strip range that are selected.
`Sort`	Sort all the Strip contained in the current StripGroup chronologically.
Declaration void Sort( void )
`CanTransform`	Function that check if the current StripGroup selection can be transformed.
Declaration bool CanTransform( float delta_time, float min_time, bool snap, bool extend, bool adjust ) Parameters `delta_time`: The amount of time that the StripGroup is trying to move. `min_time`: Smallest possible duration of the StripGroup. `snap`: Enable/disable snapping. `extend`: Determine wheter or not the Strip should be extended. `adjust`: Determine wheter or not the Strip should be adjusted. Return Value `true` if the transformation is possible; else return `false`.
`ShiftSelection`	Function to shift the current StripGroup selection.
Declaration void ShiftSelection( float delta_time ) Parameters `delta_time`: Delta representing the amount of time that should be shifted.
`TransformSelection`	Function to transform the active StripGroup selection.
Declaration bool TransformSelection( float delta_time, float min_time, bool snap, bool extend, bool adjust ) Parameters `delta_time`: The amount of time that the StripGroup is trying to move. `min_time`: Smallest possible duration of the StripGroup. `snap`: Enable/disable snapping. `extend`: Determine wheter or not the Strip should be extended. `adjust`: Determine wheter or not the Strip should be adjusted. Return Value `true` if the transformation has occured; else return `false`.
`AutoBlendSelection`	Function that calculate the appropriate blending in/out for the current StripGroup Strip selection.
Declaration void AutoBlendSelection( void )

StripGroupData

Access the properties available for the StripGroupType the active StripGroup was created with.

Static Variables

Name	Description
`type`	The active StripGroup StripGroupType.
Declaration StripGroupType type
`director`	Access the StripGroupDirector properties; available only for a StripGroup of the type `kDirector`.
Declaration StripGroupDirector *director Warning If the active StripGroupType is not `kDirector` this variable will be `nil`.
`audio`	Access the StripGroupAudio properties; available only for a StripGroup of the type `kAudio`.
Declaration StripGroupAudio *audio Warning If the active StripGroupType is not `kAudio` this variable will be `nil`.
`activity`	Access the StripGroupActivity properties; available only for a StripGroup of the type `kActivity`.
Declaration StripGroupActivity *activity Warning If the active StripGroupType is not `kActivity` this variable will be `nil`.
`conversation`	Access the StripGroupConversation properties; available for a StripGroup of the type `kConversation`.
Declaration StripGroupConversation *conversation Warning If the active StripGroupType is not `kConversation` this variable will be `nil`.
`subsequence`	Access the StripGroupSubSequence properties; available for a StripGroup of the type `kSubSequence`.
Declaration StripGroupSubSequence *subsequence Warning If the active StripGroupType is not `kSubSequence` this variable will be `nil`.

StripGroupDirector

Control the properties and settings of a kDirector StripGroup.

Static Variables

Name Description

virtual_camera Reference to the virtual Object created to handle Camera switch (if any).

Declaration

Object *virtual_camera

Variables

Name	Description
`renderlayer`	Unique id to the RenderLayer the Camera should be placed on.
Declaration unsigned int renderlayer
`main_camera`	Unique id of the fallback Camera the active StripGroup should return to when the playback time is outside of the group range.
Declaration unsigned int main_camera
`main_listener`	Specify wheter or not the fallback Camera should be set as Listener.
Declaration bool main_listener

StripGroupAudio

Control the properties and settings of a kAudio StripGroup.

Variables

Name	Description
`pan`	Control the pan direction of the sound.
Declaration float pan Range -1.0 (left) to 1.0 (right)
`soundgroup`	Unique id of SoundGroup where the virtual SoundSource should be placed on.
Declaration unsigned int soundgroup

StripGroupActivity

Control the properties and settings of a kActivity StripGroup.

Variables

Name	Description
`object`	Unique id of the Object the StripGroup control its Animation.
Declaration unsigned int object
`blend_mode`	The BlendMode to use for the active StripGroup when blending Action.
Declaration BlendMode blend_mode

StripGroupConversation

Control the properties and settings of a kText StripGroup.

Variables

Name Description

text Unique id of the Text Object the StripGroup should control.

Declaration

unsigned int text

StripGroupSubSequence

Control the properties and settings of a kSubSequence StripGroup.

Variables

Name Description

subsequence Unique id of Object to access the sub Sequence.

Declaration

unsigned int object

Extrapolation

Available types of extrapolation to use when the playback time of a StripGroup extend its current range.

kDoNothing: Stop updating the StripGroup.
kHoldForward: Continue to increase the StripGroup playback time.
kReplay: Reset the active StripGroup playback time to zero and replay it.
kPingPong: Replay the StripGroup mirrored.

BlendMode

Available when the StripGroup type is set to kActivity. The blending mode will determine how the Action connected with a Strip will be blended with the current existing values.

kMix: Interpolate between the current and active value updated by the Strip.
kOverwrite: Overwrite the current value with the active value updated by the Strip.

PlacementMode

Available for StripGroup of the type kCreator; the constant listed below specify how to handle the placement of the Entity connect to the Strip.

kTransform: Use the actual world transformation matrix to place the entity.
kPivot: Only copy the location of the target transformation.
kAttach: Connect the Object to the target Object / Bone creating a parent/child relationship.
kDistribute: Only available when the target Object is of the type Route or Region. If the target object type is a Route, the Entity will be randomly distributed along the Route path. In the case of a Region, the system will use the current shape parameter to randomly place within the shape bounds (volumetric) the Entity.

StripGroupType

List of all available StripGroup type.

kDirector: Controls which Camera should be used during the sequence playback.
kAudio: Allows you to create virtual SoundSource to play SoundBuffer either in 2D or 3D, control pan, volume, and AudioEffect.
kActivity: Controls the Action of a specific Animation. This is the type of strip group to used to animate characters, Object.
kTrigger: Run a Script, a function or custom command either at a specific point in the Sequence time or continuously.
kConversation: Provides an easy way to create subtitles or to update the string of Text object(s) either statically or progressively during the Sequence playback.
kSubSequence: Embed an existing Sequence within the active Sequence. Take note that this type of strip cannot be resized since they are strictly based on the time of the external Sequence.
kCreator: Create and destroy Entity Asset during the Sequence playback. This is the type of StripGroup to use if your Sequence requires dynamic Object created during the Sequence runtime.