Story Track class.
Tracks are containers for clips (medias), have a specific type which offer different functions.
Public Member Functions |
|
__init__ (FBStoryTrackType pTrackType, HFBStoryFolder pFolder=None, object pObject=None) | |
Constructor. |
|
__init__ (HFBComponent pSource, HFBStoryFolder pFolder=None, object pObject=None) | |
Constructor. |
|
FBDelete () | |
Virtual FBDelete function. |
|
ChangeDetailsBegin () | |
ChangeDetailsBegin. |
|
ChangeDetailsEnd () | |
ChangeDetailsEnd. |
|
FBStoryClip | CopyTakeIntoTrack (FBTimeSpan pTimeSpan, FBTake pTake, FBTime pOutputOffset=0, bool pMakeUndoable=False) |
CopyTakeIntoTrack Copy animation from the
specified take for affected objects of the track. |
|
EnableBodyPart (FBStoryTrackBodyPart pPart, bool pEnable) | |
EnableBodyPart. |
|
bool | IsBodyPartEnabled (FBStoryTrackBodyPart pPart) |
IsBodyPartEnabled. |
|
AddClip (HFBComponent pClip, FBTime pTime) | |
AddClip Add the clip to the track. |
|
Public Attributes |
|
FBPropertyStoryTrackType | Type |
Read Only Property: Type of the
track. |
|
FBPropertyString | Label |
Read Write Property: Label to display
for this story track. |
|
FBPropertyBase | Mute |
Read Write Property: If true, this
track wont' play. |
|
FBPropertyBase | Solo |
Read Write Property: If true, this
track will be the only one to play. |
|
FBPropertyStoryFolder | ParentFolder |
Read Only Property: Parent folder.
|
|
FBPropertyStoryTrack | ParentTrack |
Read Only Property: Parent track, if
the track is of Character or Animation type. |
|
FBPropertyListStorySubTrack | SubTracks |
List: Only Character and Animation
tracks can have sub-tracks. |
|
FBPropertyListStoryClip | Clips |
List: Clips contained in this track.
|
|
FBPropertyListStoryDetails | Details |
List: All objects associated to this
track for processing. |
|
FBPropertyBaseAnimatable | Weight |
Read Write Property: Control the
blend amount. |
|
FBPropertyBase | Ghost |
Read Write Property: Show ghosts.
|
|
FBPropertyBase | GhostModel |
Read Write Property: Show ghost of
models. |
|
FBPropertyBase | GhostTravelling |
Read Write Property: Show ghost of
clip vector or traveling node. |
|
FBPropertyBase | GhostPivot |
Read Write Property: Show ghost of
match object. |
|
FBPropertyBase | AcceptKey |
Read Write Property: Allow track to
accept keys. |
|
FBPropertyStoryTrackRefMode | ReferenceMode |
Read Write Property: Track
composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive.
|
|
FBPropertyBase | OffsetEnable |
Read Write Property: When enabled,
allow clip to be offset. |
|
FBPropertyBase | PassThrough |
Read Write Property: Enable
passthrough of animation if there is no clip on track animation is
taken from other tracks of take. |
|
FBPropertyCharacter | Character |
Read Write Property: Character to
use. |
|
FBPropertyBase | CharacterIndex |
Read Write Property: Character's
index to use. |
|
FBPropertyBase | ShowBackplate |
Read Write Property: If true, the
backplate will be shown. |
|
FBPropertyBase | ShowFrontplate |
Read Write Property: If true, the
frontplate will be shown. |
|
FBPropertyBase | AudioOutIndex |
Read Write Property: Audio Output's
index to use. |
|
FBPropertyVideo | TrackVideo |
Read Only Property: This FBVideo can be used as a texture. |
__init__ | ( | FBStoryTrackType | pTrackType, |
HFBStoryFolder | pFolder = None , |
||
object | pObject =
None |
||
) |
Constructor.
pTrackType | Type of the track to be created. |
pFolder | If NULL, parent will be the global root folder. |
pObject | For internal use only. |
__init__ | ( | HFBComponent | pSource, |
HFBStoryFolder | pFolder = None , |
||
object | pObject =
None |
||
) |
Constructor.
pSource | Source of the track to be created based on media component type. |
pFolder | If NULL, parent will be the global root folder. |
pObject | For internal use only. |
FBDelete | ( | ) |
ChangeDetailsBegin | ( | ) |
ChangeDetailsBegin.
You must call this function before adding/removing any object to the Details list or it won't work.
ChangeDetailsEnd | ( | ) |
ChangeDetailsEnd.
You must call this function after adding/removing any object to the Details list or it won't work.
FBStoryClip CopyTakeIntoTrack | ( | FBTimeSpan | pTimeSpan, |
FBTake | pTake, | ||
FBTime | pOutputOffset = 0 , |
||
bool | pMakeUndoable =
False |
||
) |
CopyTakeIntoTrack Copy animation from the specified take for affected objects of the track.
pTimeSpan | Time span for the clip to create. |
pTake | Take to get the animation from. |
pOutputOffset | Time offset for the clip if necessary. |
pMakeUndoable | If the operation should be undoable. |
EnableBodyPart | ( | FBStoryTrackBodyPart | pPart, |
bool | pEnable | ||
) |
EnableBodyPart.
pPart | Which part to enable/disable. |
pEnable | If True, this will enable the body part solving while false will disable it. Enable a specific body part for character solving. |
bool IsBodyPartEnabled | ( | FBStoryTrackBodyPart | pPart | ) |
AddClip | ( | HFBComponent | pClip, |
FBTime | pTime | ||
) |
AddClip Add the clip to the track.
FBPropertyStoryTrackType Type |
Read Only Property: Type of the track.
Read Write Property: Label to display for this story track.
FBPropertyBase Mute |
Read Write Property: If true, this track wont' play.
FBPropertyBase Solo |
Read Write Property: If true, this track will be the only one to play.
FBPropertyStoryFolder ParentFolder |
Read Only Property: Parent folder.
FBPropertyStoryTrack ParentTrack |
Read Only Property: Parent track, if the track is of Character or Animation type.
List: Only Character and Animation tracks can have sub-tracks.
List: Clips contained in this track.
List: All objects associated to this track for processing.
FBPropertyBaseAnimatable Weight |
Read Write Property: Control the blend amount.
Reimplemented from FBConstraint.
FBPropertyBase Ghost |
Read Write Property: Show ghosts.
FBPropertyBase GhostModel |
Read Write Property: Show ghost of models.
FBPropertyBase GhostTravelling |
Read Write Property: Show ghost of clip vector or traveling node.
FBPropertyBase GhostPivot |
Read Write Property: Show ghost of match object.
FBPropertyBase AcceptKey |
Read Write Property: Allow track to accept keys.
FBPropertyStoryTrackRefMode ReferenceMode |
Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive.
FBPropertyBase OffsetEnable |
Read Write Property: When enabled, allow clip to be offset.
FBPropertyBase PassThrough |
Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken from other tracks of take.
FBPropertyCharacter Character |
Read Write Property: Character to use.
FBPropertyBase CharacterIndex |
Read Write Property: Character's index to use.
FBPropertyBase ShowBackplate |
Read Write Property: If true, the backplate will be shown.
FBPropertyBase ShowFrontplate |
Read Write Property: If true, the frontplate will be shown.
FBPropertyBase AudioOutIndex |
Read Write Property: Audio Output's index to use.
FBPropertyVideo TrackVideo |
Read Only Property: This FBVideo can be used as a texture.