FBCharacterFace Class Reference
 
 
 
FBCharacterFace Class Reference

#include <fbcharacterface.h>


Class Description

Animates a character face using an actor as input.

These classes are under development and may change dramatically between versions.

Definition at line 109 of file fbcharacterface.h.

Inheritance diagram for FBCharacterFace:
FBConstraint FBBox FBComponent FBPlug FBWrapperHolder

Public Member Functions

  FBCharacterFace (const char *pName, HIObject pObject=NULL)
  Constructor.
  IObject_Declare (K_IMPLEMENTATION)
virtual bool  PlotAnimation ()
  Plot the animation of the character face.
virtual void  FBDelete ()
  Actual Character Face destructor.
void  GotoRest ()
  Set the character face back to its rest shape.
bool  ShapeGroupAdd (FBModelList *pList, const char *pName=NULL)
  Add a blendshape model group containing models.
bool  ShapeGroupRemove (int pShapeGrpId)
  Remove a blendshape model group.
int  ShapeGroupFindByName (const char *pName)
  Find a blendshape group by name.
int  ShapeGroupGetCount ()
  Retrieve the total number of blendshape groups on this character face.
const char *  ShapeGroupGetName (int pShapeGrpId)
  Retrieve the name of a blendshape group.
bool  ShapeGroupSetName (int pShapeGrpId, const char *pName)
  Set the name of a blendshape group.
int  ShapeFindByName (int pShapeGrpId, const char *pName)
  Find a shape in a blendshape group by name.
int  ShapeGetCount (int pShapeGrpId)
  Retrieve the total number of shapes in a blendshape group.
const char *  ShapeGetName (int pShapeGrpId, int pShapeId)
  Retrieve the name of the shape in a blendshape group.
bool  ShapeSetName (int pShapeGrpId, int pShapeId, const char *pName)
  Set the name of the shape in a blendshape group.
int  ClusterGroupAdd (FBModelList *pList, const char *pName=NULL)
  Add a cluster group to the character face.
bool  ClusterGroupRemove (int pClusterGrpId)
  Remove a cluster group from the character face.
int  ClusterGroupFindByName (const char *pName)
  Find a cluster group by name.
int  ClusterGroupGetCount ()
  Retrieve the total number of cluster groups.
const char *  ClusterGroupGetName (int pClusterGrpId)
  Retrieve the name of a cluster group.
bool  ClusterGroupSetName (int pClusterGrpId, const char *pName)
  Set the name of a cluster group.
bool  ClusterGroupSnapRest (int pClusterGrpId)
  Set a cluster group's rest pose to the current pose.
int  ClusterShapeAdd (int pClusterGrpId, const char *pName=NULL)
  Add a cluster shape to a cluster group.
bool  ClusterShapeRemove (int pClusterGrpId, int pClusterShapeId)
  Remove a cluster shape from a cluster group.
int  ClusterShapeFindByName (int pClusterGrpId, const char *pName)
  Find a cluster shape in a cluster group by name.
int  ClusterShapeGetCount (int pClusterGrpId)
  Retrieve the total number of shapes in a cluster group.
const char *  ClusterShapeGetName (int pClusterGrpId, int pClusterShapeId)
  Retrieve the name of a shape in a cluster group.
bool  ClusterShapeSetName (int pClusterGrpId, int pClusterShapeId, const char *pName)
  Set the name of a shape in a cluster group.
bool  ClusterShapeSnap (int pClusterGrpId, int pClusterShapeId)
  Record the current pose of the cluster group to a cluster shape.
int  ExpressionAdd (const char *pName)
  Add an expression to the face.
bool  ExpressionRemove (int pExpressionId)
  Remove an expression from the face.
int  ExpressionFindByName (const char *pName)
  Find an expression on the face by name.
int  ExpressionGetCount ()
  Retrieve the total number of expressions on the face.
const char *  ExpressionGetName (int pExpressionId)
  Retrieve the name of an expression.
bool  ExpressionSetName (int pExpressionId, const char *pName)
  Set the name of an expression.
bool  ExpressionSetShapeWeight (int pExpressionId, int pGrpId, int pShapeId, float pValue=0.0f)
  Assign the weight of a shape to an expression.
virtual void  ActiveChanged ()
  Notification for Activation Status Change.
virtual void  RemoveAllAnimationNodes ()
  Remove animation nodes.
virtual void  SetupAllAnimationNodes ()
  Setup animation nodes.
virtual void  SnapSuggested ()
  Suggest 'snap'.
virtual void  FreezeSuggested ()
  Suggest 'freeze'.
virtual bool  Disable (FBModel *pModel)
  Disable constraint on pModel.
virtual bool  Enable (FBModel *pModel)
  Enable constraint on pModel.
virtual bool  AnimationNodeNotify (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo, FBConstraintInfo *pConstraintInfo)
  Notification callback for connectors.
virtual bool  AnimationNodeNotify (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo)
  Notification function for animation thread.
virtual void  SaveModelState (FBModel *pModel, bool pS, bool pR, bool pT)
  Save current state of pModel.
virtual void  RestoreModelState (FBModel *pModel)
  Restore the saved model state onto pModel.
virtual void  FreezeSRT (FBModel *pModel, bool pS, bool pR, bool pT)
  Freeze current model state.
virtual FBConstraint Clone ()
  Clone the constraint.
int  ReferenceGroupGetCount ()
  Return the number of reference groups.
int  ReferenceGroupAdd (const char *pGroupName, int pMaxItemCount)
  Add a group of references.
const char *  ReferenceGroupGetName (int pGroupIndex)
  Get the name of the reference group.
int  ReferenceGroupGetMaxCount (int pGroupIndex)
  Get the maximum number of items that can exist in the reference group in question.
FBModel ReferenceGet (int pGroupIndex, int pItemIndex=0)
  Get a reference.
int  ReferenceGetCount (int pGroupIndex)
  Get number of references in a specified group.
bool  ReferenceAdd (int pGroupIndex, FBModel *pModel)
  Add a reference to a specified group.
bool  ReferenceRemove (int pGroupIndex, FBModel *pModel)
  Remove a reference to pModel from the group at pGroupIndex.
