Class InfiniteGrid

Infinite grid component

Export

InfiniteGrid

Date

2024.7.8

Author

yisky

Hierarchy (view full)

Renderer
- InfiniteGrid

Constructors

constructor

new InfiniteGrid(entity, options?): InfiniteGrid
Parameters
- entity: Entity
- options: InfiniteGridOptions = {}
Returns InfiniteGrid
Overrides Renderer.constructor

Properties

`Protected`_awoken

_awoken: boolean = false

`Protected`_bounds

_bounds: Box3 = ...

`Protected`_boundsUpdateFlag

_boundsUpdateFlag: BoolUpdateFlag

`Protected`_enabled

_enabled: boolean = false

`Protected`_object3D

_object3D: Object3D<Object3DEventMap>

`Protected`_onAfterRender

_onAfterRender: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

`Protected`_onBeforeRender

_onBeforeRender: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

`Protected`_renderOrder

_renderOrder: RenderOrder

`Readonly`entity

entity: Entity

`Readonly`isRenderer

isRenderer: boolean = true

Renderer flag

Memberof

Renderer

queryMask

queryMask: QueryMask

Query mask

Memberof

Renderer

userData

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

Component user data

Memberof

Component

Accessors

cellSize

get cellSize(): number
Get grid cell size

Returns number
Memberof
InfiniteGrid
set cellSize(value): void
Set grid cell size
Parameters
- value: number
Returns void
Memberof
InfiniteGrid

color

get color(): Readonly<Color>
Get grid color

Returns Readonly<Color>
Memberof
InfiniteGrid

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Memberof
Component

Inherited from Renderer.enabled
set enabled(value): void
Set whether the component is enabled.
Parameters
- value: boolean
Returns void
Memberof
Component

Inherited from Renderer.enabled

lineWidth

get lineWidth(): number
Get grid line width

Returns number
Memberof
InfiniteGrid
set lineWidth(value): void
Set grid line width
Parameters
- value: number
Returns void
Memberof
InfiniteGrid

object3D

get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
Get three.js native object3D

Returns Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
Memberof
Renderer

Inherited from Renderer.object3D

occluded

get occluded(): boolean
Get whether the grid can be occluded

Returns boolean
Memberof
InfiniteGrid
set occluded(value): void
Set whether the grid can be occluded
Parameters
- value: boolean
Returns void
Memberof
InfiniteGrid

position

get position(): Vector3
Get local position

Returns Vector3
Memberof
Renderer

Inherited from Renderer.position
set position(position): void
Set local position
Parameters
- position: Vector3
Returns void
Memberof
Renderer

Inherited from Renderer.position

quaternion

get quaternion(): Quaternion
Get local quaternion

Returns Quaternion
Memberof
Renderer

Inherited from Renderer.quaternion
set quaternion(quaternion): void
Set local quaternion
Parameters
- quaternion: Quaternion
Returns void
Memberof
Renderer

Inherited from Renderer.quaternion

renderOrder

get renderOrder(): RenderOrder
Get render order

Returns RenderOrder
Memberof
Renderer

Inherited from Renderer.renderOrder
set renderOrder(value): void
Set render order
Parameters
- value: RenderOrder
Returns void
Memberof
Renderer

Inherited from Renderer.renderOrder

rotation

get rotation(): Euler
Get local rotation

Returns Euler
Memberof
Renderer

Inherited from Renderer.rotation
set rotation(rotation): void
Set local rotation
Parameters
- rotation: Euler
Returns void
Memberof
Renderer

Inherited from Renderer.rotation

scale

get scale(): Vector3
Get local scale

Returns Vector3
Memberof
Renderer

Inherited from Renderer.scale
set scale(scale): void
Set local scale
Parameters
- scale: Vector3
Returns void
Memberof
Renderer

Inherited from Renderer.scale

scene

get scene(): Scene
Scene own the component

Returns Scene
Memberof
Component

Inherited from Renderer.scene

