Class Rigidbody

Hierarchy

GameObject
- Rigidbody

Constructors

constructor

new Rigidbody(world: World, __namedParameters?: RigidbodyOptions): Rigidbody
Parameters
- world: World
- __namedParameters: RigidbodyOptions = {}
Returns Rigidbody
Overrides GameObject.constructor
- Defined in src/physics/Rigidbody.ts:59

Properties

active

active: boolean = true

componentMask

componentMask: number = 0

`Readonly` isGameObject

isGameObject: boolean = true

Accessors

angularDrag

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

angularVelocity

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

canSleep

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

colliderVisible

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

colliders

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

constraints

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

drag

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

enabled

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

gravityScale

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

isDynamic

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

isKinematic

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

isSleeping

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

isStatic

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

linearVelocity

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

mass

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

Methods

add

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

addComponent

addComponent<T>(componentClass: T, initialData?: {
[key: string]: any;
}): Component
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
- initialData: {
  [key: string]: any;
  } = {}
  - [key: string]: any
Returns Component
Inherited from GameObject.addComponent
- Defined in src/ecs/GameObject.ts:46

applyForce

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

applyImpulse

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

applyTorque

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

applyTorqueImpulse

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

clone

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

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:38

destroy

destroy(): void
Returns void
Inherited from GameObject.destroy
- Defined in src/ecs/GameObject.ts:102

getComponent

getComponent<T>(componentClass: {
    bitmask: number;
    defaults: {
        [key: string]: any;
    };
    new (_cm: ComponentManager, _mi: number): T;
}): T
Type Parameters
- T extends Component<T>
Parameters
- componentClass: {
      bitmask: number;
      defaults: {
          [key: string]: any;
      };
      new (_cm: ComponentManager, _mi: number): T;
  }
  - - new (_cm: ComponentManager, _mi: number): T
    - Parameters
      
      _cm: ComponentManager
      
      _mi: number
      
      Returns T
  - bitmask: number
  - defaults: {
    [key: string]: any;
    }
    - [key: string]: any
Returns T
Inherited from GameObject.getComponent
- Defined in src/ecs/GameObject.ts:86

getComponentTypes

getComponentTypes(): typeof Component[]
Returns typeof Component[]
Inherited from GameObject.getComponentTypes
- Defined in src/ecs/GameObject.ts:97

hasComponent

hasComponent<T>(componentClass: T): boolean
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
Returns boolean
Inherited from GameObject.hasComponent
- Defined in src/ecs/GameObject.ts:81

remove

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

removeComponent

removeComponent<T>(componentClass: T): void
Type Parameters
- T extends typeof Component
Parameters
- componentClass: T
Returns void
Inherited from GameObject.removeComponent
- Defined in src/ecs/GameObject.ts:65

setAngularVelocity

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

setBodyType

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

setLinearVelocity

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

setWorldTransform

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

sleep

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

syncTransform

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

updateMatrixWorld

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

updateTransform

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

wakeUp

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

Class Rigidbody

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

world: World

__namedParameters: RigidbodyOptions = {}

Returns Rigidbody

Properties

active

componentMask

Readonly isGameObject

Accessors

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

Type Parameters

T extends typeof Component

Parameters

componentClass: T

initialData: { [key: string]: any; } = {}

[key: string]: any

Returns Component

applyForce

`Readonly` isGameObject

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

initialData: {
[key: string]: any;
} = {}

`Optional` _recursive: boolean

`Optional` _recursive: boolean

componentClass: {
bitmask: number;
defaults: {
[key: string]: any;
};
new (_cm: ComponentManager, _mi: number): T;
}

defaults: {
[key: string]: any;
}

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