Story Management class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBStory:

[legend]

Public Member Functions
	FBStory ()
	Constructor.

int	CleanEmptyTracksAndFolders ()
	Remove all empty tracks and folders present in the Story Tool.

bool	PlotAllShotTracksToCameraSwitcher (FBTake pTake)
	PlotAllShotTracksToCameraSwitcher Plot all Shot Tracks to the Camera Switcher on the given Take.

Public Member Functions inherited from FBComponent
	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
bool	ClipsTextsVisible
	Read Write Property: If true, clips' texts are visible.

bool	DisplayShotClipsExpanded
	Read Write Property: If true, shot clips are displayed in expanded mode (each Shot track reflected as a new line in the Shot clips pane), otherwise, are displayed in collapsed mode (all Shot tracks reflected as a single line in the Shot clips pane).

bool	LockedShot
	Read Write Property: If true, shots will be locked (no time discontinuity).

bool	MaintainShotAndClipShotLengthsSynced
	Read Write Property: When working in time discontinuity, if true, shots and their corresponding shot clips will be kept in sync in regards of their lengths.

bool	Mute
	Read Write Property: If true, the Story mode will be globally disabled.

bool	NoneBlockingPostprocess
	Read Write Property: If true, record to disk will post process recorded data in low priority thread without affecting application performance. Clip in story will remain unloaded.

bool	RecordToDisk
	Read Write Property: If true, record to story will record directly to disk.

FBStoryFolder	RootEditFolder
	Read Only Property: Story's root edit folder

FBStoryFolder	RootFolder
	Read Only Property: Story's root folder

bool	SummaryClip
	Read Write Property: If true, summary clips for story folders will be created to help manipulating folder content.

Public Attributes inherited from FBComponent
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.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

Detailed Description

Story Management class.

This class serve as a management control for the Story global settings and members.

See samples: CreateShotClip.py, InsertCurrentTake.py, BloopSlate.py, RecordLight.py, PlotNonSelectedCharStoryTracks.py, PlotSelectedCharStoryTracks.py, PrintClipNamesAndStartStopFrames.py.

Constructor & Destructor Documentation

◆ FBStory()

FBStory ( )

Constructor.

Member Function Documentation

◆ CleanEmptyTracksAndFolders()

int CleanEmptyTracksAndFolders ( )

Remove all empty tracks and folders present in the Story Tool.

Returns: The number of empty story tracks and/or folders removed.

◆ PlotAllShotTracksToCameraSwitcher()

bool PlotAllShotTracksToCameraSwitcher ( FBTake pTake )

PlotAllShotTracksToCameraSwitcher Plot all Shot Tracks to the Camera Switcher on the given Take.

This undoable operation will overwrite the Camera Switcher of Take.

Parameters

pTake Take to plot the Shot Tracks to the Camera Switcher to.

Returns: True if the operation is successful, false otherwise.

Remarks: To plot a single Shot Track to the Camera Switcher, use the FBStoryTrack.PlotToCameraSwitcher method.

Member Data Documentation

◆ ClipsTextsVisible

bool ClipsTextsVisible

Read Write Property: If true, clips' texts are visible.

◆ DisplayShotClipsExpanded

bool DisplayShotClipsExpanded

Read Write Property: If true, shot clips are displayed in expanded mode (each Shot track reflected as a new line in the Shot clips pane), otherwise, are displayed in collapsed mode (all Shot tracks reflected as a single line in the Shot clips pane).

◆ LockedShot

bool LockedShot

Read Write Property: If true, shots will be locked (no time discontinuity).

◆ MaintainShotAndClipShotLengthsSynced

bool MaintainShotAndClipShotLengthsSynced

Read Write Property: When working in time discontinuity, if true, shots and their corresponding shot clips will be kept in sync in regards of their lengths.

◆ Mute

bool Mute

Read Write Property: If true, the Story mode will be globally disabled.

◆ NoneBlockingPostprocess

bool NoneBlockingPostprocess

Read Write Property: If true, record to disk will post process recorded data in low priority thread without affecting application performance. Clip in story will remain unloaded.

◆ RecordToDisk

bool RecordToDisk

Read Write Property: If true, record to story will record directly to disk.

◆ RootEditFolder

FBStoryFolder RootEditFolder

Read Only Property: Story's root edit folder

◆ RootFolder

FBStoryFolder RootFolder

Read Only Property: Story's root folder

◆ SummaryClip

bool SummaryClip

Read Write Property: If true, summary clips for story folders will be created to help manipulating folder content.

Public Member Functions

Public Attributes