FBStoryClip Class Reference

#include <fbstory.h>
FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip FBStoryClip
Inheritance diagram for FBStoryClip:
Inheritance graph
[legend]

List of all members.

Detailed Description

Story Clip class.

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

Definition at line 554 of file 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. 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
FBPropertyListPivot  Pivots
  List: Pivots models (Generally, only one model is necessary)
FBPropertyStoryClipSolveMode  SolvingMode
  Read Write Property: Solve Modes for story character clips. See FBStoryClipSolveMode

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]

Virtual FBDelete function.

Reimplemented from FBComponent.

HFBStoryClip Clone (  ) 

Clone the clip.

FBTime Move ( FBTime  pDelta,
bool  pForce = true  
)

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.

FBTime MoveTo ( FBTime  pTime,
bool  pForce = true  
)

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

Match.

Match the animation clip with the specified pivot property.

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

FBPropertyColor Color

Read Write Property: Color of the clip.

Definition at line 640 of file fbstory.h.

FBPropertyTime Start

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

Definition at line 641 of file fbstory.h.

FBPropertyTime Stop

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

Definition at line 642 of file fbstory.h.

FBPropertyTime MarkIn

Read Write Property: Start time inside the clip.

Definition at line 643 of file fbstory.h.

FBPropertyTime MarkOut

Read Write Property: Stop time inside the clip.

Definition at line 644 of file fbstory.h.

FBPropertyTimeSpan PreBlend

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

Definition at line 645 of file fbstory.h.

FBPropertyTimeSpan PostBlend

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

Definition at line 646 of file fbstory.h.

FBPropertyTime Offset

Read Write Property: First loop time offset.

Definition at line 647 of file fbstory.h.

FBPropertyDouble Speed

Read Write Property: Speed of the clip.

Definition at line 648 of file fbstory.h.

FBPropertyCamera ShotCamera

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

Definition at line 651 of file fbstory.h.

FBPropertyVideo ShotBackplate

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

Definition at line 652 of file fbstory.h.

FBPropertyVideo ShotFrontplate

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

Definition at line 653 of file fbstory.h.

FBPropertyBool ShowBackplate

Read Write Property: Enable/Disable the shot backplate.

Definition at line 654 of file fbstory.h.

FBPropertyBool ShowFrontplate

Read Write Property: Enable/Disable the shot frontplate.

Definition at line 655 of file fbstory.h.

FBPropertyTime ShotActionStart

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 656 of file fbstory.h.

FBPropertyTime ShotActionStop

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 657 of file fbstory.h.

FBPropertyAudioClip AudioClip

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

Definition at line 660 of file fbstory.h.

FBPropertyDouble Scale

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

Definition at line 663 of file fbstory.h.

FBPropertyVector3d Translation

Read Write Property: Animation clip's translation offset.

Definition at line 664 of file fbstory.h.

FBPropertyVector3d Rotation

Read Write Property: Animation clip's rotation offset.

Definition at line 665 of file fbstory.h.

FBPropertyVector3d LoopTranslation

Read Write Property: Animation clip's loop translation.

Definition at line 666 of file fbstory.h.

FBPropertyBool AutoLoop

Read Write Property: If true, clip will automatically loop

Definition at line 667 of file fbstory.h.

FBPropertyBool Loop

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

Definition at line 668 of file fbstory.h.

FBPropertyBool Ghost

Read Write Property: Show ghosts

Definition at line 669 of file fbstory.h.

FBPropertyBool GhostModel

Read Write Property: Show ghost of models

Definition at line 670 of file fbstory.h.

FBPropertyBool GhostTravelling

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

Definition at line 671 of file fbstory.h.

FBPropertyBool GhostPivot

Read Write Property: Show ghost of match object

Definition at line 672 of file fbstory.h.

FBPropertyStoryClipShowGhostMode ShowGhostClipMode

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

Definition at line 673 of file fbstory.h.

FBPropertyAnimationNode PreBlendData

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

Definition at line 674 of file fbstory.h.

FBPropertyAnimationNode PostBlendData

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

Definition at line 675 of file fbstory.h.

FBPropertyListPivot Pivots

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

Definition at line 676 of file fbstory.h.

FBPropertyStoryClipSolveMode SolvingMode

Read Write Property: Solve Modes for story character clips. See FBStoryClipSolveMode

Definition at line 679 of file fbstory.h.

Please send us your comments about this page.