FBConstraintSolver Class Reference


Detailed Description

Base class for constraint solver.

Inheritance diagram for FBConstraintSolver:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
FBEvaluateInfo BackgroundEvaluateInfoBegin (FBEvaluateInfo pSourceEvaluateInfo, bool pEvaluateCandidates=False)
 Start background evaluation.
FBEvaluateInfo BackgroundEvaluateInfoRecursiveBegin (FBEvaluateInfo pSourceEvaluateInfo, bool pForceUpdateLocals=False)
 Start recursive background evaluation.
 BackgroundEvaluateInfoEnd (FBEvaluateInfo pBackgroundEvaluateInfo)
 Release background evaluation info - very important.
bool BackgroundEvaluateInfoNotify (FBEvaluateInfo pBackgroundEvaluateInfo, function pFunction, pCustomData=None)
 Enable evaluation notification.
 MultiThreaded (bool pActive)
bool IsMultiThreaded ()
 LiveChanged ()
bool BackgroundEvaluate (FBModel pModel, FBComponent pTrackOrTake, FBTime pTime, FBVector3 pT, FBVector3 pR, FBVector3 pS, FBEvaluateInfo pEvaluateInfo=None, bool pGlobal=True)

Public Attributes

FBPropertyBase SampleRecordingPrecision
 Read Write Property: Sample Recording Precision?.
FBPropertyBase SyncAnimationPlay
 Read Write Property: Sync animation play speed with solver? (for computation expensive scenes this will cause none Realtime play).

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameName of constraint.
pObjectFor internal use only (default is NULL).

Reimplemented from FBConstraint.

FBEvaluateInfo BackgroundEvaluateInfoBegin ( FBEvaluateInfo  pSourceEvaluateInfo,
bool  pEvaluateCandidates = False 
)

Start background evaluation.

Needs to be released as soon as possible.

Parameters:
pSourceEvaluateInfoSource evaluation. Needs to be valid one.
pEvaluateCandidatesNotify that we want to be able to resolve candidates - this can be called only from main thread (on other threads won't work)
Returns:
Background evaluation info that will work with new ID and in secured buffers.
Note:
Example of usage can be found in /OpenRealitySDK/samples/constraints/CharacterSolver/HIK2014Solver
FBEvaluateInfo BackgroundEvaluateInfoRecursiveBegin ( FBEvaluateInfo  pSourceEvaluateInfo,
bool  pForceUpdateLocals = False 
)

Start recursive background evaluation.

Needs to be released as soon as possible.

Parameters:
pSourceEvaluateInfoSource evaluation. Needs to be valid one.
pForceUpdateLocalsEvaluate local transformation, even if only global was requested
Returns:
Background evaluation info that will work with new ID and in secured buffers.
Note:
Example of usage can be found in /OpenRealitySDK/Samples/constraints/CharacterSolver/HIK2014Solver
BackgroundEvaluateInfoEnd ( FBEvaluateInfo  pBackgroundEvaluateInfo)

Release background evaluation info - very important.

bool BackgroundEvaluateInfoNotify ( FBEvaluateInfo  pBackgroundEvaluateInfo,
function  pFunction,
pCustomData  = None 
)

Enable evaluation notification.

Parameters:
pBackgroundEvaluateInfoBackground evaluation that was started for this object and for which we want to change enable/disable notification callback
pFunctionCallback function, will be called when FBAnimationNode of this constraint is being evaluated. Passing NULL disable notification.
pCustomDataCustomer can pass custom data to callback.
Returns:
Confirms that change was made to pBackgroundEvaluateInfo
Note:
Example of usage can be found in /OpenRealitySDK/Samples/constraints/CharacterSolver/HIK2014Solver
MultiThreaded ( bool  pActive)
bool IsMultiThreaded ( )
LiveChanged ( )
bool BackgroundEvaluate ( FBModel  pModel,
FBComponent  pTrackOrTake,
FBTime  pTime,
FBVector3  pT,
FBVector3  pR,
FBVector3  pS,
FBEvaluateInfo  pEvaluateInfo = None,
bool  pGlobal = True 
)

Member Data Documentation

FBPropertyBase SampleRecordingPrecision

Read Write Property: Sample Recording Precision?.

FBPropertyBase SyncAnimationPlay

Read Write Property: Sync animation play speed with solver? (for computation expensive scenes this will cause none Realtime play).


FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver
FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver FBConstraintSolver