visible

set visible(value): void
Set whether visible
Parameters
- value: boolean
Returns void
Memberof
Renderer

Inherited from Renderer.visible

worldBounds

get worldBounds(): Readonly<Box3>
Get renderer world bounds

Returns Readonly<Box3>
Memberof
Renderer

Inherited from Renderer.worldBounds

Methods

`Protected`_attachToScene

_attachToScene(): void
Protected
Attach renderer to scene

Returns void
Memberof
Renderer

Inherited from Renderer._attachToScene

`Protected`_destroy

_destroy(): void
Protected
Destroy

Returns void
Memberof
InfiniteGrid

Overrides Renderer._destroy

`Protected`_detachFromScene

_detachFromScene(): void
Protected
Detach renderer from scene

Returns void
Memberof
Renderer

Inherited from Renderer._detachFromScene

`Protected`_onAwake

_onAwake(): void
Protected
Awake component callback

Returns void
Memberof
Component

Inherited from Renderer._onAwake

`Protected`_onDestroy

_onDestroy(): void
Protected
Destroy callback

Returns void
Memberof
Renderer

Inherited from Renderer._onDestroy

`Protected`_onDisable

_onDisable(): void
Protected
Disable callback

Returns void
Memberof
Renderer

Inherited from Renderer._onDisable

`Protected`_onEnable

_onEnable(): void
Protected
Enable callback

Returns void
Memberof
Renderer

Inherited from Renderer._onEnable

`Protected`_updateRenderOrder

_updateRenderOrder(): void
Protected
Update renderer component render order

Returns void
Memberof
Renderer

Inherited from Renderer._updateRenderOrder

`Protected`_updateWorldBounds

_updateWorldBounds(): void
Protected
Update world bounds

Returns void
Memberof
InfiniteGrid

Overrides Renderer._updateWorldBounds

`Protected`_updateWorldMatrix

_updateWorldMatrix(): void
Protected
Update renderer component world matrix

Returns void
Memberof
Renderer

Inherited from Renderer._updateWorldMatrix

afterCameraRender

afterCameraRender(camera): void
After camera render
Parameters
- camera: Camera
Returns void
Memberof
Renderer

Inherited from Renderer.afterCameraRender

beforeCameraRender

beforeCameraRender(camera): void
Before camera render
Parameters
- camera: Camera
  the camera use to render
Returns void
Memberof
Renderer

Inherited from Renderer.beforeCameraRender

desrtoy

desrtoy(): void
Destroy component

Returns void
Memberof
Component

Inherited from Renderer.desrtoy

dispose

dispose(): void
Clear subscribers

Returns void
Memberof
EventDispatcher

Inherited from Renderer.dispose

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

Inherited from Renderer.emit

getWorldDirection

getWorldDirection(target): Vector3
Returns a vector representing the direction of transform's positive z-axis in world space.
Parameters
- target: Vector3
  The result will be copied into this Vector3.
Returns Vector3
Memberof
Renderer

Inherited from Renderer.getWorldDirection

getWorldPosition

getWorldPosition(target): Vector3
Returns a vector representing the position of the transforms in world space.
Parameters
- target: Vector3
  The result will be copied into this Vector3
Returns Vector3
Memberof
Renderer

Inherited from Renderer.getWorldPosition

getWorldQuaternion

getWorldQuaternion(target): Quaternion
Returns a quaternion representing the rotation of the transform in world space.
Parameters
- target: Quaternion
  The result will be copied into this Quaternion.
Returns Quaternion
Memberof
Renderer

Inherited from Renderer.getWorldQuaternion

getWorldScale

getWorldScale(target): Vector3
Returns a vector of the scaling factors applied to the transform for each axis in world space.
Parameters
- target: Vector3
  The result will be copied into this Vector3
Returns Vector3
Memberof
Renderer

Inherited from Renderer.getWorldScale

localToWorld

