FBStoryGroupClip Class Reference

Story Group Clip class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBStoryGroupClip:

Public Member Functions
	FBStoryGroupClip (FBArrayTemplate< FBStoryClip > pAffectedClipObject)
	Constructor.
	FBDelete ()
	Virtual FBDelete function.
FBTime	Move (FBTime pDelta, bool pForce=True)
	Move.
FBTime	MoveTo (FBTime pTime, bool pForce=True)
	MoveTo.
	Razor (FBTime pTime)
	Razor.
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
FBListObject	DependentClips
	Read Write Property: Clips that are included in the group clip.
FBTime	Start
	Read Write Property: Start time of the clip.
bool	StartStopLocked
	Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (start/end times of the clip local to its track) are locked, false otherwise.
FBTime	Stop
	Read Write Property: Stop time of the clip.
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 Group Clip class.

Group Clip represents a group of clips that can be manipulated together.

Constructor & Destructor Documentation

FBStoryGroupClip()

FBStoryGroupClip

(

FBArrayTemplate< FBStoryClip >

pAffectedClipObject

)

Constructor.

Parameters

pAffectedClipObject

Clips that will be controlled by the group clip.

Member Function Documentation

FBDelete()

FBDelete

(

)

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

Move()

FBTime Move	(	FBTime	pDelta,
		bool	pForce = True
	)

Move.

Move the clip of a delta offset.

Parameters

pDelta	Delta time to apply to the clip.
pForce	Force clip to find the nearest position if the move fail.

Returns

Return the delta between the new and previous clip's position.

MoveTo()

FBTime MoveTo	(	FBTime	pTime,
		bool	pForce = True
	)

MoveTo.

Move the clip to the specified time.

Parameters

pTime	Time where to put the clip.
pForce	Force clip to find the nearest position if the move fail.

Returns

Returns the new clip's time position.

Razor()

Razor

(

FBTime

pTime

)

Razor.

Cut (razor) the clip at the specified time.

Parameters

pTime

Time where to cut. This time is local to the track, not to the clip.

Member Data Documentation

DependentClips

FBListObject DependentClips

Read Write Property: Clips that are included in the group clip.

Start

FBTime Start

Read Write Property: Start time of the clip.

StartStopLocked

bool StartStopLocked

Read Write Property: Clip's 'In/Out Locked' property value. True if the clip's In/Out properties (start/end times of the clip local to its track) are locked, false otherwise.

Stop

FBTime Stop

Read Write Property: Stop time of the clip.