Story Clip class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBStoryClip:

[legend]

Public Member Functions
	FBStoryClip (FBComponent pClipObject, FBStoryTrack pTrack, FBTime pTime)
	Constructor.

	FBStoryClip (str pFilePath, FBStoryTrack pTrack, FBTime pTime)
	Constructor.

	FBStoryClip (str pFilePath, FBStoryTrack pTrack, FBTime pTime, FBTime pTimeOffset)
	Constructor.

bool	CanAssignSourcesToDestinations ()
	CanAssignSourcesToDestinations.

FBStoryClip	Clone ()
	Clone the clip.

bool	DestinationSetObject (str pSrcName, FBComponent pObject)
	Assign source to destination if the pSrcName is found in source list and pObject is in the Details list.

bool	ExportToFile (str pOutputFile)
	ExportToFile.

	FBDelete ()
	Virtual FBDelete function.

	GetAffectedAnimationNodes (FBArrayTemplate< FBAnimationNode > pAffectedAnimationNodes, FBComponent pClipObject)
	GetAffectedAnimationNodes.

	GetAffectedObjects (FBArrayTemplate< FBComponent > pAffectedObjects)
	GetAffectedObjects.

K_DEPRECATED_2023 void	GetAssignSourcesToDestinationsInfo (FBStringList pSrcList, FBStringList pAvailableDstList, FBStringList pDefaultDstList, FBStringList pEffectiveDstList)
	GetAssignSourcesToDestinationsInfo.

	GetAssignSourcesToDestinationsInfo (FBStringList pSrcList, FBArrayBool pValidAnimatedSrc, FBStringList pAvailableDstList, FBArrayBool pValidAnimatedDst, FBStringList pDefaultDstList, FBStringList pEffectiveDstList)
	GetAssignSourcesToDestinationsInfo.

bool	GetReadOnly ()
	GetReadOnly Retrieves the clip read-only status.

FBTime	GetSourceTimeFromDestinationTime (FBTime pDestinationTime, int pLoopNumber=nullptr)
	Get the clip source time (internal time) from a destination time (local time).

bool	MakeWritable ()
	MakeWritable.

	Match ()
	Match.

	Match (str pObjectName, FBStoryClipMatchingTimeType pTimeType, FBStoryClipMatchingTranslationType pTranslationType, FBStoryClipMatchingRotationType pRotationType)
	Match.

FBTime	Move (FBTime pDelta, bool pForce=True)
	Move.

FBTime	MoveTo (FBTime pTime, bool pForce=True)
	MoveTo.

FBStoryClip	Razor (FBTime pTime)
	Razor.

bool	SetAssignSourcesToDestinationsInfo (FBStringList pEffectiveDstList)
	SetAssignSourcesToDestinationsInfo.

bool	SetReadOnly (bool pMakeClipReadOnly, str pOutputFile=FBString())
	SetReadOnly Assigns the clip read-only status.

	SetTime (FBTime pSourceIn=None, FBTime pSourceOut=None, FBTime pDestinationIn=None, FBTime pDestinationOut=None, bool pUseAlternateSrcInProp=False)
	SetTime Sets any in/out values for the source/destination times.

bool	UpdateFromCurrentTake ()
	Update clip animation from current take animation for clip track's scope, works only for clip created by Insert Current Take and connected to current take.

Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.

str	ClassName ()
	Get the class name.

	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

bool	FBCreate ()
	Open Reality Creation function.

	FBDelete ()
	Open Reality deletion function.

	FBDestroy ()
	Open Reality destruction function.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.

	HardSelect ()
	HardSelect.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

bool	Is (int pTypeId)
	Returns true if object is of type TypeId.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.

int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.

FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.

	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.

	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
FBAudioClip	AudioClip
	Read Only Property: The audio clip used by this StoryClip.

bool	AutoLoop
	Read Write Property: If true, clip will automatically loop

str	ClipAnimationPath
	Read Write Property: Animation clip's file path

str	ClipAudioPath
	Read Write Property: Audio clip's file path

float	ClipPitch
	Read Write Property: The clip pitch value.