void  ReferenceRemoveAll ()
  Remove All References.
virtual bool  DeformerPreNotify (FBModel *pModel, FBEvaluateInfo *pEvaluateInfo, FBVertex *pBBoxMin, FBVertex *pBBoxMax)
  Deformation pre-notification function This function pass the evaluation information for deformation (if timing is required).
virtual bool  DeformerNotify (FBModel *pModel, const FBVertex *pSrcVertex, const FBVertex *pSrcNormal, int pCount, FBVertex *pDstVertex, FBVertex *pDstNormal)
  Deformation notification function.
virtual bool  EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
  Evaluation of non TRS nodes that needs to be evaluated.
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 const char *  FbxGetObjectSubType ()
  returns UniqueName if not overloaded.
virtual const char *  FbxGetObjectType ()
  Object Type "Box".
virtual bool  FBCreate ()
  Open Reality Creation function.
virtual void  FBDestroy ()
  Open Reality destruction 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.
  ICallback_Declare (K_IMPLEMENTATION)
virtual bool  Is (int pTypeId)
  Returns true if object is of type TypeId.
virtual int  GetTypeId ()
  GetTypeId( int pTypeId )
void  KObjectEvent (HIRegister pView, HKEventBase pEvent)
virtual HIObject  GetHIObject () const
  Return an internal pointer.
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 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.
FBScriptWrapper GetWrapper ()
  Return the wrapper interface of this FBObject.
void  AddWrapper (FBScriptWrapper *)
void  RemoveWrapper (FBScriptWrapper *)
FBAnimationNode AnimationNodeOutCreate (kReference pUserId, FBModel *pModel, const char *pAttribute)
  Animation Node Creations (IN/OUT).
FBAnimationNode AnimationNodeInCreate (kReference pUserId, FBModel *pModel, const char *pAttribute)
FBAnimationNode AnimationNodeInCreate (kReference pUserId, FBProperty *pProperty)
  Animation Node Creations (IN).
virtual FBAnimationNode AnimationNodeOutCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=false, double *pMin=NULL, double *pMax=NULL, bool pUserData=false)
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 bool  ReferenceAddNotify (int pGroupIndex, FBModel *pModel)
  Notification callbacks for when a reference is added or removed.
virtual bool  ReferenceRemoveNotify (int pGroupIndex, FBModel *pModel)
virtual bool  DeformerBind (FBModel *pModel)
  Bind/Unbind pModel to deformation constraint.
virtual bool  DeformerUnBind (FBModel *pModel)
virtual bool  FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
  Store/Retrieve data to/from FBX files.
virtual bool  FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
virtual FBAnimationNode AnimationNodeInGet ()
  Get the (IN/OUT) animation node for this box.
virtual FBAnimationNode AnimationNodeOutGet ()
void *  operator new (size_t stAllocateBlock)
void *  operator new (size_t stAllocateBlock, int blockType, const char *filename, int linenumber)
void  operator delete (void *pvMem)
void  RegisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void  UnregisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void  InvalidatePropertyEventsParents ()

Static Public Member Functions

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 void  PrintClassDefinitions ()
  Print out internal Class (ID) Definition table.

Public Attributes

FBPropertyActorFace  InputActorFace
  Read Write Property: The index of the actor used for the input.
FBPropertyBool  ActiveInput
  Read Write Property: Is the character input active?
FBPropertyBool  Deformer
  Read Write Property: Is a deformer constraint?
FBPropertyBool  HasLayout
  Read Write Property: Does the constraint have a layout?
FBPropertyString  Description
  Read Write Property: Long description of constraint.
FBPropertyBool  Active
  Read Write Property: Active state.
FBPropertyBool  Lock
  Read Write Property: Lock state.
FBPropertyAction  Snap
  Function Property: Snap constraint.
FBPropertyAnimatableDouble  Weight
  Read Write Property: Weight of constraint.
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?
DataFBComponent *  mLocalPtr
  Handle on DataFBComponent.
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.
KObject *  mDummyObject
  Internal Dummy Object for non KObject Components.
bool  mAllocated
  Contain the Allocation State of the Component.

Static Public Attributes

static int  TypeInfo
  Contains the Type information of the object.
static const char *  ClassGroupName
  ClassGroupName of the object.

Protected Attributes

FBString  mName
  Name of the component.
HIObject  mObject
  Handle on the Plug.
bool  mSDKComponent
  bool Plug is an SDK component.

Static Protected Attributes

static int  mGlobalTypeInfo
  Represente the Type Index.

Friends

K_DLLIMPORT friend int  __FBRegisterTypeInfo (int pInternalClassId)
  __FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.

Constructor & Destructor Documentation

FBCharacterFace::FBCharacterFace ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pName Name of new character.
pObject For internal use only. This parameter does not need to be specified by the developer.

Member Function Documentation

FBCharacterFace::IObject_Declare ( K_IMPLEMENTATION  )
virtual bool FBCharacterFace::PlotAnimation ( ) [virtual]

Plot the animation of the character face.

Returns:
True if the operation completed successfully.
virtual void FBCharacterFace::FBDelete ( ) [virtual]

Actual Character Face destructor.

This method is used to delete the actual character face object represented by an instance of FBCharacterFace.

Reimplemented from FBComponent.

void FBCharacterFace::GotoRest ( )

Set the character face back to its rest shape.

bool FBCharacterFace::ShapeGroupAdd ( FBModelList pList,
const char *  pName = NULL 
)

Add a blendshape model group containing models.

Parameters:
pList List of models to be associated with this blendshape group.
pName Optional name for this model group.
Returns:
True if the operation completed successfully.
bool FBCharacterFace::ShapeGroupRemove ( int  pShapeGrpId )

Remove a blendshape model group.

Parameters:
pShapeGrpId Index of the blendshape group to remove.
Returns:
True if the operation completed successfully.
int FBCharacterFace::ShapeGroupFindByName ( const char *  pName )

Find a blendshape group by name.

Parameters:
pName Name to search for.
Returns:
Index of the blendshape group, -1 if not found.
int FBCharacterFace::ShapeGroupGetCount ( )

