FBStoryClip Class Reference

#include <mobu-python-api.h>

Class 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 the C++ reference

Inheritance diagram for FBStoryClip:

Public Member Functions
	__reduce__ ()
	__init__ (...)
bool	ExportToFile (FBStoryClip arg1, str arg2)
	ExportToFile. More...
	FBDelete (FBStoryClip arg1)
	Virtual FBDelete function. More...
object	Clone (FBStoryClip arg1)
	Clone the clip. More...
list	GetAffectedAnimationNodes (FBStoryClip arg1, FBComponent arg2)
	GetAffectedAnimationNodes. More...
list	GetAffectedObjects (FBStoryClip arg1)
	GetAffectedObjects. More...
bool	DestinationSetObject (FBStoryClip arg1, str arg2, FBComponent arg3)
	Assign source to destination if the pSrcName is found in source list and pObject is in the Details list. More...
bool	CanAssignSourcesToDestinations (FBStoryClip arg1)
	CanAssignSourcesToDestinations. More...
tuple	GetAssignSourcesToDestinationsInfo (FBStoryClip arg1)
	GetAssignSourcesToDestinationsInfo. More...
bool	SetAssignSourcesToDestinationsInfo (FBStoryClip arg1, list arg2)
	SetAssignSourcesToDestinationsInfo. More...
	Match (...)
bool	MakeWritable (FBStoryClip arg1)
	MakeWritable. More...
FBTime	Move (FBStoryClip arg1, FBTime arg2, object arg3)
	Move. More...
FBTime	MoveTo (FBStoryClip arg1, FBTime arg2, object arg3)
	MoveTo. More...
object	Razor (FBStoryClip arg1, FBTime arg2)
	Razor. More...
	SetTime (FBStoryClip arg1, FBTime arg2, FBTime arg3, FBTime arg4, FBTime arg5, object arg6)
	SetTime Sets any in/out values for the source/destination times. More...
bool	GetReadOnly (FBStoryClip arg1)
	GetReadOnly Retrieves the clip read-only status. More...
bool	SetReadOnly (FBStoryClip arg1, object arg2, str arg3)
	SetReadOnly Assigns the clip read-only status. More...
bool	UpdateFromCurrentTake (FBStoryClip arg1)
	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. More...
Public Member Functions inherited from FBComponent
	__reduce__ ()
FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...
str	ClassName (FBComponent arg1)
	Get the class name. More...
	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...
	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...
bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...
	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...
	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...
FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...
bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...
bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...
bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...
bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...
bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...
int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...
bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...
object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...
	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...
	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...
	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...
	HardSelect (FBComponent arg1)
	HardSelect. More...
object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...
	__init__ (...)
	Constructor. More...
Public Member Functions inherited from FBPlug
	__reduce__ ()
bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...
str	ClassName (FBPlug arg1)
	internal System vars. More...
bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...
bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...
bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...
bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...
	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...
	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...
bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...
bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...
bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...
bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...
	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...
object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...
int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...
FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...
object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...
int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...
object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...
object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...
int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...
FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...
bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...
bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...
	MoveSrcAt (...)
bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...
bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...
bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...
	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...
bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...
	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...
bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...
int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...
bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...
	__init__ (...)
method	staticmethod (function)
Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()
	__init__ (...)

Public Attributes
FBPropertyBool	AutoLoop
	Read Write Property: If true, clip will automatically loop More...
FBPropertyColor	Color
	Read Write Property: Color of the clip. More...
FBPropertyBool	Loaded
	Read Write Property: If true, clip file is loaded into memory and can be evaluated (will affect track content). More...
FBPropertyBool	Ghost
	Read Write Property: Show ghosts More...
FBPropertyBool	GhostModel
	Read Write Property: Show ghost of models More...
FBPropertyBool	GhostPivot
	Read Write Property: Show ghost of match object More...
FBPropertyBool	GhostTravelling
	Read Write Property: Show ghost of clip vector or traveling node More...
FBPropertyBool	Loop
	Read Write Property: If true, loop clip's animation More...
FBPropertyVector3d	LoopTranslation
	Read Write Property: Animation clip's loop translation. More...
FBPropertyVector3d	GhostManipulatorOffset
	Read Write Property: Animation clip's ghost manipulator offset. More...
ORSDK2018::FBPropertyListObject	TravellingNode
	List: Travelling node(s). More...
FBPropertyStoryClipNodeFunction	TravellingNodeFunction
	Read Write Property: Travelling node function. More...
FBPropertyStoryClipGhostTimeMode	GhostManipulatorMode
	Read Write Property: Time mode to display ghost manipulator. More...
