interface MAGES::MeshDeformations::IConstraintSolver¶

Overview¶

Interface that must be implemented by all user defined constraint solver. More…

interface IConstraintSolver
{
    // properties

    PhysicsWorld PhysicsWorld;
    int ExecutionOrder;

    // methods

    void RegisterSolver();
    void DeregisterSolver();
    JobHandle DispatchSolveJob(in float timeStep, JobHandle dependsOn);
};

// direct descendants

class BaseConstraintSolver;

Detailed Documentation¶

Interface that must be implemented by all user defined constraint solver.

Properties¶

PhysicsWorld PhysicsWorld

Gets the physics world in which this solver will be registered.

int ExecutionOrder

Gets the execution order of this solver. The lower the value, the earlier it will be executed along other user defined solvers.

Methods¶

void RegisterSolver()

Registers the solver to the physics world.

void DeregisterSolver()

Deregisters the solver from the physics world.

JobHandle DispatchSolveJob(in float timeStep, JobHandle dependsOn)

Called by the physics world when it needs to dispatch this solver’s jobs.

Parameters:

Returns:

Returns the job handle of the dispatched job.