FBStoryFolder Class Reference
Detailed Description
Story Folder class.
With folders, you can group tracks together and create different timelines.
Inheritance diagram for FBStoryFolder:
Public Member Functions |
|
| __init__ (HFBStoryFolder pParentFolder=None, object pObject=None) | |
| Constructor. |
|
| FBDelete () | |
| Virtual FBDelete function. |
|
| Load (bool pLoad) | |
| Allow to load/unload all story clips under
this folder. |
|
Public Attributes |
|
| FBPropertyString | Label |
| Read Write Property: Label to display
for this story folder. |
|
| FBPropertyBase | Solo |
| Read Write Property: If true, this
story folder will be the only one to play. |
|
| FBPropertyBase | Mute |
| Read Write Property: If true, this
story folder will be muted. |
|
| FBPropertyString | RecordClipPath |
| Read Write Property: Path for story
recording. |
|
| FBPropertyStoryFolder | Parent |
| Read Only Property: Object pointing
to the folder's parent. |
|
| FBPropertyListStoryFolder | Childs |
| List: Children folders of this
folder. |
|
| FBPropertyListStoryTrack | Tracks |
| List: Tracks of this folder. |
|
Member Function Documentation
| __init__ | ( | HFBStoryFolder | pParentFolder =
None, |
| object | pObject =
None |
||
| ) |
Constructor.
- 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.
| FBDelete | ( | ) |
| Load | ( | bool | pLoad | ) |
Allow to load/unload all story clips under this folder.
- Remarks:
- Currently only animation clips are supported.
Member Data Documentation
Read Write Property: Label to display for this story folder.
| FBPropertyBase Solo |
Read Write Property: If true, this story folder will be the only one to play.
| FBPropertyBase Mute |
Read Write Property: If true, this story folder will be muted.
Read Write Property: Path for story recording.
Can be relative or full path.
| FBPropertyStoryFolder Parent |
Read Only Property: Object pointing to the folder's parent.
List: Children folders of this folder.
List: Tracks of this folder.
