FBStoryClip Class Reference

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:

[legend]

List of all members.

---

Detailed Description

Story Clip class.

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

See samples: AudioTrackSetupTool.py, PrintClipNamesAndStartStopFrames.py.

Public Member Functions
	FBStoryClip (FBComponent pClipObject, FBStoryTrack pTrack, FBTime pTime)
	Constructor.
	FBStoryClip (str pFilePath, FBStoryTrack pTrack, FBTime pTime)
	Constructor.
FBStoryClip	Clone ()
	Clone the clip.
bool	ExportToFile (str pOutputFile)
	ExportToFile.
	FBDelete ()
	Virtual FBDelete function.
	GetAffectedAnimationNodes (FBArrayTemplate< HFBAnimationNode > pAffectedAnimationNodes, FBComponent pClipObject)
	GetAffectedAnimationNodes.
	GetAffectedObjects (FBArrayTemplate< HFBComponent > pAffectedObjects)
	GetAffectedObjects.
	Match ()
	Match.
FBTime	Move (FBTime pDelta, bool pForce=True)
	Move.
FBTime	MoveTo (FBTime pTime, bool pForce=True)
	MoveTo.
FBStoryClip	Razor (FBTime pTime)
	Razor.
Public Attributes
bool	AutoLoop
	Read Write Property: If true, clip will automatically loop
FBColor	Color
	Read Write Property: Color of the clip.
bool	Ghost
	Read Write Property: Show ghosts
bool	GhostModel
	Read Write Property: Show ghost of models
bool	GhostPivot
	Read Write Property: Show ghost of match object
bool	GhostTravelling
	Read Write Property: Show ghost of clip vector or traveling node
bool	Loop
	Read Write Property: If true, loop clip's animation
FBVector3d	LoopTranslation
	Read Write Property: Animation clip's loop translation.
FBTime	MarkIn
	Read Write Property: Start time inside the clip.
FBTime	MarkOut
	Read Write Property: Stop time inside the clip.
FBTime	Offset
	Read Write Property: First loop time offset.
FBListPivot	Pivots
	List: Pivots models (Generally, only one model is necessary)
FBTimeSpan	PostBlend
	Read Write Property: Start/Stop time of the post-blend phase.
FBTimeSpan	PreBlend
	Read Write Property: Start/Stop time of the pre-blend phase.
FBVector3d	Rotation
	Read Write Property: Animation clip's rotation offset.
float	Scale
	Read Write Property: Animation clip's scaling (some don't support this property)
FBTime	ShotActionStart
	Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.
FBTime	ShotActionStop
	Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property.
FBVideo	ShotBackplate
	Read Write Property: The backplate used for that specific shot.
FBCamera	ShotCamera
	Read Write Property: The camera used for that specific shot.
FBVideo	ShotFrontplate
	Read Write Property: The frontplate used for that specific shot.
bool	ShowBackplate
	Read Write Property: Enable/Disable the shot backplate.
bool	ShowFrontplate
	Read Write Property: Enable/Disable the shot frontplate.
FBStoryClipShowGhostMode	ShowGhostClipMode
	Read Write Property: Show the ghost depending on the time. See FBStoryClipShowGhostMode
FBStoryClipSolveMode	SolvingMode
	Read Write Property: Solve Modes for story character clips. See FBStoryClipSolveMode
float	Speed
	Read Write Property: Speed of the clip.
FBTime	Start
	Read Write Property: Start time of the clip local to its track.
FBTime	Stop
	Read Write Property: Stop time of the clip local to its track.
FBVector3d	Translation
	Read Write Property: Animation clip's translation offset.

---

Constructor & Destructor Documentation

FBStoryClip	(	FBComponent	pClipObject,
		FBStoryTrack	pTrack,
		FBTime	pTime
	)

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.

FBStoryClip	(	str	pFilePath,
		FBStoryTrack	pTrack,
		FBTime	pTime
	)

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.

---

Member Function Documentation

FBStoryClip Clone

(

)

Clone the clip.

bool ExportToFile

(

str

pOutputFile

)

ExportToFile.

Export animation clip to disk file.

Parameters:

pOutputFile

Output file path name.

Returns:

Returns true if successful.

FBDelete

(

)

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

Reimplemented from FBComponent.

GetAffectedAnimationNodes	(	FBArrayTemplate< HFBAnimationNode >	pAffectedAnimationNodes,
		FBComponent	pClipObject
	)

GetAffectedAnimationNodes.

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

Parameters:

	pAffectedAnimationNodes	Array of affected animation nodes, will be filled by the function.
	pClipObject	The object for which we search for affected animation nodes.

Python

The function takes only one parameter (pClipObject) and returns a Python list. ex : lArray = lClip.GetAffectedAnimationNodes(lObject)

GetAffectedObjects

(

FBArrayTemplate< HFBComponent >

pAffectedObjects

)

GetAffectedObjects.

Get the list of objects affected by this story clip.

Parameters:

pAffectedObjects

Array of affected objects, will be filled by the function.

Python

The function takes no parameter and returns a Python list. ex : lArray = lClip.GetAffectedObjects()

Match

(

)

Match.

Match the animation clip with the specified pivot property.

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.

FBStoryClip 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).

---

Member Data Documentation

bool AutoLoop

Read Write Property: If true, clip will automatically loop

FBColor Color

Read Write Property: Color of the clip.

bool Ghost

Read Write Property: Show ghosts

bool GhostModel

Read Write Property: Show ghost of models

bool GhostPivot

Read Write Property: Show ghost of match object

bool GhostTravelling

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

bool Loop

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

FBVector3d LoopTranslation

Read Write Property: Animation clip's loop translation.

FBTime MarkIn

Read Write Property: Start time inside the clip.

FBTime MarkOut

Read Write Property: Stop time inside the clip.

FBTime Offset

Read Write Property: First loop time offset.

FBListPivot Pivots

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

FBTimeSpan PostBlend

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

FBTimeSpan PreBlend

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

FBVector3d Rotation

Read Write Property: Animation clip's rotation offset.

float Scale

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

FBTime ShotActionStart

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

FBTime ShotActionStop

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

FBVideo ShotBackplate

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

FBCamera ShotCamera

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

FBVideo ShotFrontplate

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

bool ShowBackplate

Read Write Property: Enable/Disable the shot backplate.

bool ShowFrontplate

Read Write Property: Enable/Disable the shot frontplate.

FBStoryClipShowGhostMode ShowGhostClipMode

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

FBStoryClipSolveMode SolvingMode

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

float Speed

Read Write Property: Speed of the clip.

FBTime Start

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

FBTime Stop

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

FBVector3d Translation

Read Write Property: Animation clip's translation offset.

---