Public Member Functions | Static Public Member Functions | Public Attributes

FBConstraintSolver Class Reference

Search for all occurrences

Detailed Description

Base class for constraint solver.

Definition at line 559 of file fbconstraint.h.

#include <fbconstraint.h>

Inheritance diagram for FBConstraintSolver:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBConstraintSolver (const char *pName, HIObject pObject=NULL)
FBEvaluateInfoBackgroundEvaluateInfoBegin (FBEvaluateInfo *pSourceEvaluateInfo, bool pEvaluateCandidates=false)
 Start background evaluation.
FBEvaluateInfoBackgroundEvaluateInfoRecursiveBegin (FBEvaluateInfo *pSourceEvaluateInfo, bool pForceUpdateLocals=false)
 Start recursive background evaluation.
void BackgroundEvaluateInfoEnd (FBEvaluateInfo *pBackgroundEvaluateInfo)
 Release background evaluation info - very important.
bool BackgroundEvaluateInfoNotify (FBEvaluateInfo *pBackgroundEvaluateInfo, kBackgroundEvaluationCallback pFunction, void *pCustomData=NULL)
 Enable evaluation notification.
void MultiThreaded (bool pActive)
bool IsMultiThreaded ()
virtual void LiveChanged ()

Static Public Member Functions

static bool BackgroundEvaluate (FBModel *pModel, FBComponent *pTrackOrTake, FBTime pTime, FBVector3d &pT, FBVector3d &pR, FBVector3d &pS, FBEvaluateInfo *pEvaluateInfo=NULL, bool pGlobal=true)

Public Attributes

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

Constructor & Destructor Documentation

FBConstraintSolver ( const char *  pName,
HIObject  pObject = NULL 
)

Member Function Documentation

static bool BackgroundEvaluate ( FBModel pModel,
FBComponent pTrackOrTake,
FBTime  pTime,
FBVector3d pT,
FBVector3d pR,
FBVector3d pS,
FBEvaluateInfo pEvaluateInfo = NULL,
bool  pGlobal = true 
) [static]
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
void BackgroundEvaluateInfoEnd ( FBEvaluateInfo pBackgroundEvaluateInfo)

Release background evaluation info - very important.

bool BackgroundEvaluateInfoNotify ( FBEvaluateInfo pBackgroundEvaluateInfo,
kBackgroundEvaluationCallback  pFunction,
void *  pCustomData = NULL 
)

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
void MultiThreaded ( bool  pActive)
bool IsMultiThreaded ( )
virtual void LiveChanged ( ) [virtual]

Member Data Documentation

Read Write Property: Sample Recording Precision?

Definition at line 598 of file fbconstraint.h.

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

Definition at line 599 of file fbconstraint.h.


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

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