Click or drag to resize

FrictionJoint Class

Friction joint. This is used for top-down friction. It provides 2D translational friction and angular friction.
Inheritance Hierarchy
SystemObject
  Internal.tainicom.Aether.Physics2D.Dynamics.JointsJoint
    Internal.tainicom.Aether.Physics2D.Dynamics.JointsFrictionJoint

Namespace:  Internal.tainicom.Aether.Physics2D.Dynamics.Joints
Assembly:  NeoAxis.Core (in NeoAxis.Core.dll) Version: 2023.1.2.0 (2023.1.2.0)
Syntax
C#
public class FrictionJoint : Joint

The FrictionJoint type exposes the following members.

Constructors
  NameDescription
Public methodFrictionJoint
Constructor for FrictionJoint.
Top
Properties
  NameDescription
Public propertyBodyA
Get the first body attached to this joint.
(Inherited from Joint.)
Public propertyBodyB
Get the second body attached to this joint.
(Inherited from Joint.)
Public propertyBreakpoint
The Breakpoint simply indicates the maximum Value the JointError can be before it breaks. The default value is float.MaxValue, which means it never breaks.
(Inherited from Joint.)
Public propertyCollideConnected
Set this flag to true if the attached bodies should collide.
(Inherited from Joint.)
Public propertyJointType
Gets or sets the type of the joint.
(Inherited from Joint.)
Public propertyLocalAnchorA
The local anchor point on BodyA
Public propertyLocalAnchorB
The local anchor point on BodyB
Public propertyMaxForce
The maximum friction force in N.
Public propertyMaxTorque
The maximum friction torque in N-m.
Public propertyWorld
Get the parent World of this joint. This is null if the joint is not attached.
(Inherited from Joint.)
Public propertyWorldAnchorA (Overrides JointWorldAnchorA.)
Public propertyWorldAnchorB (Overrides JointWorldAnchorB.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetReactionForce (Overrides JointGetReactionForce(Single).)
Public methodGetReactionTorque (Overrides JointGetReactionTorque(Single).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsFixedType
Return true if the joint is a fixed type.
(Inherited from Joint.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodWakeBodies (Inherited from Joint.)
Top
Events
  NameDescription
Public eventBroke
Fires when the joint is broken.
(Inherited from Joint.)
Top
Fields
  NameDescription
Public fieldEnabled
Indicate if this join is enabled or not. Disabling a joint means it is still in the simulation, but inactive.
(Inherited from Joint.)
Public fieldTag
Set the user data pointer.
(Inherited from Joint.)
Top
Extension Methods
See Also