Jopnal Engine  alpha 0.4
Simple Component Based 2D/3D Game Engine
Public Member Functions | List of all members
jop::RopeJoint2D Class Reference

#include <RopeJoint2D.hpp>

Inheritance diagram for jop::RopeJoint2D:
jop::Joint2D

Public Member Functions

 RopeJoint2D (World2D &worldRef, RigidBody2D &bodyA, RigidBody2D &bodyB, const bool collide, const glm::vec2 &anchorA=glm::vec2(0.f, 0.f), const glm::vec2 &anchorB=glm::vec2(0.f, 0.f))
 RopeJoint2D constructor. More...
 
std::pair< float, float > getDamping () const
 
RopeJoint2DsetDamping (const float frequency, const float damping)
 
- Public Member Functions inherited from jop::Joint2D
 Joint2D (World2D &worldRef, RigidBody2D &bodyA, RigidBody2D &bodyB, const bool collide)
 Joint2D constructor. More...
 
virtual ~Joint2D ()=0
 
unsigned int getID () const
 Get joint ID. More...
 
Joint2DsetID (const unsigned int id)
 Set new ID for the joint. More...
 

Additional Inherited Members

- Public Attributes inherited from jop::Joint2D
World2Dm_worldRef
 Pointer to the world. More...
 
RigidBody2Dm_bodyA
 Pointer to bodyA. More...
 
RigidBody2Dm_bodyB
 Pointer to bodyB. More...
 
- Static Protected Member Functions inherited from jop::Joint2D
static b2Body * getBody (RigidBody2D &body)
 Return engine internal pointer to body. More...
 
- Protected Attributes inherited from jop::Joint2D
bool m_collide
 Should the linked bodies collide. More...
 
b2Joint * m_joint
 Pointer to Box2D joint. More...
 
unsigned int m_ID
 Joint ID. More...
 

Detailed Description

Definition at line 38 of file RopeJoint2D.hpp.

Constructor & Destructor Documentation

jop::RopeJoint2D::RopeJoint2D ( World2D worldRef,
RigidBody2D bodyA,
RigidBody2D bodyB,
const bool  collide,
const glm::vec2 &  anchorA = glm::vec2(0.f, 0.f),
const glm::vec2 &  anchorB = glm::vec2(0.f, 0.f) 
)

RopeJoint2D constructor.

Creates a link / rope between the bodies. For longer ropes, ropes made from several rigidbodies and attached one after another should be used.

Parameters
anchorAAnchor point in local coordinates. Please use values between -1.f - +1.f. Defaults to the center of the body.
anchorBAnchor point in local coordinates. Please use values between -1.f - +1.f. Defaults to the center of the body.

Member Function Documentation

std::pair<float, float> jop::RopeJoint2D::getDamping ( ) const
Returns
Returns damping values: first = frequency, second = damping.
RopeJoint2D& jop::RopeJoint2D::setDamping ( const float  frequency,
const float  damping 
)
Parameters
frequencyDamping frequency in Hz.
dampingDamping ratio. Please use values between 0.f - 1.0f.
Returns
Returns reference to self.

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