Story Folder class. More...
#include <pyfbsdk_generated.h>
Public Member Functions | |
FBStoryFolder (FBStoryFolder pParentFolder=None) | |
Constructor. | |
AlignSelectedClips (FBStoryClipAlignmentType pType, FBComponent pReferenceClip) | |
Used to align selected clips . | |
AlignSelectedClipsGroup (FBStoryGroupClipAlignmentType pType) | |
Used to align clips inside a group. | |
ConvertClipsToReadOnly (bool pSelected, str pFilePath) | |
Convert all clips to read-only clips. | |
ExpandSelectedClips (bool pPreserveOverlap) | |
Used to expand selected clips . | |
ExpandSelectedClipsGroup (bool pPreserveOverlap) | |
ExpandSelectedClipsGroup Used to expand group clip dependent clips. | |
FBDelete () | |
Virtual FBDelete function. | |
Load (bool pLoad) | |
Allow to load/unload all story clips under this folder. | |
![]() | |
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 | |
FBListStoryFolder | Childs |
List: Children folders of this folder. | |
bool | Collapsed |
Read Write Property: Toggle to collapse or expand the story folder. | |
str | Label |
Read Write Property: Label to display for this story folder. | |
bool | Mute |
Read Write Property: If true, this story folder will be muted. | |
FBStoryFolder | Parent |
Read Only Property: Object pointing to the folder's parent. | |
str | RecordClipPath |
Read Write Property: Path for story recording. Can be relative or full path. | |
bool | Solo |
Read Write Property: If true, this story folder will be the only one to play. | |
FBListStoryTrack | Tracks |
List: Tracks of this folder. | |
![]() | |
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. | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
Story Folder class.
With folders, you can group tracks together and create different timelines.
FBStoryFolder | ( | FBStoryFolder | pParentFolder = None | ) |
Constructor.
pParentFolder | If NULL, parent will be the global root folder, according to its type. |
AlignSelectedClips | ( | FBStoryClipAlignmentType | pType, |
FBComponent | pReferenceClip | ||
) |
Used to align selected clips .
pType | Type of alignment that will be done. |
pReferenceClip | Needed when kFBStoryClipAlignmentEndPreviousAllAligned, kFBStoryClipAlignmentBeginningNextAllAligned or kFBStoryClipAlignmentCurrentTimelineWithOffset are used. |
AlignSelectedClipsGroup | ( | FBStoryGroupClipAlignmentType | pType | ) |
Used to align clips inside a group.
pType | Type of alignment that will be done. |
Convert all clips to read-only clips.
Identical clips are replaced by the same read-only clip.
pSelected | Only selected clip will be converted. |
pFilePath | Folder path where the read-only clips will be saved. |
ExpandSelectedClips | ( | bool | pPreserveOverlap | ) |
Used to expand selected clips .
pPreserveOverlap | If true, portion of clips that overlap other clips won't be modified. |
ExpandSelectedClipsGroup | ( | bool | pPreserveOverlap | ) |
ExpandSelectedClipsGroup Used to expand group clip dependent clips.
pPreserveOverlap | If true, portion of clips that overlap other clips won't be modified. |
FBDelete | ( | ) |
Virtual FBDelete function.
Load | ( | bool | pLoad | ) |
Allow to load/unload all story clips under this folder.
FBListStoryFolder Childs |
List: Children folders of this folder.
bool Collapsed |
Read Write Property: Toggle to collapse or expand the story folder.
str Label |
Read Write Property: Label to display for this story folder.
bool Mute |
Read Write Property: If true, this story folder will be muted.
FBStoryFolder Parent |
Read Only Property: Object pointing to the folder's parent.
str RecordClipPath |
Read Write Property: Path for story recording. Can be relative or full path.
bool Solo |
Read Write Property: If true, this story folder will be the only one to play.
FBListStoryTrack Tracks |
List: Tracks of this folder.