Cocos2d-x  v3.12
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
PhysicsJointSpring Class Reference

Connecting two physics bodies together with a spring. More...

Inherits PhysicsJoint.

Public Member Functions

Vec2 getAnchr1 () const
 Get the anchor point on body a.
 
void setAnchr1 (const Vec2 &anchr1)
 Set the anchor point on body a.
 
Vec2 getAnchr2 () const
 Get the anchor point on body b.
 
void setAnchr2 (const Vec2 &anchr2)
 Set the anchor point on body b.
 
float getRestLength () const
 Get the distance of the anchor points.
 
void setRestLength (float restLength)
 Set the distance of the anchor points.
 
float getStiffness () const
 Get the spring constant.
 
void setStiffness (float stiffness)
 Set the spring constant.
 
float getDamping () const
 Get the spring soft constant.
 
void setDamping (float damping)
 Set the spring soft constant.
 
virtual bool createConstraints () override
 Create constraints for this type joint.
 
- Public Member Functions inherited from PhysicsJoint
PhysicsBodygetBodyA () const
 Get the first physics body a connected to this joint.
 
local getBodyA ()
 Get the first physics body a connected to this joint.
 
PhysicsBodygetBodyB () const
 Get the second physics body b connected to this joint.
 
PhysicsWorldgetWorld () const
 Get the physics world.
 
int getTag () const
 Get this joint's tag. More...
 
local getTag ()
 Get this joint's tag. More...
 
void setTag (int tag)
 Set this joint's tag. More...
 
bool isEnabled () const
 Determines if the joint is enable.
 
void setEnable (bool enable)
 Enable or disable the joint.
 
bool isCollisionEnabled () const
 Determines if the collsion is enable.
 
void setCollisionEnable (bool enable)
 Enable or disable collision.
 
void removeFormWorld ()
 Remove the joint from the world.
 
void setMaxForce (float force)
 Set the max force between two bodies.
 
float getMaxForce () const
 Get the max force setting.
 

Static Public Member Functions

static PhysicsJointSpringconstruct (PhysicsBody *a, PhysicsBody *b, const Vec2 &anchr1, const Vec2 &anchr2, float stiffness, float damping)
 Create a spring joint. More...
 
local construct ( local a, local b, local anchr1, local anchr2, local stiffness, local damping)
 Create a spring joint. More...
 

Detailed Description

Connecting two physics bodies together with a spring.

Member Function Documentation

static PhysicsJointSpring*
construct
( PhysicsBody a,
PhysicsBody b,
const Vec2 anchr1,
const Vec2 anchr2,
float  stiffness,
float  damping 
)
static

Create a spring joint.

A is the body to connect. B is the body to connect. Anchr1 is the anchor point on body a. Anchr2 is the anchor point on body b. It's the spring constant. It's how soft to make the damping of the spring. A object pointer.

var construct ( var  a,
var  b,
var  anchr1,
var  anchr2,
var  stiffness,
var  damping 
)
static

Create a spring joint.

A is the body to connect. B is the body to connect. Anchr1 is the anchor point on body a. Anchr2 is the anchor point on body b. It's the spring constant. It's how soft to make the damping of the spring. A object pointer.

local construct ( local  a,
local  b,
local  anchr1,
local  anchr2,
local  stiffness,
local  damping 
)
static

Create a spring joint.

A is the body to connect. B is the body to connect. Anchr1 is the anchor point on body a. Anchr2 is the anchor point on body b. It's the spring constant. It's how soft to make the damping of the spring. A object pointer.


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