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

#include <fbcore.h>

Inheritance diagram for FBBox:

[legend]

Public Types
enum	ECandidateAction { eCandidateAccept , eCandidateIntercept , eCandidateInterceptAfterEvaluation }
	Resolving action for candidates. More...

Public Member Functions
	FBBox (const char *pName, HIObject pObject=NULL)
	Constructor.

virtual FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)
	Creation of IN/OUT Animation Nodes.

virtual FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)

virtual bool	EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
	Evaluation of non TRS nodes that needs to be evaluated.

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread.

virtual bool	ResolveCandidate (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Function is call when candidate needs to be resolved (like global to local).

virtual ECandidateAction	SetGlobalCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a global candidate is set on an animation node.

virtual ECandidateAction	SetStdCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a non-global candidate is set on an animation node.

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

virtual bool	AnimationNodeDestroy (FBAnimationNode *pAnimationNode)
	Destroy an animation node.

virtual bool	AnimationNodeIsUserData (FBAnimationNode *pAnimationNode)
	Is the animation node user data?

virtual void	AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo)
	This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.

virtual FBAnimationNode *	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.

virtual FBAnimationNode *	AnimationNodeOutGet ()

virtual const char *	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.

virtual const char *	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.

	IObject_Declare (override)

virtual int	GetOutConnectorCount () const
	Get the number of animation node outputs for this box.

virtual int	GetInConnectorCount () const
	Get the number of animation node inputs for this box.

virtual FBAnimationNode *	GetOutConnector (int pIndex) const
	Get the animation node output associated with the given index.

virtual FBAnimationNode *	GetInConnector (int pIndex) const
	Get the animation node input associated with the given index.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

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

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
const char *	UniqueName
	internal Unique name.

FBPropertyBool	Animatable
	Read Write Property: Is the box animatable.

FBPropertyBool	Live
	Read Write Property: Is live?

FBPropertyBool	RecordMode
	Read Write Property: Is recording?

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

FBPropertyString	LongName
	Read Write Property: Name and namespace for object.

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

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.

Definition at line 218 of file fbcore.h.

Member Enumeration Documentation

◆ ECandidateAction

enum ECandidateAction

Resolving action for candidates.

Enumerator
eCandidateAccept	Let the standard system take care of the candidate.
eCandidateIntercept	Intercept the candidate.
eCandidateInterceptAfterEvaluation	Ask for an evaluation before using the candidate.

Definition at line 228 of file fbcore.h.

Constructor & Destructor Documentation

◆ FBBox()

FBBox	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pName	Box name.
pObject	For internal use only (default is NULL).

Member Function Documentation

◆ AnimationNodeDestroy()

virtual bool AnimationNodeDestroy ( FBAnimationNode * pAnimationNode )

virtual

Destroy an animation node.

Parameters

pAnimationNode Handle to the animation node to be destroyed.

Returns: true if destruction was successful.

◆ AnimationNodeInCreate()

virtual FBAnimationNode * AnimationNodeInCreate	(	kReference	pUserId,
		const char *	pName,
		const char *	pDataType,
		bool	pIsPublic = `false`,
		double *	pMin = `NULL`,
		double *	pMax = `NULL`,
		bool	pUserData = `false`
	)

virtual

Creation of IN/OUT Animation Nodes.

Parameters

pUserId	User-defined reference number.
pName	Name of animation node.
pDataType	Type of data being animated.
pIsPublic	Determine if the animation node is published, that means whether to show it in property editor and have input / output in relation constraints editor (default is false).
pMin	Minimum values for data (default is NULL).
pMax	Maximum values for data (default is NULL).
pUserData	Is this user data? False means the property is NOT animated, user cannot change the data. Especially for device, it doesn't make sense to make it animated, unless you want to record the device data. (default is false).

Returns: A handle to the newly created animation node.

Reimplemented in FBDevice.

◆ AnimationNodeInGet()

virtual FBAnimationNode * AnimationNodeInGet ( )

virtual

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

Returns: A handle to the animation node for this box.

◆ AnimationNodeIsUserData()

virtual bool AnimationNodeIsUserData ( FBAnimationNode * pAnimationNode )

virtual

Is the animation node user data?

Parameters

pAnimationNode Handle to the animation to be queried.

Returns: true if node is user data.

◆ AnimationNodeNotify()

virtual bool AnimationNodeNotify	(	FBAnimationNode *	pAnimationNode,
		FBEvaluateInfo *	pEvaluateInfo
	)

virtual

Notification function for animation thread.

This function is called by the real-time engine in order to process animation information.

Parameters

pAnimationNode	Node containing the modified information.
pEvaluateInfo	Information concerning the evaluation of the animation (time, etc.)

Returns: true if animation node notification is successful.

Reimplemented in FBDevice, FBDeviceOptical, and FBDeviceSync.

◆ AnimationNodesOutDisableIfNotWritten()

virtual void AnimationNodesOutDisableIfNotWritten ( FBEvaluateInfo * pEvaluateInfo )

