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

#include <RopeJoint.hpp>

Inheritance diagram for jop::RopeJoint:
jop::Joint

Public Member Functions

 RopeJoint (World &worldRef, RigidBody &bodyA, RigidBody &bodyB, const bool collide)
 RopeJoint constructor. More...
 
RopeJointlockAxis (const bool lock, const unsigned int axis)
 Lock/Unlock specific rotation axis. More...
 
- Public Member Functions inherited from jop::Joint
 Joint (World &worldRef, RigidBody &bodyA, RigidBody &bodyB, const bool collide)
 Joint constructor. More...
 
virtual ~Joint ()=0
 
unsigned int getID () const
 Get joint ID. More...
 
JointsetID (const unsigned int id)
 Set new ID for the joint. More...
 

Additional Inherited Members

- Public Attributes inherited from jop::Joint
Worldm_worldRef
 Pointer to the world. More...
 
RigidBodym_bodyA
 Pointer to bodyA. More...
 
RigidBodym_bodyB
 Pointer to bodyB. More...
 
- Protected Member Functions inherited from jop::Joint
btRigidBody * getBody (RigidBody &body) const
 Return engine internal pointer to body. More...
 
btDiscreteDynamicsWorld & getWorld (World &world) const
 Return engine internal pointer to world. More...
 
glm::vec3 defaultCenter (const glm::vec3 &jPos) const
 
glm::vec3 computeCenter () const
 Calculates the point in the middle between this' m_bodies. More...
 
- Protected Attributes inherited from jop::Joint
bool m_collide
 
std::unique_ptr< btTypedConstraint > m_joint
 < Should the linked bodies collide. More...
 
unsigned int m_ID
 Joint ID. More...
 

Detailed Description

Definition at line 36 of file RopeJoint.hpp.

Constructor & Destructor Documentation

jop::RopeJoint::RopeJoint ( World worldRef,
RigidBody bodyA,
RigidBody bodyB,
const bool  collide 
)

RopeJoint constructor.

Length of the rope is calculated from the difference in global coordinates between the two bodies. Longer ropes, where accurate physics computations are needed, should be created by creating separate RigidBodies and attaching RopeJoint to them one after another.

Member Function Documentation

RopeJoint& jop::RopeJoint::lockAxis ( const bool  lock,
const unsigned int  axis 
)

Lock/Unlock specific rotation axis.

Parameters
lockTrue to lock. False to free.
axisRotation axis to target. 0 = X, 1 = Y, 2 = Z.
Returns
Returns reference to self.

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