Public Member Functions | Public Attributes

FBStoryFolder Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014, MotionBuilder 2013.


Search for all occurrences

Detailed Description

Story Folder class.

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

Definition at line 429 of file fbstory.h.

#include <fbstory.h>

Inheritance diagram for FBStoryFolder:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBStoryFolder (FBStoryFolder *pParentFolder=NULL, HIObject pObject=NULL)
 Constructor.
virtual void FBDelete ()
 Virtual FBDelete function.
void 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.
FBPropertyBool Collapsed
 Read Write Property: Toggle to collapse or expand the story folder.
FBPropertyBool Solo
 Read Write Property: If true, this story folder will be the only one to play.
FBPropertyBool 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.

Constructor & Destructor Documentation

FBStoryFolder ( FBStoryFolder pParentFolder = NULL,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pParentFolderIf NULL, parent will be the global root folder, according to its type.
pObjectFor internal use only.
Remarks:
You can't create a folder with the RootEditFolder as parent.

Member Function Documentation

virtual void FBDelete ( ) [virtual]

Virtual FBDelete function.

Reimplemented from FBComponent.

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

Definition at line 451 of file fbstory.h.

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

Definition at line 452 of file fbstory.h.

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

Definition at line 453 of file fbstory.h.

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

Definition at line 454 of file fbstory.h.

Read Write Property: Path for story recording.

Can be relative or full path.

Definition at line 455 of file fbstory.h.

FBPropertyStoryFolder Parent

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

Definition at line 456 of file fbstory.h.

List: Children folders of this folder.

Definition at line 457 of file fbstory.h.

List: Tracks of this folder.

Definition at line 458 of file fbstory.h.


The documentation for this class was generated from the following file:

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