Package pybox2d :: Module Box2D :: Class b2GearJoint
[hide private]
[frames] | no frames]

type b2GearJoint

source code


A gear joint is used to connect two joints together. Either joint can be a revolute or prismatic joint. You specify a gear ratio to bind the motions together: coordinate1 + ratio * coordinate2 = constant The ratio can be negative or positive. If one joint is a revolute joint and the other joint is a prismatic joint, then the ratio will have units of length or units of 1/length. WARNING: The revolute and prismatic joints must be attached to fixed bodies (which must be body1 on those joints).

Instance Methods [hide private]
 
__init__(self, *args)
__init__(self, b2GearJointDef data) -> b2GearJoint
source code
 
__repr__(self) source code
 
__getstate__(self, world=None)
Get the state of a joint.
source code
 
__setstate__(self, data)
The factory output cannot be created just yet, so store the necessary information to create it later.
source code
 
_pickle_finalize(data, world)
Finalize a joint.
source code
 
__swig_destroy__(...)
delete_b2GearJoint(b2GearJoint self)
 
GetRatio(...)
b2GearJoint_GetRatio(b2GearJoint self) -> float32
source code
 
InitVelocityConstraints(...)
b2GearJoint_InitVelocityConstraints(b2GearJoint self, b2TimeStep step)
source code
 
SolveVelocityConstraints(...)
b2GearJoint_SolveVelocityConstraints(b2GearJoint self, b2TimeStep step)
source code
 
SolvePositionConstraints(...)
b2GearJoint_SolvePositionConstraints(b2GearJoint self, float32 baumgarte) -> bool
source code
    Inherited from b2Joint
 
ClearUserData(...)
b2Joint_ClearUserData(b2Joint self)
source code
 
GetAnchor1(...)
b2Joint_GetAnchor1(b2Joint self) -> b2Vec2
source code
 
GetAnchor2(...)
b2Joint_GetAnchor2(b2Joint self) -> b2Vec2
source code
 
GetBody1(...)
b2Joint_GetBody1(b2Joint self) -> b2Body
source code
 
GetBody2(...)
b2Joint_GetBody2(b2Joint self) -> b2Body
source code
 
GetCollideConnected(...)
b2Joint_GetCollideConnected(b2Joint self) -> bool
source code
 
GetNext(...)
b2Joint_GetNext(b2Joint self) -> b2Joint
source code
 
GetReactionForce(...)
b2Joint_GetReactionForce(b2Joint self, float32 inv_dt) -> b2Vec2
source code
 
GetReactionTorque(...)
b2Joint_GetReactionTorque(b2Joint self, float32 inv_dt) -> float32
source code
 
GetType(...)
b2Joint_GetType(b2Joint self) -> b2JointType
source code
 
GetUserData(...)
b2Joint_GetUserData(b2Joint self) -> PyObject
source code
 
SetUserData(...)
b2Joint_SetUserData(b2Joint self, PyObject data)
source code
 
__eq__(a, b) source code
 
__hash__(...)
b2Joint___hash__(b2Joint self) -> int32
source code
 
__ne__(self, other) source code
 
asDistanceJoint(...)
b2Joint_asDistanceJoint(b2Joint self) -> b2DistanceJoint
source code
 
asGearJoint(...)
b2Joint_asGearJoint(b2Joint self) -> b2GearJoint
source code
 
asLineJoint(...)
b2Joint_asLineJoint(b2Joint self) -> b2LineJoint
source code
 
asMouseJoint(...)
b2Joint_asMouseJoint(b2Joint self) -> b2MouseJoint
source code
 
asPrismaticJoint(...)
b2Joint_asPrismaticJoint(b2Joint self) -> b2PrismaticJoint
source code
 
asPulleyJoint(...)
b2Joint_asPulleyJoint(b2Joint self) -> b2PulleyJoint
source code
 
asRevoluteJoint(...)
b2Joint_asRevoluteJoint(b2Joint self) -> b2RevoluteJoint
source code
 
getAsType(self)
Return a typecasted version of the joint
source code
 
typeName(self)
Return the name of the joint from:...
source code
Properties [hide private]
  thisown
The membership flag
  ground1
b2GearJoint_ground1_get(b2GearJoint self) -> b2Body
  ground2
b2GearJoint_ground2_get(b2GearJoint self) -> b2Body
  revolute1