Retrieve the total number of blendshape groups on this character face.

Returns:
Number of blendshape groups on this character face.
const char* FBCharacterFace::ShapeGroupGetName ( int  pShapeGrpId )

Retrieve the name of a blendshape group.

Parameters:
pShapeGrpId Index of the blendshape group to query.
Returns:
Name of the blendshape group.
bool FBCharacterFace::ShapeGroupSetName ( int  pShapeGrpId,
const char *  pName 
)

Set the name of a blendshape group.

Parameters:
pShapeGrpId Index of the blendshape group to modify.
pName Name to set on the blendshape group.
Returns:
True if the operation completed successfully.
int FBCharacterFace::ShapeFindByName ( int  pShapeGrpId,
const char *  pName 
)

Find a shape in a blendshape group by name.

Parameters:
pShapeGrpId Index of the blendshape group to search.
pName Name to search for.
Returns:
Index of the shape, -1 if not found.
int FBCharacterFace::ShapeGetCount ( int  pShapeGrpId )

Retrieve the total number of shapes in a blendshape group.

Parameters:
pShapeGrpId Index of the blendshape group to query.
Returns:
Number of shapes in the specified blendshape group.
const char* FBCharacterFace::ShapeGetName ( int  pShapeGrpId,
int  pShapeId 
)

Retrieve the name of the shape in a blendshape group.

Parameters:
pShapeGrpId Index of the blendshape group to query.
pShapeId Index of the shape in the blendshape group to query.
Returns:
Name of the specified shape.
bool FBCharacterFace::ShapeSetName ( int  pShapeGrpId,
int  pShapeId,
const char *  pName 
)

Set the name of the shape in a blendshape group.

Parameters:
pShapeGrpId Index of the blendshape group to query.
pShapeId Index of the shape in the blendshape group to set.
pName Name to set on the shape.
Returns:
True if the operation completed successfully.
int FBCharacterFace::ClusterGroupAdd ( FBModelList pList,
const char *  pName = NULL 
)

Add a cluster group to the character face.

Parameters:
pList List of clusters to add to this group.
pName Optional name to assign to this cluster group.
Returns:
Index of the new cluster group -1 if the operation failed to complete.
bool FBCharacterFace::ClusterGroupRemove ( int  pClusterGrpId )

Remove a cluster group from the character face.

Parameters:
pClusterGrpId Index of the cluster group to remove.
Returns:
True if the operation completed successfully.
int FBCharacterFace::ClusterGroupFindByName ( const char *  pName )

Find a cluster group by name.

Parameters:
pName Name to search for on the face.
Returns:
Index of the matching cluster group. -1 if not found.
int FBCharacterFace::ClusterGroupGetCount ( )

Retrieve the total number of cluster groups.

Returns:
Number of cluster groups on the face.
const char* FBCharacterFace::ClusterGroupGetName ( int  pClusterGrpId )

Retrieve the name of a cluster group.

Parameters:
pClusterGrpId Index of the cluster group to query.
Returns:
Name of the specified cluster group.
bool FBCharacterFace::ClusterGroupSetName ( int  pClusterGrpId,
const char *  pName 
)

Set the name of a cluster group.

Parameters:
pClusterGrpId Index of the cluster group to modify.
pName New name for the cluster group.
Returns:
True of the operation completed successfully.
bool FBCharacterFace::ClusterGroupSnapRest ( int  pClusterGrpId )

Set a cluster group's rest pose to the current pose.

Parameters:
pClusterGrpId Index of the cluster group to modify.
Returns:
True if the operation completed succesfully.
int FBCharacterFace::ClusterShapeAdd ( int  pClusterGrpId,
const char *  pName = NULL 
)

Add a cluster shape to a cluster group.

Parameters:
pClusterGrpId Index of the cluster group to modify.
pName Optional name to assign to the shape.
Returns:
Index of the new shape. -1 if the operation failed to complete.
bool FBCharacterFace::ClusterShapeRemove ( int  pClusterGrpId,
int  pClusterShapeId 
)

Remove a cluster shape from a cluster group.

Parameters:
pClusterGrpId Index of the cluster group to modify.
pClusterShapeId Index of the shape in the cluster group to remove.
Returns:
True of the operation completed succesfully.
int FBCharacterFace::ClusterShapeFindByName ( int  pClusterGrpId,
const char *  pName 
)

Find a cluster shape in a cluster group by name.

Parameters:
pClusterGrpId Index of the cluster group to search.
pName Name to search for in the cluster group.
Returns:
Index of the matching shape. -1 if not found.
int FBCharacterFace::ClusterShapeGetCount ( int  pClusterGrpId )

Retrieve the total number of shapes in a cluster group.

Parameters:
pClusterGrpId Index of the cluster group to query.
Returns:
Number of shapes in the specified cluster group.
const char* FBCharacterFace::ClusterShapeGetName ( int  pClusterGrpId,
int  pClusterShapeId 
)

Retrieve the name of a shape in a cluster group.

Parameters:
pClusterGrpId Index of the cluster group to query.
pClusterShapeId Index of the cluster shape to query.
Returns:
Name of the specified shape.
bool FBCharacterFace::ClusterShapeSetName ( int  pClusterGrpId,
int  pClusterShapeId,
const char *  pName 
)

Set the name of a shape in a cluster group.

Parameters:
pClusterGrpId Index of the cluster group to modify.
pClusterShapeId Index of the cluster shape to modify.
pName Name to assign to the cluster shape.
Returns:
True if the operation completed successfully.
bool FBCharacterFace::ClusterShapeSnap ( int  pClusterGrpId,
int  pClusterShapeId 
)

Record the current pose of the cluster group to a cluster shape.

Parameters:
pClusterGrpId Index of the cluster group to record.
pClusterShapeId Index of the cluster shape to record the pose.
Returns:
True if the operation completed successfully.
int FBCharacterFace::ExpressionAdd ( const char *  pName )

Add an expression to the face.

Parameters:
pName Optional name to assign to the new expression.
Returns:
Index of the new expression. -1 if the operation failed to complete.
bool FBCharacterFace::ExpressionRemove ( int  pExpressionId )