FBPropertyTime	GhostManipulatorCustomTime
	Read Write Property: Custom time to display ghost manipulator, only applicable if GhostManipulatorMode is kFBStoryClipGhostCustom. More...
FBPropertyTime	MarkIn
	Read Write Property: Start time inside the clip. More...
FBPropertyTime	MarkOut
	Read Write Property: Stop time inside the clip. More...
FBPropertyTime	Offset
	Read Write Property: First loop time offset. More...
ORSDK2018::FBPropertyListPivot	Pivots
	List: Pivots models (Generally, only one model is necessary) More...
FBPropertyTimeSpan	PostBlend
	Read Write Property: Start/Stop time of the post-blend phase. More...
FBPropertyTimeSpan	PreBlend
	Read Write Property: Start/Stop time of the pre-blend phase. More...
FBPropertyVector3d	Rotation
	Read Write Property: Animation clip's rotation offset. More...
FBPropertyDouble	Scale
	Read Write Property: Animation clip's scaling (some don't support this property) More...
FBPropertyTime	ShotActionStart
	Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property. More...
FBPropertyTime	ShotActionStop
	Read Write Property: If not in locked shot mode (time discontinuity enabled), this time can be different from the Clip->Start property. More...
FBPropertyVideo	ShotBackplate
	Read Write Property: The backplate used for that specific shot. More...
FBPropertyVideo	ShotFrontplate
	Read Write Property: The frontplate used for that specific shot. More...
FBPropertyCamera	ShotCamera
	Read Write Property: The camera used for that specific shot. More...
FBPropertyBool	ShowBackplate
	Read Write Property: Enable/Disable the shot backplate. More...
FBPropertyBool	ShowFrontplate
	Read Write Property: Enable/Disable the shot frontplate. More...
FBPropertyStoryClipShowGhostMode	ShowGhostClipMode
	Read Write Property: Show the ghost depending on the time. More...
FBPropertyTime	GhostCustomTime
	Read Write Property: Custom time to display ghost, only applicable if ShowGhostClipMode is kFBStoryClipTimeCustom. More...
FBPropertyStoryClipSolveMode	SolvingMode
	Read Write Property: Solve Modes for story character clips. More...
FBPropertyDouble	Speed
	Read Write Property: Speed of the clip. More...
FBPropertyTime	Start
	Read Write Property: Start time of the clip local to its track. More...
FBPropertyTime	Stop
	Read Write Property: Stop time of the clip local to its track. More...
FBPropertyVector3d	Translation
	Read Write Property: Animation clip's translation offset. More...
FBPropertyAudioClip	AudioClip
	Read Only Property: The audio clip used by this StoryClip. More...
ORSDK2018::FBPropertyEvent	OnChange
	Event: Something in the clip has changed. More...
FBPropertyBool	TimeWarpEnabled
	Read Write Property: Animation clip's TimeWarp activeness. More...
FBPropertyStoryClipTimeWarpInterpolatorType	TimeWarpInterpolatorType
	Read Write Property: Animation clip's TimeWarp interpolation type. More...
FBPropertyBool	TimeWarpReverse
	Read Write Property: If true, reverse the Animation clip's TimeWarp FCurve. More...
FBPropertyAnimationNode	CustomTimeWarp
	Read Only Property: Animation clip's custom TimeWarp FCurve. More...
FBPropertyDouble	ClipPitch
	Read Write Property: The clip pitch value. More...
FBPropertyBool	LockPitchToSpeed
	Read Write Property: Time-stretching enabled or not. More...
FBPropertyBool	ImageSequence
	Read Write Property: Whether is a image sequence. More...
FBPropertyBool	UseSystemFrameRate
	Read Write Property: Whether always use system frame rate. More...
FBPropertyDouble	FrameRate
	Read Write Property: Frame rate value. More...
object	ShowEmbeddedTimecode
ORSDK2018::FBPropertyString	ClipAnimationPath
	Read Write Property: Animation clip's file path More...
ORSDK2018::FBPropertyString	ClipAudioPath
	Read Write Property: Audio clip's file path More...
ORSDK2018::FBPropertyString	ClipVideoPath
	Read Write Property: Video clip's file path More...
FBPropertyBool	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. More...
FBPropertyBool	MirrorAnimation
	Read Write Property: If true, clip animation will be mirrored More...
FBPropertyStoryClipMirrorPlane	MirrorPlane
	Read Write Property: Several mirror planes to mirror animation. More...
Public Attributes inherited from FBComponent
object	OwnerNamespace
ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...
ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...
ORSDK2018::FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...
object	FullName
ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...
ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...
FBPropertyBool	Selected
	Read Write Property: Selected property. More...
Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__

