Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Public Attributes | List of all members
om::physics::constraints::ConstraintRequest Class Reference

A class that contains parameters for how constraint solving should be done. More...

#include <omPhysicsConstraintRequest.h>

Public Member Functions

 ConstraintRequest ()
 Create a new constraint request with the default parameters. More...
 

Public Attributes

Float maxPositionError
 A value close to zero indicating the error tolerance in distance units for constraint solving. More...
 
Float maxVelocityError
 A value close to zero indicating the error tolerance in velocity units for constraint solving. More...
 
Float errorCorrection
 A value between 0 and 1 indicating how quickly constraint position error is corrected. More...
 
Size minIterations
 The minimum number of iterations that should be performed when solving constraints. More...
 
Size maxIterations
 The maximum number of iterations that should be performed when solving constraints. More...
 

Detailed Description

A class that contains parameters for how constraint solving should be done.

Constructor & Destructor Documentation

om::physics::constraints::ConstraintRequest::ConstraintRequest ( )
inline

Create a new constraint request with the default parameters.

Member Data Documentation

Float om::physics::constraints::ConstraintRequest::maxPositionError

A value close to zero indicating the error tolerance in distance units for constraint solving.

Float om::physics::constraints::ConstraintRequest::maxVelocityError

A value close to zero indicating the error tolerance in velocity units for constraint solving.

This value is used to determine when to terminate constraint solving. When the largest solver delta for a given constraint island falls below this value, constraint solving is stopped for a constraint solver island.

Float om::physics::constraints::ConstraintRequest::errorCorrection

A value between 0 and 1 indicating how quickly constraint position error is corrected.

Size om::physics::constraints::ConstraintRequest::minIterations

The minimum number of iterations that should be performed when solving constraints.

Size om::physics::constraints::ConstraintRequest::maxIterations

The maximum number of iterations that should be performed when solving constraints.


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