Remove an expression from the face.

Parameters:
pExpressionId Index of the expression to remove.
Returns:
True if the operation completed successfully.
int FBCharacterFace::ExpressionFindByName ( const char *  pName )

Find an expression on the face by name.

Parameters:
pName Name of the expression to search for.
Returns:
Index of the matching expression. -1 if not found.
int FBCharacterFace::ExpressionGetCount ( )

Retrieve the total number of expressions on the face.

Returns:
Number of expressions on the face.
const char* FBCharacterFace::ExpressionGetName ( int  pExpressionId )

Retrieve the name of an expression.

Parameters:
pExpressionId Index of the expression to query.
Returns:
Name of the specified expression.
bool FBCharacterFace::ExpressionSetName ( int  pExpressionId,
const char *  pName 
)

Set the name of an expression.

Parameters:
pExpressionId Index of the expression to modify.
pName Name to assign to the expression.
Returns:
True if the operation completed successfully.
bool FBCharacterFace::ExpressionSetShapeWeight ( int  pExpressionId,
int  pGrpId,
int  pShapeId,
float  pValue = 0.0f 
)

Assign the weight of a shape to an expression.

Parameters:
pExpressionId Index of the expression to modify.
pGrpId Index of the blendshape or cluster group containing the shape of interest.
pShapeId Index of the blendshape or cluster shape to weight.
pValue Weight of the shape to assign to this expression. Valid range of [0.0, 1.0].
Returns:
True if the operation completed successfully.
virtual void FBConstraint::ActiveChanged ( ) [virtual, inherited]

Notification for Activation Status Change.

virtual void FBConstraint::RemoveAllAnimationNodes ( ) [virtual, inherited]

Remove animation nodes.

virtual void FBConstraint::SetupAllAnimationNodes ( ) [virtual, inherited]

Setup animation nodes.

virtual void FBConstraint::SnapSuggested ( ) [virtual, inherited]

Suggest 'snap'.

virtual void FBConstraint::FreezeSuggested ( ) [virtual, inherited]

Suggest 'freeze'.

virtual bool FBConstraint::Disable ( FBModel pModel ) [virtual, inherited]

Disable constraint on pModel.

Parameters:
pModel Model on which constraint should be disabled.
Returns:
true if successful.
virtual bool FBConstraint::Enable ( FBModel pModel ) [virtual, inherited]

Enable constraint on pModel.

Parameters:
pModel Model on which constraint should be enable.
Returns:
true if successful.
virtual bool FBConstraint::AnimationNodeNotify ( FBAnimationNode pAnimationNode,
FBEvaluateInfo pEvaluateInfo,
FBConstraintInfo pConstraintInfo 
) [virtual, inherited]

Notification callback for connectors.

Parameters:
pAnimationNode Animation node being notified.
pEvaluateInfo Information for evaluation.
pConstraintInfo Information for constraint.
Returns:
true if successful.
virtual bool FBBox::AnimationNodeNotify ( FBAnimationNode pAnimationNode,
FBEvaluateInfo pEvaluateInfo 
) [virtual, inherited]

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.

FBAnimationNode* FBConstraint::AnimationNodeOutCreate ( kReference  pUserId,
FBModel pModel,
const char *  pAttribute 
) [inherited]

Animation Node Creations (IN/OUT).

Used to create the connectors (in or out) on an animation node. This function will return a newly created animation node, connected to the model specified by pModel.

Parameters:
pUserId User specified reference number.
pModel Model to associate with animation node.
pAttribute Attribute of model to animate (i.e. Translation, Lcl Translation, etc.)
Returns:
Newly created IN/OUT animation node.
virtual FBAnimationNode* FBBox::AnimationNodeOutCreate ( kReference  pUserId,
const char *  pName,
const char *  pDataType,
bool  pIsPublic = false,
double *  pMin = NULL,
double *  pMax = NULL,
bool  pUserData = false 
) [virtual, inherited]
FBAnimationNode* FBConstraint::AnimationNodeInCreate ( kReference  pUserId,
FBModel pModel,
const char *  pAttribute 
) [inherited]
FBAnimationNode* FBConstraint::AnimationNodeInCreate ( kReference  pUserId,
FBProperty pProperty 
) [inherited]

Animation Node Creations (IN).

Used to create the In connectors on an animation node. This function will return a newly created animation node, connected to the model specified by pProperty.

Parameters:
pUserId User specified reference number.
pProperty Property of model to animate (must be animatable)
Returns:
Newly created IN animation node.
virtual FBAnimationNode* FBBox::AnimationNodeInCreate ( kReference  pUserId,
const char *  pName,
const char *  pDataType,
bool  pIsPublic = false,
double *  pMin = NULL,
double *  pMax = NULL,
bool  pUserData = false 
) [virtual, inherited]

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.

virtual void FBConstraint::SaveModelState ( FBModel pModel,
bool  pS,
bool  pR,
bool  pT 
) [virtual, inherited]

Save current state of pModel.

Parameters:
pModel Model to save.
pS Scaling information?
pR Rotation information?
pT Translation information?
virtual void FBConstraint::RestoreModelState ( FBModel pModel ) [virtual, inherited]

Restore the saved model state onto pModel.

Parameters:
pModel Model to affect with previous state.
virtual void FBConstraint::FreezeSRT ( FBModel pModel,
bool  pS,
bool  pR,
bool  pT 
) [virtual, inherited]

Freeze current model state.

Parameters:
pModel Model to freeze constraint on.
pS Scaling freeze?
pR Rotation freeze?
pT Translation freeze?
virtual FBConstraint* FBConstraint::Clone ( ) [virtual, inherited]

Clone the constraint.

Returns:
Newly created (and copied) constraint.

Reimplemented in FBCharacter.

int FBConstraint::ReferenceGroupGetCount ( ) [inherited]

Return the number of reference groups.

Returns:
Number of reference groups.
int FBConstraint::ReferenceGroupAdd ( const char *  pGroupName,
int  pMaxItemCount 
) [inherited]

