Class HingeJointDrive

Properties of a drive that drives the joint's angular velocity towards a particular value.

System.Object
HingeJointDrive
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class HingeJointDrive : ValueType

Constructors

HingeJointDrive(Single, Single, Single, Boolean)

Initializes a new instance of the HingeJointDrive struct.

Declaration
public HingeJointDrive(float velocity, float forceLimit, float gearRatio, bool freeSpin)
Parameters
System.Single velocity

The velocity.
System.Single forceLimit

The force limit.
System.Single gearRatio

The gear ratio.
System.Boolean freeSpin

if set to true [free spin].

Fields

ForceLimit

Maximum torque the drive is allowed to apply.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
public float ForceLimit
Field Value
System.Single

FreeSpin

If the joint is moving faster than the drive's target speed, the drive will try to break. If you don't want the breaking to happen set this to true.

Declaration
public bool FreeSpin
Field Value
System.Boolean

GearRatio

Scales the velocity of the first body, and its response to drive torque is scaled down.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
public float GearRatio
Field Value
System.Single

Velocity

Target velocity of the joint.

Declaration
public float Velocity
Field Value
System.Single

Properties

Default

The default HingeJointDrive.

Declaration
public static HingeJointDrive Default { get; }
Property Value
HingeJointDrive

Extension Methods