Class Grid

Hierarchy

Grid

Index

Constructors

Properties

Accessors

Methods

dispose getBox getCell getCellAtPosition getColor getIndex getOpacity isCell isIndex raycast setColor setOpacity createFromBox

Constructors

constructor

new Grid(size: THREE.Vector3, scale: THREE.Vector3, material?: THREE.Material, color?: Color, opacity?: number): Grid
Parameters
- size: THREE.Vector3
- scale: THREE.Vector3
- Optional material: THREE.Material
- Optional color: Color
- Optional opacity: number
Returns Grid
- Defined in src/viewer/gizmos/gizmoGrid.ts:75

Properties

box

box: Box3

mesh

mesh: THREE.Mesh<BufferGeometry, THREE.Material | THREE.Material[]>

size

size: THREE.Vector3

Accessors

cellCount

get cellCount(): number
Returns number
- Defined in src/viewer/gizmos/gizmoGrid.ts:105

Methods

dispose

dispose(): void
Returns void
- Defined in src/viewer/gizmos/gizmoGrid.ts:346

getBox

getBox(cell: number | THREE.Vector3): Box3
Parameters
- cell: number | THREE.Vector3
Returns Box3
- Defined in src/viewer/gizmos/gizmoGrid.ts:156

getCell

getCell(index: number): THREE.Vector3
Parameters
- index: number
Returns THREE.Vector3
- Defined in src/viewer/gizmos/gizmoGrid.ts:140

getCellAtPosition

getCellAtPosition(position: THREE.Vector3): THREE.Vector3
Parameters
- position: THREE.Vector3
Returns THREE.Vector3
- Defined in src/viewer/gizmos/gizmoGrid.ts:151

getColor

getColor(cell: number | THREE.Vector3): Color
Parameters
- cell: number | THREE.Vector3
Returns Color
- Defined in src/viewer/gizmos/gizmoGrid.ts:211

getIndex

getIndex(cell: THREE.Vector3): number
Parameters
- cell: THREE.Vector3
Returns number
- Defined in src/viewer/gizmos/gizmoGrid.ts:135

getOpacity

getOpacity(cell: number | THREE.Vector3): number
Parameters
- cell: number | THREE.Vector3
Returns number
- Defined in src/viewer/gizmos/gizmoGrid.ts:180

isCell

isCell(cell: THREE.Vector3): boolean
Parameters
- cell: THREE.Vector3
Returns boolean
- Defined in src/viewer/gizmos/gizmoGrid.ts:109

isIndex

isIndex(index: number): boolean
Parameters
- index: number
Returns boolean
- Defined in src/viewer/gizmos/gizmoGrid.ts:131

raycast

raycast(raycaster: THREE.Raycaster): THREE.Vector3
Parameters
- raycaster: THREE.Raycaster
Returns THREE.Vector3
- Defined in src/viewer/gizmos/gizmoGrid.ts:164

setColor

setColor(cell: number | THREE.Vector3, color: Color): void
Parameters
- cell: number | THREE.Vector3
- color: Color
Returns void
- Defined in src/viewer/gizmos/gizmoGrid.ts:199

setOpacity

setOpacity(cell: number | THREE.Vector3, opacity: number): void
Parameters
- cell: number | THREE.Vector3
- opacity: number
Returns void
- Defined in src/viewer/gizmos/gizmoGrid.ts:186

`Static` createFromBox

createFromBox(box: Box3, scale: THREE.Vector3, material?: THREE.Material): Grid
Parameters
- box: Box3
- scale: THREE.Vector3
- Optional material: THREE.Material
Returns Grid
- Defined in src/viewer/gizmos/gizmoGrid.ts:93

Generated using TypeDoc