virtual

This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.

Parameters

pEvaluateInfo Evaluation synchronization object (contains evaluation id).

Note: This can be also done per individual AnimationNode -> FBAnimationNode::DisableIfNotWritten

◆ EvaluateAnimationNodes()

virtual bool EvaluateAnimationNodes ( FBEvaluateInfo * pEvaluateInfo )

virtual

Evaluation of non TRS nodes that needs to be evaluated.

This function is called by the real-time engine in order to process animation information.

Parameters

pEvaluateInfo Information concerning the evaluation of the animation (time, etc.)

Returns: true if animation node notification is successful.

◆ FbxGetObjectSubType()

virtual const char * FbxGetObjectSubType ( )

virtual

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.

Reimplemented in FBMaterial, FBModel, FBModelNull, and FBModelMarker.

◆ FbxGetObjectType()

virtual const char * FbxGetObjectType ( )

virtual

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.

Reimplemented in FBDevice, FBMaterial, FBModel, FBModelNull, and FBModelMarker.

◆ FbxRetrieve()

virtual bool FbxRetrieve	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

virtual

Reimplemented in FBHUDElement, FBModel, FBModelNull, and FBModelMarker.

◆ FbxStore()

virtual bool FbxStore	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

virtual

Storage/Retrieval of information into the FBX file format.

Parameters

pFbxObject	Object to interface with FBX file format.
pStoreWhat	Attributes to store in FBX file.

Returns: true if successful.

Reimplemented in FBConstraint, FBDevice, FBHUDElement, FBMaterial, FBModel, FBModelNull, FBModelMarker, FBDeviceOptical, FBDeviceSync, FBDeviceCamera, and FBUserObject.

◆ GetInConnector()

virtual FBAnimationNode * GetInConnector ( int pIndex ) const

virtual

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()

virtual int GetInConnectorCount ( ) const

virtual

Get the number of animation node inputs for this box.

Returns: The number of animation node inputs for this box.

◆ GetOutConnector()

virtual FBAnimationNode * GetOutConnector ( int pIndex ) const

virtual

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()

virtual int GetOutConnectorCount ( ) const

virtual

Get the number of animation node outputs for this box.

Returns: The number of animation node outputs for this box.

◆ ResolveCandidate()

virtual bool ResolveCandidate	(	FBAnimationNode *	pAnimationNode,
		FBEvaluateInfo *	pEvaluateInfo
	)

virtual

Function is call when candidate needs to be resolved (like global to local).

Parameters

pAnimationNode	Node containing the information to resolve.
pEvaluateInfo	Information concerning the evaluation of the animation (time, etc.)

Returns: function should return true (not used for now).

◆ SetGlobalCandidate()

virtual ECandidateAction SetGlobalCandidate	(	FBAnimationNode *	pAnimationNode,
		double *	pData,
		FBEvaluateInfo *	pEvaluateInfo
	)

virtual

Function is call when a global candidate is set on an animation node.

Parameters

pAnimationNode	Node containing the information to resolve.
pEvaluateInfo	Information concerning the evaluation of the animation (time, etc.)

Returns: Action to take with the candidate.

◆ SetStdCandidate()

virtual ECandidateAction SetStdCandidate	(	FBAnimationNode *	pAnimationNode,
		double *	pData,
		FBEvaluateInfo *	pEvaluateInfo
	)

virtual

Function is call when a non-global candidate is set on an animation node.

Parameters

pAnimationNode	Node containing the information to resolve.
pEvaluateInfo	Information concerning the evaluation of the animation (time, etc.)

Returns: Action to take with the candidate.

Member Data Documentation

◆ Animatable

FBPropertyBool Animatable

Read Write Property: Is the box animatable.

Definition at line 358 of file fbcore.h.

◆ Live

FBPropertyBool Live

Read Write Property: Is live?

Definition at line 359 of file fbcore.h.

◆ RecordMode

FBPropertyBool RecordMode

Read Write Property: Is recording?

Definition at line 360 of file fbcore.h.

◆ UniqueName

const char* UniqueName

internal Unique name.

Definition at line 322 of file fbcore.h.

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

fbcore.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ECandidateAction

Constructor & Destructor Documentation

◆ FBBox()

Member Function Documentation

◆ AnimationNodeDestroy()

◆ AnimationNodeInCreate()

◆ AnimationNodeInGet()

◆ AnimationNodeIsUserData()

◆ AnimationNodeNotify()

◆ AnimationNodesOutDisableIfNotWritten()

◆ EvaluateAnimationNodes()

◆ FbxGetObjectSubType()

◆ FbxGetObjectType()

◆ FbxRetrieve()

◆ FbxStore()

◆ GetInConnector()

◆ GetInConnectorCount()

◆ GetOutConnector()

◆ GetOutConnectorCount()

◆ ResolveCandidate()

◆ SetGlobalCandidate()

◆ SetStdCandidate()

Member Data Documentation

◆ Animatable

◆ Live

◆ RecordMode

◆ UniqueName