Public Member Functions | Public Attributes

FBStoryClip Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014, Story.


Search for all occurrences

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.

Definition at line 594 of file fbstory.h.

#include <fbstory.h>

Inheritance diagram for FBStoryClip:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBStoryClip (FBComponent *pClipObject, FBStoryTrack *pTrack, FBTime pTime, HIObject pObject=NULL)
 Constructor.
 FBStoryClip (const char *pFilePath, FBStoryTrack *pTrack, FBTime pTime, HIObject pObject=NULL)
 Constructor.
virtual void FBDelete ()
 Virtual FBDelete function.
FBStoryClipClone ()
 Clone the clip.
FBTime Move (FBTime pDelta, bool pForce=true)
 Move.
FBTime MoveTo (FBTime pTime, bool pForce=true)
 MoveTo.
FBStoryClipRazor (FBTime pTime)
 Razor.
void Match ()
 Match.
bool ExportToFile (FBString pOutputFile)
 ExportToFile.
bool MakeWritable ()
 MakeWritable.
void GetAffectedObjects (FBArrayTemplate< FBComponent * > *pAffectedObjects)
 GetAffectedObjects.
void GetAffectedAnimationNodes (FBArrayTemplate< FBAnimationNode * > *pAffectedAnimationNodes, FBComponent *pClipObject)
 GetAffectedAnimationNodes.
FBXSDK_NAMESPACE::FbxScene * GetFbxScene ()
 Get KFbxScene.

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.
FBPropertyBool ImageSequence
 Read Write Property: Whether is a image sequence.
FBPropertyBool UseSystemFrameRate
 Read Write Property: Whether always use system frame rate.
FBPropertyDouble FrameRate
 Read Write Property: Frame rate value.
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)
FBPropertyBool 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.

Constructor & Destructor Documentation

FBStoryClip ( FBComponent pClipObject,
FBStoryTrack pTrack,
FBTime  pTime,
HIObject  pObject = NULL 
)

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.
FBStoryClip ( const char *  pFilePath,
FBStoryTrack pTrack,
FBTime  pTime,
HIObject  pObject = NULL 
)

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.

Member Function Documentation

virtual void FBDelete ( ) [virtual]

Virtual FBDelete function.

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).
void Match ( )

Match.

Match the animation clip with the specified pivot property.

bool ExportToFile ( FBString  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.
void GetAffectedObjects ( FBArrayTemplate< FBComponent * > *  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:
pAffectedObjectsArray of affected objects, will be filled by the function.
void GetAffectedAnimationNodes ( FBArrayTemplate< FBAnimationNode * > *  pAffectedAnimationNodes,
FBComponent 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:
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

Read Write Property: Color of the clip.

Definition at line 691 of file fbstory.h.

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

Definition at line 692 of file fbstory.h.

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

Definition at line 693 of file fbstory.h.

Read Write Property: Start time inside the clip.

Definition at line 694 of file fbstory.h.

Read Write Property: Stop time inside the clip.

Definition at line 695 of file fbstory.h.

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

Definition at line 696 of file fbstory.h.

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

Definition at line 697 of file fbstory.h.

Read Write Property: First loop time offset.

Definition at line 698 of file fbstory.h.

Read Write Property: Speed of the clip.

Definition at line 699 of file fbstory.h.

FBPropertyCamera ShotCamera

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

Definition at line 702 of file fbstory.h.

FBPropertyVideo ShotBackplate

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

Definition at line 703 of file fbstory.h.

FBPropertyVideo ShotFrontplate

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

Definition at line 704 of file fbstory.h.

Read Write Property: Enable/Disable the shot backplate.

Definition at line 705 of file fbstory.h.

Read Write Property: Enable/Disable the shot frontplate.

Definition at line 706 of file fbstory.h.

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

Definition at line 707 of file fbstory.h.

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

Definition at line 708 of file fbstory.h.

FBPropertyAudioClip AudioClip

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

Definition at line 711 of file fbstory.h.

Read Write Property: Whether is a image sequence.

Definition at line 714 of file fbstory.h.

Read Write Property: Whether always use system frame rate.

Definition at line 715 of file fbstory.h.

Read Write Property: Frame rate value.

Only effective when UseSystemFrameRate is false.

Definition at line 716 of file fbstory.h.

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

Definition at line 719 of file fbstory.h.

Read Write Property: Animation clip's translation offset.

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

Definition at line 720 of file fbstory.h.

Read Write Property: Animation clip's rotation offset.

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

Definition at line 721 of file fbstory.h.

Read Write Property: Animation clip's loop translation.

Definition at line 722 of file fbstory.h.

Read Write Property: If true, clip will automatically loop

Definition at line 723 of file fbstory.h.

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

Definition at line 724 of file fbstory.h.

Read Write Property: Show ghosts

Definition at line 725 of file fbstory.h.

Read Write Property: Show ghost of models

Definition at line 726 of file fbstory.h.

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

Definition at line 727 of file fbstory.h.

Read Write Property: Show ghost of match object

Definition at line 728 of file fbstory.h.

FBPropertyStoryClipShowGhostMode ShowGhostClipMode

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

See FBStoryClipShowGhostMode

Definition at line 729 of file fbstory.h.

FBPropertyAnimationNode PreBlendData

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

Definition at line 730 of file fbstory.h.

FBPropertyAnimationNode PostBlendData

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

Definition at line 731 of file fbstory.h.

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

Definition at line 732 of file fbstory.h.

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

Definition at line 733 of file fbstory.h.

FBPropertyStoryClipSolveMode SolvingMode

Read Write Property: Solve Modes for story character clips.

See FBStoryClipSolveMode

Definition at line 736 of file fbstory.h.


The documentation for this class was generated from the following file:

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