Class Rigidbody

This class extends THREE.Object3D

See

https://threejs.org/docs/#api/en/core/Object3D

Hierarchy

GameObject
- Rigidbody

Constructors

constructor

new Rigidbody(__namedParameters?: {
    angularDrag: number;
    canSleep: boolean;
    ccdEnabled: boolean;
    drag: number;
    gravityScale: number;
    type: RigidbodyType;
}): Rigidbody
Parameters
- __namedParameters: {
      angularDrag: number;
      canSleep: boolean;
      ccdEnabled: boolean;
      drag: number;
      gravityScale: number;
      type: RigidbodyType;
  } = {}
  - angularDrag: number
  - canSleep: boolean
  - ccdEnabled: boolean
  - drag: number
  - gravityScale: number
  - type: RigidbodyType
Returns Rigidbody
Overrides GameObject.constructor
- Defined in src/physics/Rigidbody.ts:47

Properties

isGameObject

isGameObject: boolean = true

Accessors

alive

get alive(): boolean
Returns boolean
Inherited from GameObject.alive
- Defined in src/ecs/GameObject.ts:45

angularDrag

get angularDrag(): number
Returns number
- Defined in src/physics/Rigidbody.ts:159
set angularDrag(value: number): void
Parameters
- value: number
Returns void
- Defined in src/physics/Rigidbody.ts:163

angularVelocity

get angularVelocity(): Vector3
Returns Vector3
- Defined in src/physics/Rigidbody.ts:131

canSleep

get canSleep(): boolean
Returns boolean
- Defined in src/physics/Rigidbody.ts:171

colliderVisible

