dali-physics/third-party/chipmunk2d/include/chipmunk/cpDampedSpring.h

   1 /* Copyright (c) 2013 Scott Lembcke and Howling Moon Software
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to deal
   5  * in the Software without restriction, including without limitation the rights
   6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   7  * copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  19  * SOFTWARE.
  20  */
  21
  22 /// @defgroup cpDampedSpring cpDampedSpring
  23 /// @{
  24
  25 /// Check if a constraint is a slide joint.
  26 CP_EXPORT cpBool cpConstraintIsDampedSpring(const cpConstraint *constraint);
  27
  28 /// Function type used for damped spring force callbacks.
  29 typedef cpFloat (*cpDampedSpringForceFunc)(cpConstraint *spring, cpFloat dist);
  30
  31 /// Allocate a damped spring.
  32 CP_EXPORT cpDampedSpring* cpDampedSpringAlloc(void);
  33 /// Initialize a damped spring.
  34 CP_EXPORT cpDampedSpring* cpDampedSpringInit(cpDampedSpring *joint, cpBody *a, cpBody *b, cpVect anchorA, cpVect anchorB, cpFloat restLength, cpFloat stiffness, cpFloat damping);
  35 /// Allocate and initialize a damped spring.
  36 CP_EXPORT cpConstraint* cpDampedSpringNew(cpBody *a, cpBody *b, cpVect anchorA, cpVect anchorB, cpFloat restLength, cpFloat stiffness, cpFloat damping);
  37
  38 /// Get the location of the first anchor relative to the first body.
  39 CP_EXPORT cpVect cpDampedSpringGetAnchorA(const cpConstraint *constraint);
  40 /// Set the location of the first anchor relative to the first body.
  41 CP_EXPORT void cpDampedSpringSetAnchorA(cpConstraint *constraint, cpVect anchorA);
  42
  43 /// Get the location of the second anchor relative to the second body.
  44 CP_EXPORT cpVect cpDampedSpringGetAnchorB(const cpConstraint *constraint);
  45 /// Set the location of the second anchor relative to the second body.
  46 CP_EXPORT void cpDampedSpringSetAnchorB(cpConstraint *constraint, cpVect anchorB);
  47
  48 /// Get the rest length of the spring.
  49 CP_EXPORT cpFloat cpDampedSpringGetRestLength(const cpConstraint *constraint);
  50 /// Set the rest length of the spring.
  51 CP_EXPORT void cpDampedSpringSetRestLength(cpConstraint *constraint, cpFloat restLength);
  52
  53 /// Get the stiffness of the spring in force/distance.
  54 CP_EXPORT cpFloat cpDampedSpringGetStiffness(const cpConstraint *constraint);
  55 /// Set the stiffness of the spring in force/distance.
  56 CP_EXPORT void cpDampedSpringSetStiffness(cpConstraint *constraint, cpFloat stiffness);
  57
  58 /// Get the damping of the spring.
  59 CP_EXPORT cpFloat cpDampedSpringGetDamping(const cpConstraint *constraint);
  60 /// Set the damping of the spring.
  61 CP_EXPORT void cpDampedSpringSetDamping(cpConstraint *constraint, cpFloat damping);
  62
  63 /// Get the damping of the spring.
  64 CP_EXPORT cpDampedSpringForceFunc cpDampedSpringGetSpringForceFunc(const cpConstraint *constraint);
  65 /// Set the damping of the spring.
  66 CP_EXPORT void cpDampedSpringSetSpringForceFunc(cpConstraint *constraint, cpDampedSpringForceFunc springForceFunc);
  67
  68 /// @}