FBStoryTrack Class Reference

FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack FBStoryTrack
Inheritance diagram for FBStoryTrack:
Inheritance graph
[legend]

List of all members.


Detailed Description

Story Track class.

Tracks are containers for clips (medias), have a specific type which offer different functions.

See samples: CreateShotClip.py, AudioTrackSetupTool.py, PlotNonSelectedCharStoryTracks.py, PlotSelectedCharStoryTracks.py, PrintClipNamesAndStartStopFrames.py.


Public Member Functions

  FBStoryTrack (FBStoryTrackType pTrackType, FBStoryFolder pFolder=None)
  Constructor.
  FBStoryTrack (FBComponent pSource, FBStoryFolder pFolder=None)
  Constructor.
  AddClip (FBComponent pClip, FBTime pTime)
  AddClip Add the clip to the track.
  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.
  FBDelete ()
  Virtual FBDelete function.
bool  IsBodyPartEnabled (FBStoryTrackBodyPart pPart)
  IsBodyPartEnabled.

Public Attributes

bool  AcceptKey
  Read Write Property: Allow track to accept keys
int  AudioOutIndex
  Read Write Property: Audio Output's index to use.
int  CharacterIndex
  Read Write Property: Character's index to use.
FBListStoryClip  Clips
  List: Clips contained in this track.
FBListStoryDetails  Details
  List: All objects associated to this track for processing.
bool  Ghost
  Read Write Property: Show ghosts
bool  GhostModel
  Read Write Property: Show ghost of models
bool  GhostPivot
  Read Write Property: Show ghost of match object
bool  GhostTravelling
  Read Write Property: Show ghost of clip vector or traveling node
str  Label
  Read Write Property: Label to display for this story track.
bool  Mute
  Read Write Property: If true, this track wont' play.
bool  OffsetEnable
  Read Write Property: When enabled, allow clip to be offset
FBStoryFolder  ParentFolder
  Read Only Property: Parent folder.
FBStoryTrack  ParentTrack
  Read Only Property: Parent track, if the track is of Character or Animation type.
bool  PassThrough
  Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken from other tracks of take
FBStoryTrackRefMode  ReferenceMode
  Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive
bool  ShowBackplate
  Read Write Property: If true, the backplate will be shown.
bool  ShowFrontplate
  Read Write Property: If true, the frontplate will be shown.
bool  Solo
  Read Write Property: If true, this track will be the only one to play.
FBListStorySubTrack  SubTracks
  List: Only Character and Animation tracks can have sub-tracks.
FBVideo  TrackVideo
  Read Only Property: This FBVideo can be used as a texture.
FBStoryTrackType  Type
  Read Only Property: Type of the track
FBAnimatableDouble  Weight
  Read Write Property: Control the blend amount.

Constructor & Destructor Documentation

FBStoryTrack ( FBStoryTrackType  pTrackType,
FBStoryFolder  pFolder = None  
)

Constructor.

Parameters:
pTrackType  Type of the track to be created.
pFolder  If NULL, parent will be the global root folder.

FBStoryTrack ( FBComponent  pSource,
FBStoryFolder  pFolder = None  
)

Constructor.

Parameters:
pSource  Source of the track to be created based on media component type.
pFolder  If NULL, parent will be the global root folder.

Member Function Documentation

AddClip ( FBComponent  pClip,
FBTime  pTime  
)

AddClip Add the clip to the track.

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.

Parameters:
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.
Returns:
Created story clip if the operation succeeded otherwize NULL.

EnableBodyPart ( FBStoryTrackBodyPart  pPart,
bool  pEnable  
)

EnableBodyPart.

Parameters:
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.

FBDelete (  ) 

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

Reimplemented from FBComponent.

bool IsBodyPartEnabled ( FBStoryTrackBodyPart  pPart  ) 

IsBodyPartEnabled.

Is a specific body part is enabled.


Member Data Documentation

bool AcceptKey

Read Write Property: Allow track to accept keys

int AudioOutIndex

Read Write Property: Audio Output's index to use.

int CharacterIndex

Read Write Property: Character's index to use.

FBListStoryClip Clips

List: Clips contained in this track.

FBListStoryDetails Details

List: All objects associated to this track for processing.

bool Ghost

Read Write Property: Show ghosts

bool GhostModel

Read Write Property: Show ghost of models

bool GhostPivot

Read Write Property: Show ghost of match object

bool GhostTravelling

Read Write Property: Show ghost of clip vector or traveling node

str Label

Read Write Property: Label to display for this story track.

bool Mute

Read Write Property: If true, this track wont' play.

bool OffsetEnable

Read Write Property: When enabled, allow clip to be offset

FBStoryFolder ParentFolder

Read Only Property: Parent folder.

FBStoryTrack ParentTrack

Read Only Property: Parent track, if the track is of Character or Animation type.

bool PassThrough

Read Write Property: Enable passthrough of animation if there is no clip on track animation is taken from other tracks of take

FBStoryTrackRefMode ReferenceMode

Read Write Property: Track composition mode, kFBStoryTrackOverride or kFBStoryTrackAdditive

bool ShowBackplate

Read Write Property: If true, the backplate will be shown.

bool ShowFrontplate

Read Write Property: If true, the frontplate will be shown.

bool Solo

Read Write Property: If true, this track will be the only one to play.

FBListStorySubTrack SubTracks

List: Only Character and Animation tracks can have sub-tracks.

FBVideo TrackVideo

Read Only Property: This FBVideo can be used as a texture.

FBStoryTrackType Type

Read Only Property: Type of the track

FBAnimatableDouble Weight

Read Write Property: Control the blend amount.

Reimplemented from FBConstraint.


Generated on Tue Feb 9 19:34:38 2010 for Python Reference Guide by  doxygen 1.5.3