Add a group of references.

Parameters:
pGroupName Name of reference group to add.
pMaxItemCount Maximum number of items in pGroupName.
Returns:
Index of new reference group.
const char* FBConstraint::ReferenceGroupGetName ( int  pGroupIndex ) [inherited]

Get the name of the reference group.

Parameters:
pGroupIndex Index of the reference group to get the name for.
Returns:
The name of the reference group pGroupIndex.
int FBConstraint::ReferenceGroupGetMaxCount ( int  pGroupIndex ) [inherited]

Get the maximum number of items that can exist in the reference group in question.

Parameters:
pGroupIndex Index of reference group.
Returns:
Maximum number of items that can be added to the reference group.
FBModel* FBConstraint::ReferenceGet ( int  pGroupIndex,
int  pItemIndex = 0 
) [inherited]

Get a reference.

Parameters:
pGroupIndex Index of reference group containing desired reference.
pItemIndex Index of reference in group to get (default is 0).
Returns:
Model at specified reference.
int FBConstraint::ReferenceGetCount ( int  pGroupIndex ) [inherited]

Get number of references in a specified group.

Parameters:
pGroupIndex Index of group to query the number of references.
Returns:
Number of references in specified group.
bool FBConstraint::ReferenceAdd ( int  pGroupIndex,
FBModel pModel 
) [inherited]

Add a reference to a specified group.

Parameters:
pGroupIndex Group to add reference to.
pModel Model to place at new reference.
Returns:
true if successful.
Warning:
If you try to add a model to a group that is already full, the success of the operation will be false and the reference will not be added.
bool FBConstraint::ReferenceRemove ( int  pGroupIndex,
FBModel pModel 
) [inherited]

Remove a reference to pModel from the group at pGroupIndex.

Parameters:
pGroupIndex Index to remove reference from.
pModel Model to remove reference from.
Returns:
true if successful.
void FBConstraint::ReferenceRemoveAll ( ) [inherited]

Remove All References.

virtual bool FBConstraint::ReferenceAddNotify ( int  pGroupIndex,
FBModel pModel 
) [virtual, inherited]

Notification callbacks for when a reference is added or removed.

Parameters:
pGroupIndex Index of group where reference was affected.
pModel Model to which reference was associated.
Returns:
true if successful.
virtual bool FBConstraint::ReferenceRemoveNotify ( int  pGroupIndex,
FBModel pModel 
) [virtual, inherited]
virtual bool FBConstraint::DeformerPreNotify ( FBModel pModel,
FBEvaluateInfo pEvaluateInfo,
FBVertex pBBoxMin,
FBVertex pBBoxMax 
) [virtual, inherited]

Deformation pre-notification function This function pass the evaluation information for deformation (if timing is required).

And user should provide the estimation of the bounding volume of the model after deformation. This estimation will be used to determine the model's visibility in the camera's frustum. Only those potential visible models will receive the following DeformerNotify() callback.

Parameters:
pModel Model to deform.
pEvaluateInfo Information for evaluation.
pBBoxMin (In/Out) The estimation of min vertex of the bounding box before & after deformation
pBBoxMax (In/Out) The estimation of max vertex of the bounding box before & after deformation
Returns:
true if the deformer provide valid bbox estimation and wish reduce the following deformation if possible, false if deformer wish to continue deformation without considering frustum visibility.
virtual bool FBConstraint::DeformerNotify ( FBModel pModel,
const FBVertex pSrcVertex,
const FBVertex pSrcNormal,
int  pCount,
FBVertex pDstVertex,
FBVertex pDstNormal 
) [virtual, inherited]

Deformation notification function.

Parameters:
pModel Model to deform.
pSrcVertex Source vertex array (i.e. vertex to deform).
pSrcNormal Normals at source vertex array.
pCount Number of vertices in source/destination arrays
pDstVertex Destination vertex array (i.e. where source vertex gets deformed to)
pDstNormal Normals at destination vertex array.
Returns:
true if successful.
virtual bool FBConstraint::DeformerBind ( FBModel pModel ) [virtual, inherited]

Bind/Unbind pModel to deformation constraint.

These functions are used for adding/removing a deformation binding to/from pModel if the constraint is a deformation constraint.

Parameters:
pModel Model to bind/unbind.
Returns:
true if successful.
virtual bool FBConstraint::DeformerUnBind ( FBModel pModel ) [virtual, inherited]
virtual bool FBConstraint::FbxStore ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual, inherited]

Store/Retrieve data to/from FBX files.

Parameters:
pFbxObject Interface to FBX format.
pStoreWhat Attributes to store in FBX file.
Returns:
true if successful.

Reimplemented from FBBox.

virtual bool FBConstraint::FbxRetrieve ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual, inherited]

Reimplemented from FBBox.

virtual bool FBBox::EvaluateAnimationNodes ( FBEvaluateInfo pEvaluateInfo ) [virtual, inherited]

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.
virtual bool FBBox::AnimationNodeDestroy ( FBAnimationNode pAnimationNode ) [virtual, inherited]

Destroy an animation node.

Parameters:
pAnimationNode Handle to the animation node to be destroyed.
Returns:
true if destruction was successful.
virtual bool FBBox::AnimationNodeIsUserData ( FBAnimationNode pAnimationNode ) [virtual, inherited]

Is the animation node user data?

Parameters:
pAnimationNode Handle to the animation to be queried.
Returns:
true if node is user data.
virtual void FBBox::AnimationNodesOutDisableIfNotWritten ( FBEvaluateInfo pEvaluateInfo ) [virtual, inherited]

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
virtual FBAnimationNode* FBBox::AnimationNodeInGet ( ) [virtual, inherited]

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

Returns:
A handle to the animation node for this box.
virtual FBAnimationNode* FBBox::AnimationNodeOutGet ( ) [virtual, inherited]
virtual const char* FBBox::FbxGetObjectSubType ( ) [virtual, inherited]

returns UniqueName if not overloaded.

Reimplemented in FBMaterial, FBModel, FBModelNull, and FBModelMarker.

virtual const char* FBBox::FbxGetObjectType ( ) [virtual, inherited]

