FBStoryFolder Class Reference


Detailed Description

Story Folder class.

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

Inheritance diagram for FBStoryFolder:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ (HFBStoryFolder pParentFolder=None, object pObject=None)
  Constructor.
  FBDelete ()
  Virtual FBDelete function.

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

Virtual FBDelete function.

Examples
Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.


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.

FBPropertyStoryFolder Parent

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

List: Children folders of this folder.


FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder
FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder FBStoryFolder