dali-physics/third-party/chipmunk2d/include/chipmunk/cpGearJoint.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 cpGearJoint cpGearJoint
  23 /// @{
  24
  25 /// Check if a constraint is a damped rotary springs.
  26 CP_EXPORT cpBool cpConstraintIsGearJoint(const cpConstraint *constraint);
  27
  28 /// Allocate a gear joint.
  29 CP_EXPORT cpGearJoint* cpGearJointAlloc(void);
  30 /// Initialize a gear joint.
  31 CP_EXPORT cpGearJoint* cpGearJointInit(cpGearJoint *joint, cpBody *a, cpBody *b, cpFloat phase, cpFloat ratio);
  32 /// Allocate and initialize a gear joint.
  33 CP_EXPORT cpConstraint* cpGearJointNew(cpBody *a, cpBody *b, cpFloat phase, cpFloat ratio);
  34
  35 /// Get the phase offset of the gears.
  36 CP_EXPORT cpFloat cpGearJointGetPhase(const cpConstraint *constraint);
  37 /// Set the phase offset of the gears.
  38 CP_EXPORT void cpGearJointSetPhase(cpConstraint *constraint, cpFloat phase);
  39
  40 /// Get the angular distance of each ratchet.
  41 CP_EXPORT cpFloat cpGearJointGetRatio(const cpConstraint *constraint);
  42 /// Set the ratio of a gear joint.
  43 CP_EXPORT void cpGearJointSetRatio(cpConstraint *constraint, cpFloat ratio);
  44
  45 /// @}