Safe Haskell	None
Language	GHC2021

Box3D.PrismaticJoint

Synopsis

create :: WorldId -> PrismaticJointDef -> IO JointId
enableSpring :: JointId -> Bool -> IO ()
isSpringEnabled :: JointId -> IO Bool
setSpringHertz :: JointId -> Float -> IO ()
getSpringHertz :: JointId -> IO Float
setSpringDampingRatio :: JointId -> Float -> IO ()
getSpringDampingRatio :: JointId -> IO Float
setTargetTranslation :: JointId -> Float -> IO ()
getTargetTranslation :: JointId -> IO Float
enableLimit :: JointId -> Bool -> IO ()
isLimitEnabled :: JointId -> IO Bool
getLowerLimit :: JointId -> IO Float
getUpperLimit :: JointId -> IO Float
setLimits :: JointId -> Float -> Float -> IO ()
enableMotor :: JointId -> Bool -> IO ()
isMotorEnabled :: JointId -> IO Bool
setMotorSpeed :: JointId -> Float -> IO ()
getMotorSpeed :: JointId -> IO Float
setMaxMotorForce :: JointId -> Float -> IO ()
getMaxMotorForce :: JointId -> IO Float
getMotorForce :: JointId -> IO Float
getTranslation :: JointId -> IO Float
getSpeed :: JointId -> IO Float

Documentation

create :: WorldId -> PrismaticJointDef -> IO JointId Source #

Create a prismatic (slider) joint. See also b3PrismaticJointDef for details.

Binds b3CreatePrismaticJoint.

enableSpring Source #

Arguments

:: JointId
-> Bool	enableSpring
-> IO ()

Enable/disable the joint spring.

Binds b3PrismaticJoint_EnableSpring.

isSpringEnabled :: JointId -> IO Bool Source #

Is the prismatic joint spring enabled or not?

Binds b3PrismaticJoint_IsSpringEnabled.

setSpringHertz Source #

Arguments

:: JointId
-> Float	hertz
-> IO ()

Set the prismatic joint stiffness in Hertz. This should usually be less than a quarter of the simulation rate. For example, if the simulation runs at 60Hz then the joint stiffness should be 15Hz or less.

Binds b3PrismaticJoint_SetSpringHertz.

getSpringHertz :: JointId -> IO Float Source #

Get the prismatic joint stiffness in Hertz

Binds b3PrismaticJoint_GetSpringHertz.

setSpringDampingRatio Source #

Arguments

:: JointId
-> Float	dampingRatio
-> IO ()

Set the prismatic joint damping ratio (non-dimensional)

Binds b3PrismaticJoint_SetSpringDampingRatio.

getSpringDampingRatio :: JointId -> IO Float Source #

Get the prismatic spring damping ratio (non-dimensional)

Binds b3PrismaticJoint_GetSpringDampingRatio.

setTargetTranslation Source #

Arguments

:: JointId
-> Float	targetTranslation
-> IO ()

Set the prismatic joint target translation. Usually in meters.

Binds b3PrismaticJoint_SetTargetTranslation.

getTargetTranslation :: JointId -> IO Float Source #

Get the prismatic joint target translation. Usually in meters.

Binds b3PrismaticJoint_GetTargetTranslation.

enableLimit Source #

Arguments

:: JointId
-> Bool	enableLimit
-> IO ()

Enable/disable a prismatic joint limit

Binds b3PrismaticJoint_EnableLimit.

isLimitEnabled :: JointId -> IO Bool Source #

Is the prismatic joint limit enabled?

Binds b3PrismaticJoint_IsLimitEnabled.

getLowerLimit :: JointId -> IO Float Source #

Get the prismatic joint lower limit

Binds b3PrismaticJoint_GetLowerLimit.

getUpperLimit :: JointId -> IO Float Source #

Get the prismatic joint upper limit

Binds b3PrismaticJoint_GetUpperLimit.

setLimits Source #

Arguments

:: JointId
-> Float	lower
-> Float	upper
-> IO ()

Set the prismatic joint limits

Binds b3PrismaticJoint_SetLimits.

enableMotor Source #

Arguments

:: JointId
-> Bool	enableMotor
-> IO ()

Enable/disable a prismatic joint motor

Binds b3PrismaticJoint_EnableMotor.

isMotorEnabled :: JointId -> IO Bool Source #

Is the prismatic joint motor enabled?

Binds b3PrismaticJoint_IsMotorEnabled.

setMotorSpeed Source #

Arguments

:: JointId
-> Float	motorSpeed
-> IO ()

Set the prismatic joint motor speed, usually in meters per second

Binds b3PrismaticJoint_SetMotorSpeed.

getMotorSpeed :: JointId -> IO Float Source #

Get the prismatic joint motor speed, usually in meters per second

Binds b3PrismaticJoint_GetMotorSpeed.

setMaxMotorForce Source #

Arguments

:: JointId
-> Float	force
-> IO ()

Set the prismatic joint maximum motor force, usually in newtons

Binds b3PrismaticJoint_SetMaxMotorForce.

getMaxMotorForce :: JointId -> IO Float Source #

Get the prismatic joint maximum motor force, usually in newtons

Binds b3PrismaticJoint_GetMaxMotorForce.

getMotorForce :: JointId -> IO Float Source #

Get the prismatic joint current motor force, usually in newtons

Binds b3PrismaticJoint_GetMotorForce.

getTranslation :: JointId -> IO Float Source #

Get the current joint translation, usually in meters.

Binds b3PrismaticJoint_GetTranslation.

getSpeed :: JointId -> IO Float Source #

Get the current joint translation speed, usually in meters per second.

Binds b3PrismaticJoint_GetSpeed.