#include <mobu-python-api.h>

Class Description

Story Folder class.

With folders, you can group tracks together and create different timelines.

Inheritance diagram for FBStoryFolder:

Public Member Functions
	__reduce__ ()

	__init__ (object arg1, FBStoryFolder arg2)
	Constructor. More...

	FBDelete (FBStoryFolder arg1)
	Virtual FBDelete function. More...

	Load (FBStoryFolder arg1, object arg2)
	Allow to load/unload all story clips under this folder. More...

	ExpandSelectedClips (FBStoryFolder arg1, object arg2)
	Used to expand selected clips . More...

	ExpandSelectedClipsGroup (FBStoryFolder arg1, object arg2)
	ExpandSelectedClipsGroup Used to expand group clip dependent clips. More...

	AlignSelectedClips (FBStoryFolder arg1, FBStoryClipAlignmentType arg2, FBComponent arg3)
	Used to align selected clips . More...

	AlignSelectedClipsGroup (FBStoryFolder arg1, FBStoryGroupClipAlignmentType arg2)
	Used to align clips inside a group. More...

	ConvertClipsToReadOnly (FBStoryFolder arg1, object arg2, str arg3)
	Convert all clips to read-only clips. 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
ORSDK2018::FBPropertyListStoryFolder	Childs
	List: Children folders of this folder. More...

ORSDK2018::FBPropertyString	Label
	Read Write Property: Label to display for this story folder. More...

FBPropertyBool	Mute
	Read Write Property: If true, this story folder will be muted. More...

FBPropertyStoryFolder	Parent
	Read Only Property: Object pointing to the folder's parent. More...

FBPropertyBool	Solo
	Read Write Property: If true, this story folder will be the only one to play. More...

FBPropertyBool	Collapsed
	Read Write Property: Toggle to collapse or expand the story folder. More...

ORSDK2018::FBPropertyString	RecordClipPath
	Read Write Property: Path for story recording. More...

ORSDK2018::FBPropertyListStoryTrack	Tracks
	List: Tracks of this folder. 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__	(	object	arg1,
		FBStoryFolder	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1 [, (FBStoryFolder)arg2]) -> None

C++ Signature:

 FBStoryFolder(ORSDK2018::FBStoryFolder * pParentFolder = ((void *) 0), HIObject pObject = ((void *) 0))

Parameters

pParentFolder	If NULL, parent will be the global root folder, according to its type.
pObject	For internal use only.

Remarks: You can't create a folder with the RootEditFolder as parent.

See the C++ reference

__reduce__ ( )

AlignSelectedClips	(	FBStoryFolder	arg1,
		FBStoryClipAlignmentType	arg2,
		FBComponent	arg3
	)

Used to align selected clips .

Python Docstring:

AlignSelectedClips( (FBStoryFolder)arg1, (FBStoryClipAlignmentType)arg2, (FBComponent)arg3) -> None

C++ Signature:

void AlignSelectedClips(FBStoryClipAlignmentType pType, ORSDK2018::FBComponent * pReferenceClip)

Parameters

pType	Type of alignment that will be done.
pReferenceClip	Needed when kFBStoryClipAlignmentEndPreviousAllAligned, kFBStoryClipAlignmentBeginningNextAllAligned or kFBStoryClipAlignmentCurrentTimelineWithOffset are used.

See the C++ reference

AlignSelectedClipsGroup	(	FBStoryFolder	arg1,
		FBStoryGroupClipAlignmentType	arg2
	)

Used to align clips inside a group.

Python Docstring:

AlignSelectedClipsGroup( (FBStoryFolder)arg1, (FBStoryGroupClipAlignmentType)arg2) -> None

C++ Signature:

void AlignSelectedClipsGroup(FBStoryGroupClipAlignmentType pType)

Parameters

pType Type of alignment that will be done.

See the C++ reference

ConvertClipsToReadOnly	(	FBStoryFolder	arg1,
		object	arg2,
		str	arg3
	)

Convert all clips to read-only clips.

Python Docstring:

ConvertClipsToReadOnly( (FBStoryFolder)arg1, (object)arg2, (str)arg3) -> None

C++ Signature:

void ConvertClipsToReadOnly(bool pSelected, char * pFilePath)

Identical clips are replaced by the same read-only clip.

Parameters

pSelected	Only selected clip will be converted.
pFilePath	Folder path where the read-only clips will be saved.

Remarks: Currently only animation clips are supported in the Root Folder

See the C++ reference

ExpandSelectedClips	(	FBStoryFolder	arg1,
		object	arg2
	)

Used to expand selected clips .

Python Docstring:

ExpandSelectedClips( (FBStoryFolder)arg1, (object)arg2) -> None

C++ Signature:

void ExpandSelectedClips(bool pPreserveOverlap)

Parameters

pPreserveOverlap If true, portion of clips that overlap other clips won't be modified.

See the C++ reference

ExpandSelectedClipsGroup	(	FBStoryFolder	arg1,
		object	arg2
	)

ExpandSelectedClipsGroup Used to expand group clip dependent clips.

Python Docstring:

ExpandSelectedClipsGroup( (FBStoryFolder)arg1, (object)arg2) -> None

C++ Signature:

void ExpandSelectedClipsGroup(bool pPreserveOverlap)

Parameters

pPreserveOverlap If true, portion of clips that overlap other clips won't be modified.

See the C++ reference

FBDelete ( FBStoryFolder arg1 )

Virtual FBDelete function.

Python Docstring:

FBDelete( (FBStoryFolder)arg1) -> None

C++ Signature:

void FBDelete()

See the C++ reference

Load	(	FBStoryFolder	arg1,
		object	arg2
	)

Allow to load/unload all story clips under this folder.

Python Docstring:

Load( (FBStoryFolder)arg1, (object)arg2) -> None

C++ Signature:

void Load(bool pLoad)

Remarks: Currently only animation clips are supported.

See the C++ reference

Member Data Documentation

ORSDK2018::FBPropertyListStoryFolder Childs

List: Children folders of this folder.

See the C++ reference

FBPropertyBool Collapsed

Read Write Property: Toggle to collapse or expand the story folder.

See the C++ reference

ORSDK2018::FBPropertyString Label

Read Write Property: Label to display for this story folder.

See the C++ reference

FBPropertyBool Mute

Read Write Property: If true, this story folder will be muted.

See the C++ reference

FBPropertyStoryFolder Parent

Read Only Property: Object pointing to the folder's parent.

See the C++ reference

ORSDK2018::FBPropertyString RecordClipPath

Read Write Property: Path for story recording.

Can be relative or full path.

See the C++ reference

FBPropertyBool Solo

Read Write Property: If true, this story folder will be the only one to play.

See the C++ reference

ORSDK2018::FBPropertyListStoryTrack Tracks

List: Tracks of this folder.

See the C++ reference

FBStoryFolder Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation