Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
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. More...
 
void setAnchr1 (const Vec2 &anchr1)
 Set the anchor point on body a. More...
 
var setAnchr1 ( var anchr1)
 Set the anchor point on body a. More...
 
local setAnchr1 ( local anchr1)
 Set the anchor point on body a. More...
 
Vec2 getAnchr2 () const
 Get the anchor point on body b. More...
 
local getAnchr2 ()
 Get the anchor point on body b. More...
 
void setAnchr2 (const Vec2 &anchr2)
 Set the anchor point on body b. More...
 
local setAnchr2 ( local anchr2)
 Set the anchor point on body b. More...
 
float getRestLength () const
 Get the distance of the anchor points. More...
 
local getRestLength ()
 Get the distance of the anchor points. More...
 
void setRestLength (float restLength)
 Set the distance of the anchor points. More...
 
var setRestLength ( var restLength)
 Set the distance of the anchor points. More...
 
local setRestLength ( local restLength)
 Set the distance of the anchor points. More...
 
float getStiffness () const
 Get the spring constant. More...
 
local getStiffness ()
 Get the spring constant. More...
 
void setStiffness (float stiffness)
 Set the spring constant. More...
 
local setStiffness ( local stiffness)
 Set the spring constant. More...
 
float getDamping () const
 Get the spring soft constant. More...
 
void setDamping (float damping)
 Set the spring soft constant. More...
 
local setDamping ( local damping)
 Set the spring soft constant. More...
 
virtual bool createConstraints () override
 Create constraints for this type joint.
 
- Public Member Functions inherited from PhysicsJoint
PhysicsBodygetBodyA () const
 Get physics body a connected to this joint. More...
 
PhysicsBodygetBodyB () const
 Get physics body b connected to this joint. More...
 
local getBodyB ()
 Get physics body b connected to this joint. More...
 
PhysicsWorldgetWorld () const
 Get the physics world. More...
 
local getWorld ()
 Get the physics world. More...
 
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...
 
var setTag ( var tag)
 Set this joint's tag. More...
 
local setTag ( local tag)
 Set this joint's tag. More...
 
bool isEnabled () const
 Determines if the joint is enable. More...
 
local isEnabled ()
 Determines if the joint is enable. More...
 
void setEnable (bool enable)
 Enable/Disable the joint. More...
 
local setEnable ( local enable)
 Enable/Disable the joint. More...
 
bool isCollisionEnabled () const
 Determines if the collision is enable. More...
 
local isCollisionEnabled ()
 Determines if the collision is enable. More...
 
void setCollisionEnable (bool enable)
 Enable/disable the collision between two bodies. More...
 
local setCollisionEnable ( local enable)
 Enable/disable the collision between two bodies. More...
 
void removeFormWorld ()
 Remove the joint from the world. More...
 
local removeFormWorld ()
 Remove the joint from the world. More...
 
void setMaxForce (float force)
 Set the max force between two bodies. More...
 
local setMaxForce ( local force)
 Set the max force between two bodies. More...
 
float getMaxForce () const
 Get the max force setting. More...
 

Static Public Member Functions

static PhysicsJointSpringconstruct (PhysicsBody *a, PhysicsBody *b, const Vec2 &anchr1, const Vec2 &anchr2, float stiffness, float damping)
 Create a fixed distance joint. More...
 
local construct ( local a, local b, local anchr1, local anchr2, local stiffness, local damping)
 Create a fixed distance 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 fixed distance joint.

Parameters
aA is the body to connect.
bB is the body to connect.
anchr1Anchr1 is the anchor point on body a.
anchr2Anchr2 is the anchor point on body b.
stiffnessIt's the spring constant.
dampingIt's how soft to make the damping of the spring.
Returns
A object pointer.
var construct ( var  a,
var  b,
var  anchr1,
var  anchr2,
var  stiffness,
var  damping 
)
static

Create a fixed distance joint.

Parameters
aA is the body to connect.
bB is the body to connect.
anchr1Anchr1 is the anchor point on body a.
anchr2Anchr2 is the anchor point on body b.
stiffnessIt's the spring constant.
dampingIt's how soft to make the damping of the spring.
Returns
A object pointer.
local construct ( local  a,
local  b,
local  anchr1,
local  anchr2,
local  stiffness,
local  damping 
)
static

Create a fixed distance joint.

Parameters
aA is the body to connect.
bB is the body to connect.
anchr1Anchr1 is the anchor point on body a.
anchr2Anchr2 is the anchor point on body b.
stiffnessIt's the spring constant.
dampingIt's how soft to make the damping of the spring.
Returns
A object pointer.
Vec2 getAnchr1 ( ) const

Get the anchor point on body a.

var getAnchr1 ( )

Get the anchor point on body a.

local getAnchr1 ( )

Get the anchor point on body a.

void setAnchr1 ( const Vec2 anchr1)

Set the anchor point on body a.

var setAnchr1 ( var  anchr1)

Set the anchor point on body a.

local setAnchr1 ( local  anchr1)

Set the anchor point on body a.

Vec2 getAnchr2 ( ) const

Get the anchor point on body b.

var getAnchr2 ( )

Get the anchor point on body b.

local getAnchr2 ( )

Get the anchor point on body b.

void setAnchr2 ( const Vec2 anchr2)

Set the anchor point on body b.

var setAnchr2 ( var  anchr2)

Set the anchor point on body b.

local setAnchr2 ( local  anchr2)

Set the anchor point on body b.

float getRestLength ( ) const

Get the distance of the anchor points.

var getRestLength ( )

Get the distance of the anchor points.

local getRestLength ( )

Get the distance of the anchor points.

void setRestLength ( float  restLength)

Set the distance of the anchor points.

var setRestLength ( var  restLength)

Set the distance of the anchor points.

local setRestLength ( local  restLength)

Set the distance of the anchor points.

float getStiffness ( ) const

Get the spring constant.

var getStiffness ( )

Get the spring constant.

local getStiffness ( )

Get the spring constant.

void setStiffness ( float  stiffness)

Set the spring constant.

var setStiffness ( var  stiffness)

Set the spring constant.

local setStiffness ( local  stiffness)

Set the spring constant.

float getDamping ( ) const

Get the spring soft constant.

var getDamping ( )

Get the spring soft constant.

local getDamping ( )

Get the spring soft constant.

void setDamping ( float  damping)

Set the spring soft constant.

var setDamping ( var  damping)

Set the spring soft constant.

local setDamping ( local  damping)

Set the spring soft constant.


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