(

...

)

Python Docstring:

__init__( (object)arg1, (FBComponent)arg2, (FBStoryTrack)arg3, (FBTime)arg4) -> None

__init__( (object)arg1, (str)arg2, (FBStoryTrack)arg3, (FBTime)arg4) -> None

__init__( (object)arg1, (str)arg2, (FBStoryTrack)arg3, (FBTime)arg4, (FBTime)arg5) -> None 

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

 FBStoryClip(ORSDK2018::FBComponent * pClipObject, ORSDK2018::FBStoryTrack * pTrack, ORSDK2018::FBTime pTime, HIObject pObject = ((void *) 0))
 FBStoryClip(const char * pFilePath, ORSDK2018::FBStoryTrack * pTrack, ORSDK2018::FBTime pTime, HIObject pObject = ((void *) 0))
 FBStoryClip(const char * pFilePath, ORSDK2018::FBStoryTrack * pTrack, ORSDK2018::FBTime pTime, ORSDK2018::FBTime pTimeOffset, HIObject pObject = ((void *) 0))

__reduce__

(

)

bool CanAssignSourcesToDestinations

(

FBStoryClip

arg1

)

CanAssignSourcesToDestinations.

Python Docstring:

CanAssignSourcesToDestinations( (FBStoryClip)arg1) -> bool 

C++ Signature:

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

See the C++ reference

object Clone

(

FBStoryClip

arg1

)

Clone the clip.

Python Docstring:

Clone( (FBStoryClip)arg1) -> object 

C++ Signature:

ORSDK2018::FBStoryClip * Clone() 

See the C++ reference

bool DestinationSetObject	(	FBStoryClip	arg1,
		str	arg2,
		FBComponent	arg3
	)

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

Python Docstring:

DestinationSetObject( (FBStoryClip)arg1, (str)arg2, (FBComponent)arg3) -> bool 

C++ Signature:

bool DestinationSetObject(const char * pSrcName, ORSDK2018::FBComponent * pObject) 

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.

See the C++ reference

bool ExportToFile	(	FBStoryClip	arg1,
		str	arg2
	)

ExportToFile.

Python Docstring:

ExportToFile( (FBStoryClip)arg1, (str)arg2) -> bool 

C++ Signature:

bool ExportToFile(ORSDK2018::FBString pOutputFile) 

Export animation clip to disk file.

Parameters

pOutputFile

Output file path name.

Returns

Returns true if successful.

See the C++ reference

FBDelete

(

FBStoryClip

arg1

)

Virtual FBDelete function.

Python Docstring:

FBDelete( (FBStoryClip)arg1) -> None 

C++ Signature:

void FBDelete() 

See the C++ reference

list GetAffectedAnimationNodes	(	FBStoryClip	arg1,
		FBComponent	arg2
	)

GetAffectedAnimationNodes.

Python Docstring:

GetAffectedAnimationNodes( (FBStoryClip)arg1, (FBComponent)arg2) -> list 

C++ Signature:

void GetAffectedAnimationNodes(ORSDK2018::FBArrayTemplate< ORSDK2018::FBAnimationNode * > * pAffectedAnimationNodes, ORSDK2018::FBComponent * pClipObject) 

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

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

See the C++ reference

list GetAffectedObjects

(

FBStoryClip

arg1

)

GetAffectedObjects.

Python Docstring:

GetAffectedObjects( (FBStoryClip)arg1) -> list 

C++ Signature:

void GetAffectedObjects(ORSDK2018::FBArrayTemplate< ORSDK2018::FBComponent * > * pAffectedObjects) 

Get the list of objects affected by this story clip.

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

See the C++ reference

tuple GetAssignSourcesToDestinationsInfo

(

FBStoryClip

arg1

)

GetAssignSourcesToDestinationsInfo.

Python Docstring:

GetAssignSourcesToDestinationsInfo( (FBStoryClip)arg1) -> tuple 

C++ Signature:

void GetAssignSourcesToDestinationsInfo(ORSDK2018::FBStringList & pSrcList, ORSDK2018::FBStringList & pAvailableDstList, ORSDK2018::FBStringList & pDefaultDstList, ORSDK2018::FBStringList & pEffectiveDstList) 

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.

See the C++ reference

bool GetReadOnly

(

FBStoryClip

arg1

)

GetReadOnly Retrieves the clip read-only status.

Python Docstring:

GetReadOnly( (FBStoryClip)arg1) -> bool 

C++ Signature:

bool GetReadOnly() 

Returns

Returns the clip read-only status.

See the C++ reference

bool MakeWritable

(

FBStoryClip

arg1

)

