Base class of any constraints. This class defines the interface of a ShapeOp constraint. More...

#include <Constraint.h>

Inheritance diagram for ShapeOp::Constraint:

Public Member Functions
	Constraint (const std::vector< int > &idI, Scalar weight)
	Constraint constructor. More...

virtual void	project (const Matrix3X &positions, Matrix3X &projections) const =0
	Find the closest, in the least-squre sense, configuration from the input positions that satisfy the constraint. More...

virtual void	addConstraint (std::vector< Triplet > &triplets, int &idO) const =0
	Add the constraint to the linear system. More...

std::size_t	nIndices () const
	Number of indices of vertices involved in the constraint.

Static Public Member Functions
static std::shared_ptr< Constraint >	shapeConstraintFactory (const std::string &ConstraintType, const std::vector< int > &idI, Scalar weight, const Matrix3X &positions)
	Creates a constraint from a string type, a number of indices, a weight and the initial point positions. More...

Protected Attributes
std::vector< int >	idI_
	ids of the vertices involved in this constraint.

Scalar	weight_
	weight for the constraint.

int	idO_
	location of this constraint in the linear system.

Detailed Description

Base class of any constraints. This class defines the interface of a ShapeOp constraint.

Constructor & Destructor Documentation

SHAPEOP_INLINE ShapeOp::Constraint::Constraint	(	const std::vector< int > &	idI,
		Scalar	weight
	)

Constraint constructor.

Parameters

idI	A vector of indices of the vertices to be constrained.
weight	The weight of the constraint to be added relative to the other constraints.

virtual void ShapeOp::Constraint::addConstraint	(	std::vector< Triplet > &	triplets,
		int &	idO
	)		const

pure virtual

Add the constraint to the linear system.

Parameters

[out]	triplets	A vector of triplets each representing an entry in a sparse matrix.
[in,out]	idO	In: The first row index of the constraint in the sparse matrix. Out: The last row index plus one.

virtual void ShapeOp::Constraint::project	(	const Matrix3X &	positions,
		Matrix3X &	projections
	)		const

pure virtual

Find the closest, in the least-squre sense, configuration from the input positions that satisfy the constraint.

Parameters

positions	The positions of all the n vertices stacked in a 3 by n matrix.
projections	The projections of the vertices involved in the constraint.

SHAPEOP_INLINE std::shared_ptr< Constraint > ShapeOp::Constraint::shapeConstraintFactory	(	const std::string &	ConstraintType,
		const std::vector< int > &	idI,
		Scalar	weight,
		const Matrix3X &	positions
	)

static

Creates a constraint from a string type, a number of indices, a weight and the initial point positions.

Parameters

ConstraintType	One of the following: "EdgeStrain", see ShapeOp::EdgeStrainConstraint "TriangleStrain", see ShapeOp::TriangleStrainConstraint "TetrahedronStrain", see ShapeOp::TetrahedronStrainConstraint "Area", see ShapeOp::AreaConstraint "Volume", see ShapeOp::VolumeConstraint "Bending", see ShapeOp::BendingConstraint "Closeness", see ShapeOp::ClosenessConstraint "Line", see ShapeOp::LineConstraint "Plane", see ShapeOp::PlaneConstraint "Circle", see ShapeOp::CircleConstraint "Sphere", see ShapeOp::SphereConstraint "Similarity", see ShapeOp::SimilarityConstraint with scaling "Rigid", see ShapeOp::SimilarityConstraint without scaling "Rectangle", see ShapeOp::RectangleConstraint "Parallelogram", see ShapeOp::ParallelogramConstraint "Laplacian", see ShapeOp::UniformLaplacianConstraint "LaplacianDisplacement", see ShapeOp::UniformLaplacianConstraint of deformation
idI	A vector of indices of the vertices to be constrained.
weight	The weight of the constraint to be added relative to the other constraints.
positions	The positions of all the n vertices stacked in a 3 by n matrix.

Returns: A std::shared pointer to the Constraint, which is empty/null if failed.

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