Detailed Description

Story Track class.

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

Examples: Tasks/PlotNonSelectedCharStoryTracks.py, Tasks/PlotSelectedCharStoryTracks.py, Tasks/PrintClipNamesAndStartStopFrames.py, Samples/HUD/RecordLight.py, ComplexTools/AudioTrackSetupTool.py, BasicOperations/CreateShotClip.py, BasicOperations/NamespaceOperationsOnTrack.py

Inheritance diagram for FBStoryTrack:

Public Member Functions
	__init__ (FBStoryTrackType pTrackType, HFBStoryFolder pFolder=None, object pObject=None)
	Constructor.
	__init__ (FBComponent 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 (FBComponent pClip, FBTime pTime)
	AddClip Add the clip to the track.
	Load (bool pLoad)
	Allow to load/unload all story clips under this 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.
FBPropertyString	RecordClipPath
	Read Write Property: Path for story recording.
FBPropertyString	ClipNameConvention
	Read Write Property: Naming convention for each new recording clip that is created.
FBPropertyBase	RecordTrack
	Read Write Property: Path for story recording.
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.

Member Function Documentation

__init__	(	FBStoryTrackType	pTrackType,
		HFBStoryFolder	pFolder = `None`,
		object	pObject = `None`
	)

Search for all occurrences

Constructor.

Parameters:

pTrackType	Type of the track to be created.
pFolder	If NULL, parent will be the global root folder.
pObject	For internal use only.

Examples: Tasks/PlotNonSelectedCharStoryTracks.py, Tasks/PlotSelectedCharStoryTracks.py, Tasks/PrintClipNamesAndStartStopFrames.py, Samples/HUD/RecordLight.py, ComplexTools/AudioTrackSetupTool.py, BasicOperations/CreateShotClip.py, BasicOperations/NamespaceOperationsOnTrack.py

__init__	(	FBComponent	pSource,
		HFBStoryFolder	pFolder = `None`,
		object	pObject = `None`
	)

Search for all occurrences

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.
pObject	For internal use only.

Examples: Tasks/PlotNonSelectedCharStoryTracks.py, Tasks/PlotSelectedCharStoryTracks.py, Tasks/PrintClipNamesAndStartStopFrames.py, Samples/HUD/RecordLight.py, ComplexTools/AudioTrackSetupTool.py, BasicOperations/CreateShotClip.py, BasicOperations/NamespaceOperationsOnTrack.py

FBDelete ( )

Search for all occurrences

Virtual FBDelete function.

Examples: Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.

ChangeDetailsBegin ( )

Search for all occurrences

ChangeDetailsBegin.

You must call this function before adding/removing any object to the Details list or it won't work.

ChangeDetailsEnd ( )

Search for all occurrences

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`
	)

Search for all occurrences

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
	)

Search for all occurrences

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.

bool IsBodyPartEnabled ( FBStoryTrackBodyPart pPart )

Search for all occurrences

IsBodyPartEnabled.

Is a specific body part is enabled.