Appearance

@fibbojs / 3d / FSensor

Class: FSensor ​

A 3d sensor that can be attached to a component.

Extends ​

Accessors ​

component ​

get component(): undefined | FComponent

set component(component): void

Parameters ​

• component: undefined | FComponent

Returns ​

undefined | FComponent

Inherited from ​

FRigidBody.component

Defined in ​

3d/src/core/FRigidBody.ts:366

Constructors ​

new FSensor() ​

new FSensor(scene, options?): FSensor

Creates a rigidBody for the given component.

Parameters ​

• scene: FScene

The scene the rigidBody belongs to.

• options?: FRigidBodyOptions

The options for the rigidBody.

Returns ​

FSensor

Example ​

ts
const sensor = new FSensor(scene, {
  position: { x: 0, y: 0, z: 0 },
  scale: { x: 1, y: 1, z: 1 },
  rotation: { x: 0, y: 0, z: 0 },
  shape: FShapes.CUBOID
})

Overrides ​

FRigidBody.constructor

Defined in ​

3d/src/core/FSensor.ts:40

Methods ​

__SET_POSITION__() ​

__SET_POSITION__(position): void

Set the position of the rigidBody.

Parameters ​

• position: FVector3

The new position of the rigidBody.

Returns ​

void

Inherited from ​

FRigidBody.__SET_POSITION__

Defined in ​

3d/src/core/FRigidBody.ts:328

__SET_ROTATION__() ​

__SET_ROTATION__(rotation): void

Set the rotation of the rigidBody.

Parameters ​

• rotation: FVector3

The new rotation of the rigidBody.

Returns ​

void

Inherited from ​

FRigidBody.__SET_ROTATION__

Defined in ​

3d/src/core/FRigidBody.ts:338

__SET_SCALE__() ​

__SET_SCALE__(scale): void

Set the scale of the rigidBody.

Parameters ​

• scale: FVector3

The new scale of the rigidBody.

Returns ​

void

Inherited from ​

FRigidBody.__SET_SCALE__

Defined in ​

3d/src/core/FRigidBody.ts:348

__UPDATE_POSITION__() ​

__UPDATE_POSITION__(initiator): void

Update the position of the rigidBody according to the transform. This method should be called after updating the transform properties.

Parameters ​

• initiator: boolean = false

By default (false), the rigidBody won't be considered as the initiator of the position update. This means the new position will be the position of the attached component, plus the offset. Setting this to true will propagate the event to other objects (component, sensor,...).

Returns ​

void

Inherited from ​

FRigidBody.__UPDATE_POSITION__

Defined in ​

3d/src/core/FRigidBody.ts:241

__UPDATE_ROTATION__() ​

__UPDATE_ROTATION__(initiator): void

Update the rotation of the rigidBody according to the transform. This method should be called after updating the transform properties.

Parameters ​

• initiator: boolean = false

By default (false), the rigidBody won't be considered as the initiator of the rotation update. This means the new rotation will be the rotation of the attached component, plus the offset. Setting this to true will propagate the event to other objects (component, sensor,...).

Returns ​

void

Inherited from ​

FRigidBody.__UPDATE_ROTATION__

Defined in ​

3d/src/core/FRigidBody.ts:271

__UPDATE_SCALE__() ​

__UPDATE_SCALE__(initiator): void

Update the scale of the rigidBody according to the transform. This method should be called after updating the transform properties.

Parameters ​

• initiator: boolean = false

By default (false), the rigidBody won't be considered as the initiator of the scale update. This means the new scale will be the scale of the attached component, plus the offset. Setting this to true will propagate the event to other objects (component, sensor,...).

Returns ​

void

Inherited from ​

FRigidBody.__UPDATE_SCALE__

Defined in ​

3d/src/core/FRigidBody.ts:301

frame() ​

frame(_delta): void

Parameters ​

• _delta: number

Returns ​

void

Inherited from ​

FRigidBody.frame

Defined in ​

3d/src/core/FRigidBody.ts:203

setAngvel() ​

setAngvel(velocity): void

Set the angular velocity of the rigidBody.

Parameters ​

• velocity: FVector3

The new angular velocity of the rigidBody.

Returns ​

void

Inherited from ​

FRigidBody.setAngvel

Defined in ​

3d/src/core/FRigidBody.ts:230

setLinvel() ​

setLinvel(velocity): void

Set the linear velocity of the rigidBody.

Parameters ​

• velocity: FVector3

The new linear velocity of the rigidBody.

Returns ​

void

Inherited from ​

FRigidBody.setLinvel

Defined in ​

3d/src/core/FRigidBody.ts:222

Properties ​

__COMPONENT__? ​

optional __COMPONENT__: FComponent

The component the rigidBody is attached to.

Inherited from ​

FRigidBody.__COMPONENT__

Defined in ​

3d/src/core/FRigidBody.ts:54

__RIGIDBODY__ ​

__RIGIDBODY__: RigidBody

RAPIER RigidBody

Inherited from ​

FRigidBody.__RIGIDBODY__

Defined in ​

3d/src/core/FRigidBody.ts:46

collider ​

collider: FCollider

Fibbo Collider

Inherited from ​

FRigidBody.collider

Defined in ​

3d/src/core/FRigidBody.ts:50

offset ​

offset: FTransform

The transform offset of the rigidBody.

Inherited from ​

FRigidBody.offset

Defined in ​

3d/src/core/FRigidBody.ts:62

transform ​

transform: FTransform

The transform of the rigidBody.

Inherited from ​

FRigidBody.transform

Defined in ​

3d/src/core/FRigidBody.ts:58