get colliderVisible(): boolean
Returns boolean
- Defined in src/physics/Rigidbody.ts:247
set colliderVisible(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/physics/Rigidbody.ts:251

colliders

get colliders(): Collider[]
Returns Collider[]
- Defined in src/physics/Rigidbody.ts:243

constraints

get constraints(): RigidbodyConstraints
Returns RigidbodyConstraints
- Defined in src/physics/Rigidbody.ts:191
set constraints(value: RigidbodyConstraints): void
Parameters
- value: RigidbodyConstraints
Returns void
- Defined in src/physics/Rigidbody.ts:195

drag

get drag(): number
Returns number
- Defined in src/physics/Rigidbody.ts:151
set drag(value: number): void
Parameters
- value: number
Returns void
- Defined in src/physics/Rigidbody.ts:155

enabled

get enabled(): boolean
Returns boolean
- Defined in src/physics/Rigidbody.ts:93
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/physics/Rigidbody.ts:97

gravityScale

get gravityScale(): number
Returns number
- Defined in src/physics/Rigidbody.ts:143
set gravityScale(value: number): void
Parameters
- value: number
Returns void
- Defined in src/physics/Rigidbody.ts:147

isDynamic

get isDynamic(): boolean
Returns boolean
- Defined in src/physics/Rigidbody.ts:81

isKinematic

get isKinematic(): boolean
Returns boolean
- Defined in src/physics/Rigidbody.ts:85

isSleeping

get isSleeping(): boolean
Returns boolean
- Defined in src/physics/Rigidbody.ts:167

isStatic

get isStatic(): boolean
Returns boolean
- Defined in src/physics/Rigidbody.ts:89

linearVelocity

get linearVelocity(): Vector3
Returns Vector3
- Defined in src/physics/Rigidbody.ts:118

mass

get mass(): number
Returns number
- Defined in src/physics/Rigidbody.ts:113

Methods

add

add(...object: Object3D<Object3DEventMap>[]): Rigidbody
Parameters
- Rest ...object: Object3D<Object3DEventMap>[]
Returns Rigidbody
Overrides GameObject.add
- Defined in src/physics/Rigidbody.ts:223

addComponent

addComponent(GameComponent: GameComponentConstructor<GameComponent<any>>, values?: Partial<Omit<GameComponent<any>, keyof GameComponent<any>>>): void
Add a GameComponent to the entity.
Parameters
- GameComponent: GameComponentConstructor<GameComponent<any>>
- Optional values: Partial<Omit<GameComponent<any>, keyof GameComponent<any>>>
Returns void
Inherited from GameObject.addComponent
- Defined in src/ecs/GameObject.ts:58

applyForce

applyForce(force: Vector3): void
Parameters
- force: Vector3
Returns void
- Defined in src/physics/Rigidbody.ts:175

applyImpulse

applyImpulse(impulse: Vector3): void
Parameters
- impulse: Vector3
Returns void
- Defined in src/physics/Rigidbody.ts:183

applyTorque

applyTorque(torque: Vector3): void
Parameters
- torque: Vector3
Returns void
- Defined in src/physics/Rigidbody.ts:179

applyTorqueImpulse

applyTorqueImpulse(torqueImpulse: Vector3): void
Parameters
- torqueImpulse: Vector3
Returns void
- Defined in src/physics/Rigidbody.ts:187

clone

clone(_recursive?: boolean): Rigidbody
Parameters
- Optional _recursive: boolean
Returns Rigidbody
Inherited from GameObject.clone
- Defined in src/ecs/GameObject.ts:53

copy

copy(_source: Rigidbody, _recursive?: boolean): Rigidbody
Parameters
- _source: Rigidbody
- Optional _recursive: boolean
Returns Rigidbody
Inherited from GameObject.copy
- Defined in src/ecs/GameObject.ts:49

destroy

destroy(forceImmediate?: boolean): void
Destroy this GameObject
Parameters
- forceImmediate: boolean = false
Returns void
Inherited from GameObject.destroy
- Defined in src/ecs/GameObject.ts:152

getComponent

getComponent(GameComponent: GameComponentConstructor<GameComponent<any>>, includeRemoved?: boolean): Readonly<GameComponent<any>>
Get an immutable reference to a GameComponent on this entity.
Parameters
- GameComponent: GameComponentConstructor<GameComponent<any>>
- Optional includeRemoved: boolean
Returns Readonly<GameComponent<any>>
Inherited from GameObject.getComponent
- Defined in src/ecs/GameObject.ts:69

getComponentTypes

getComponentTypes(): Component<any>[]
Get a list of GameComponent types that have been added to this entity.

Returns Component<any>[]
Inherited from GameObject.getComponentTypes
- Defined in src/ecs/GameObject.ts:87

getComponents

getComponents(): {
[componentName: string]: Component<any>;
}
Get an object containing all the GameComponent on this entity, where the object keys are the component types.

Returns {
[componentName: string]: Component<any>;
}
- [componentName: string]: Component<any>
Inherited from GameObject.getComponents
- Defined in src/ecs/GameObject.ts:95

getComponentsToRemove

getComponentsToRemove(): {
[componentName: string]: Component<any>;
}
Get an object containing all the GameComponent that are slated to be removed from this entity, where the object keys are the component types.

Returns {
[componentName: string]: Component<any>;
}
- [componentName: string]: Component<any>
Inherited from GameObject.getComponentsToRemove
- Defined in src/ecs/GameObject.ts:103

getMutableComponent

getMutableComponent(GameComponent: GameComponentConstructor<GameComponent<any>>): GameComponent<any>
Get an mutable reference to a GameComponent on this entity.
Parameters
- GameComponent: GameComponentConstructor<GameComponent<any>>
Returns GameComponent<any>
Inherited from GameObject.getMutableComponent
- Defined in src/ecs/GameObject.ts:77

getRemovedComponent

getRemovedComponent(GameComponent: GameComponentConstructor<GameComponent<any>>): Readonly<GameComponent<any>>
Get a GameComponent that is slated to be removed from this entity.
Parameters
- GameComponent: GameComponentConstructor<GameComponent<any>>
Returns Readonly<GameComponent<any>>
Inherited from GameObject.getRemovedComponent
- Defined in src/ecs/GameObject.ts:108

hasAllComponents

hasAllComponents(GameComponents: GameComponentConstructor<any>[]): boolean
Boolean value indicating whether the entity has all GameComponent in a list.
Parameters
- GameComponents: GameComponentConstructor<any>[]
Returns boolean
Inherited from GameObject.hasAllComponents
- Defined in src/ecs/GameObject.ts:118

hasAnyComponents

hasAnyComponents(GameComponents: GameComponentConstructor<any>[]): boolean
Boolean value indicating whether the entity has any GameComponent in a list.
Parameters
- GameComponents: GameComponentConstructor<any>[]
Returns boolean
Inherited from GameObject.hasAnyComponents
- Defined in src/ecs/GameObject.ts:126

hasComponent

hasComponent(GameComponent: GameComponentConstructor<any>): boolean
Boolean value indicating whether the entity has the given GameComponent.
Parameters
- GameComponent: GameComponentConstructor<any>
Returns boolean
Inherited from GameObject.hasComponent
- Defined in src/ecs/GameObject.ts:134

remove

remove(...object: Object3D<Object3DEventMap>[]): Rigidbody
Parameters
- Rest ...object: Object3D<Object3DEventMap>[]
Returns Rigidbody
Overrides GameObject.remove
- Defined in src/physics/Rigidbody.ts:233

removeAllComponents

removeAllComponents(forceImmediate: boolean): void
Remove all GameComponent on this entity.
Parameters
- forceImmediate: boolean
Returns void
Inherited from GameObject.removeAllComponents
- Defined in src/ecs/GameObject.ts:139

removeComponent

removeComponent(GameComponent: GameComponentConstructor<any>, forceImmediate: boolean): void
Remove a GameComponent from the entity.
Parameters
- GameComponent: GameComponentConstructor<any>
- forceImmediate: boolean
Returns void
Inherited from GameObject.removeComponent
- Defined in src/ecs/GameObject.ts:144

setAngularVelocity

setAngularVelocity(angularVelocity: Vector3): void
Parameters
- angularVelocity: Vector3
Returns void
- Defined in src/physics/Rigidbody.ts:136

setBodyType

setBodyType(type: RigidbodyType): void
Parameters
- type: RigidbodyType
Returns void
- Defined in src/physics/Rigidbody.ts:101

setLinearVelocity

setLinearVelocity(linearVelocity: Vector3): void
Parameters
- linearVelocity: Vector3
Returns void
- Defined in src/physics/Rigidbody.ts:123

setWorldTransform

setWorldTransform(worldPosition: Vector3, worldQuaternion: Quaternion): void
Parameters
- worldPosition: Vector3
- worldQuaternion: Quaternion
Returns void
- Defined in src/physics/Rigidbody.ts:283

sleep

sleep(): void
Returns void
- Defined in src/physics/Rigidbody.ts:219

syncTransform

syncTransform(): void
Returns void
- Defined in src/physics/Rigidbody.ts:269

updateMatrixWorld

updateMatrixWorld(force?: boolean): void
Parameters
- Optional force: boolean
Returns void
Overrides GameObject.updateMatrixWorld
- Defined in src/physics/Rigidbody.ts:312

updateTransform

updateTransform(): void
Returns void
- Defined in src/physics/Rigidbody.ts:258

wakeUp

wakeUp(): void
Returns void
- Defined in src/physics/Rigidbody.ts:215

Class Rigidbody

See

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { angularDrag: number; canSleep: boolean; ccdEnabled: boolean; drag: number; gravityScale: number; type: RigidbodyType; } = {}

angularDrag: number

canSleep: boolean

ccdEnabled: boolean

drag: number

gravityScale: number

type: RigidbodyType

Returns Rigidbody

Properties

isGameObject

Accessors

alive

Returns boolean

angularDrag

Returns number

Parameters

value: number

Returns void

angularVelocity

Returns Vector3

canSleep

Returns boolean

colliderVisible

Returns boolean

Parameters

value: boolean

Returns void

colliders

Returns Collider[]

constraints

Returns RigidbodyConstraints

Parameters

value: RigidbodyConstraints

Returns void

drag

Returns number

Parameters

value: number

Returns void

enabled

Returns boolean

Parameters

value: boolean

Returns void

gravityScale

Returns number

Parameters

value: number

Returns void

isDynamic

Returns boolean

isKinematic

Returns boolean

isSleeping

Returns boolean

isStatic

Returns boolean

linearVelocity

Returns Vector3

mass

Returns number

Methods

add

Parameters

Rest ...object: Object3D<Object3DEventMap>[]

Returns Rigidbody

addComponent

Parameters

GameComponent: GameComponentConstructor<GameComponent<any>>

__namedParameters: {
angularDrag: number;
canSleep: boolean;
ccdEnabled: boolean;
drag: number;
gravityScale: number;
type: RigidbodyType;
} = {}

`Rest` ...object: Object3D<Object3DEventMap>[]

`Optional` values: Partial<Omit<GameComponent<any>, keyof GameComponent<any>>>

`Optional` _recursive: boolean

`Optional` _recursive: boolean

`Optional` includeRemoved: boolean

Returns {
[componentName: string]: Component<any>;
}

Returns {
[componentName: string]: Component<any>;
}

`Rest` ...object: Object3D<Object3DEventMap>[]