This reference page is linked to from the following overview topics: Story.
Detailed Description
Story Clip class.
Clips represents media, at a specific time, for a specific duration, in a track.
#include <fbstory.h>
Public Member Functions |
|
| FBStoryClip (HFBComponent pClipObject, HFBStoryTrack pTrack, FBTime pTime, HIObject pObject=NULL) | |
| Constructor. |
|
| FBStoryClip (char *pFilePath, HFBStoryTrack pTrack, FBTime pTime, HIObject pObject=NULL) | |
| Constructor. |
|
| virtual void | 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. |
|
| void | Match () |
| Match. |
|
| bool | ExportToFile (FBString pOutputFile) |
| ExportToFile. |
|
| void | GetAffectedObjects (FBArrayTemplate< HFBComponent > *pAffectedObjects) |
| GetAffectedObjects. |
|
| void | GetAffectedAnimationNodes (FBArrayTemplate< HFBAnimationNode > *pAffectedAnimationNodes, HFBComponent pClipObject) |
| GetAffectedAnimationNodes. |
|
Public Attributes |
|
| FBPropertyColor | Color |
| Read Write Property: Color of the
clip. |
|
| FBPropertyTime | Start |
| Read Write Property: Start time of
the clip local to its track. |
|
| FBPropertyTime | Stop |
| Read Write Property: Stop time of the
clip local to its track. |
|
| FBPropertyTime | MarkIn |
| Read Write Property: Start time
inside the clip. |
|
| FBPropertyTime | MarkOut |
| Read Write Property: Stop time inside
the clip. |
|
| FBPropertyTimeSpan | PreBlend |
| Read Write Property: Start/Stop time
of the pre-blend phase. |
|
| FBPropertyTimeSpan | PostBlend |
| Read Write Property: Start/Stop time
of the post-blend phase. |
|
| FBPropertyTime | Offset |
| Read Write Property: First loop time
offset. |
|
| FBPropertyDouble | 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. |
|
| FBPropertyBool | ShowBackplate |
| Read Write Property: Enable/Disable
the shot backplate. |
|
| FBPropertyBool | ShowFrontplate |
| Read Write Property: Enable/Disable
the shot frontplate. |
|
| FBPropertyTime | ShotActionStart |
| Read Write Property: If not in locked
shot mode (time discontinuity enabled), this time can be different
from the Clip->Start property. |
|
| FBPropertyTime | 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. |
|
| FBPropertyDouble | Scale |
| Read Write Property: Animation clip's
scaling (some don't support this property) |
|
| FBPropertyVector3d | Translation |
| Read Write Property: Animation clip's
translation offset. |
|
| FBPropertyVector3d | Rotation |
| Read Write Property: Animation clip's
rotation offset. |
|
| FBPropertyVector3d | LoopTranslation |
| Read Write Property: Animation clip's
loop translation. |
|
| FBPropertyBool | AutoLoop |
| Read Write Property: If true, clip
will automatically loop |
|
| FBPropertyBool | Loop |
| Read Write Property: If true, loop
clip's animation |
|
| FBPropertyBool | Ghost |
| Read Write Property: Show ghosts
|
|
| FBPropertyBool | GhostModel |
| Read Write Property: Show ghost of
models |
|
| FBPropertyBool | GhostTravelling |
| Read Write Property: Show ghost of
clip vector or traveling node |
|
| FBPropertyBool | 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) |
|
| FBPropertyStoryClipSolveMode | SolvingMode |
| Read Write Property: Solve Modes for
story character clips. |
|
Constructor & Destructor Documentation
| FBStoryClip | ( | HFBComponent | pClipObject, |
| HFBStoryTrack | pTrack, | ||
| FBTime | pTime, | ||
| HIObject | pObject =
NULL |
||
| ) |
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.
| FBStoryClip | ( | char * | pFilePath, |
| HFBStoryTrack | pTrack, | ||
| FBTime | pTime, | ||
| HIObject | pObject =
NULL |
||
| ) |
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.
Member Function Documentation
| virtual void FBDelete | ( | ) | [virtual] |
| 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).
| void Match | ( | ) |
| bool ExportToFile | ( | FBString | pOutputFile | ) |
ExportToFile.
Export animation clip to disk file.
- Parameters:
-
pOutputFile Output file path name.
- Returns:
- Returns true if successful.
| void GetAffectedObjects | ( | FBArrayTemplate< HFBComponent > * | pAffectedObjects | ) |
GetAffectedObjects.
Get the list of objects affected by this story clip.
- Python
- 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.
| void GetAffectedAnimationNodes | ( | FBArrayTemplate< HFBAnimationNode > * | pAffectedAnimationNodes, |
| HFBComponent | pClipObject | ||
| ) |
GetAffectedAnimationNodes.
Get the list of animation nodes affected by this story clip, for a specific object.
- Python
- 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
Read Write Property: Color of the clip.
Read Write Property: Start time of the clip local to its track.
Read Write Property: Stop time of the clip local to its track.
Read Write Property: Start time inside the clip.
Read Write Property: Stop time inside the clip.
Read Write Property: Start/Stop time of the pre-blend phase.
Read Write Property: Start/Stop time of the post-blend phase.
Read Write Property: First loop time offset.
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.
Read Write Property: Enable/Disable the shot backplate.
Read Write Property: Enable/Disable the shot frontplate.
Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.
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.
Read Write Property: Animation clip's scaling (some don't support this property)
Read Write Property: Animation clip's translation offset.
Read Write Property: Animation clip's rotation offset.
Read Write Property: Animation clip's loop translation.
Read Write Property: If true, clip will automatically loop
Read Write Property: If true, loop clip's animation
Read Write Property: Show ghosts
Read Write Property: Show ghost of models
Read Write Property: Show ghost of clip vector or traveling node
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)
| FBPropertyStoryClipSolveMode SolvingMode |
Read Write Property: Solve Modes for story character clips.
See FBStoryClipSolveMode
The documentation for this class was generated from the following file:
- fbsdk/fbstory.h
