FBStoryClip Class Reference
Detailed Description
Story Clip class.
Clips represents media, at a specific time, for a specific duration, in a track.
Public Member Functions |
|
| __init__ (FBComponent pClipObject, HFBStoryTrack pTrack, FBTime pTime, object pObject=None) | |
| Constructor. |
|
| __init__ (str pFilePath, HFBStoryTrack pTrack, FBTime pTime, object pObject=None) | |
| Constructor. |
|
| FBDelete () | |
| Virtual FBDelete function. |
|
| HFBStoryClip | Clone () |
| Clone the clip. |
|
| FBTime | Move (FBTime pDelta, bool pForce=True) |
| Move. |
|
| FBTime | MoveTo (FBTime pTime, bool pForce=True) |
| MoveTo. |
|
| HFBStoryClip | Razor (FBTime pTime) |
| Razor. |
|
| Match () | |
| Match. |
|
| bool | ExportToFile (str pOutputFile) |
| ExportToFile. |
|
| GetAffectedObjects (tuple pAffectedObjects) | |
| GetAffectedObjects. |
|
| GetAffectedAnimationNodes (tuple pAffectedAnimationNodes, FBComponent pClipObject) | |
| GetAffectedAnimationNodes. |
|
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 | 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, |
| HFBStoryTrack | pTrack, | ||
| FBTime | pTime, | ||
| object | pObject =
None |
||
| ) |
Constructor.
- Parameters:
-
pClipObject Object (media data) for the clip. pTrack The track in which we create the clip. pTime Time where the clip should begin. pObject For internal use only.
Constructor.
- Parameters:
-
pFilePath Media file path to create clip with. pTrack The track in which we create the clip. pTime Time where the clip should begin. pObject For internal use only.
| FBDelete | ( | ) |
| HFBStoryClip Clone | ( | ) |
Clone the clip.
Move.
Move the clip of a delta offset.
- Parameters:
-
pDelta Delta time to apply to the clip. pForce Force clip to find the nearest position if the move fail.
- Returns:
- Return the delta between the new and previous clip's position.
MoveTo.
Move the clip to the specified time.
- Parameters:
-
pTime Time where to put the clip. pForce Force clip to find the nearest position if the move fail.
- Returns:
- Returns the new clip's time position.
| HFBStoryClip Razor | ( | FBTime | pTime | ) |
Razor.
Cut (razor) the clip at the specified time.
- Parameters:
-
pTime Time 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 | ( | ) |
ExportToFile.
Export animation clip to disk file.
- Parameters:
-
pOutputFile Output file path name.
- 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:
-
pAffectedObjects Array 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:
-
pAffectedAnimationNodes Array of affected animation nodes, will be filled by the function. pClipObject The object for which we search for affected animation nodes.
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 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.
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.