Object Type "Box".

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

FBComponent::GetInternalClassId ( ) [static, inherited]
Returns:
Internal class Id

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual bool FBComponent::FBCreate ( ) [virtual, inherited]
virtual void FBComponent::FBDestroy ( ) [virtual, inherited]
virtual bool FBComponent::SetHIObject ( HIObject  pObject,
bool  pSDKComponent 
) [override, virtual, inherited]

Assign component to an internal pointer.

Reimplemented from FBPlug.

virtual int FBComponent::PropertyAdd ( FBProperty pProperty ) [virtual, inherited]

Add a property to the component's property manager.

Parameters:
pProperty The property to add to the property manager.
Returns:
Index in the property array where property was inserted.
bool FBComponent::PropertyAddReferenceProperty ( FBProperty pReferenceProperty ) [inherited]

Add a reference property to the component's property manager.

Parameters:
pReferenceProperty The property to from an other object to add a reference to (property cannot be a custom ORSDK property).
Returns:
True if the reference property could be added.
void FBComponent::PropertyRemove ( FBProperty pProperty ) [inherited]

Remove a Property from the component's Property manager.

If the property was dynamically allocated, it is deleted.

Parameters:
pProperty The property to remove from the property manager.
void FBComponent::PropertyGetModifiedList ( FBArrayTemplate< FBProperty * > &  pPropList,
FBPlugModificationFlag  pModificationFlags 
) [inherited]

Get list of properties which have been modified since last loading.

Parameters:
pPropList property list to hold the modified properties.
pModificationFlags type of modification to query.
FBProperty* FBComponent::PropertyCreate ( const char *  pName,
FBPropertyType  pType,
const char *  pDataType,
bool  pAnimatable,
bool  pIsUser = false,
FBProperty pReferenceSource = NULL 
) [inherited]

Create user or dynamic property.

Parameters:
pName The name of the property.
pType Type of the property. See enum FBPropertyType.
pDataType DataType of the property.
pAnimatable To specify if the property can be animated.
pIsUser To specify if the property is available as a custom property or dynamic and attached to the object.
pReferenceSource Specifies the property that a reference refers to.
FBObjectFlag FBComponent::GetObjectFlags ( ) [inherited]

Get all Object Flags (concatenated).

Returns:
Get all object flags in one call. Flags can be concatenated.
void FBComponent::SetObjectFlags ( FBObjectFlag  pFlags ) [inherited]

SetObjectFlags.

Parameters:
pFlags Set flag values. Note: this function overwrites all flags with those passed in parameter.
bool FBComponent::HasObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Check whether a specific object flag is enabled.

Parameters:
pFlags Flags to check if they are present.
Returns:
True if all flags in pFlags are enabled.
void FBComponent::EnableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Enable a specific Object Flags.

Parameters:
pFlags Flags to enable.
void FBComponent::DisableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Disable a specific Object Flags.

Parameters:
pFlags Flags to disable.
void FBComponent::SetObjectStatus ( FBObjectStatus  pStatus,
bool  pValue 
) [inherited]

Enable/Disable a specific Object Status.

Parameters:
pStatus Status to change.
pValue Value to change the status to.
bool FBComponent::GetObjectStatus ( FBObjectStatus  pStatus ) [inherited]

Check to see if an object status is enabled.

Parameters:
pStatus Status to query.
bool FBComponent::ProcessNamespaceHierarchy ( FBNamespaceAction  pNamespaceAction,
const char *  pNamespaceName,
const char *  pReplaceTo = NULL,
bool  pAddRight = true 
) [inherited]

ProcessNamespaceHierarchy.

New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This recursive function goes through the whole hierarchy (children) to add/replace the prefix. If you need to work on a single object, use the ProcessObjectPrefix function.

Parameters:
pNamespaceAction Which operation to do on the hierarchy (children).
pNamespaceName The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo The new Namespace Name or NULL in case of add or delete.
pAddRight Whether to add the namespace on right-most or left-most side or other namespace.
Returns:
return true if process successful.
bool FBComponent::ProcessObjectNamespace ( FBNamespaceAction  pNamespaceAction,
const char *  pNamespaceName,
const char *  pReplaceTo = NULL,
bool  pAddRight = true 
) [inherited]

ProcessObjectNamespace.

New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This function is the same as ProcessNamespaceHierarchy except that it applies only on the current object and not to the object's children.

Parameters:
pNamespaceAction Which operation to do on the hierarchy (children).
pNamespaceName The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo The new Namespace Name or NULL in case of add or delete.
pAddRight Whether to add the namespace on right-most or left-most side or other namespace.
Returns:
return true if process successful.
virtual const char* FBComponent::ClassName ( ) [override, virtual, inherited]

Get the class name.

Returns:
The class name (i.e. "FBComponent").

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual bool FBComponent::UseCustomPropertyViewSet ( ) const [inline, virtual, inherited]

Use the custom property viewSet or not.

To have custom property view for custom subclass, modification bin/config/propertyview.fbx is required.

Returns:
False if to use internal corresponding object's viewSet of the parent class.

Definition at line 791 of file fbcomponent.h.

{ return true; }
const char* FBComponent::GetFullName ( void  ) [inherited]

Get the full name.

Returns:
the full name of the component.
void FBComponent::SetOwnerNamespace ( FBNamespace pOwnerNSObj ) [inherited]

Set the owner Namespace object.

FBNamespace* FBComponent::GetOwnerNamespace ( void  ) [inherited]

Get the owner Namespace object.

Returns:
the owner Namespace object
FBFileReference* FBComponent::GetOwnerFileReference ( void  ) [inherited]

Get the owner FileReference object.

Returns:
the owner FileReference object
void FBComponent::HardSelect ( ) [inherited]

HardSelect.

Selects the object, and emits a hard select event for UI update notification.

