FBStoryClip Class Reference


Detailed Description

Story Clip class.

Clips represents media, at a specific time, for a specific duration, in a track.

Clip offset is depending on Traveling node and Traveling node function. First we compute clip transformation matrix, where scaling is always 1, 1, 1. Translation is in position of Traveling node at clip first frame. Rotation is based on vector from first to last frame position of Traveling node. On top of that we apply offset and expose that as Clip Offset T & R. When you change clip offset T or R we extract clip offset based on current clip transformation matrix. Clip transformation matrix can change when Traveling node change or Traveling node function change.

Examples
Tasks/PrintClipNamesAndStartStopFrames.py, Samples/Story/VideoClip.py, ComplexTools/AudioTrackSetupTool.py
Inheritance diagram for FBStoryClip:

List of all members.

Public Member Functions

 __init__ (FBComponent pClipObject, FBStoryTrack pTrack, FBTime pTime, object pObject=None)
 Constructor.
 __init__ (str pFilePath, FBStoryTrack pTrack, FBTime pTime, object pObject=None)
 Constructor.
 FBDelete ()
 Virtual FBDelete function.
FBStoryClip Clone ()
 Clone the clip.
FBTime Move (FBTime pDelta, bool pForce=True)
 Move.
FBTime MoveTo (FBTime pTime, bool pForce=True)
 MoveTo.
FBStoryClip Razor (FBTime pTime)
 Razor.
 Match ()
 Match.
bool ExportToFile (str pOutputFile)
 ExportToFile.
bool MakeWritable ()
 MakeWritable.
 GetAffectedObjects (tuple pAffectedObjects)
 GetAffectedObjects.
 GetAffectedAnimationNodes (tuple pAffectedAnimationNodes, FBComponent pClipObject)
 GetAffectedAnimationNodes.
FBXSDK_NAMESPACE FbxScene GetFbxScene ()
 Get KFbxScene.

Public Attributes

FBPropertyBase Color
 Read Write Property: Color of the clip.
FBPropertyBase Start
 Read Write Property: Start time of the clip local to its track.
FBPropertyBase Stop
 Read Write Property: Stop time of the clip local to its track.
FBPropertyBase MarkIn
 Read Write Property: Start time inside the clip.
FBPropertyBase MarkOut
 Read Write Property: Stop time inside the clip.
FBPropertyBase PreBlend
 Read Write Property: Start/Stop time of the pre-blend phase.
FBPropertyBase PostBlend
 Read Write Property: Start/Stop time of the post-blend phase.
FBPropertyBase Offset
 Read Write Property: First loop time offset.
FBPropertyBase Speed
 Read Write Property: Speed of the clip.
FBPropertyCamera ShotCamera
 Read Write Property: The camera used for that specific shot.
FBPropertyVideo ShotBackplate
 Read Write Property: The backplate used for that specific shot.
FBPropertyVideo ShotFrontplate
 Read Write Property: The frontplate used for that specific shot.
FBPropertyBase ShowBackplate
 Read Write Property: Enable/Disable the shot backplate.
FBPropertyBase ShowFrontplate
 Read Write Property: Enable/Disable the shot frontplate.
FBPropertyBase ShotActionStart
 Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.
FBPropertyBase ShotActionStop
 Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.
FBPropertyAudioClip AudioClip
 Read Only Property: The audio clip used by this StoryClip.
FBPropertyBase ImageSequence
 Read Write Property: Whether is a image sequence.
FBPropertyBase UseSystemFrameRate
 Read Write Property: Whether always use system frame rate.
FBPropertyBase FrameRate
 Read Write Property: Frame rate value.
FBPropertyBase Scale
 Read Write Property: Animation clip's scaling (some don't support this property).
FBPropertyBase Translation
 Read Write Property: Animation clip's translation offset.
FBPropertyBase Rotation
 Read Write Property: Animation clip's rotation offset.
FBPropertyBase LoopTranslation
 Read Write Property: Animation clip's loop translation.
FBPropertyBase AutoLoop
 Read Write Property: If true, clip will automatically loop.
FBPropertyBase Loop
 Read Write Property: If true, loop clip's animation.
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.
FBPropertyStoryClipShowGhostMode ShowGhostClipMode
 Read Write Property: Show the ghost depending on the time.
FBPropertyAnimationNode PreBlendData
 Read Only Property: To get the animation of the Pre blend curve.
FBPropertyAnimationNode PostBlendData
 Read Only Property: To get the animation of the Post blend curve.
FBPropertyListPivot Pivots
 List: Pivots models (Generally, only one model is necessary).
FBPropertyBase Loaded
 Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track content).
FBPropertyStoryClipSolveMode SolvingMode
 Read Write Property: Solve Modes for story character clips.

Member Function Documentation

__init__ ( FBComponent  pClipObject,
FBStoryTrack  pTrack,
FBTime  pTime,
object  pObject = None 
)

Constructor.

Parameters:
pClipObjectObject (media data) for the clip.
pTrackThe track in which we create the clip.
pTimeTime where the clip should begin.
pObjectFor internal use only.
Examples
Tasks/PrintClipNamesAndStartStopFrames.py, Samples/Story/VideoClip.py, ComplexTools/AudioTrackSetupTool.py
__init__ ( str  pFilePath,
FBStoryTrack  pTrack,
FBTime  pTime,
object  pObject = None 
)

Constructor.