MakeWritable.

Python Docstring:

MakeWritable( (FBStoryClip)arg1) -> bool 

C++ Signature:

bool MakeWritable() 

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

Returns

Returns true if successful.

See the C++ reference

Match

(

...

)

Python Docstring:

Match( (FBStoryClip)arg1) -> None

Match( (FBStoryClip)arg1, (str)arg2, (FBStoryClipMatchingTimeType)arg3, (FBStoryClipMatchingTranslationType)arg4, (FBStoryClipMatchingRotationType)arg5) -> None 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

void Match()
void Match(ORSDK2018::FBString pObjectName, FBStoryClipMatchingTimeType pTimeType, FBStoryClipMatchingTranslationType pTranslationType, FBStoryClipMatchingRotationType pRotationType)

FBTime Move	(	FBStoryClip	arg1,
		FBTime	arg2,
		object	arg3
	)

Move.

Python Docstring:

Move( (FBStoryClip)arg1, (FBTime)arg2, (object)arg3) -> FBTime 

C++ Signature:

ORSDK2018::FBTime Move(ORSDK2018::FBTime pDelta, bool pForce = true) 

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.

See the C++ reference

FBTime MoveTo	(	FBStoryClip	arg1,
		FBTime	arg2,
		object	arg3
	)

MoveTo.

Python Docstring:

MoveTo( (FBStoryClip)arg1, (FBTime)arg2, (object)arg3) -> FBTime 

C++ Signature:

ORSDK2018::FBTime MoveTo(ORSDK2018::FBTime pTime, bool pForce = true) 

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.

See the C++ reference

object Razor	(	FBStoryClip	arg1,
		FBTime	arg2
	)

Razor.

Python Docstring:

Razor( (FBStoryClip)arg1, (FBTime)arg2) -> object 

C++ Signature:

ORSDK2018::FBStoryClip * Razor(ORSDK2018::FBTime pTime) 

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

See the C++ reference

bool SetAssignSourcesToDestinationsInfo	(	FBStoryClip	arg1,
		list	arg2
	)

SetAssignSourcesToDestinationsInfo.

Python Docstring:

SetAssignSourcesToDestinationsInfo( (FBStoryClip)arg1, (list)arg2) -> bool 

C++ Signature:

bool SetAssignSourcesToDestinationsInfo(ORSDK2018::FBStringList & pEffectiveDstList) 

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.

See the C++ reference

bool SetReadOnly	(	FBStoryClip	arg1,
		object	arg2,
		str	arg3
	)

SetReadOnly Assigns the clip read-only status.

Python Docstring:

SetReadOnly( (FBStoryClip)arg1, (object)arg2 [, (str)arg3]) -> bool 

C++ Signature:

bool SetReadOnly(bool pMakeClipReadOnly, ORSDK2018::FBString pOutputFile = FBString()) 

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.

See the C++ reference

SetTime	(	FBStoryClip	arg1,
		FBTime	arg2,
		FBTime	arg3,
		FBTime	arg4,
		FBTime	arg5,
		object	arg6
	)

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

Python Docstring:

SetTime( (FBStoryClip)arg1, (FBTime)arg2, (FBTime)arg3, (FBTime)arg4, (FBTime)arg5, (object)arg6) -> None 

C++ Signature:

void SetTime(ORSDK2018::FBTime * pSourceIn = ((void *) 0), ORSDK2018::FBTime * pSourceOut = ((void *) 0), ORSDK2018::FBTime * pDestinationIn = ((void *) 0), ORSDK2018::FBTime * pDestinationOut = ((void *) 0), bool pUseAlternateSrcInProp = false) 

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.

See the C++ reference

bool UpdateFromCurrentTake

(

FBStoryClip

arg1

)

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.

Python Docstring:

UpdateFromCurrentTake( (FBStoryClip)arg1) -> bool 

C++ Signature:

bool UpdateFromCurrentTake() 

Returns

Returns true if succeed.

See the C++ reference

Member Data Documentation

FBPropertyAudioClip AudioClip

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

See the C++ reference

FBPropertyBool AutoLoop

Read Write Property: If true, clip will automatically loop

See the C++ reference

ORSDK2018::FBPropertyString ClipAnimationPath

Read Write Property: Animation clip's file path

See the C++ reference

ORSDK2018::FBPropertyString ClipAudioPath

Read Write Property: Audio clip's file path

See the C++ reference

FBPropertyDouble ClipPitch

Read Write Property: The clip pitch value.

See the C++ reference

ORSDK2018::FBPropertyString ClipVideoPath

Read Write Property: Video clip's file path

See the C++ reference

