SimpleGrid
An infinite grid. Created by fyrestar and translated to typescript by dkaraush.
Implements
Hideable
Disposable
Configurable
<SimpleGridConfigManager
,SimpleGridConfig
>
Properties
components
components:
Components
The components instance to which this grid belongs.
config
config:
SimpleGridConfigManager
Implementation of
isSetup
isSetup:
boolean
=false
Implementation of
onDisposed
readonly
onDisposed:Event
<unknown
>
Implementation of
onSetup
readonly
onSetup:Event
<unknown
>
Implementation of
three
readonly
three:Mesh
<BufferGeometry
<NormalBufferAttributes
>,Material
|Material
[],Object3DEventMap
>
The Three.js mesh that contains the infinite grid.
world
world:
World
The world instance to which this Raycaster belongs.
Accessors
fade
get
fade():boolean
Whether the grid should fade away with distance. Recommended to be true for perspective cameras and false for orthographic cameras.
set
fade(active
):void
Whether the grid should fade away with distance. Recommended to be true for perspective cameras and false for orthographic cameras.
Parameters
Parameter | Type |
---|---|
active | boolean |
Returns
boolean
material
get
material():ShaderMaterial
The material of the grid.
Returns
ShaderMaterial
visible
get
visible():boolean
set
visible(visible
):void
Parameters
Parameter | Type |
---|---|
visible | boolean |
Returns
boolean
Methods
dispose()
dispose():
void
Returns
void
Implementation of
setup()
setup(
config
?):void
Parameters
Parameter | Type |
---|---|
config ? | Partial <SimpleGridConfig > |
Returns
void