str	ClipVideoPath
	Read Write Property: Video clip's file path

FBColor	Color
	Read Write Property: Color of the clip.

bool	ConnectedToTake
	Read Write Property: When connected to current take, user can do updating from current take, but user can't edit clip animation by adding keys, only works for clips created by Insert Current Take.

FBAnimationNode	CustomTimeWarp
	Read Only Property: Animation and Shot clip's custom TimeWarp FCurve.

float	FrameRate
	Read Write Property: Frame rate value. Only effective when UseSystemFrameRate is false.

bool	Ghost
	Read Write Property: Show ghosts

FBTime	GhostCustomTime
	Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryClipTimeCustom.

FBTime	GhostManipulatorCustomTime
	Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMode is kFBStoryClipGhostCustom.

FBStoryClipGhostTimeMode	GhostManipulatorMode
	Read Write Property: Time mode to display ghost manipulator. See FBStoryClipGhostTimeMode.

FBVector3d	GhostManipulatorOffset
	Read Write Property: Animation clip's ghost manipulator offset.

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	ImageSequence
	Read Write Property: Whether is a image sequence.

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

bool	LockPitchToSpeed
	Read Write Property: Time-stretching enabled or not.

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.

bool	MirrorAnimation
	Read Write Property: If true, clip animation will be mirrored

FBStoryClipMirrorPlane	MirrorPlane
	Read Write Property: Several mirror planes to mirror animation. See FBStoryClipMirrorPlane

FBTime	Offset
	Read Write Property: First loop time offset.

FBEvent	OnChange
	Event: Something in the clip has changed. (FBEventClip)

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. Refer to class notes to learn more about how this is applied.

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	ShotStartStopLocked
	Read Write Property: Shot clip's 'In/Out Locked' property value. True if the shot clip's In/Out properties (start/stop times of the clip local to its track) are locked, false otherwise.

bool	ShowBackplate
	Read Write Property: Enable/Disable the shot backplate.

K_DEPRECATED_2024 FBBool	ShowEmbeddedTimecode
	Read Write Property: Whether to show the embedded timecode (real, if available, or custom) of the video.

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.

bool	StartStopLocked
	Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (start/stop times of the clip local to its track) are locked, false otherwise.

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

bool	TimeWarpEnabled
	Read Write Property: Animation and Shot clip's TimeWarp activeness.

FBStoryClipTimeWarpInterpolatorType	TimeWarpInterpolatorType
	Read Write Property: Animation and Shot clip's TimeWarp interpolation type. See FBStoryClipTimeWarpInterpolatorType.

bool	TimeWarpReverse
	Read Write Property: If true, reverse the Animation or Shot clip's TimeWarp FCurve.

FBVector3d	Translation
	Read Write Property: Animation clip's translation offset. Refer to class notes to learn more about how this is applied.

FBListObject	TravellingNode
	List: Travelling node(s). If set, this property will overwrite the Track's Travelling node(s).

FBStoryClipNodeFunction	TravellingNodeFunction
	Read Write Property: Travelling node function. If set, this property will overwrite the Track's Travelling node function. See FBStoryClipNodeFunction.

bool	UseSystemFrameRate
	Read Write Property: Whether always use system frame rate.

Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.

str	LongName
	Read Write Property: Name and namespace for object.

str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

FBListComponent	Parents
	List: Parents.

FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

bool	Selected
	Read Write Property: Selected property.

int	TypeInfo
	Contains the Type information of the object.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

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.

See samples: AudioTrackSetupTool.py, VideoClip.py, PrintClipNamesAndStartStopFrames.py.

Constructor & Destructor Documentation

◆ FBStoryClip() [1/3]

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() [2/3]

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.

◆ FBStoryClip() [3/3]

FBStoryClip	(	str	pFilePath,
		FBStoryTrack	pTrack,
		FBTime	pTime,
		FBTime	pTimeOffset
	)

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.
pTimeOffset	Time offset where the clip should begin.

Member Function Documentation

◆ CanAssignSourcesToDestinations()

bool CanAssignSourcesToDestinations ( )

CanAssignSourcesToDestinations.

