Class PhysicsObject3D

Hierarchy

Object3D<THREE.Object3D>
- PhysicsObject3D

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new PhysicsObject3D(three: Object3D, body: RigidBody): PhysicsObject3D

Overrides Object3D.constructor
- Defined in src/PhysicsObject3D.ts:11
Parameters
- three: Object3D
- body: RigidBody
Returns PhysicsObject3D

Properties

Protected _body

_body: RigidBody

Protected _children

_children: DisplayObject<Object3D>[] = []

Protected _contactEnabled

_contactEnabled: boolean = false

Protected _pivot

_pivot: Vector3 = ...

Protected _position

_position: BodyPosition

Protected _rotation

_rotation: BodyRotation

Protected _size

_size: Vector3 = ...

Protected _sub

_sub: Object3D

Protected _task

_task: Task

Protected _three

_three: Object3D

interactive

interactive: boolean = false

taskEnabledChildren

taskEnabledChildren: boolean = true

Accessors

body

get body(): RigidBody

- Defined in src/PhysicsObject3D.ts:23
Returns RigidBody

children

get children(): DisplayObject<Object3D>[]

- Defined in src/DisplayObject.ts:86
Returns DisplayObject<Object3D>[]

depth

get depth(): number

- Defined in src/DisplayObject.ts:104
Returns number

height

get height(): number

- Defined in src/DisplayObject.ts:99
Returns number

parent

get parent(): null | DisplayObject<Object3D>

- Defined in src/DisplayObject.ts:82
Returns null | DisplayObject<Object3D>

pivot

get pivot(): Vector3

- Defined in src/DisplayObject.ts:143
Returns Vector3

position

get position(): BodyPosition

- Defined in src/PhysicsObject3D.ts:51
Returns BodyPosition

rotation

get rotation(): BodyRotation

- Defined in src/PhysicsObject3D.ts:56
Returns BodyRotation

scale

get scale(): Vector3

- Defined in src/DisplayObject.ts:139
Returns Vector3

task

get task(): Task

- Defined in src/DisplayObject.ts:70
Returns Task

taskEnabled

get taskEnabled(): boolean
set taskEnabled(value: boolean): void

- Defined in src/DisplayObject.ts:74
Returns boolean
- Defined in src/DisplayObject.ts:78
Parameters
- value: boolean
Returns void

three

get three(): T

- Defined in src/DisplayObject.ts:66
Returns T

width

get width(): number

- Defined in src/DisplayObject.ts:94
Returns number

x

get x(): any
set x(value: any): void

- Defined in src/PhysicsObject3D.ts:27
Returns any
- Defined in src/PhysicsObject3D.ts:31
Parameters
- value: any
Returns void

y

get y(): any
set y(value: any): void

- Defined in src/PhysicsObject3D.ts:35
Returns any
- Defined in src/PhysicsObject3D.ts:39
Parameters
- value: any
Returns void

z

get z(): any
set z(value: any): void

- Defined in src/PhysicsObject3D.ts:43
Returns any
- Defined in src/PhysicsObject3D.ts:47
Parameters
- value: any
Returns void

Methods

addChild

addChild(object: DisplayObject<Object3D>): DisplayObject<Object3D>

Inherited from Object3D.addChild
- Defined in src/DisplayObject.ts:168
Parameters
- object: DisplayObject<Object3D>
Returns DisplayObject<Object3D>

addCollisionGroup

addCollisionGroup(collisionGroup: number): void

- Defined in src/PhysicsObject3D.ts:69
Parameters
- collisionGroup: number
Returns void

addCollisionMask

addCollisionMask(collisionMask: number): void

- Defined in src/PhysicsObject3D.ts:81
Parameters
- collisionMask: number
Returns void

cemit

cemit(type: string, context: any, ...args: any[]): PhysicsObject3D

Inherited from Object3D.cemit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:43
Emit event with specifying a context.

Parameters
- type: string
  
  Event type to emit.
- context: any
  
  Context to execute the callback.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns PhysicsObject3D

cemitAll

cemitAll(context: any, ...args: any[]): PhysicsObject3D

Inherited from Object3D.cemitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:57
Emit all events with specifying a context.

Parameters
- context: any
  
  Context to execute the callback.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns PhysicsObject3D

clear

clear(type?: string): PhysicsObject3D

Inherited from Object3D.clear
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:63
Remove events grouped event type.

Parameters
- Optional type: string
  
  Event type to remove. If it is empty, removes all events.
Returns PhysicsObject3D

emit

emit(type: string, ...args: any[]): PhysicsObject3D

Inherited from Object3D.emit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:35
Emit event.

Parameters
- type: string
  
  Event type to emit.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns PhysicsObject3D

emitAll

emitAll(...args: any[]): PhysicsObject3D

Inherited from Object3D.emitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:50
Emit all events.

Parameters
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns PhysicsObject3D

off

off(type: string, callback: IEmitterDelegate): PhysicsObject3D

Inherited from Object3D.off
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:27
Unregister event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Registered callback.
Returns PhysicsObject3D

on

on(type: string, callback: IEmitterDelegate): PhysicsObject3D

Inherited from Object3D.on
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:13
Register event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Callback when the event fires.
Returns PhysicsObject3D

once

once(type: string, callback: IEmitterDelegate): PhysicsObject3D

Inherited from Object3D.once
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:20
Register one-time event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Callback when the event fires.
Returns PhysicsObject3D

removeChild

removeChild(object: DisplayObject<Object3D>): undefined | DisplayObject<Object3D>

Inherited from Object3D.removeChild
- Defined in src/DisplayObject.ts:180
Parameters
- object: DisplayObject<Object3D>
Returns undefined | DisplayObject<Object3D>

removeCollisionGroup

removeCollisionGroup(collisionGroup: number): void

- Defined in src/PhysicsObject3D.ts:73
Parameters
- collisionGroup: number
Returns void

removeCollisionMask

removeCollisionMask(collisionMask: number): void

- Defined in src/PhysicsObject3D.ts:85
Parameters
- collisionMask: number
Returns void

setCollisionGroup

setCollisionGroup(collisionGroup: number): void

- Defined in src/PhysicsObject3D.ts:65
Parameters
- collisionGroup: number
Returns void

setCollisionMask

setCollisionMask(collisionMask: number): void

- Defined in src/PhysicsObject3D.ts:77
Parameters
- collisionMask: number
Returns void

update

update(e: ITickerData, taskDisabledChildren: boolean): void

Inherited from Object3D.update
- Defined in src/DisplayObject.ts:147
Parameters
- e: ITickerData
- taskDisabledChildren: boolean
Returns void

updateBoundingBox

updateBoundingBox(): void

Inherited from Object3D.updateBoundingBox
- Defined in src/DisplayObject.ts:160
Returns void

updateTask

updateTask(e: ITickerData): void

Inherited from Object3D.updateTask
- Defined in src/DisplayObject.ts:90
Parameters
- e: ITickerData
Returns void

updateTransform

updateTransform(): void

Overrides Object3D.updateTransform
- Defined in src/PhysicsObject3D.ts:60
Returns void

Generated using TypeDoc