Class ThreeSelectionTool

Hierarchy

ThreeTool
- ThreeSelectionTool

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ThreeSelectionTool(service: ThreeToolsService): ThreeSelectionTool

Inherited from ThreeTool.constructor
- Defined in src/tools/three-tool.ts:10
Parameters
- service: ThreeToolsService
Returns ThreeSelectionTool

Properties

active

active: boolean = false

Optional filterObjects

filterObjects: (type: "hover" | "click", intersections: Intersection[]) => Intersection[]

Type declaration

- (type: "hover" | "click", intersections: Intersection[]): Intersection[]
- Parameters
  - type: "hover" | "click"
  - intersections: Intersection[]
  Returns Intersection[]

Private keydowns

keydowns: {} = ...

Type declaration

[type: number]: boolean

name

name: string = 'select'

objects

objects: THREESelectedObject[] = ...

rootObject

rootObject: Object3D

selectableObjects

selectableObjects: Object3D[]

service

service: ThreeToolsService

Private style

style: SelectionStyle = ...

Private subscriptions

subscriptions: Subscription[] = ...

three

three: ThreeCustomElement

type

type: ThreeSelectionTypes = 'add'

Accessors

box

get box(): Box3

- Defined in src/tools/three-selection-tool.ts:486
Returns Box3

center

get center(): Vector3

- Defined in src/tools/three-selection-tool.ts:490
Returns Vector3

hasSelection

get hasSelection(): boolean

- Defined in src/tools/three-selection-tool.ts:481
Returns boolean

isRoot

get isRoot(): boolean

- Defined in src/tools/three-selection-tool.ts:247
Returns boolean

selectionHasChildren

get selectionHasChildren(): boolean

- Defined in src/tools/three-selection-tool.ts:276
Returns boolean

Methods

activate

activate(three: ThreeCustomElement): void

Inherited from ThreeTool.activate
- Defined in src/tools/three-tool.ts:26
Parameters
- three: ThreeCustomElement
Returns void

addObjectsToSelection

addObjectsToSelection(objects: Object3D[]): void

- Defined in src/tools/three-selection-tool.ts:424
Parameters
- objects: Object3D[]
Returns void

all

all(type?: ThreeSelectionTypes): void

- Defined in src/tools/three-selection-tool.ts:253
Parameters
- Optional type: ThreeSelectionTypes
Returns void

applySelectionStyle

applySelectionStyle(object: Object3D, style: SelectionStyle, type: "hover" | "auto" | "excluded" | "unselected" | "selected" | "ghost", force?: boolean): void

- Defined in src/tools/three-selection-tool.ts:196
Parameters
- object: Object3D
- style: SelectionStyle
- type: "hover" | "auto" | "excluded" | "unselected" | "selected" | "ghost"
- force: boolean = false
Returns void

applySelectionStyles

applySelectionStyles(): void

- Defined in src/tools/three-selection-tool.ts:510
Returns void

canRegister

canRegister(): boolean

Inherited from ThreeTool.canRegister
- Defined in src/tools/three-tool.ts:22
Returns boolean

clearSelectionStyle

clearSelectionStyle(): void

- Defined in src/tools/three-selection-tool.ts:181
Returns void

clearSelectionStyles

clearSelectionStyles(): void

- Defined in src/tools/three-selection-tool.ts:494
Returns void

deactivate

deactivate(): void

Inherited from ThreeTool.deactivate
- Defined in src/tools/three-tool.ts:32
Returns void

getFirstObjectWithChildren

getFirstObjectWithChildren(): THREESelectedObject

- Defined in src/tools/three-selection-tool.ts:282
Returns THREESelectedObject

handleCursor

handleCursor(type: "hover" | "click", intersections: Intersection[]): void

- Defined in src/tools/three-selection-tool.ts:323
Parameters
- type: "hover" | "click"
- intersections: Intersection[]
Returns void

handleEvent

handleEvent(event: KeyboardEvent): void

- Defined in src/tools/three-selection-tool.ts:151
Parameters
- event: KeyboardEvent
Returns void

none

none(type?: ThreeSelectionTypes): boolean

- Defined in src/tools/three-selection-tool.ts:265
Parameters
- Optional type: ThreeSelectionTypes
Returns boolean

onActivate

onActivate(): void

Overrides ThreeTool.onActivate
- Defined in src/tools/three-selection-tool.ts:123
Returns void

onDeactivate

onDeactivate(): void

Overrides ThreeTool.onDeactivate
- Defined in src/tools/three-selection-tool.ts:143
Returns void

removeObjectsFromSelection

removeObjectsFromSelection(objects: Object3D[]): void

- Defined in src/tools/three-selection-tool.ts:439
Parameters
- objects: Object3D[]
Returns void

selectChildren

selectChildren(): void

- Defined in src/tools/three-selection-tool.ts:299
Returns void

setRootStyles

setRootStyles(): void

- Defined in src/tools/three-selection-tool.ts:168
Returns void

Private setSelectedObjects

setSelectedObjects(objects: Object3D[]): void

- Defined in src/tools/three-selection-tool.ts:406
Parameters
- objects: Object3D[]
Returns void

setStyle

setStyle(style: string): void

- Defined in src/tools/three-selection-tool.ts:157
Parameters
- style: string
Returns void

setType

setType(type?: ThreeSelectionTypes): void

- Defined in src/tools/three-selection-tool.ts:315
Parameters
- type: ThreeSelectionTypes = 'add'
Returns void

toggleType

toggleType(type: "add" | "remove"): void

- Defined in src/tools/three-selection-tool.ts:307
Parameters
- type: "add" | "remove"
Returns void

Generated using TypeDoc