Blender V5.3
blender::xpbd::ConstraintSet Class Referenceabstract

#include <GEO_xpbd_constraint_set.hh>

Inherited by blender::xpbd::TemplatedConstraintSet< CollisionEdgeConstraintSet >, blender::xpbd::TemplatedConstraintSet< CollisionFaceConstraintSet >, blender::xpbd::TemplatedConstraintSet< DistanceConstraintSet >, blender::xpbd::TemplatedConstraintSet< PinPositionConstraintSet >, blender::xpbd::TemplatedConstraintSet< PinRotationConstraintSet >, blender::xpbd::TemplatedConstraintSet< RodBendAndTwistConstraintSet >, blender::xpbd::TemplatedConstraintSet< RodStretchAndShearConstraintSet >, and blender::xpbd::TemplatedConstraintSet< Child >.

Public Member Functions

 ConstraintSet (int constraints_num, Vector< int > affected_geo_indices)
virtual ~ConstraintSet ()=default
virtual StringRefNull debug_name () const =0
virtual void solve_sequential (const ConstraintSetParams &params, GaussSeidelUpdater &updater, const IndexMask &mask)=0
virtual void reset_forces ()=0
virtual ConstraintColoring color_constraints (LinearAllocator<> &memory) const =0
void solve_sequential_all (const ConstraintSetParams &params, GaussSeidelUpdater &updater)
Span< int > get_affected_geo_indices () const

Protected Attributes

int constraints_num_
Vector< int > affected_geo_indices_

Detailed Description

Base class for constraint evaluators. It evaluate a batch of constraints and writes back the results using a passed in "updater".

Use TemplatedConstraintSet to instantiate the constraint evaluation for each updater automatically. This avoids having to implement separate Jacobian and Gauss Seidel code paths for such constraints.

Definition at line 26 of file GEO_xpbd_constraint_set.hh.

Constructor & Destructor Documentation

◆ ConstraintSet()

blender::xpbd::ConstraintSet::ConstraintSet ( int constraints_num,
Vector< int > affected_geo_indices )
inline

◆ ~ConstraintSet()

virtual blender::xpbd::ConstraintSet::~ConstraintSet ( )
virtualdefault

Member Function Documentation

◆ color_constraints()

◆ debug_name()

◆ get_affected_geo_indices()

Span< int > blender::xpbd::ConstraintSet::get_affected_geo_indices ( ) const
inline

Definition at line 51 of file GEO_xpbd_constraint_set.hh.

References affected_geo_indices_.

◆ reset_forces()

◆ solve_sequential()

◆ solve_sequential_all()

void blender::xpbd::ConstraintSet::solve_sequential_all ( const ConstraintSetParams & params,
GaussSeidelUpdater & updater )
inline

Member Data Documentation

◆ affected_geo_indices_

◆ constraints_num_


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