b2GearJoint_revolute1_get(b2GearJoint self) -> b2RevoluteJoint
  prismatic1
b2GearJoint_prismatic1_get(b2GearJoint self) -> b2PrismaticJoint
  revolute2
b2GearJoint_revolute2_get(b2GearJoint self) -> b2RevoluteJoint
  prismatic2
b2GearJoint_prismatic2_get(b2GearJoint self) -> b2PrismaticJoint
  groundAnchor1
b2GearJoint_groundAnchor1_get(b2GearJoint self) -> b2Vec2
  groundAnchor2
b2GearJoint_groundAnchor2_get(b2GearJoint self) -> b2Vec2
  localAnchor1
b2GearJoint_localAnchor1_get(b2GearJoint self) -> b2Vec2
  localAnchor2
b2GearJoint_localAnchor2_get(b2GearJoint self) -> b2Vec2
  J
b2GearJoint_J_get(b2GearJoint self) -> b2Jacobian
  constant
b2GearJoint_constant_get(b2GearJoint self) -> float32
  ratio
b2GearJoint_ratio_get(b2GearJoint self) -> float32
  mass
b2GearJoint_mass_get(b2GearJoint self) -> float32
  impulse
b2GearJoint_impulse_get(b2GearJoint self) -> float32
  joint1
  joint2
    Inherited from b2Joint
  body1
GetBody1(self) -> b2Body
  body2
GetBody2(self) -> b2Body
  collideConnected
GetCollideConnected(self) -> bool
  type
GetType(self) -> b2JointType
  userData
GetUserData(self) -> PyObject
Method Details [hide private]

__init__(self, *args)
(Constructor)

source code 

__init__(self, b2GearJointDef data) -> b2GearJoint

A gear joint is used to connect two joints together. Either joint can be a revolute or prismatic joint. You specify a gear ratio to bind the motions together: coordinate1 + ratio * coordinate2 = constant The ratio can be negative or positive. If one joint is a revolute joint and the other joint is a prismatic joint, then the ratio will have units of length or units of 1/length. WARNING: The revolute and prismatic joints must be attached to fixed bodies (which must be body1 on those joints).

Overrides: b2Joint.__init__

__repr__(self)
(Representation operator)

source code 
Overrides: b2Joint.__repr__

__getstate__(self, world=None)

source code 

Get the state of a joint.

Overrides: no_pickle

__setstate__(self, data)

source code 

The factory output cannot be created just yet, so store the necessary information to create it later.

Overrides: _generic_setstate

_pickle_finalize(data, world)

source code 

Finalize a joint. The bodies and joints need to be retrieved from the world list in order to make the joint.

GetRatio(...)

source code 

b2GearJoint_GetRatio(b2GearJoint self) -> float32

Get the gear ratio.


Property Details [hide private]

thisown

The membership flag

ground1

b2GearJoint_ground1_get(b2GearJoint self) -> b2Body

ground2

b2GearJoint_ground2_get(b2GearJoint self) -> b2Body

revolute1

b2GearJoint_revolute1_get(b2GearJoint self) -> b2RevoluteJoint

prismatic1

b2GearJoint_prismatic1_get(b2GearJoint self) -> b2PrismaticJoint

revolute2

b2GearJoint_revolute2_get(b2GearJoint self) -> b2RevoluteJoint

prismatic2

b2GearJoint_prismatic2_get(b2GearJoint self) -> b2PrismaticJoint

groundAnchor1

b2GearJoint_groundAnchor1_get(b2GearJoint self) -> b2Vec2

groundAnchor2

b2GearJoint_groundAnchor2_get(b2GearJoint self) -> b2Vec2

localAnchor1

b2GearJoint_localAnchor1_get(b2GearJoint self) -> b2Vec2

localAnchor2

b2GearJoint_localAnchor2_get(b2GearJoint self) -> b2Vec2

J

b2GearJoint_J_get(b2GearJoint self) -> b2Jacobian

constant

b2GearJoint_constant_get(b2GearJoint self) -> float32

ratio

b2GearJoint_ratio_get(b2GearJoint self) -> float32

mass

b2GearJoint_mass_get(b2GearJoint self) -> float32

impulse

b2GearJoint_impulse_get(b2GearJoint self) -> float32

joint1

joint2