FBBox Class Reference

FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox FBBox

Inheritance diagram for FBBox:

[legend]

List of all members.

---

Detailed Description

Box class.

A box is a fundamental building block in the application architecture. All animatable elements derive in some way from the main box class (either by deriving directly or owning a box).

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 ()
	Get the (IN/OUT) animation node for this box.
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.

---

Constructor & Destructor Documentation

FBBox

(

str

pName

)

Constructor.

Parameters:

pName

Box name.

---

Member Function Documentation

bool AnimationNodeDestroy

(

FBAnimationNode

pAnimationNode

)

Destroy an animation node.

Parameters:

pAnimationNode

Handle to the animation node to be destroyed.

Returns:

true if destruction was successful.

FBAnimationNode AnimationNodeInGet

(

)

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

Returns:

A handle to the animation node for this box.

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.

FBAnimationNode AnimationNodeOutGet

(

)

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

Returns:

A handle to the animation node for this box.

---

Member Data Documentation

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.

---