/usr/include/kido/dynamics/SoftBodyNode.hpp is in libkido-dev 0.1.0+dfsg-2build9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 | /*
* Copyright (c) 2013-2015, Georgia Tech Research Corporation
* All rights reserved.
*
* Author(s): Jeongseok Lee <jslee02@gmail.com>
*
* Georgia Tech Graphics Lab and Humanoid Robotics Lab
*
* Directed by Prof. C. Karen Liu and Prof. Mike Stilman
* <karenliu@cc.gatech.edu> <mstilman@cc.gatech.edu>
*
* This file is provided under the following "BSD-style" License:
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef KIDO_DYNAMICS_SOFTBODYNODE_HPP_
#define KIDO_DYNAMICS_SOFTBODYNODE_HPP_
const double KIDO_DEFAULT_VERTEX_STIFFNESS = 1.0;
const double KIDO_DEFAULT_EDGE_STIFNESS = 1.0;
const double KIDO_DEFAULT_DAMPING_COEFF = 0.01;
#include <string>
#include <vector>
#include <Eigen/Dense>
#include "kido/dynamics/BodyNode.hpp"
#include "kido/dynamics/PointMass.hpp"
namespace kido {
namespace dynamics {
class PointMass;
class PointMassNotifier;
class SoftMeshShape;
/// SoftBodyNode represent a soft body that has one deformable skin
///
/// This class is implementation of Sumit Jain and C. Karen Liu's paper:
/// http://www.cc.gatech.edu/graphics/projects/Sumit/homepage/projects/softcontacts/index.html
class SoftBodyNode : public BodyNode
{
public:
friend class Skeleton;
friend class PointMass;
friend class PointMassNotifier;
struct UniqueProperties
{
/// Spring stiffness for vertex deformation restoring spring force of the
/// point masses
double mKv;
/// Spring stiffness for edge deformation restoring spring force of the
/// point masses
double mKe;
/// Damping coefficient
double mDampCoeff;
/// Array of Properties for PointMasses
std::vector<PointMass::Properties> mPointProps;
// TODO(JS): Let's remove this because this is rendering part
/// \brief Tri-mesh indexes for rendering.
std::vector<Eigen::Vector3i> mFaces;
UniqueProperties(
double _Kv = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _Ke = KIDO_DEFAULT_EDGE_STIFNESS,
double _DampCoeff = KIDO_DEFAULT_DAMPING_COEFF,
const std::vector<PointMass::Properties>& _points =
std::vector<PointMass::Properties>(),
const std::vector<Eigen::Vector3i>& _faces =
std::vector<Eigen::Vector3i>());
virtual ~UniqueProperties() = default;
/// Add a PointMass to this Properties struct
void addPointMass(const PointMass::Properties& _properties);
/// Connect two PointMasses together in this Properties struct
bool connectPointMasses(size_t i1, size_t i2);
/// Add a face to this Properties struct
void addFace(const Eigen::Vector3i& _newFace);
};
struct Properties : BodyNode::Properties, UniqueProperties
{
Properties(
const BodyNode::Properties& _bodyProperties = BodyNode::Properties(),
const SoftBodyNode::UniqueProperties& _softProperties =
SoftBodyNode::UniqueProperties());
virtual ~Properties() = default;
};
/// \brief
virtual ~SoftBodyNode();
/// Set the Properties of this SoftBodyNode
void setProperties(const Properties& _properties);
/// Set the Properties of this SoftBodyNode
void setProperties(const UniqueProperties& _properties);
/// Remove all SoftBodyShapes and return the last one that was encountered
/// Note: This will be deprecated once VisualizationNodes and CollisionNodes
/// are implemented. Please see #394.
ShapePtr removeSoftBodyShapes();
using SkeletonRefCountingBase::getSkeleton;
/// Get the Properties of this SoftBodyNode
Properties getSoftBodyNodeProperties() const;
/// Copy the Properties of another SoftBodyNode
void copy(const SoftBodyNode& _otherSoftBodyNode);
/// Copy the Properties of another SoftBodyNode
void copy(const SoftBodyNode* _otherSoftBodyNode);
/// Copy the Properties of another SoftBodyNode
SoftBodyNode& operator=(const SoftBodyNode& _otherSoftBodyNode);
/// Get the update notifier for the PointMasses of this SoftBodyNode
PointMassNotifier* getNotifier();
/// Get the update notifier for the PointMasses of this SoftBodyNode
const PointMassNotifier* getNotifier() const;
/// \brief Get mass.
double getMass() const;
/// \brief
void setVertexSpringStiffness(double _kv);
/// \brief
double getVertexSpringStiffness() const;
/// \brief
void setEdgeSpringStiffness(double _ke);
/// \brief
double getEdgeSpringStiffness() const;
/// \brief
void setDampingCoefficient(double _damp);
/// \brief
double getDampingCoefficient() const;
/// \brief
void removeAllPointMasses();
/// \brief
PointMass* addPointMass(const PointMass::Properties& _properties);
/// \brief
size_t getNumPointMasses() const;
/// \brief
PointMass* getPointMass(size_t _idx);
/// \brief
const PointMass* getPointMass(size_t _idx) const;
/// \brief
void connectPointMasses(size_t _idx1, size_t _idx2);
/// \brief
void addFace(const Eigen::Vector3i& _face);
/// \brief
const Eigen::Vector3i& getFace(size_t _idx) const;
/// \brief
size_t getNumFaces() const;
// Documentation inherited.
virtual void clearConstraintImpulse() override;
protected:
/// Constructor called by Skeleton class
SoftBodyNode(BodyNode* _parentBodyNode, Joint* _parentJoint,
const Properties& _properties);
/// Create a clone of this SoftBodyNode. This may only be called by the
/// Skeleton class.
virtual BodyNode* clone(BodyNode* _parentBodyNode, Joint* _parentJoint) const override;
//--------------------------------------------------------------------------
// Sub-functions for Recursive Kinematics Algorithms
//--------------------------------------------------------------------------
// Documentation inherited.
virtual void init(const SkeletonPtr& _skeleton) override;
// Documentation inherited.
// virtual void aggregateGenCoords(std::vector<GenCoord*>* _genCoords);
// Documentation inherited.
// virtual void aggregatePointMassGenCoords(std::vector<GenCoord*>* _genCoords);
//----------------------------------------------------------------------------
/// \{ \name Recursive dynamics routines
//----------------------------------------------------------------------------
/// Update articulated inertia if necessary
void checkArticulatedInertiaUpdate() const;
// Documentation inherited.
virtual void updateTransform() override;
// Documentation inherited.
virtual void updateVelocity() override;
// Documentation inherited.
virtual void updatePartialAcceleration() const override;
// Documentation inherited.
virtual void updateArtInertia(double _timeStep) const override;
// Documentation inherited.
virtual void updateBiasForce(const Eigen::Vector3d& _gravity,
double _timeStep) override;
// Documentation inherited.
virtual void updateBiasImpulse() override;
// Documentation inherited.
virtual void updateAccelerationID() override;
// Documentation inherited.
virtual void updateAccelerationFD() override;
// Documentation inherited.
virtual void updateVelocityChangeFD() override;
// Documentation inherited.
virtual void updateTransmittedForceID(
const Eigen::Vector3d& _gravity,
bool _withExternalForces = false) override;
// Documentation inherited.
virtual void updateTransmittedForceFD() override;
// Documentation inherited.
virtual void updateTransmittedImpulse() override;
// Documentation inherited.
virtual void updateJointForceID(double _timeStep,
double _withDampingForces,
double _withSpringForces) override;
// Documentation inherited.
virtual void updateJointForceFD(double _timeStep,
double _withDampingForces,
double _withSpringForces) override;
// Documentation inherited.
virtual void updateJointImpulseFD() override;
// Documentation inherited.
virtual void updateConstrainedTerms(double _timeStep) override;
/// \}
//----------------------------------------------------------------------------
/// \{ \name Equations of motion related routines
//----------------------------------------------------------------------------
// Documentation inherited.
virtual void updateMassMatrix() override;
// Documentation inherited.
virtual void aggregateMassMatrix(Eigen::MatrixXd& _MCol, size_t _col) override;
// Documentation inherited.
virtual void aggregateAugMassMatrix(Eigen::MatrixXd& _MCol, size_t _col,
double _timeStep) override;
// Documentation inherited.
virtual void updateInvMassMatrix() override;
// Documentation inherited.
virtual void updateInvAugMassMatrix() override;
// Documentation inherited.
virtual void aggregateInvMassMatrix(Eigen::MatrixXd& _InvMCol, size_t _col) override;
// Documentation inherited.
virtual void aggregateInvAugMassMatrix(Eigen::MatrixXd& _InvMCol, size_t _col,
double _timeStep) override;
// Documentation inherited.
// TODO(JS): Not implemented yet.
virtual void aggregateCoriolisForceVector(Eigen::VectorXd& _C) override;
// Documentation inherited.
virtual void aggregateGravityForceVector(Eigen::VectorXd& _g,
const Eigen::Vector3d& _gravity) override;
// Documentation inherited.
virtual void updateCombinedVector() override;
// Documentation inherited.
virtual void aggregateCombinedVector(Eigen::VectorXd& _Cg,
const Eigen::Vector3d& _gravity) override;
// Documentation inherited.
virtual void aggregateExternalForces(Eigen::VectorXd& _Fext) override;
/// \}
// Documentation inherited.
virtual void clearExternalForces() override;
virtual void clearInternalForces() override;
//--------------------------------------------------------------------------
// Rendering
//--------------------------------------------------------------------------
/// \brief Render the entire subtree rooted at this body node.
virtual void draw(renderer::RenderInterface* _ri = nullptr,
const Eigen::Vector4d& _color = Eigen::Vector4d::Ones(),
bool _useDefaultColor = true, int _depth = 0) const override;
protected:
/// \brief List of point masses composing deformable mesh.
std::vector<PointMass*> mPointMasses;
/// An Entity which tracks when the point masses need to be updated
PointMassNotifier* mNotifier;
/// SoftBodyNode Properties
UniqueProperties mSoftP;
/// \brief Soft mesh shape belonging to this node.
std::shared_ptr<SoftMeshShape> mSoftShape;
/// Generalized inertia with point masses
math::Inertia mI2;
///
math::Inertia mArtInertia2;
///
math::Inertia mArtInertiaImplicit2;
private:
/// \brief
void _addPiToArtInertia(const Eigen::Vector3d& _p, double _Pi) const;
/// \brief
void _addPiToArtInertiaImplicit(const Eigen::Vector3d& _p,
double _ImplicitPi) const;
///
void updateInertiaWithPointMass();
};
class SoftBodyNodeHelper
{
public:
/// Create a Properties struct for a box-shaped SoftBodyNode with 8
/// PointMasses
static SoftBodyNode::UniqueProperties makeBoxProperties(
const Eigen::Vector3d& _size,
const Eigen::Isometry3d& _localTransform,
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
/// \brief
/// This should be called before SoftBodyNode::init() is called
static void setBox(SoftBodyNode* _softBodyNode,
const Eigen::Vector3d& _size,
const Eigen::Isometry3d& _localTransform,
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
/// Create a Properties struct for a box-shaped SoftBodyNode. Specify the
/// number of vertices along each axis with _frags. Each component should be
/// equal to or greater than 3. For example, [3 3 3] is allowed but [2 2 2] is
/// not.
static SoftBodyNode::UniqueProperties makeBoxProperties(
const Eigen::Vector3d& _size,
const Eigen::Isometry3d& _localTransform,
const Eigen::Vector3i& _frags,
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
/// \brief
/// This should be called before SoftBodyNode::init() is called
/// \param[in] _frags Number of vertices of box mesh. Each component should be
/// equal or greater than 3. For example, [3 3 3] is allowed but [2 2 2] is
/// not.
// TODO: The component of _frags should allow 2.
static void setBox(SoftBodyNode* _softBodyNode,
const Eigen::Vector3d& _size,
const Eigen::Isometry3d& _localTransform,
const Eigen::Vector3i& _frags,
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
/// Create a Properties struct for a SoftBodyNode with a single PointMass
static SoftBodyNode::UniqueProperties makeSinglePointMassProperties(
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
/// \brief
/// This should be called before SoftBodyNode::init() is called
static void setSinglePointMass(
SoftBodyNode* _softBodyNode,
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
/// Create a Properties struct for an Ellipsoid-shaped SoftBodyNode
static SoftBodyNode::UniqueProperties makeEllipsoidProperties(
const Eigen::Vector3d& _size,
size_t _nSlices,
size_t _nStacks,
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
/// \brief
/// This should be called before SoftBodyNode::init() is called
static void setEllipsoid(SoftBodyNode* _softBodyNode,
const Eigen::Vector3d& _size,
size_t _nSlices,
size_t _nStacks,
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
/// Create a Properties struct for a cylinder-shaped SoftBodyNode
static SoftBodyNode::UniqueProperties makeCylinderProperties(
double _radius,
double _height,
size_t _nSlices,
size_t _nStacks,
size_t _nRings,
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
///
/// This should be called before SoftBodyNode::init() is called
static void setCylinder(SoftBodyNode* _softBodyNode,
double _radius,
double _height,
size_t _nSlices,
size_t _nStacks,
size_t _nRings,
double _totalMass,
double _vertexStiffness = KIDO_DEFAULT_VERTEX_STIFFNESS,
double _edgeStiffness = KIDO_DEFAULT_EDGE_STIFNESS,
double _dampingCoeff = KIDO_DEFAULT_DAMPING_COEFF);
};
} // namespace dynamics
} // namespace kido
#endif // KIDO_DYNAMICS_SOFTBODYNODE_HPP_
|