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

# type b2DistanceJointDef

source code

Distance joint definition. This requires defining an anchor point on both bodies and the non-zero length of the distance joint. The definition uses local anchor points so that the initial configuration can violate the constraint slightly. This helps when saving and loading a game. WARNING: Do not use a zero or short length.

Instance Methods | [hide private]
b2DistanceJointDef |
__init__(self) Distance joint definition. | source code
__repr__(self) | source code
__getstate__(self, additional_ignore=`[``]`) Returns a dictionary representation of self, with dict(var=value [, ...]) | source code
__setstate__(self, dict) Takes each variable=value pair in the dictionary and sets the attributes based on them | source code
__swig_destroy__(...) delete_b2DistanceJointDef(b2DistanceJointDef self) |
Initialize(...) b2DistanceJointDef_Initialize(b2DistanceJointDef self, b2Body body1, b2Body body2, b2Vec2 anchor1, b2Vec2 anchor2) | source code
Inherited from b2JointDef
ClearUserData(...) b2JointDef_ClearUserData(b2JointDef self) | source code
GetUserData(...) b2JointDef_GetUserData(b2JointDef self) -> PyObject | source code
SetUserData(...) b2JointDef_SetUserData(b2JointDef self, PyObject data) | source code
__del__(self) | source code
typeName(self) Return the name of the joint from:... | source code

Properties | [hide private]
| thisown The membership flag
| localAnchor1 b2DistanceJointDef_localAnchor1_get(b2DistanceJointDef self) -> b2Vec2
| localAnchor2 b2DistanceJointDef_localAnchor2_get(b2DistanceJointDef self) -> b2Vec2
| length b2DistanceJointDef_length_get(b2DistanceJointDef self) -> float32
| frequencyHz b2DistanceJointDef_frequencyHz_get(b2DistanceJointDef self) -> float32
| dampingRatio b2DistanceJointDef_dampingRatio_get(b2DistanceJointDef self) -> float32
Inherited from b2JointDef
| body1 b2JointDef_body1_get(b2JointDef self) -> b2Body
| body2 b2JointDef_body2_get(b2JointDef self) -> b2Body
| collideConnected b2JointDef_collideConnected_get(b2JointDef self) -> bool
| type b2JointDef_type_get(b2JointDef self) -> b2JointType
| userData GetUserData(self) -> PyObject

Method Details | [hide private]

### __init__(self) (Constructor) | source code
Distance joint definition. This requires defining an anchor point on both bodies and the non-zero length of the distance joint. The definition uses local anchor points so that the initial configuration can violate the constraint slightly. This helps when saving and loading a game. WARNING: Do not use a zero or short length. Returns: b2DistanceJointDef Overrides: b2JointDef.__init__

### __repr__(self) (Representation operator) | source code
Overrides: b2JointDef.__repr__

### __getstate__(self, additional_ignore=`[``]`) | source code
    Returns a dictionary representation of self, with
     dict(var=value [, ...])

    additional_ignore can be specified to ignore certain
    properties.
Overrides: _generic_getstate

### __setstate__(self, dict) | source code
Takes each variable=value pair in the dictionary and sets the attributes based on them Overrides: _generic_setstate

### __swig_destroy__(...) |
delete_b2DistanceJointDef(b2DistanceJointDef self) Overrides: b2JointDef.__swig_destroy__

### Initialize(...) | source code
    b2DistanceJointDef_Initialize(b2DistanceJointDef self, b2Body body1, b2Body body2,
        b2Vec2 anchor1, b2Vec2 anchor2)

    Initialize the bodies, anchors, and length using the world anchors.

Property Details | [hide private]

### thisown The membership flag

### localAnchor1 b2DistanceJointDef_localAnchor1_get(b2DistanceJointDef self) -> b2Vec2

### localAnchor2 b2DistanceJointDef_localAnchor2_get(b2DistanceJointDef self) -> b2Vec2

### length b2DistanceJointDef_length_get(b2DistanceJointDef self) -> float32

### frequencyHz b2DistanceJointDef_frequencyHz_get(b2DistanceJointDef self) -> float32

### dampingRatio b2DistanceJointDef_dampingRatio_get(b2DistanceJointDef self) -> float32