FBPropertyColor Color

Read Write Property: Color of the clip.

See the C++ reference

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

See the C++ reference

FBPropertyAnimationNode CustomTimeWarp

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

See the C++ reference

FBPropertyDouble FrameRate

Read Write Property: Frame rate value.

Only effective when UseSystemFrameRate is false.

See the C++ reference

FBPropertyBool Ghost

Read Write Property: Show ghosts

See the C++ reference

FBPropertyTime GhostCustomTime

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

See the C++ reference

FBPropertyTime GhostManipulatorCustomTime

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

See the C++ reference

FBPropertyStoryClipGhostTimeMode GhostManipulatorMode

Read Write Property: Time mode to display ghost manipulator.

See FBStoryClipGhostTimeMode.

See the C++ reference

FBPropertyVector3d GhostManipulatorOffset

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

See the C++ reference

FBPropertyBool GhostModel

Read Write Property: Show ghost of models

See the C++ reference

FBPropertyBool GhostPivot

Read Write Property: Show ghost of match object

See the C++ reference

FBPropertyBool GhostTravelling

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

See the C++ reference

FBPropertyBool ImageSequence

Read Write Property: Whether is a image sequence.

See the C++ reference

FBPropertyBool Loaded

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

See the C++ reference

FBPropertyBool LockPitchToSpeed

Read Write Property: Time-stretching enabled or not.

See the C++ reference

FBPropertyBool Loop

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

See the C++ reference

FBPropertyVector3d LoopTranslation

Read Write Property: Animation clip's loop translation.

See the C++ reference

FBPropertyTime MarkIn

Read Write Property: Start time inside the clip.

See the C++ reference

FBPropertyTime MarkOut

Read Write Property: Stop time inside the clip.

See the C++ reference

FBPropertyBool MirrorAnimation

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

See the C++ reference

FBPropertyStoryClipMirrorPlane MirrorPlane

Read Write Property: Several mirror planes to mirror animation.

See FBStoryClipMirrorPlane

See the C++ reference

FBPropertyTime Offset

Read Write Property: First loop time offset.

See the C++ reference

ORSDK2018::FBPropertyEvent OnChange

Event: Something in the clip has changed.

(FBEventClip)

See the C++ reference

ORSDK2018::FBPropertyListPivot Pivots

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

See the C++ reference

FBPropertyTimeSpan PostBlend

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

See the C++ reference

FBPropertyTimeSpan PreBlend

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

See the C++ reference

FBPropertyVector3d Rotation

Read Write Property: Animation clip's rotation offset.

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

See the C++ reference

FBPropertyDouble Scale

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

See the C++ reference

FBPropertyTime ShotActionStart

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

See the C++ reference

FBPropertyTime ShotActionStop

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

See the C++ reference

FBPropertyVideo ShotBackplate

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

See the C++ reference

FBPropertyCamera ShotCamera

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

See the C++ reference

FBPropertyVideo ShotFrontplate

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

See the C++ reference

FBPropertyBool ShowBackplate

Read Write Property: Enable/Disable the shot backplate.

See the C++ reference

object ShowEmbeddedTimecode

FBPropertyBool ShowFrontplate

Read Write Property: Enable/Disable the shot frontplate.

See the C++ reference

FBPropertyStoryClipShowGhostMode ShowGhostClipMode

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

See FBStoryClipShowGhostMode

See the C++ reference

FBPropertyStoryClipSolveMode SolvingMode

Read Write Property: Solve Modes for story character clips.

See FBStoryClipSolveMode

See the C++ reference

FBPropertyDouble Speed

Read Write Property: Speed of the clip.

See the C++ reference

FBPropertyTime Start

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

See the C++ reference

FBPropertyTime Stop

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

See the C++ reference

FBPropertyBool TimeWarpEnabled

Read Write Property: Animation clip's TimeWarp activeness.

See the C++ reference

FBPropertyStoryClipTimeWarpInterpolatorType TimeWarpInterpolatorType

Read Write Property: Animation clip's TimeWarp interpolation type.

See FBStoryClipTimeWarpInterpolatorType.

See the C++ reference

FBPropertyBool TimeWarpReverse

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

See the C++ reference

FBPropertyVector3d Translation

Read Write Property: Animation clip's translation offset.

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

See the C++ reference

ORSDK2018::FBPropertyListObject TravellingNode

List: Travelling node(s).

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

See the C++ reference

FBPropertyStoryClipNodeFunction TravellingNodeFunction

Read Write Property: Travelling node function.

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

See the C++ reference

FBPropertyBool UseSystemFrameRate

Read Write Property: Whether always use system frame rate.

See the C++ reference