localToWorld(vector): Vector3
Converts the vector from this object's local space to world space.
Parameters
- vector: Vector3
  A vector representing a position in this object's local space.
Returns Vector3
Memberof
Renderer

Inherited from Renderer.localToWorld

lookAt

lookAt(target): void
Rotates the object to face a point in world space.
Parameters
- target: Vector3
  A vector representing a position in world space to look at.
Returns void
Memberof
Renderer

Inherited from Renderer.lookAt

off

off(type, callback?): void
Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.
Parameters
- type: string
- Optionalcallback: SubscriberCallbackFn
  subscriber callback
Returns void
Memberof
EventDispatcher

Inherited from Renderer.off

on

on(type, callback, options?): void
Subscribe a event
Parameters
- type: string
  event type
- callback: SubscriberCallbackFn
  callback functions
- Optionaloptions: {
  priority?: Priority;
  target?: any;
  } = {}
  options
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from Renderer.on

once

once(type, callback, options?): void
Subscribe a event, just emit once
Parameters
- type: string
- callback: SubscriberCallbackFn
  subscriber callback
- options: {
  priority?: Priority;
  target?: any;
  } = {}
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from Renderer.once

raycast

raycast(raycaster): Intersection<Object3D<Object3DEventMap>>
Raycast
Parameters
- raycaster: Raycaster
Returns Intersection<Object3D<Object3DEventMap>>
Memberof
InfiniteGrid

Overrides Renderer.raycast

setTransformation

setTransformation(transformation): void
Set renderer's transformation
Parameters
- transformation: Transformation
Returns void
Memberof
Renderer

Inherited from Renderer.setTransformation

update

update(timeSinceLastFrame, totalTime): void
Renderer component frame update
Parameters
- timeSinceLastFrame: number
  time since last frame in seconds
- totalTime: number
  total time in seconds
Returns void
Memberof
Renderer

Inherited from Renderer.update

updateWorldMatrix

updateWorldMatrix(): void
Update world matrix

Returns void
Memberof
Renderer

Inherited from Renderer.updateWorldMatrix

worldToLocal

worldToLocal(vector): Vector3
Converts the vector from world space to this object's local space.
Parameters
- vector: Vector3
  A vector representing a position in world space.
Returns Vector3
Memberof
Renderer

Inherited from Renderer.worldToLocal

Class InfiniteGrid

Export

Date

Author

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns InfiniteGrid

Properties

Protected_awoken

Protected_bounds

Protected_boundsUpdateFlag

Protected_enabled

Protected_object3D

Protected_onAfterRender

Protected_onBeforeRender

Protected_renderOrder

Readonlyentity

ReadonlyisRenderer

Memberof

queryMask

Memberof

userData

Memberof

Accessors

cellSize

Returns number

Memberof

Parameters

Returns void

Memberof

color

Returns Readonly<Color>

Memberof

enabled

Returns boolean

Memberof

Parameters

Returns void

Memberof

lineWidth

Returns number

Memberof

Parameters

Returns void

Memberof

object3D

Returns Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

Memberof

occluded

Returns boolean

Memberof

Parameters

Returns void

Memberof

position

Returns Vector3

Memberof

Parameters

Returns void

Memberof

quaternion

Returns Quaternion

Memberof

Parameters

Returns void

Memberof

renderOrder

Returns RenderOrder

Memberof

Parameters

Returns void

Memberof

rotation

`Protected`_awoken

`Protected`_bounds

`Protected`_boundsUpdateFlag

`Protected`_enabled

`Protected`_object3D

`Protected`_onAfterRender

`Protected`_onBeforeRender

`Protected`_renderOrder

`Readonly`entity

`Readonly`isRenderer

`Protected`_attachToScene

`Protected`_destroy

`Protected`_detachFromScene

`Protected`_onAwake

`Protected`_onDestroy

`Protected`_onDisable

`Protected`_onEnable

`Protected`_updateRenderOrder

`Protected`_updateWorldBounds

`Protected`_updateWorldMatrix