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

type b2MouseJoint

source code


A mouse joint is used to make a point on a body track a specified world point. This a soft constraint with a maximum force. This allows the constraint to stretch and without applying huge forces.

Instance Methods [hide private]
 
__init__(self, *args)
__init__(self, b2MouseJointDef _def) -> b2MouseJoint
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_b2MouseJoint(b2MouseJoint self)
 
SetTarget(...)
b2MouseJoint_SetTarget(b2MouseJoint self, b2Vec2 target)
source code
 
InitVelocityConstraints(...)
b2MouseJoint_InitVelocityConstraints(b2MouseJoint self, b2TimeStep step)
source code
 
SolveVelocityConstraints(...)
b2MouseJoint_SolveVelocityConstraints(b2MouseJoint self, b2TimeStep step)
source code
 
SolvePositionConstraints(...)
b2MouseJoint_SolvePositionConstraints(b2MouseJoint 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
  localAnchor
b2MouseJoint_localAnchor_get(b2MouseJoint self) -> b2Vec2
  target
b2MouseJoint_target_get(b2MouseJoint self) -> b2Vec2
  impulse
b2MouseJoint_impulse_get(b2MouseJoint self) -> b2Vec2
  mass
b2MouseJoint_mass_get(b2MouseJoint self) -> b2Mat22
  C
b2MouseJoint_C_get(b2MouseJoint self) -> b2Vec2
  maxForce
b2MouseJoint_maxForce_get(b2MouseJoint self) -> float32
  frequencyHz
b2MouseJoint_frequencyHz_get(b2MouseJoint self) -> float32
  dampingRatio
b2MouseJoint_dampingRatio_get(b2MouseJoint self) -> float32
  beta
b2MouseJoint_beta_get(b2MouseJoint self) -> float32
  gamma
b2MouseJoint_gamma_get(b2MouseJoint self) -> float32
    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, b2MouseJointDef _def) -> b2MouseJoint

A mouse joint is used to make a point on a body track a specified world point. This a soft constraint with a maximum force. This allows the constraint to stretch and without applying huge forces.

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.

SetTarget(...)

source code 

b2MouseJoint_SetTarget(b2MouseJoint self, b2Vec2 target)

Use this to update the target point.


Property Details [hide private]

thisown

The membership flag

localAnchor

b2MouseJoint_localAnchor_get(b2MouseJoint self) -> b2Vec2

target

b2MouseJoint_target_get(b2MouseJoint self) -> b2Vec2

impulse

b2MouseJoint_impulse_get(b2MouseJoint self) -> b2Vec2

mass

b2MouseJoint_mass_get(b2MouseJoint self) -> b2Mat22

C

b2MouseJoint_C_get(b2MouseJoint self) -> b2Vec2

maxForce

b2MouseJoint_maxForce_get(b2MouseJoint self) -> float32

frequencyHz

b2MouseJoint_frequencyHz_get(b2MouseJoint self) -> float32

dampingRatio

b2MouseJoint_dampingRatio_get(b2MouseJoint self) -> float32

beta

b2MouseJoint_beta_get(b2MouseJoint self) -> float32

gamma

b2MouseJoint_gamma_get(b2MouseJoint self) -> float32