Chipmunk2D Pro API Reference  7.0.0
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 
24 
27 
30 
34 cpDampedSpring* cpDampedSpringInit(cpDampedSpring *joint, cpBody *a, cpBody *b, cpVect anchorA, cpVect anchorB, cpFloat restLength, cpFloat stiffness, cpFloat damping);
36 cpConstraint* cpDampedSpringNew(cpBody *a, cpBody *b, cpVect anchorA, cpVect anchorB, cpFloat restLength, cpFloat stiffness, cpFloat damping);
37 
41 void cpDampedSpringSetAnchorA(cpConstraint *constraint, cpVect anchorA);
42 
46 void cpDampedSpringSetAnchorB(cpConstraint *constraint, cpVect anchorB);
47 
51 void cpDampedSpringSetRestLength(cpConstraint *constraint, cpFloat restLength);
52 
56 void cpDampedSpringSetStiffness(cpConstraint *constraint, cpFloat stiffness);
57 
61 void cpDampedSpringSetDamping(cpConstraint *constraint, cpFloat damping);
62 
67 
void cpDampedSpringSetStiffness(cpConstraint *constraint, cpFloat stiffness)
Set the stiffness of the spring in force/distance.
cpFloat cpDampedSpringGetDamping(const cpConstraint *constraint)
Get the damping of the spring.
void cpDampedSpringSetAnchorB(cpConstraint *constraint, cpVect anchorB)
Set the location of the second anchor relative to the second body.
Definition: chipmunk_private.h:80
cpFloat(* cpDampedSpringForceFunc)(cpConstraint *spring, cpFloat dist)
Function type used for damped spring force callbacks.
Definition: cpDampedSpring.h:29
void cpDampedSpringSetSpringForceFunc(cpConstraint *constraint, cpDampedSpringForceFunc springForceFunc)
Set the damping of the spring.
unsigned char cpBool
Chipmunk's boolean type.
Definition: chipmunk_types.h:199
cpFloat cpDampedSpringGetRestLength(const cpConstraint *constraint)
Get the rest length of the spring.
double cpFloat
Chipmunk's floating point type.
Definition: chipmunk_types.h:83
cpVect cpDampedSpringGetAnchorA(const cpConstraint *constraint)
Get the location of the first anchor relative to the first body.
void cpDampedSpringSetDamping(cpConstraint *constraint, cpFloat damping)
Set the damping of the spring.
cpVect cpDampedSpringGetAnchorB(const cpConstraint *constraint)
Get the location of the second anchor relative to the second body.
cpDampedSpringForceFunc cpDampedSpringGetSpringForceFunc(const cpConstraint *constraint)
Get the damping of the spring.
void cpDampedSpringSetRestLength(cpConstraint *constraint, cpFloat restLength)
Set the rest length of the spring.
Definition: chipmunk_types.h:271
cpFloat cpDampedSpringGetStiffness(const cpConstraint *constraint)
Get the stiffness of the spring in force/distance.
Definition: chipmunk_private.h:456
cpBool cpConstraintIsDampedSpring(const cpConstraint *constraint)
Check if a constraint is a slide joint.
Definition: chipmunk_private.h:385
cpDampedSpring * cpDampedSpringInit(cpDampedSpring *joint, cpBody *a, cpBody *b, cpVect anchorA, cpVect anchorB, cpFloat restLength, cpFloat stiffness, cpFloat damping)
Initialize a damped spring.
cpDampedSpring * cpDampedSpringAlloc(void)
Allocate a damped spring.
void cpDampedSpringSetAnchorA(cpConstraint *constraint, cpVect anchorA)
Set the location of the first anchor relative to the first body.
cpConstraint * cpDampedSpringNew(cpBody *a, cpBody *b, cpVect anchorA, cpVect anchorB, cpFloat restLength, cpFloat stiffness, cpFloat damping)
Allocate and initialize a damped spring.