void* FBComponent::operator new ( size_t  stAllocateBlock ) [inherited]
void* FBComponent::operator new ( size_t  stAllocateBlock,
int  blockType,
const char *  filename,
int  linenumber 
) [inherited]
void FBComponent::operator delete ( void *  pvMem ) [inherited]
void FBComponent::RegisterPropertyEvent ( FBPropertyEvent pPropertyEvent ) [inherited]
void FBComponent::UnregisterPropertyEvent ( FBPropertyEvent pPropertyEvent ) [inherited]
void FBComponent::InvalidatePropertyEventsParents ( ) [inherited]
FBComponent::ICallback_Declare ( K_IMPLEMENTATION  ) [inherited]

Reimplemented from FBPlug.

Reimplemented in FBModel, and FBVisualComponent.

virtual bool FBComponent::Is ( int  pTypeId ) [virtual, inherited]

Returns true if object is of type TypeId.

Parameters:
pTypeId TypeId to compare object to.
Returns:
Result of the comparison.

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual int FBComponent::GetTypeId ( ) [virtual, inherited]

GetTypeId( int pTypeId )

Returns:
The TypeInfo of the object

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

static void FBComponent::FBComponentSetName ( FBComponent pObject,
const char *  pName 
) [static, inherited]
static const char* FBComponent::FBComponentGetName ( FBComponent pObject ) [static, inherited]
static void FBComponent::FBComponentSetLongName ( FBComponent pObject,
const char *  pName 
) [static, inherited]
static const char* FBComponent::FBComponentGetLongName ( FBComponent pObject ) [static, inherited]
void FBComponent::KObjectEvent ( HIRegister  pView,
HKEventBase  pEvent 
) [inherited]
virtual HIObject FBPlug::GetHIObject ( ) const [virtual, inherited]

Return an internal pointer.

bool FBPlug::IsSDKComponent ( ) [inherited]

Return whether or not item is an SDK component.

