The wheel joint can be used to simulate wheels on vehicles. More...

Inheritance diagram for Box2D.WheelJoint:

Collaboration diagram for Box2D.WheelJoint:

Public Member Functions
unsafe void	EnableSpring (bool enableSpring)
	Enable/disable the wheel joint spring.

unsafe void	SetLimits (float lower, float upper)
	Set the wheel joint limits.

Public Member Functions inherited from Box2D.Joint
unsafe void	Destroy ()
	Destroys this joint.

unsafe void	WakeBodies ()
	Wakes the bodies connected to this joint.

	unsafe (float hertz, float dampingRatio) ConstraintTuning
	Gets or sets the joint constraint tuning in Hertz and damping ratio. Advanced feature.

Properties
unsafe bool	SpringEnabled `[get, set]`
	Gets or sets wheel joint spring enabled state.

unsafe float	SpringHertz `[get, set]`
	Set the wheel joint spring frequency in hertz.

unsafe float	SpringDampingRatio `[get, set]`
	The wheel joint damping ratio, non-dimensional.

unsafe bool	LimitEnabled `[get, set]`
	The wheel joint limit enabled flag.

unsafe float	LowerLimit `[get]`
	The lower wheel joint limit.

unsafe float	UpperLimit `[get]`
	The upper wheel joint limit.

unsafe bool	MotorEnabled `[get, set]`
	The wheel joint motor enabled flag.

unsafe float	MotorSpeed `[get, set]`
	The wheel joint motor speed in radians per second.

unsafe float	MaxMotorTorque `[get, set]`
	The wheel joint maximum motor torque, usually in newton-meters.

unsafe float	MotorTorque `[get]`
	The current wheel joint motor torque, usually in newton-meters.

Properties inherited from Box2D.Joint
unsafe bool	Valid `[get]`
	Checks if this joint is valid.

unsafe JointType	Type `[get]`
	Gets the joint type.

unsafe Body	BodyA `[get]`
	Gets body A on this joint.

unsafe Body	BodyB `[get]`
	Gets body B on this joint.

unsafe World	World `[get]`
	Gets the world that owns this joint.

unsafe Vec2	LocalAnchorA `[get, set]`
	The local anchor on body A.

unsafe Vec2	LocalAnchorB `[get, set]`
	The local anchor on body B.

unsafe bool	CollideConnected `[get, set]`
	Set this flag to true if the attached bodies should collide.

unsafe? object	UserData `[get, set]`
	The user data object for this joint.

unsafe Vec2	ConstraintForce `[get]`
	Gets the current constraint force for this joint.

unsafe float	ConstraintTorque `[get]`
	Gets the current constraint torque for this joint.

unsafe float	LinearSeparation `[get]`
	Gets the current linear separation error for this joint.

unsafe float	AngularSeparation `[get]`
	Gets the current angular separation error for this joint.

unsafe float	ReferenceAngle `[get, set]`
	The reference angle in radians for joints that support it.

unsafe Vec2	LocalAxisA `[get, set]`
	The local axis on body A for joints that support it.

Detailed Description

The wheel joint can be used to simulate wheels on vehicles.

The wheel joint restricts body B to move along a local axis in body A. Body B is free to rotate. Supports a linear spring, linear limits, and a rotational motor.

Member Function Documentation

◆ EnableSpring()

unsafe void Box2D.WheelJoint.EnableSpring ( bool enableSpring )

Enable/disable the wheel joint spring.

Parameters

enableSpring True to enable the spring, false to disable the spring

◆ SetLimits()

unsafe void Box2D.WheelJoint.SetLimits	(	float	lower,
		float	upper
	)

Set the wheel joint limits.

Parameters

lower	The lower limit
upper	The upper limit

Property Documentation

◆ SpringEnabled

unsafe bool Box2D.WheelJoint.SpringEnabled

getset

Gets or sets wheel joint spring enabled state.

Returns: True if the spring is enabled

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

src/Box2DBindings/Joints/WheelJoint.cs
src/Box2DBindings/Joints/WheelJoint_Externs.cs