Class TunnelControls

Hierarchy

EventDispatcher
- TunnelControls

Methods

addEventListener

addEventListener(type, listener): void
Adds the specified event listener.
Parameters
- type: string
  event name
- listener: Listener
  handler function
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in src/controls/EventDispatcher.ts:18

dispatchEvent

dispatchEvent(event): void
Fire an event type.
Parameters
- event: DispatcherEvent
  DispatcherEvent
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in src/controls/EventDispatcher.ts:74

hasEventListener

hasEventListener(type, listener): boolean
Presence of the specified event listener.
Parameters
- type: string
  event name
- listener: Listener
  handler function
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in src/controls/EventDispatcher.ts:32

removeAllEventListeners

removeAllEventListeners(type?): void
Removes all event listeners
Parameters
- Optional type: string
  event name
Returns void
Inherited from EventDispatcher.removeAllEventListeners
- Defined in src/controls/EventDispatcher.ts:60

removeEventListener

removeEventListener(type, listener): void
Removes the specified event listener
Parameters
- type: string
  event name
- listener: Listener
  handler function
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in src/controls/EventDispatcher.ts:44

Other

constructor

new TunnelControls(group): TunnelControls
Parameters
- group: Object3D<Object3DEventMap>
Returns TunnelControls
Overrides EventDispatcher.constructor
- Defined in src/controls/TunnelControls.ts:24

`Private` _group

_group: Object3D<Object3DEventMap>

`Private` _grouts

_grouts: Grout3D[] = []

`Private` _mirror

_mirror: Group<Object3DEventMap>

`Private` _result

_result: Group<Object3DEventMap>

`Private` _spread

_spread: Group<Object3DEventMap>

`Private` _tunnel

_tunnel: null | Tunnel3D = null

groupGrouts

groupGrouts: boolean = true

`Private` _buildStick

_buildStick(): void
Returns void
- Defined in src/controls/TunnelControls.ts:100

`Private` _generateSpreadGrout

_generateSpreadGrout(initialGrout): void
Parameters
- initialGrout: Grout3D
Returns void
- Defined in src/controls/TunnelControls.ts:160

`Private` _generateSpreadGrouts

_generateSpreadGrouts(): void
Given a spread, generate the grouts around the spread

Returns void
- Defined in src/controls/TunnelControls.ts:146

`Private` _setGroutPosition

_setGroutPosition(previousGrout, currentGrout): void
Parameters
- previousGrout: Grout3D
- currentGrout: Grout3D
Returns void
- Defined in src/controls/TunnelControls.ts:136

`Private` _updateGrouts

_updateGrouts(): void
Returns void
- Defined in src/controls/TunnelControls.ts:92

`Private` _updateGroutsAsGroup

_updateGroutsAsGroup(): void
Returns void
- Defined in src/controls/TunnelControls.ts:110

`Private` _updateGroutsIndividually

_updateGroutsIndividually(): void
Returns void
- Defined in src/controls/TunnelControls.ts:125

addGrout

addGrout(): Grout3D
Returns Grout3D
- Defined in src/controls/TunnelControls.ts:62

attach

attach(tunnel): void
Parameters
- tunnel: Tunnel3D
Returns void
- Defined in src/controls/TunnelControls.ts:38

clearGrouts

clearGrouts(): void
Returns void
- Defined in src/controls/TunnelControls.ts:73

detach

detach(): void
Returns void
- Defined in src/controls/TunnelControls.ts:45

fromParams

fromParams(_json): void
Parameters
- _json: object
Returns void
- Defined in src/controls/TunnelControls.ts:240

getGrouts

getGrouts(): Grout3D[]
Returns Grout3D[]
- Defined in src/controls/TunnelControls.ts:77

getTunnel

getTunnel(): null | Tunnel3D
Returns null | Tunnel3D
- Defined in src/controls/TunnelControls.ts:51

setGroutParams

setGroutParams(index, params): void
Parameters
- index: number
- params: Partial<AbstractGrout3DParams>
Returns void
- Defined in src/controls/TunnelControls.ts:81

setTunnelParams

setTunnelParams(params): void
Parameters
- params: Partial<AbstractTunnel3DParams>
Returns void
- Defined in src/controls/TunnelControls.ts:55

toParams

toParams(): object
Export control parameters (currently empty placeholder).

Returns object
- Defined in src/controls/TunnelControls.ts:234

update

update(): void
Returns void
- Defined in src/controls/TunnelControls.ts:88