bool FBPlug::ConnectSrc ( FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a source connection.

Parameters:
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ConnectDst ( FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a destination connection.

Parameters:
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False)
bool FBPlug::ConnectSrcAt ( int  pDst_SrcIndex,
FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a source connection.

Parameters:
pDst_SrcIndex Index that tells where to add this source connection in the destination's connection list. if index is out of bound, and this source connection will be appended at the end.
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ConnectDstAt ( int  pSrc_DstIndex,
FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a destination connection.

Parameters:
pSrc_DstIndex Index that tells where to add this destination connection in the source's connection list. if index is out of bound, and this destination connection will be appended at the end.
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectDst ( FBPlug pDst ) [inherited]

Remove a destination connection.

Parameters:
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrc ( FBPlug pSrc ) [inherited]

Remove a source connection.

Parameters:
pSrc Source plug.
Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::DisconnectAllSrc ( ) [inherited]

Remove all source connections.

void FBPlug::DisconnectAllDst ( ) [inherited]

Remove all destination connections.

bool FBPlug::DisconnectDstAt ( int  pIndex ) [inherited]

Remove a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrcAt ( int  pIndex ) [inherited]

Remove a source connection at a specified index.

Parameters:
pIndex Source plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceDstAt ( int  pIndex,
FBPlug pDst 
) [inherited]

Replace a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
pDst Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceSrcAt ( int  pIndex,
FBPlug pSrc 
) [inherited]

Replace a source connection at a specified index.

Parameters:
pIndex Source plug index.
pSrc Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::SwapSrc ( int  pIndexA,
int  pIndexB 
) [inherited]

Swap source connection at index A with source connection at index B.

Parameters:
pIndexA Plug index.
pIndexB Other plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::MoveSrcAt ( int  pIndex,
int  pAtIndex 
) [inherited]

Move source connection at pIndex to pAtIndex.

Parameters:
pIndex Plug current index.
pAtIndex Plug new index.
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtIndex is untouched.
bool FBPlug::MoveSrcAt ( FBPlug pSrc,
FBPlug pAtSrc 
) [inherited]

Move source connection pSrc to the position of pAtSrc.

Parameters:
pSrc Plug.
pAtSrc Plug that mark where we want to insert (will insert before this one).
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtSrc is untouched.
int FBPlug::GetSrcCount ( ) [inherited]

Get source connection count.

Returns:
Total sources connections count.
FBPlug* FBPlug::GetSrc ( int  pIndex ) [inherited]

Get a source connection's plug at specified index.

Parameters:
pIndex Index of the source connection's plug.
Returns:
Source plug at specified index.
FBConnectionType FBPlug::GetSrcType ( int  pIndex ) [inherited]

Get a source connection's type at specified index.

Parameters:
pIndex Index of the source connection's type.
Returns:
Source connection's type at specified index.
int FBPlug::GetDstCount ( ) [inherited]

Get destination connection count.

Returns:
Total destinations connections count.
FBPlug* FBPlug::GetDst ( int  pIndex ) [inherited]

Get a destination connection's plug at specified index.

Parameters:
pIndex Index of the destination connection's plug.
Returns:
Destination plug at specified index.
FBConnectionType FBPlug::GetDstType ( int  pIndex ) [inherited]

Get a destination connection's type at specified index.

Parameters:
pIndex Index of the destination connection's type.
Returns:
Destination connection's type at specified index.
bool FBPlug::BeginChange ( ) [inherited]

Begins a change on multiple plugs.

Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::EndChange ( ) [inherited]

Ends a change on multiple plugs.

void FBPlug::SetSelfModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's self modification flag.

Parameters:
pFlag bitwise AND of self modification flags.
pBool true if self changed.
bool FBPlug::GetSelfModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's self has changed.

Parameters:
pFlag bitwise AND of self modification flags.
Returns:
true if self changed
void FBPlug::SetContentModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's owned property/object's modification flag.

Parameters:
pFlag bitwise AND of content modification flags.
pBool true if content has modification.
bool FBPlug::GetContentModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's content has changed.

Parameters:
pFlag bitwise AND of content modification flags.
Returns:
true if content connection changed.
int FBPlug::GetPlugConnectionModifiedList ( FBPlugList pPlugList,
FBPlugModificationFlag  pConnectionModificatonFlag,
bool  pAddRemove 
) [inherited]

Get plug's modified src/dst property/object connection added/removed List.

Parameters:
pPlugList plug list to fill up.
pConnectionModificatonFlag Src/Dst Property/Object connection modification flag.
pAddRemove Ask for the added list if true, removed list if false.
Returns:
count of list;
bool FBPlug::RevertModification ( FBPlugModificationFlag  pFlag = kFBAllModifiedMask ) [inherited]

Revert the plug's modification to original status.

Parameters:
pFlag the type of modification to be reverted.
Returns:
true if revert successfully.
void FBPlug::SetStatusFlag ( FBPlugStatusFlag  pStatus,
bool  pValue 
) [inherited]

Set the plug's status flag.

Parameters:
pStatus bitwise AND of status flags.
pValue true if status has modification.
bool FBPlug::GetStatusFlag ( FBPlugStatusFlag  pStatus ) const [inherited]

Tell if the plug's status has changed.

Parameters:
pStatus bitwise AND of self modification flags.
Returns:
true if self changed
FBPlug* FBPlug::GetOwner ( ) [inherited]

Get the owner of this plug.

Very useful for properties since they are plugs too.

Returns:
The owner of this plug.
FBPlug* FBPlug::GetOwned ( int  pIndex ) [inherited]

Get the owned plug at specified index.

Parameters:
pIndex Index of the owned plug to get.
Returns:
The owned plug at specified index.
int FBPlug::GetOwnedCount ( ) [inherited]

Get the owned plug count.

Returns:
The owned plug count.
virtual bool FBPlug::PlugDataNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true
virtual bool FBPlug::PlugStateNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true except in the case of property rename kFBRename
virtual bool FBPlug::PlugNotify ( FBConnectionAction  pAction,
FBPlug pThis,
int  pIndex,
FBPlug pPlug = NULL,
FBConnectionType  pConnectionType = kFBConnectionTypeNone,
FBPlug pNewPlug = NULL 
) [virtual, inherited]

PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pIndex Index of the plug.
pPlug Other plug concerned.
pConnectionType Connection type between the plugs.
pNewPlug New plug (for the replace event).
Returns:
should by default return true except in the case of connection requests (kFBRequestConnectSrc or kFBRequestConnectDst)
static void FBPlug::PrintClassDefinitions ( ) [static, inherited]

Print out internal Class (ID) Definition table.

For internal debug purpose only.

FBScriptWrapper* FBWrapperHolder::GetWrapper ( ) [inherited]

Return the wrapper interface of this FBObject.

void FBWrapperHolder::AddWrapper ( FBScriptWrapper ) [inherited]
void FBWrapperHolder::RemoveWrapper ( FBScriptWrapper ) [inherited]

Friends And Related Function Documentation

K_DLLIMPORT friend int __FBRegisterTypeInfo ( int  pInternalClassId ) [friend, inherited]

__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.


Member Data Documentation

FBPropertyActorFace FBCharacterFace::InputActorFace

Read Write Property: The index of the actor used for the input.

Definition at line 123 of file fbcharacterface.h.

Read Write Property: Is the character input active?

Definition at line 124 of file fbcharacterface.h.

Read Write Property: Is a deformer constraint?

Definition at line 335 of file fbconstraint.h.

Read Write Property: Does the constraint have a layout?

Definition at line 336 of file fbconstraint.h.

Read Write Property: Long description of constraint.

Definition at line 337 of file fbconstraint.h.

Read Write Property: Active state.

Definition at line 339 of file fbconstraint.h.

Read Write Property: Lock state.

Definition at line 340 of file fbconstraint.h.

Function Property: Snap constraint.

Definition at line 341 of file fbconstraint.h.

Read Write Property: Weight of constraint.

Reimplemented in FBStoryTrack.

Definition at line 342 of file fbconstraint.h.

const char* FBBox::UniqueName [inherited]

internal Unique name.

Definition at line 293 of file fbcore.h.

Read Write Property: Is the box animatable.

Definition at line 299 of file fbcore.h.

Read Write Property: Is live?

Definition at line 300 of file fbcore.h.

Read Write Property: Is recording?

Definition at line 301 of file fbcore.h.

DataFBComponent* FBComponent::mLocalPtr [inherited]

Handle on DataFBComponent.

Reimplemented in FBCustomManager.

Definition at line 650 of file fbcomponent.h.

FBString FBComponent::mName [protected, inherited]

Name of the component.

Definition at line 653 of file fbcomponent.h.

int FBComponent::TypeInfo [static, inherited]

Contains the Type information of the object.

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

Definition at line 658 of file fbcomponent.h.

Read Only Property: Manages all of the properties for the component.

Definition at line 838 of file fbcomponent.h.

List: List of components.

Reimplemented in FBScene, and FBPropertyInspector.

Definition at line 839 of file fbcomponent.h.

List: Parents.

Definition at line 840 of file fbcomponent.h.

Read Write Property: Selected property.

Definition at line 841 of file fbcomponent.h.

Read Write Property: Unique name of object.

Reimplemented in FBAssetMng, FBConsoleChannel, FBTriggerGroup, FBTrigger, FBMotionClip, and FBTool.

Definition at line 842 of file fbcomponent.h.

Read Write Property: Name and namespace for object.

Definition at line 843 of file fbcomponent.h.

FBPropertyFolder FBComponent::Folder [inherited]

Read Write Property: The folder that contain this component.

Definition at line 846 of file fbcomponent.h.

KObject* FBComponent::mDummyObject [inherited]

Internal Dummy Object for non KObject Components.

Definition at line 871 of file fbcomponent.h.

const char* FBPlug::ClassGroupName [static, inherited]

ClassGroupName of the object.

Definition at line 444 of file fbplug.h.

bool FBPlug::mAllocated [inherited]

Contain the Allocation State of the Component.

Definition at line 450 of file fbplug.h.

int FBPlug::mGlobalTypeInfo [static, protected, inherited]

Represente the Type Index.

Definition at line 500 of file fbplug.h.

HIObject FBPlug::mObject [protected, inherited]

Handle on the Plug.

Definition at line 502 of file fbplug.h.

bool FBPlug::mSDKComponent [protected, inherited]

bool Plug is an SDK component.

Definition at line 503 of file fbplug.h.


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