Parameters:
pFilePathMedia file path to create clip with.
pTrackThe track in which we create the clip.
pTimeTime where the clip should begin.
pObjectFor internal use only.
Examples
Tasks/PrintClipNamesAndStartStopFrames.py, Samples/Story/VideoClip.py, ComplexTools/AudioTrackSetupTool.py
FBDelete ( )

Virtual FBDelete function.

Examples
Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.

FBStoryClip Clone ( )
FBTime Move ( FBTime  pDelta,
bool  pForce = True 
)

Move.

Move the clip of a delta offset.

Parameters:
pDeltaDelta time to apply to the clip.
pForceForce clip to find the nearest position if the move fail.
Returns:
Return the delta between the new and previous clip's position.
FBTime MoveTo ( FBTime  pTime,
bool  pForce = True 
)

MoveTo.

Move the clip to the specified time.

Parameters:
pTimeTime where to put the clip.
pForceForce clip to find the nearest position if the move fail.
Returns:
Returns the new clip's time position.
FBStoryClip Razor ( FBTime  pTime)

Razor.

Cut (razor) the clip at the specified time.

Parameters:
pTimeTime where to cut. This time is local to the track, not to the clip.
Returns:
Returns the new clip generated by the razor action (right part).
Match ( )

Match.

Match the animation clip with the specified pivot property.

bool ExportToFile ( str  pOutputFile)

ExportToFile.

Export animation clip to disk file.

Parameters:
pOutputFileOutput file path name.
Returns:
Returns true if successful.
bool MakeWritable ( )

MakeWritable.

Imports FCurves from story clip scene making them accessible for the user.

Returns:
Returns true if successful.
GetAffectedObjects ( tuple  pAffectedObjects)

GetAffectedObjects.

Get the list of objects affected by this story clip.

The function takes no parameter and returns a Python list. ex : lArray = lClip.GetAffectedObjects()
Parameters:
pAffectedObjectsArray of affected objects, will be filled by the function.
GetAffectedAnimationNodes ( tuple  pAffectedAnimationNodes,
FBComponent  pClipObject 
)

GetAffectedAnimationNodes.

Get the list of animation nodes affected by this story clip, for a specific object.

The function takes only one parameter (pClipObject) and returns a Python list. ex : lArray = lClip.GetAffectedAnimationNodes(lObject)
Parameters:
pAffectedAnimationNodesArray of affected animation nodes, will be filled by the function.
pClipObjectThe object for which we search for affected animation nodes.
FBXSDK_NAMESPACE FbxScene GetFbxScene ( )

Get KFbxScene.

Will only return valid pointer to KFbxScene for readonly animation clip.


Member Data Documentation

FBPropertyBase Color

Read Write Property: Color of the clip.

FBPropertyBase Start

Read Write Property: Start time of the clip local to its track.

FBPropertyBase Stop

Read Write Property: Stop time of the clip local to its track.

FBPropertyBase MarkIn

Read Write Property: Start time inside the clip.

FBPropertyBase MarkOut

Read Write Property: Stop time inside the clip.

FBPropertyBase PreBlend

Read Write Property: Start/Stop time of the pre-blend phase.

FBPropertyBase PostBlend

Read Write Property: Start/Stop time of the post-blend phase.

FBPropertyBase Offset

Read Write Property: First loop time offset.

FBPropertyBase Speed

Read Write Property: Speed of the clip.

FBPropertyCamera ShotCamera

Read Write Property: The camera used for that specific shot.

FBPropertyVideo ShotBackplate

Read Write Property: The backplate used for that specific shot.

FBPropertyVideo ShotFrontplate

Read Write Property: The frontplate used for that specific shot.

FBPropertyBase ShowBackplate

Read Write Property: Enable/Disable the shot backplate.

FBPropertyBase ShowFrontplate

Read Write Property: Enable/Disable the shot frontplate.

FBPropertyBase ShotActionStart

Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.

FBPropertyBase ShotActionStop

Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.

FBPropertyAudioClip AudioClip

Read Only Property: The audio clip used by this StoryClip.

FBPropertyBase ImageSequence

Read Write Property: Whether is a image sequence.

FBPropertyBase UseSystemFrameRate

Read Write Property: Whether always use system frame rate.

FBPropertyBase FrameRate

Read Write Property: Frame rate value.

Only effective when UseSystemFrameRate is false.

FBPropertyBase Scale

Read Write Property: Animation clip's scaling (some don't support this property).

FBPropertyBase Translation

Read Write Property: Animation clip's translation offset.

Refer to class notes to learn more about how this is applied.

FBPropertyBase Rotation

Read Write Property: Animation clip's rotation offset.

Refer to class notes to learn more about how this is applied.

FBPropertyBase LoopTranslation

Read Write Property: Animation clip's loop translation.

FBPropertyBase AutoLoop

Read Write Property: If true, clip will automatically loop.

FBPropertyBase Loop

Read Write Property: If true, loop clip's animation.

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.

FBPropertyStoryClipShowGhostMode ShowGhostClipMode

Read Write Property: Show the ghost depending on the time.

See FBStoryClipShowGhostMode

FBPropertyAnimationNode PreBlendData

Read Only Property: To get the animation of the Pre blend curve.

FBPropertyAnimationNode PostBlendData

Read Only Property: To get the animation of the Post blend curve.

List: Pivots models (Generally, only one model is necessary).

FBPropertyBase Loaded

Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track content).

FBPropertyStoryClipSolveMode SolvingMode

Read Write Property: Solve Modes for story character clips.

See FBStoryClipSolveMode


FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip
FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip