ToyMaker::ConstraintParametrized< TConfig, TParameter, LagrangeCount > Class Template Reference

Subclass implementation for any constraint which takes data of type TParameter. More...

#include <types.hpp>

Inheritance diagram for ToyMaker::ConstraintParametrized< TConfig, TParameter, LagrangeCount >:

Public Types
using	Config = TConfig
using	Parameter = TParameter
Public Types inherited from ToyMaker::BaseConstraint
using	ParticipantID = std::size_t
using	ParticipantTable

Public Member Functions
	ConstraintParametrized (const TConfig &config, const std::vector< TParameter > &constraintParameters, float compliance)
	Initializes this constraint with some initial compliance value and constraint parameters.
void	setConfig (const TConfig &config)
	Sets configuration for this constraint.
TConfig	getConfig () const
	Gets the current configuration of this constraint.
void	setParameter (BaseConstraint::ParticipantID participant, const TParameter &parameter)
	Adds a parameter for this constraint.
TParameter	getParameter (BaseConstraint::ParticipantID participant) const
	Gets parameter belonging to a particular constraint participant.
void	removeParameter (BaseConstraint::ParticipantID participant)
	Removes a parameter belonging to a particular constraint participant.
const std::unordered_map< BaseConstraint::ParticipantID, TParameter > &	getParameters () const
	Returns all parameters known to this constraint.
Public Member Functions inherited from ToyMaker::Constraint< LagrangeCount >
void	applyLagrangeDelta (float delta, uint8_t index)
	Adds a delta to a lagrange value located at index.
const std::array< float, LagrangeCount > &	getLagrange () const
	Gets the current Lagrange multiplier values for this constraint.
const std::array< float, LagrangeCount > &	getLagrangeDelta () const
	Gets the latest lagrange delta applied to a constraint.
void	resetLagrange () override
	Sets all lagrange multipliers to 0 in preparation for the next physics update.
template<uint8_t ... indices>
void	resetLagrange (std::integer_sequence< uint8_t, indices... > sequence)
Public Member Functions inherited from ToyMaker::BaseConstraint
float	getCompliance () const
	Gets the current compliance value for this constraint.
virtual void	applyConstraintPosition (const ParticipantTable &states, float substepSeconds)
	Applies positional constraint to current set of bounds and physics states.
virtual void	applyConstraintVelocity (const ParticipantTable &states, float substepSeconds)
	Applies velocity-based constraint to current set of bounds and physics states.
void	setCompliance (float newCompliance)
	Sets the compliance value for this constraint.
template<typename TConstraint, std::enable_if_t< std::is_base_of< ConstraintParametrized< typename TConstraint::Config, typename TConstraint::Parameter, TConstraint::NLagrange >, TConstraint >::value, bool > = true>
void	setParameter (ParticipantID participant, const typename TConstraint::Parameter &parameter)
	Sets a parameter belonging to a particular constraint participant.
template<typename TConstraint, std::enable_if_t< std::is_base_of< ConstraintParametrized< typename TConstraint::Config, typename TConstraint::Parameter, TConstraint::NLagrange >, TConstraint >::value, bool > = true>
TConstraint::Parameter	getParameter (ParticipantID participant) const
	Gets a parameter associated with a particular constraint participant.
template<typename TConstraint, std::enable_if_t< std::is_base_of< ConstraintParametrized< typename TConstraint::Config, typename TConstraint::Parameter, TConstraint::NLagrange >, TConstraint >::value, bool > = true>
void	setConfig (const typename TConstraint::Config &config)
	Sets the configuration of a constraint.
template<typename TConstraint, std::enable_if_t< std::is_base_of< ConstraintParametrized< typename TConstraint::Config, typename TConstraint::Parameter, TConstraint::NLagrange >, TConstraint >::value, bool > = true>
TConstraint::Config	getConfig () const
	Gets the configuration of a constraint.

Static Public Attributes
static const uint8_t	NLagrange = LagrangeCount

Private Attributes
std::unordered_map< BaseConstraint::ParticipantID, TParameter >	mParameters {}
	A set of parameters associated with each entity.
TConfig	mConfig {}
	The configuration of the constraint as a whole, specific to this constraint.

Additional Inherited Members
Protected Member Functions inherited from ToyMaker::Constraint< LagrangeCount >
	Constraint (float compliance)
	Initializes this constraint with some initial compliance value.
Protected Member Functions inherited from ToyMaker::BaseConstraint
	BaseConstraint (float compliance)
	Initializes this constraint.

Detailed Description

template<typename TConfig, typename TParameter, uint8_t LagrangeCount>
class ToyMaker::ConstraintParametrized< TConfig, TParameter, LagrangeCount >

Subclass implementation for any constraint which takes data of type TParameter.

Template Parameters

TConfig	The configuration data for the constraint as a whole
TParameter	A per-entity parameter specific to this constraint.
LagrangeCount	The number of Lagrange multipliers used by this constraint

TODO: Why am I doing all this overcomplicated template nonsense here? Review and simplify.

Member Data Documentation

mParameters

template<typename TConfig, typename TParameter, uint8_t LagrangeCount>

std::unordered_map<BaseConstraint::ParticipantID, TParameter> ToyMaker::ConstraintParametrized< TConfig, TParameter, LagrangeCount >::mParameters {}

private

A set of parameters associated with each entity.

These parameters store values that augment the values known by the engine – i.e., physics state and object bounds – but are specific to the constraint itself

---

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

• ToyMaker_Main/include/toymaker/engine/physics/types.hpp