FBBox Class Reference

A box is a fundamental building block in the application architecture. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBBox:

Public Member Functions
	FBBox (str pName)
	Constructor.
bool	AnimationNodeDestroy (FBAnimationNode pAnimationNode)
	Destroy an animation node.
FBAnimationNode	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.
bool	AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
	Is the animation node user data?
FBAnimationNode	AnimationNodeOutGet ()
str	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.
str	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.
FBAnimationNode	GetInConnector (int pIndex)
	Get the animation node input associated with the given index.
int	GetInConnectorCount ()
	Get the number of animation node inputs for this box.
FBAnimationNode	GetOutConnector (int pIndex)
	Get the animation node output associated with the given index.
int	GetOutConnectorCount ()
	Get the number of animation node outputs for this box.
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	Animatable
	Read Write Property: Is the box animatable.
bool	Live
	Read Write Property: Is live?
bool	RecordMode
	Read Write Property: Is recording?
str	UniqueName
	internal Unique name.
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

A box is a fundamental building block in the application architecture.

All animatable elements are derived in some way from the main box class, either by deriving directly or owning a box.

Constructor & Destructor Documentation

FBBox()

FBBox

(

str

pName

)

Constructor.

Parameters

pName

Box name.

Member Function Documentation

AnimationNodeDestroy()

bool AnimationNodeDestroy

(

FBAnimationNode

pAnimationNode

)

Destroy an animation node.

Parameters

pAnimationNode

Handle to the animation node to be destroyed.

Returns

true if destruction was successful.

AnimationNodeInGet()

FBAnimationNode AnimationNodeInGet

(

)

Get the (IN/OUT) animation node for this box.

Returns

A handle to the animation node for this box.

AnimationNodeIsUserData()

bool AnimationNodeIsUserData

(

FBAnimationNode

pAnimationNode

)

Is the animation node user data?

Parameters

pAnimationNode

Handle to the animation to be queried.

Returns

true if node is user data.

AnimationNodeOutGet()

FBAnimationNode AnimationNodeOutGet

(

)

FbxGetObjectSubType()

str FbxGetObjectSubType

(

)

Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.

Returns

The class sub type inherited by the class of an object.

FbxGetObjectType()

str FbxGetObjectType

(

)

Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.

Returns

The class type inherited by the class of an object.

GetInConnector()

FBAnimationNode GetInConnector

(

int

pIndex

)

Get the animation node input associated with the given index.

Parameters

pIndex

The animation node input associated with the given index.

Returns

The animation node input, or NULL if the pIndex value is invalid.

GetInConnectorCount()

int GetInConnectorCount

(

)

Get the number of animation node inputs for this box.

Returns

The number of animation node inputs for this box.

GetOutConnector()

FBAnimationNode GetOutConnector

(

int

pIndex

)

Get the animation node output associated with the given index.

Parameters

pIndex

The animation node output associated with the given index.

Returns

The animation node output, or NULL if the pIndex value is invalid.

GetOutConnectorCount()

int GetOutConnectorCount

(

)

Get the number of animation node outputs for this box.

Returns

The number of animation node outputs for this box.

Member Data Documentation

Animatable

bool Animatable

Read Write Property: Is the box animatable.

Live

bool Live

Read Write Property: Is live?

RecordMode

bool RecordMode

Read Write Property: Is recording?

UniqueName

str UniqueName

internal Unique name.