Class SphereCollider

Hierarchy

Collider
- SphereCollider

Index

Constructors

Properties

_globalPosition _globalRadius _position _radius gameObject onActiveChanges onPositionUpdates onRadiusUpdates

Accessors

globalPosition globalRadius isActive position radius transform

Methods

awake destroy error getCollisions lateUpdate log onDestroy register render start uiRender update updateGlobalPosition updateGlobalRadius warn

Constructors

constructor

new SphereCollider(radius?: number, position?: Vector3): SphereCollider
Parameters
- radius: number = 1
- position: Vector3 = Vector3.zero
Returns SphereCollider
Overrides Collider.constructor
- Defined in components/colliders/SphereCollider.ts:36

Properties

`Private` _globalPosition

_globalPosition: Vector3

`Private` _globalRadius

_globalRadius: number

`Private` _position

_position: Vector3

`Private` _radius

_radius: number

gameObject

gameObject: GameObject

onActiveChanges

onActiveChanges: Event<Component>

onPositionUpdates

onPositionUpdates: Event<SphereCollider>

onRadiusUpdates

onRadiusUpdates: Event<SphereCollider>

Accessors

globalPosition

get globalPosition(): Vector3
Returns Vector3
- Defined in components/colliders/SphereCollider.ts:29

globalRadius

get globalRadius(): number
Returns number
- Defined in components/colliders/SphereCollider.ts:24

isActive

get isActive(): boolean
Returns boolean
Inherited from Collider.isActive
- Defined in classes/Components/Component.ts:16
set isActive(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Collider.isActive
- Defined in classes/Components/Component.ts:19

position

get position(): Vector3
Returns Vector3
- Defined in components/colliders/SphereCollider.ts:15
set position(value: Vector3): void
Parameters
- value: Vector3
Returns void
- Defined in components/colliders/SphereCollider.ts:18

radius

get radius(): number
Returns number
- Defined in components/colliders/SphereCollider.ts:7
set radius(value: number): void
Parameters
- value: number
Returns void
- Defined in components/colliders/SphereCollider.ts:10

transform

get transform(): Transform
Returns Transform
Inherited from Collider.transform
- Defined in classes/Components/Component.ts:11

Methods

awake

awake(): Promise<void>
Called on scene load

Returns Promise<void>
Inherited from Collider.awake
- Defined in classes/Components/Component.ts:49

destroy

destroy(): void
Destroy component

Returns void
Inherited from Collider.destroy
- Defined in classes/Components/Component.ts:40

error

error(...obj: any): void
Utility function for logging. Logs using console.error and appends info about gameObject and component
Parameters
- Rest ...obj: any
  
  thing to log
Returns void
Inherited from Collider.error
- Defined in classes/Components/Component.ts:102

getCollisions

getCollisions(): Collider[]
Returns Collider[]
Inherited from Collider.getCollisions
- Defined in components/colliders/Collider.ts:16

lateUpdate

lateUpdate(): Promise<void>
Called every frame after render

Returns Promise<void>
Inherited from Collider.lateUpdate
- Defined in classes/Components/Component.ts:64

log

log(...obj: any): void
Utility function for logging. Logs using console.log and appends info about gameObject and component
Parameters
- Rest ...obj: any
  
  thing to log
Returns void
Inherited from Collider.log
- Defined in classes/Components/Component.ts:89

onDestroy

onDestroy(): Promise<void>
Called when component is destroyed

Returns Promise<void>
Inherited from Collider.onDestroy
- Defined in components/colliders/Collider.ts:12

register

register(obj: GameObject): void
Called when component added to GameObject
Parameters
- obj: GameObject
  
  GameObject
Returns void
Inherited from Collider.register
- Defined in classes/Components/Component.ts:33

render

render(_renderer: Renderer, _camera: Camera): void
Used for rendering
Parameters
- _renderer: Renderer
- _camera: Camera
Returns void
Inherited from Collider.render
- Defined in classes/Components/Component.ts:76

start

start(): Promise<void>
Called when object is created

Returns Promise<void>
Overrides Collider.start
- Defined in components/colliders/SphereCollider.ts:54

uiRender

uiRender(_canvas: VirtualCanvas): void
Used for rendering UI
Parameters
- _canvas: VirtualCanvas
Returns void
Inherited from Collider.uiRender
- Defined in classes/Components/Component.ts:82

update

update(): Promise<void>
Called every frame before render

Returns Promise<void>
Inherited from Collider.update
- Defined in classes/Components/Component.ts:59

updateGlobalPosition

updateGlobalPosition(): void
Returns void
- Defined in components/colliders/SphereCollider.ts:66

updateGlobalRadius

updateGlobalRadius(): void
Returns void
- Defined in components/colliders/SphereCollider.ts:70

warn

warn(...obj: any): void
Utility function for logging. Logs using console.warn and appends info about gameObject and component
Parameters
- Rest ...obj: any
  
  thing to log
Returns void
Inherited from Collider.warn
- Defined in classes/Components/Component.ts:115

Generated using TypeDoc