Determines if the animation clip can assign its sources to some destinations or not.

Returns: Returns true if the animation clip can assign its sources to some destinations, false otherwise.

◆ Clone()

FBStoryClip Clone ( )

Clone the clip.

◆ DestinationSetObject()

bool DestinationSetObject	(	str	pSrcName,
		FBComponent	pObject
	)

Assign source to destination if the pSrcName is found in source list and pObject is in the Details list.

Parameters

pSrcName	The name of the source.
pObject	The destination object.

Returns: Returns true if assignment has been executed when the pSrcName is found in source list and pObject is in the Details list.

Remarks: Assignment success depends on if they have the same name property and with animation on the source property.

◆ ExportToFile()

bool ExportToFile ( str pOutputFile )

ExportToFile.

Export animation clip to disk file.

Parameters

pOutputFile Output file path name.

Returns: Returns true if successful.

◆ FBDelete()

FBDelete ( )

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

◆ GetAffectedAnimationNodes()

GetAffectedAnimationNodes	(	FBArrayTemplate< FBAnimationNode >	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()

GetAffectedObjects ( FBArrayTemplate< FBComponent > 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()

◆ GetAssignSourcesToDestinationsInfo() [1/2]

GetAssignSourcesToDestinationsInfo	(	FBStringList	pSrcList,
		FBArrayBool	pValidAnimatedSrc,
		FBStringList	pAvailableDstList,
		FBArrayBool	pValidAnimatedDst,
		FBStringList	pDefaultDstList,
		FBStringList	pEffectiveDstList
	)

GetAssignSourcesToDestinationsInfo.

Returns the information about the current state of Sources to Destinations assignment. The pSrcList, pValidAnimatedSrc, pDefaultDstList & pEffectiveDstList parameters will all be of the same size, each index being related to the same index in the other lists/array. The pAvailableDstList & pValidAnimatedDst parameters can contain more items than the other lists. Both will all be of the same size, each index being related to the same index in the other list/array.

Parameters

pSrcList	(C++ only) String list containing all the sources, will be filled by the method.
pValidAnimatedSrc	(C++ only) Array of bool containing the animated validity state of the sources, will be filled by the method.
pAvailableDstList	(C++ only) String list containing all the available destinations, will be filled by the method.
pValidAnimatedDst	(C++ only) Array of bool containing the animated validity state of the available destinations, will be filled by the method.
pDefaultDstList	(C++ only) String list containing the default destinations (contains each string item that will be put back when pressing the 'Reset' button in the UI), will be filled by the method.
pEffectiveDstList	(C++ only) String list containing the effective destination (destinations currently active), will be filled by the method.

Returns: (Python only) A tuple with 6 values: (pSrcList, pValidAnimatedSrc, pAvailableDstList, pValidAnimatedDst, pDefaultDstList, pEffectiveDstList).

◆ GetAssignSourcesToDestinationsInfo() [2/2]

K_DEPRECATED_2023 void GetAssignSourcesToDestinationsInfo	(	FBStringList	pSrcList,
		FBStringList	pAvailableDstList,
		FBStringList	pDefaultDstList,
		FBStringList	pEffectiveDstList
	)

GetAssignSourcesToDestinationsInfo.

Returns the information about the current state of Sources to Destinations assignment. The pSrcList, pDefaultDstList & pEffectiveDstList parameters will all be of same size, each index being related to the same index in the other lists. The pAvailableDstList parameter can contains more item than the other lists.

Parameters

pSrcList	String list containing all the sources, will be filled by the method.
pAvailableDstList	String list containing all the available destinations, will be filled by the method.
pDefaultDstList	String list containing the default destinations (contains each string item that will be put back when pressing the 'Reset' button in the UI), will be filled by the method.
pEffectiveDstList	String list containing the effective destination (destinations currently active), will be filled by the method.

◆ GetReadOnly()

bool GetReadOnly ( )

GetReadOnly Retrieves the clip read-only status.

Returns: Returns the clip read-only status.

◆ GetSourceTimeFromDestinationTime()

FBTime GetSourceTimeFromDestinationTime	(	FBTime	pDestinationTime,
		int	pLoopNumber = `nullptr`
	)

Get the clip source time (internal time) from a destination time (local time).

Parameters

pDestinationTime	The destination time to convert.
pLoopNumber	The number of loops applied on the source time to match the destination time to convert. Optional. Will be filled by the method.

Returns: The clip source time matching the input destination time.

Python: The function takes only one parameter (pDestinationTime) and returns a Python tuple: (sourceTime, loopNumber). ex : lTuple = lClip.GetSourceTimeFromDestinationTime(lDestinationTime)

◆ MakeWritable()

bool MakeWritable ( )

MakeWritable.

Imports FCurves from story clip scene making them accessible for the user.

Returns: Returns true if successful.

◆ Match() [1/2]

Match ( )

Match.

Match the animation clip with the specified pivot property.

◆ Match() [2/2]

Match	(	str	pObjectName,
		FBStoryClipMatchingTimeType	pTimeType,
		FBStoryClipMatchingTranslationType	pTranslationType,
		FBStoryClipMatchingRotationType	pRotationType
	)

Match.

Match the animation clip to its previous/next animation clip, one to each other.

Parameters

pObjectName	The object name that specifies which part of the track content to use to match clips. If the object name is not valid, or empty, the match object will be disabled so that the blend does not take it into account when matching clips.
pTimeType	The time type specifying which point of a cross-blend the selected clip is matched.
pTranslationType	The translation type specifying if/how a clip's match object is translated to match another clip's animation.
pRotationType	The rotation type specifying if/how a clip's match object is rotated to match another clip's animation.

◆ Move()

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.

◆ MoveTo()

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.

◆ Razor()

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

◆ SetAssignSourcesToDestinationsInfo()

bool SetAssignSourcesToDestinationsInfo ( FBStringList pEffectiveDstList )

SetAssignSourcesToDestinationsInfo.

Sets the new effective destinations information for the Sources to Destinations assignment. The input string list size must contain the same number of items than the effective destination list returned by the GetAssignSourcesToDestinationsInfo method. Each item in the input string list must match an item in the available destination list returned by the GetAssignSourcesToDestinationsInfo method. The item at a given index of the input string list will be related to the same index of the sources list returned by the GetAssignSourcesToDestinationsInfo method.

Parameters

pEffectiveDstList String list containing the new effective destination.

Returns: Returns true if the assign succeeded, false otherwise.

◆ SetReadOnly()

bool SetReadOnly	(	bool	pMakeClipReadOnly,
		str	pOutputFile = `FBString()`
	)

SetReadOnly Assigns the clip read-only status.

Parameters

pMakeClipReadOnly	New read-only status
pOutputFile	Output file path name, when setting the clip's read-only status to true.

Returns: Returns true if successful.

◆ SetTime()

SetTime	(	FBTime	pSourceIn = `None`,
		FBTime	pSourceOut = `None`,
		FBTime	pDestinationIn = `None`,
		FBTime	pDestinationOut = `None`,
		bool	pUseAlternateSrcInProp = `False`
	)

SetTime Sets any in/out values for the source/destination times.

In and out values are optional and the current values for the story clip will be used if not supplied. The story "Speed" property will be adjusted in order for the supplied values to be respected by the story clip.

Parameters

pSourceIn	New value for the source IN time. Passing a value will modify the "MarkIn" and/or the "Speed" properties.
pSourceOut	New value for the source OUT time. Passing a value will modify the "MarkOut" and/or the "Speed" properties.
pDestinationIn	New value for the destination IN time. Passing a value will modify the "Stop" and/or the "Speed" properties.
pDestinationOut	New value for the destination OUT time. Passing a value will modify the "Start" and/or the "Speed" properties.
pUseAlternateSrcInProp	Will work on the "ExtractStart" property instead of the "MarkIn" property when passing pSourceIn.

◆ UpdateFromCurrentTake()

bool UpdateFromCurrentTake ( )

Update clip animation from current take animation for clip track's scope, works only for clip created by Insert Current Take and connected to current take.

Returns: Returns true if succeed.

Member Data Documentation

◆ AudioClip

FBAudioClip AudioClip

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

◆ AutoLoop

bool AutoLoop

Read Write Property: If true, clip will automatically loop

◆ ClipAnimationPath

str ClipAnimationPath

Read Write Property: Animation clip's file path

◆ ClipAudioPath

str ClipAudioPath

Read Write Property: Audio clip's file path

◆ ClipPitch

float ClipPitch

Read Write Property: The clip pitch value.

◆ ClipVideoPath

str ClipVideoPath

Read Write Property: Video clip's file path

◆ Color

FBColor Color

Read Write Property: Color of the clip.

◆ ConnectedToTake

bool ConnectedToTake

Read Write Property: When connected to current take, user can do updating from current take, but user can't edit clip animation by adding keys, only works for clips created by Insert Current Take.

◆ CustomTimeWarp

FBAnimationNode CustomTimeWarp

Read Only Property: Animation and Shot clip's custom TimeWarp FCurve.

◆ FrameRate

float FrameRate

Read Write Property: Frame rate value. Only effective when UseSystemFrameRate is false.

◆ Ghost

bool Ghost

Read Write Property: Show ghosts

◆ GhostCustomTime

FBTime GhostCustomTime

Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryClipTimeCustom.

◆ GhostManipulatorCustomTime

FBTime GhostManipulatorCustomTime

Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMode is kFBStoryClipGhostCustom.

◆ GhostManipulatorMode

FBStoryClipGhostTimeMode GhostManipulatorMode

Read Write Property: Time mode to display ghost manipulator. See FBStoryClipGhostTimeMode.

◆ GhostManipulatorOffset

FBVector3d GhostManipulatorOffset

Read Write Property: Animation clip's ghost manipulator offset.

◆ GhostModel

bool GhostModel

Read Write Property: Show ghost of models

◆ GhostPivot

bool GhostPivot

Read Write Property: Show ghost of match object

◆ GhostTravelling

bool GhostTravelling

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

◆ ImageSequence

bool ImageSequence

Read Write Property: Whether is a image sequence.

◆ Loaded

bool Loaded

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

◆ LockPitchToSpeed

bool LockPitchToSpeed

Read Write Property: Time-stretching enabled or not.

◆ Loop

bool Loop

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

◆ LoopTranslation

FBVector3d LoopTranslation

Read Write Property: Animation clip's loop translation.

◆ MarkIn

FBTime MarkIn

Read Write Property: Start time inside the clip.

◆ MarkOut

FBTime MarkOut

Read Write Property: Stop time inside the clip.

◆ MirrorAnimation

bool MirrorAnimation

Read Write Property: If true, clip animation will be mirrored

◆ MirrorPlane

FBStoryClipMirrorPlane MirrorPlane

Read Write Property: Several mirror planes to mirror animation. See FBStoryClipMirrorPlane

◆ Offset

FBTime Offset

Read Write Property: First loop time offset.

◆ OnChange

FBEvent OnChange

Event: Something in the clip has changed. (FBEventClip)

◆ Pivots

FBListPivot Pivots

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

◆ PostBlend

FBTimeSpan PostBlend

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

◆ PreBlend

FBTimeSpan PreBlend

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

◆ Rotation

FBVector3d Rotation

Read Write Property: Animation clip's rotation offset. Refer to class notes to learn more about how this is applied.

◆ Scale

float Scale

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

◆ ShotActionStart

FBTime ShotActionStart

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

◆ ShotActionStop

FBTime ShotActionStop

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

◆ ShotBackplate

FBVideo ShotBackplate

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

◆ ShotCamera

FBCamera ShotCamera

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

◆ ShotFrontplate

FBVideo ShotFrontplate

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

◆ ShotStartStopLocked

bool ShotStartStopLocked

Read Write Property: Shot clip's 'In/Out Locked' property value. True if the shot clip's In/Out properties (start/stop times of the clip local to its track) are locked, false otherwise.

◆ ShowBackplate

bool ShowBackplate

Read Write Property: Enable/Disable the shot backplate.

◆ ShowEmbeddedTimecode

K_DEPRECATED_2024 FBBool ShowEmbeddedTimecode

Read Write Property: Whether to show the embedded timecode (real, if available, or custom) of the video.

◆ ShowFrontplate

bool ShowFrontplate

Read Write Property: Enable/Disable the shot frontplate.

◆ ShowGhostClipMode

FBStoryClipShowGhostMode ShowGhostClipMode

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

◆ SolvingMode

FBStoryClipSolveMode SolvingMode

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

◆ Speed

float Speed

Read Write Property: Speed of the clip.

◆ Start

FBTime Start

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

◆ StartStopLocked

bool StartStopLocked

Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (start/stop times of the clip local to its track) are locked, false otherwise.

◆ Stop

FBTime Stop

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

◆ TimeWarpEnabled

bool TimeWarpEnabled

Read Write Property: Animation and Shot clip's TimeWarp activeness.

◆ TimeWarpInterpolatorType

FBStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType

Read Write Property: Animation and Shot clip's TimeWarp interpolation type. See FBStoryClipTimeWarpInterpolatorType.

◆ TimeWarpReverse

bool TimeWarpReverse

Read Write Property: If true, reverse the Animation or Shot clip's TimeWarp FCurve.

◆ Translation

FBVector3d Translation

Read Write Property: Animation clip's translation offset. Refer to class notes to learn more about how this is applied.

◆ TravellingNode

FBListObject TravellingNode

List: Travelling node(s). If set, this property will overwrite the Track's Travelling node(s).

◆ TravellingNodeFunction

FBStoryClipNodeFunction TravellingNodeFunction

Read Write Property: Travelling node function. If set, this property will overwrite the Track's Travelling node function. See FBStoryClipNodeFunction.

◆ UseSystemFrameRate

bool UseSystemFrameRate

Read Write Property: Whether always use system frame rate.

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FBStoryClip() [1/3]

◆ FBStoryClip() [2/3]

◆ FBStoryClip() [3/3]

Member Function Documentation

◆ CanAssignSourcesToDestinations()

◆ Clone()

◆ DestinationSetObject()

◆ ExportToFile()

◆ FBDelete()

◆ GetAffectedAnimationNodes()

◆ GetAffectedObjects()

◆ GetAssignSourcesToDestinationsInfo() [1/2]

◆ GetAssignSourcesToDestinationsInfo() [2/2]

◆ GetReadOnly()

◆ GetSourceTimeFromDestinationTime()

◆ MakeWritable()

◆ Match() [1/2]

◆ Match() [2/2]

◆ Move()

◆ MoveTo()

◆ Razor()

◆ SetAssignSourcesToDestinationsInfo()

◆ SetReadOnly()

◆ SetTime()

◆ UpdateFromCurrentTake()

Member Data Documentation

◆ AudioClip

◆ AutoLoop

◆ ClipAnimationPath

◆ ClipAudioPath

◆ ClipPitch

◆ ClipVideoPath

◆ Color

◆ ConnectedToTake

◆ CustomTimeWarp

◆ FrameRate

◆ Ghost

◆ GhostCustomTime

◆ GhostManipulatorCustomTime

◆ GhostManipulatorMode

◆ GhostManipulatorOffset

◆ GhostModel

◆ GhostPivot

◆ GhostTravelling

◆ ImageSequence

◆ Loaded

◆ LockPitchToSpeed

◆ Loop

◆ LoopTranslation

◆ MarkIn

◆ MarkOut

◆ MirrorAnimation

◆ MirrorPlane

◆ Offset

◆ OnChange

◆ Pivots

◆ PostBlend

◆ PreBlend

◆ Rotation

◆ Scale

◆ ShotActionStart

◆ ShotActionStop

◆ ShotBackplate

◆ ShotCamera

◆ ShotFrontplate

◆ ShotStartStopLocked

◆ ShowBackplate

◆ ShowEmbeddedTimecode

◆ ShowFrontplate

◆ ShowGhostClipMode

◆ SolvingMode

◆ Speed

◆ Start

◆ StartStopLocked

◆ Stop

◆ TimeWarpEnabled