C# Class Box2D.Dynamics.Joints.Joint

The base joint class. Joints are used to raint two bodies together in various fashions. Some joints also feature limits and motors.

Mostra file Open project: gerich-home/box2dnet Class Usage Examples

Public Properties

Property	Type	Description
BodyA	Body
BodyB	Body
CollideConnected	bool
EdgeA	JointEdge
EdgeB	JointEdge
Index	int
IslandFlag	bool
Next	Joint
Prev	Joint
Type	JointType
UserData	Object

Protected Properties

Property	Type	Description
Pool	IWorldPool

Public Methods

Method	Description
Create ( World argWorld, JointDef def ) : Joint
Destroy ( Joint joint ) : void
Destructor ( ) : void	Override to handle destruction of joint
GetAnchorA ( Vec2 argOut ) : void	get the anchor point on bodyA in world coordinates.
GetAnchorB ( Vec2 argOut ) : void	get the anchor point on bodyB in world coordinates.
GetReactionForce ( float inv_dt, Vec2 argOut ) : void	get the reaction force on body2 at the joint anchor in Newtons.
GetReactionTorque ( float inv_dt ) : float	get the reaction torque on body2 in N*m.
InitVelocityConstraints ( SolverData data ) : void
SolvePositionConstraints ( SolverData data ) : bool	This returns true if the position errors are within tolerance.
SolveVelocityConstraints ( SolverData data ) : void

Protected Methods

Method	Description
Joint ( IWorldPool argWorldPool, JointDef def ) : System

Method Details

Create() public static method

public static Create ( World argWorld, JointDef def ) : Joint
argWorld	World
def	JointDef
return	Joint

Destroy() public static method

public static Destroy ( Joint joint ) : void
joint	Joint
return	void

Destructor() public method

Override to handle destruction of joint

public Destructor ( ) : void
return	void

GetAnchorA() public abstract method

get the anchor point on bodyA in world coordinates.

public abstract GetAnchorA ( Vec2 argOut ) : void
argOut	Box2D.Common.Vec2
return	void

GetAnchorB() public abstract method

get the anchor point on bodyB in world coordinates.

public abstract GetAnchorB ( Vec2 argOut ) : void
argOut	Box2D.Common.Vec2
return	void

GetReactionForce() public abstract method

get the reaction force on body2 at the joint anchor in Newtons.

public abstract GetReactionForce ( float inv_dt, Vec2 argOut ) : void
inv_dt	float
argOut	Box2D.Common.Vec2
return	void

GetReactionTorque() public abstract method

get the reaction torque on body2 in N*m.

public abstract GetReactionTorque ( float inv_dt ) : float
inv_dt	float
return	float

InitVelocityConstraints() public abstract method

public abstract InitVelocityConstraints ( SolverData data ) : void
data	SolverData
return	void

Joint() protected method

protected Joint ( IWorldPool argWorldPool, JointDef def ) : System
argWorldPool	IWorldPool
def	JointDef
return	System

SolvePositionConstraints() public abstract method

This returns true if the position errors are within tolerance.

public abstract SolvePositionConstraints ( SolverData data ) : bool
data	SolverData
return	bool

SolveVelocityConstraints() public abstract method

public abstract SolveVelocityConstraints ( SolverData data ) : void
data	SolverData
return	void

Property Details

BodyA public_oe property

The first body attached to this joint.

public Body BodyA
return	Body

BodyB public_oe property

get the second body attached to this joint.

public Body BodyB
return	Body

CollideConnected public_oe property

Get collide connected. Note: modifying the collide connect flag won't work correctly because the flag is only checked when fixture AABBs begin to overlap.

public bool CollideConnected
return	bool

EdgeA public_oe property

public JointEdge,Box2D.Dynamics.Joints EdgeA
return	JointEdge

EdgeB public_oe property

public JointEdge,Box2D.Dynamics.Joints EdgeB
return	JointEdge

Index public_oe property

public int Index
return	int

IslandFlag public_oe property

public bool IslandFlag
return	bool

Next public_oe property

The next joint the world joint list.

public Joint,Box2D.Dynamics.Joints Next
return	Joint

Pool protected_oe property

protected IWorldPool Pool
return	IWorldPool

Prev public_oe property

public Joint,Box2D.Dynamics.Joints Prev
return	Joint

Type public_oe property

The type of the concrete joint.

public JointType Type
return	JointType

UserData public_oe property

The user data pointer.

public Object UserData
return	Object