Inheritance diagram for jop::GearJoint:

Public Member Functions
	GearJoint (World &worldRef, RigidBody &bodyA, RigidBody &bodyB, const bool collide, const glm::vec3 &rotAxisA, const glm::vec3 &rotAxisB, const float ratio=1.f)
	GearJoint constructor. More...

glm::vec3	getAxis (const bool bodyA=true) const

float	getRatio () const

GearJoint &	setAxis (const glm::vec3 &axis, const bool bodyA=true)

GearJoint &	setRatio (const float ratio)

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...

Joint &	setID (const unsigned int id)
	Set new ID for the joint. More...

Additional Inherited Members
Public Attributes inherited from jop::Joint
World *	m_worldRef
	Pointer to the world. More...

RigidBody *	m_bodyA
	Pointer to bodyA. More...

RigidBody *	m_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 GearJoint.hpp.

Constructor & Destructor Documentation

GearJoint constructor.

Parameters

rotAxisA	Local axis of bodyA in which to apply and observe rotation.
rotAxisB	Local axis of bodyB in which to apply and observe rotation.
ratio	Ratio between the linked bodies.

glm::vec3 jop::GearJoint::getAxis ( const bool bodyA = true ) const

Parameters

bodyA Body which axis to get. True for bodyA, false for bodyB. Default true.

float jop::GearJoint::getRatio ( ) const

GearJoint& jop::GearJoint::setAxis	(	const glm::vec3 &	axis,
		const bool	bodyA = `true`
	)

Parameters

axis	Axis to use
bodyA	Body which axis to get. True for bodyA, false for bodyB. Default true.

GearJoint& jop::GearJoint::setRatio ( const float ratio )

Parameters

ratio New ratio to use in the joint.

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