WorldPhysics (Nu)

WorldPhysics Module

Namespace: Nu
Assembly: Nu.dll

Physics functions for the world.

Type extensions

Type extension	Description
`World.applyBodyAngularImpulse angularImpulse bodyId world` Full Usage: `World.applyBodyAngularImpulse angularImpulse bodyId world` Parameters: angularImpulse : `Vector3` bodyId : `BodyId` world : `World`	Send a physics message to apply angular impulse to a body with the given body id. Extended Type: `World` angularImpulse : `Vector3` bodyId : `BodyId` world : `World`
`World.applyBodyForce force originWorldOpt bodyId world` Full Usage: `World.applyBodyForce force originWorldOpt bodyId world` Parameters: force : `Vector3` originWorldOpt : `Vector3 option` bodyId : `BodyId` world : `World`	Send a physics message to apply force to a body with the given body id. Extended Type: `World` force : `Vector3` originWorldOpt : `Vector3 option` bodyId : `BodyId` world : `World`
`World.applyBodyLinearImpulse linearImpulse originWorldOpt bodyId world` Full Usage: `World.applyBodyLinearImpulse linearImpulse originWorldOpt bodyId world` Parameters: linearImpulse : `Vector3` originWorldOpt : `Vector3 option` bodyId : `BodyId` world : `World`	Send a physics message to apply linear impulse to a body with the given body id. Extended Type: `World` linearImpulse : `Vector3` originWorldOpt : `Vector3 option` bodyId : `BodyId` world : `World`
`World.applyBodyTorque torque bodyId world` Full Usage: `World.applyBodyTorque torque bodyId world` Parameters: torque : `Vector3` bodyId : `BodyId` world : `World`	Send a physics message to apply torque to a body with the given body id. Extended Type: `World` torque : `Vector3` bodyId : `BodyId` world : `World`
`World.clearFluidParticles emitterId world` Full Usage: `World.clearFluidParticles emitterId world` Parameters: emitterId : `FluidEmitterId` world : `World`	Clear fluid particles for a given emitter id. Extended Type: `World` emitterId : `FluidEmitterId` world : `World`
`World.createBodies2d bodySource bodiesProperties world` Full Usage: `World.createBodies2d bodySource bodiesProperties world` Parameters: bodySource : `Simulant` bodiesProperties : `BodyProperties list` world : `World`	Send a physics message to create several 2d physics bodies. Extended Type: `World` bodySource : `Simulant` bodiesProperties : `BodyProperties list` world : `World`
`World.createBodies3d bodySource bodiesProperties world` Full Usage: `World.createBodies3d bodySource bodiesProperties world` Parameters: bodySource : `Simulant` bodiesProperties : `BodyProperties list` world : `World`	Send a physics message to create several 3d physics bodies. Extended Type: `World` bodySource : `Simulant` bodiesProperties : `BodyProperties list` world : `World`
`World.createBody2d bodyId bodyProperties world` Full Usage: `World.createBody2d bodyId bodyProperties world` Parameters: bodyId : `BodyId` bodyProperties : `BodyProperties` world : `World`	Send a physics message to create a 2d physics body. Extended Type: `World` bodyId : `BodyId` bodyProperties : `BodyProperties` world : `World`
`World.createBody3d bodyId bodyProperties world` Full Usage: `World.createBody3d bodyId bodyProperties world` Parameters: bodyId : `BodyId` bodyProperties : `BodyProperties` world : `World`	Send a physics message to create a 3d physics body. Extended Type: `World` bodyId : `BodyId` bodyProperties : `BodyProperties` world : `World`
`World.createBodyJoint2d bodyJointSource bodyJointProperties world` Full Usage: `World.createBodyJoint2d bodyJointSource bodyJointProperties world` Parameters: bodyJointSource : `Simulant` bodyJointProperties : `BodyJointProperties` world : `World`	Send a physics message to create a 2d physics joint. Extended Type: `World` bodyJointSource : `Simulant` bodyJointProperties : `BodyJointProperties` world : `World`
`World.createBodyJoint3d bodyJointSource bodyJointProperties world` Full Usage: `World.createBodyJoint3d bodyJointSource bodyJointProperties world` Parameters: bodyJointSource : `Simulant` bodyJointProperties : `BodyJointProperties` world : `World`	Send a physics message to create a 3d physics joint. Extended Type: `World` bodyJointSource : `Simulant` bodyJointProperties : `BodyJointProperties` world : `World`
`World.destroyBodies2d bodyIds world` Full Usage: `World.destroyBodies2d bodyIds world` Parameters: bodyIds : `BodyId list` world : `World`	Send a physics message to destroy several 2d physics bodies. Extended Type: `World` bodyIds : `BodyId list` world : `World`
`World.destroyBodies3d bodyIds world` Full Usage: `World.destroyBodies3d bodyIds world` Parameters: bodyIds : `BodyId list` world : `World`	Send a physics message to destroy several 3d physics bodies. Extended Type: `World` bodyIds : `BodyId list` world : `World`
`World.destroyBody2d bodyId world` Full Usage: `World.destroyBody2d bodyId world` Parameters: bodyId : `BodyId` world : `World`	Send a physics message to destroy a 2d physics body. Extended Type: `World` bodyId : `BodyId` world : `World`
`World.destroyBody3d bodyId world` Full Usage: `World.destroyBody3d bodyId world` Parameters: bodyId : `BodyId` world : `World`	Send a physics message to destroy a 3d physics body. Extended Type: `World` bodyId : `BodyId` world : `World`
`World.destroyBodyJoint2d bodyJointTarget bodyJointTarget2Opt bodyJointId world` Full Usage: `World.destroyBodyJoint2d bodyJointTarget bodyJointTarget2Opt bodyJointId world` Parameters: bodyJointTarget : `BodyId` bodyJointTarget2Opt : `BodyId option` bodyJointId : `BodyJointId` world : `World`	Send a physics message to destroy a 2d physics joint. Extended Type: `World` bodyJointTarget : `BodyId` bodyJointTarget2Opt : `BodyId option` bodyJointId : `BodyJointId` world : `World`
`World.destroyBodyJoint3d bodyJointTarget bodyJointTarget2Opt bodyJointId world` Full Usage: `World.destroyBodyJoint3d bodyJointTarget bodyJointTarget2Opt bodyJointId world` Parameters: bodyJointTarget : `BodyId` bodyJointTarget2Opt : `BodyId option` bodyJointId : `BodyJointId` world : `World`	Send a physics message to destroy a 3d physics joint. Extended Type: `World` bodyJointTarget : `BodyId` bodyJointTarget2Opt : `BodyId option` bodyJointId : `BodyJointId` world : `World`
`World.emitFluidParticles particles emitterId world` Full Usage: `World.emitFluidParticles particles emitterId world` Parameters: particles : `FluidParticle SArray` emitterId : `FluidEmitterId` world : `World`	Emit fluid particles for a given emitter id. Extended Type: `World` particles : `FluidParticle SArray` emitterId : `FluidEmitterId` world : `World`
`World.filterFluidParticles predicate emitterId world` Full Usage: `World.filterFluidParticles predicate emitterId world` Parameters: predicate : `FluidParticle -> bool` emitterId : `FluidEmitterId` world : `World`	Filter fluid particles for a given emitter id. Extended Type: `World` predicate : `FluidParticle -> bool` emitterId : `FluidEmitterId` world : `World`
`World.getBodyAngularVelocity bodyId world` Full Usage: `World.getBodyAngularVelocity bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `Vector3`	Get the angular velocity of the body with the given body id. Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `Vector3`
`World.getBodyContactNormals bodyId world` Full Usage: `World.getBodyContactNormals bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `Vector3 array`	Get the contact normals of the body with the given body id. Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `Vector3 array`
`World.getBodyExists bodyId world` Full Usage: `World.getBodyExists bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `bool`	Check that the world contains a body with the given body id. Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `bool`
`World.getBodyGrounded bodyId world` Full Usage: `World.getBodyGrounded bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `bool`	Check that the body with the given body id is on the ground. Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `bool`
`World.getBodyJointExists bodyJointId world` Full Usage: `World.getBodyJointExists bodyJointId world` Parameters: bodyJointId : `BodyJointId` world : `World` Returns: `bool`	Check that the world contains a body joint with the given body joint id. Extended Type: `World` bodyJointId : `BodyJointId` world : `World` Returns: `bool`
`World.getBodyJointMotorSpeed bodyId world` Full Usage: `World.getBodyJointMotorSpeed bodyId world` Parameters: bodyId : `BodyJointId` world : `World` Returns: `single`	Get the enabled-ness of the motor of the body joint with the given body joint id. Extended Type: `World` bodyId : `BodyJointId` world : `World` Returns: `single`
`World.getBodyJointTargetAngle bodyId world` Full Usage: `World.getBodyJointTargetAngle bodyId world` Parameters: bodyId : `BodyJointId` world : `World` Returns: `single`	Get the target angle of the body joint with the given body joint id. Extended Type: `World` bodyId : `BodyJointId` world : `World` Returns: `single`
`World.getBodyLinearVelocity bodyId world` Full Usage: `World.getBodyLinearVelocity bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `Vector3`	Get the linear velocity of the body with the given body id. Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `Vector3`
`World.getBodySensor bodyId world` Full Usage: `World.getBodySensor bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `bool`	Check that the body with the given body id is a sensor. Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `bool`
`World.getBodyToGroundContactNormalOpt bodyId world` Full Usage: `World.getBodyToGroundContactNormalOpt bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `Vector3 option`	Get a contact normal where the body with the given body id is touching the ground (if one exists). Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `Vector3 option`
`World.getBodyToGroundContactNormals bodyId world` Full Usage: `World.getBodyToGroundContactNormals bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `Vector3 array`	Get the contact normals where the body with the given body id is touching the ground. Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `Vector3 array`
`World.getBodyToGroundContactTangentOpt bodyId world` Full Usage: `World.getBodyToGroundContactTangentOpt bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `Vector3 option`	Get a contact tangent where the body with the given body id is touching the ground (if one exists). Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `Vector3 option`
`World.getBodyWheelAngularVelocity wheelIndex bodyId world` Full Usage: `World.getBodyWheelAngularVelocity wheelIndex bodyId world` Parameters: wheelIndex : `int` bodyId : `BodyId` world : `World` Returns: `single`	Get the wheel angular velocity of the vehicle body with the given body id. Extended Type: `World` wheelIndex : `int` bodyId : `BodyId` world : `World` Returns: `single`
`World.getBodyWheelModelMatrix wheelModelRight wheelModelUp wheelIndex bodyId world` Full Usage: `World.getBodyWheelModelMatrix wheelModelRight wheelModelUp wheelIndex bodyId world` Parameters: wheelModelRight : `Vector3` wheelModelUp : `Vector3` wheelIndex : `int` bodyId : `BodyId` world : `World` Returns: `Matrix4x4`	Get the wheel model matrix of the vehicle body with the given body id. Extended Type: `World` wheelModelRight : `Vector3` wheelModelUp : `Vector3` wheelIndex : `int` bodyId : `BodyId` world : `World` Returns: `Matrix4x4`
`World.getBodyWheelSpeedAtClutch bodyId world` Full Usage: `World.getBodyWheelSpeedAtClutch bodyId world` Parameters: bodyId : `BodyId` world : `World` Returns: `single`	Get the wheel speed at the clutch of the vehicle body with the given body id. Extended Type: `World` bodyId : `BodyId` world : `World` Returns: `single`
`World.getGravity2d world` Full Usage: `World.getGravity2d world` Parameters: world : `World` Returns: `Vector3`	Retrieve the global gravity of the 2d physics engine. Extended Type: `World` world : `World` Returns: `Vector3`
`World.getGravity3d world` Full Usage: `World.getGravity3d world` Parameters: world : `World` Returns: `Vector3`	Retrieve the global gravity of the 2d physics engine. Extended Type: `World` world : `World` Returns: `Vector3`
`World.getGravityDefault2d world` Full Usage: `World.getGravityDefault2d world` Parameters: world : `World` Returns: `Vector3`	Retrieve the default global gravity of the 2d physics engine in world space. Extended Type: `World` world : `World` Returns: `Vector3`
`World.getGravityDefault3d world` Full Usage: `World.getGravityDefault3d world` Parameters: world : `World` Returns: `Vector3`	Retrieve the default global gravity of the 3d physics engine in world space. Extended Type: `World` world : `World` Returns: `Vector3`
`World.handlePhysicsMessage2d message world` Full Usage: `World.handlePhysicsMessage2d message world` Parameters: message : `PhysicsMessage` world : `World`	Handle a 2d physics message in the world. Extended Type: `World` message : `PhysicsMessage` world : `World`
`World.handlePhysicsMessage3d message world` Full Usage: `World.handlePhysicsMessage3d message world` Parameters: message : `PhysicsMessage` world : `World`	Send a 3d physics message in the world. Extended Type: `World` message : `PhysicsMessage` world : `World`
`World.handlePhysicsMessages2d messages world` Full Usage: `World.handlePhysicsMessages2d messages world` Parameters: messages : `PhysicsMessage seq` world : `World`	Send multiple 2d physics messages to the world. Extended Type: `World` messages : `PhysicsMessage seq` world : `World`
`World.handlePhysicsMessages3d messages world` Full Usage: `World.handlePhysicsMessages3d messages world` Parameters: messages : `PhysicsMessage seq` world : `World`	Send multiple 3d physics messages to the world. Extended Type: `World` messages : `PhysicsMessage seq` world : `World`
`World.jumpBody canJumpInAir jumpSpeed bodyId world` Full Usage: `World.jumpBody canJumpInAir jumpSpeed bodyId world` Parameters: canJumpInAir : `bool` jumpSpeed : `single` bodyId : `BodyId` world : `World`	Send a physics message to jump to a body with the given body id (KinematicCharacter only). Extended Type: `World` canJumpInAir : `bool` jumpSpeed : `single` bodyId : `BodyId` world : `World`
`World.localizePrimitiveBodyShape size bodyShape` Full Usage: `World.localizePrimitiveBodyShape size bodyShape` Parameters: size : `Vector3` bodyShape : `BodyShape` Returns: `BodyShape`	Localize a primitive body shape to a specific size; non-primitive body shapes are unaffected. Extended Type: `World` size : `Vector3` bodyShape : `BodyShape` Returns: `BodyShape`
`World.mapFluidParticles mapper emitterId world` Full Usage: `World.mapFluidParticles mapper emitterId world` Parameters: mapper : `FluidParticle -> FluidParticle` emitterId : `FluidEmitterId` world : `World`	Map fluid particles for a given emitter id. Extended Type: `World` mapper : `FluidParticle -> FluidParticle` emitterId : `FluidEmitterId` world : `World`
`World.rayCastBodies2d ray collisionMask closestOnly world` Full Usage: `World.rayCastBodies2d ray collisionMask closestOnly world` Parameters: ray : `Ray3` collisionMask : `int` closestOnly : `bool` world : `World` Returns: `BodyIntersection array`	Ray cast against 2d physics bodies. Extended Type: `World` ray : `Ray3` collisionMask : `int` closestOnly : `bool` world : `World` Returns: `BodyIntersection array`
`World.rayCastBodies3d ray collisionMask closestOnly world` Full Usage: `World.rayCastBodies3d ray collisionMask closestOnly world` Parameters: ray : `Ray3` collisionMask : `int` closestOnly : `bool` world : `World` Returns: `BodyIntersection array`	Ray cast against 3d physics bodies. Extended Type: `World` ray : `Ray3` collisionMask : `int` closestOnly : `bool` world : `World` Returns: `BodyIntersection array`
`World.reloadPhysicsAssets world` Full Usage: `World.reloadPhysicsAssets world` Parameters: world : `World`	Reload all currently selected physics assets. Extended Type: `World` world : `World`
`World.reregisterPhysics world` Full Usage: `World.reregisterPhysics world` Parameters: world : `World`	Reregister all currently selected 3d physics. Extended Type: `World` world : `World`
`World.setBodyAngularVelocity angularVelocity bodyId world` Full Usage: `World.setBodyAngularVelocity angularVelocity bodyId world` Parameters: angularVelocity : `Vector3` bodyId : `BodyId` world : `World`	Send a physics message to set the angular velocity of a body with the given body id. Extended Type: `World` angularVelocity : `Vector3` bodyId : `BodyId` world : `World`
`World.setBodyCenter center bodyId world` Full Usage: `World.setBodyCenter center bodyId world` Parameters: center : `Vector3` bodyId : `BodyId` world : `World`	Send a physics message to set the position of a body with the given body id. Extended Type: `World` center : `Vector3` bodyId : `BodyId` world : `World`
`World.setBodyEnabled enabled bodyId world` Full Usage: `World.setBodyEnabled enabled bodyId world` Parameters: enabled : `bool` bodyId : `BodyId` world : `World`	Send a physics message to set the enabled-ness of a body with the given body id. Extended Type: `World` enabled : `bool` bodyId : `BodyId` world : `World`
`World.setBodyJointMotorEnabled enabled bodyJointId world` Full Usage: `World.setBodyJointMotorEnabled enabled bodyJointId world` Parameters: enabled : `bool` bodyJointId : `BodyJointId` world : `World`	Extended Type: `World` enabled : `bool` bodyJointId : `BodyJointId` world : `World`
`World.setBodyJointMotorSpeed motorSpeed bodyJointId world` Full Usage: `World.setBodyJointMotorSpeed motorSpeed bodyJointId world` Parameters: motorSpeed : `single` bodyJointId : `BodyJointId` world : `World`	Extended Type: `World` motorSpeed : `single` bodyJointId : `BodyJointId` world : `World`
`World.setBodyLinearVelocity linearVelocity bodyId world` Full Usage: `World.setBodyLinearVelocity linearVelocity bodyId world` Parameters: linearVelocity : `Vector3` bodyId : `BodyId` world : `World`	Send a physics message to set the linear velocity of a body with the given body id. Extended Type: `World` linearVelocity : `Vector3` bodyId : `BodyId` world : `World`
`World.setBodyRotation rotation bodyId world` Full Usage: `World.setBodyRotation rotation bodyId world` Parameters: rotation : `Quaternion` bodyId : `BodyId` world : `World`	Send a physics message to set the rotation of a body with the given body id. Extended Type: `World` rotation : `Quaternion` bodyId : `BodyId` world : `World`
`World.setBodyVehicleBrakeInput brakeInput bodyId world` Full Usage: `World.setBodyVehicleBrakeInput brakeInput bodyId world` Parameters: brakeInput : `single` bodyId : `BodyId` world : `World`	Send a physics message to set the brake input of a vehicle body with the given body id. Extended Type: `World` brakeInput : `single` bodyId : `BodyId` world : `World`
`World.setBodyVehicleForwardInput forwardInput bodyId world` Full Usage: `World.setBodyVehicleForwardInput forwardInput bodyId world` Parameters: forwardInput : `single` bodyId : `BodyId` world : `World`	Send a physics message to set the forward input of a vehicle body with the given body id. Extended Type: `World` forwardInput : `single` bodyId : `BodyId` world : `World`
`World.setBodyVehicleHandBrakeInput handBrakeInput bodyId world` Full Usage: `World.setBodyVehicleHandBrakeInput handBrakeInput bodyId world` Parameters: handBrakeInput : `single` bodyId : `BodyId` world : `World`	Send a physics message to set the hand brake input of a vehicle body with the given body id. Extended Type: `World` handBrakeInput : `single` bodyId : `BodyId` world : `World`
`World.setBodyVehicleRightInput rightInput bodyId world` Full Usage: `World.setBodyVehicleRightInput rightInput bodyId world` Parameters: rightInput : `single` bodyId : `BodyId` world : `World`	Send a physics message to set the right input of a vehicle body with the given body id. Extended Type: `World` rightInput : `single` bodyId : `BodyId` world : `World`
`World.setFluidParticles particles emitterId world` Full Usage: `World.setFluidParticles particles emitterId world` Parameters: particles : `FluidParticle SArray` emitterId : `FluidEmitterId` world : `World`	Set fluid particles for a given emitter id. Extended Type: `World` particles : `FluidParticle SArray` emitterId : `FluidEmitterId` world : `World`
`World.setGravity2d gravity world` Full Usage: `World.setGravity2d gravity world` Parameters: gravity : `Vector3` world : `World`	Send a physics message to adjust the global gravity of the 2d physics engine. Extended Type: `World` gravity : `Vector3` world : `World`
`World.setGravity3d gravity world` Full Usage: `World.setGravity3d gravity world` Parameters: gravity : `Vector3` world : `World`	Send a physics message to adjust the global gravity of the 3d physics engine. Extended Type: `World` gravity : `Vector3` world : `World`
`World.shapeCastBodies2d shape transformOpt ray collisionMask closestOnly world` Full Usage: `World.shapeCastBodies2d shape transformOpt ray collisionMask closestOnly world` Parameters: shape : `BodyShape` transformOpt : `Affine option` ray : `Ray3` collisionMask : `int` closestOnly : `bool` world : `World` Returns: `BodyIntersection array`	Shape cast against 2d physics bodies. Extended Type: `World` shape : `BodyShape` transformOpt : `Affine option` ray : `Ray3` collisionMask : `int` closestOnly : `bool` world : `World` Returns: `BodyIntersection array`
`World.shapeCastBodies3d shape transformOpt ray collisionMask closestOnly world` Full Usage: `World.shapeCastBodies3d shape transformOpt ray collisionMask closestOnly world` Parameters: shape : `BodyShape` transformOpt : `Affine option` ray : `Ray3` collisionMask : `int` closestOnly : `bool` world : `World` Returns: `BodyIntersection array`	Shape cast against 3d physics bodies. Extended Type: `World` shape : `BodyShape` transformOpt : `Affine option` ray : `Ray3` collisionMask : `int` closestOnly : `bool` world : `World` Returns: `BodyIntersection array`