API Docs for: 1.0.2
Show:

GIScene.Control.Select Class

Extends GIScene.Control
Defined in: GIScene\Control\Select.js:1
Module: GIScene

Control to enable the interactive selection and or highlighting of 3D Objects in the scene

Constructor

GIScene.Control.Select

(
  • selectables
  • camera
  • [config]
)

Defined in GIScene\Control\Select.js:1

Parameters:

  • selectables Array | THREE.Object3D

    An Array or single THREE.Object3D. Contains the potentially selectable Elements of type THREE.Object3D

  • camera THREE.Camera

    The active camera

  • [config] Object optional

    Configuration properties to influence the behaviour of this Control

    You can use multiple options to customize the behaviour of the Select Control:

    Main options: 

1. Choose between hover or click behaviour by setting hover:true || hover:false
    1. Choose whether objects should be really selected or just highlighted by setting highlightOnly:true || highlightOnly:false
    2. Choose a highlighting color by setting e.g: selectColor:0xff0000

    The following options are only available if hover:false:

    multi - whether it is possible to select only one object or multiple (hold down CTRL-Key)

    toggle - whether click on a selected/highlighted object unselects/unhighlights it again

    clickout - whether a click somewhere not on a selectable object unselects all others

    You can even combine 2 Select controls to enable highlighting on mouseover ('hover') and selection on click:

Example:

    var selectControl = new GIScene.Control.Select(scene.root.children, scene.camera, {highlightOnly:false, hover:false, multi:false, toggle:true, clickout:true});
    scene.addControl(selectControl);
    selectControl.activate();

    var highlightControl = new GIScene.Control.Select(scene.root.children, scene.camera, {highlightOnly:true, hover:true});
    scene.addControl(highlightControl);
    highlightControl.activate();

Methods

activate

()

Inherited from GIScene.Control but overwritten in GIScene\Control\Select.js:433

Activates this Control

deactivate

()

Inherited from GIScene.Control but overwritten in GIScene\Control\Select.js:458

Deactivates this Control

highlight

(
  • object
  • interaction
)

Defined in GIScene\Control\Select.js:91

Highlight an object. This will also be called by the select() function. Sets object.userData.isHighlighted = true.

Parameters:

  • object THREE.Object3D
  • interaction Boolean

    this flag is used to differentiate between user interaction triggered selection or programmatical selection resulting in a special event for user-triggerd selections.

removeSelectable

(
  • object
)

Defined in GIScene\Control\Select.js:289

Removes an object from the selectables Array

Parameters:

  • object THREE.Object3D

select

(
  • object
  • interaction
)

Defined in GIScene\Control\Select.js:217

Select an object. This will also call the highlight() function. Sets object.userData.isSelected = true.

Parameters:

  • object THREE.Object3D
  • interaction Boolean

    this flag is used to differentiate between user interaction triggered selection or programmatical selection resulting in a special event for user-triggerd selections.

setScene

(
  • scene
)

Inherited from GIScene.Control: GIScene\Control.js:30

Sets the scene property. This is automatically called on scene.addControl()

Parameters:

  • scene Object

unhighlight

(
  • object
  • interaction
)

Defined in GIScene\Control\Select.js:156

Unhighlight an object. This will also be called by the unselect() function. Sets object.userData.isHighlighted = false.

Parameters:

  • object THREE.Object3D
  • interaction Boolean

    this flag is used to differentiate between user interaction triggered selection or programmatical selection resulting in a special event for user-triggerd selections.

unselect

(
  • object
  • interaction
)

Defined in GIScene\Control\Select.js:255

Unselect an object. This will also call the unhighlight() function. Sets object.userData.isSelected = false.

Parameters:

  • object THREE.Object3D
  • interaction Boolean

    this flag is used to differentiate between user interaction triggered selection or programmatical selection resulting in a special event for user-triggerd selections.

Properties

config

Object

Defined in GIScene\Control\Select.js:54

The config which is used to initialize the Control. Merged from defaults and passed config Object.

isActive

Boolean

Inherited from GIScene.Control: GIScene\Control.js:17

Events

highlighted

Defined in GIScene\Control\Select.js:133

The highlighted event will be triggered after the feature is highlighted. The event contains a content property with a reference to the highlighted object.

highlightedbyuser

Defined in GIScene\Control\Select.js:140

The highlightedbyuser event will be triggered after the feature is highlighted by a user interaction. The event contains a content property with a reference to the highlighted object.

selected

Defined in GIScene\Control\Select.js:230

The selected event will be triggered before the feature is highlighted. The event contains a content property with a reference to the selected object.

selectedbyuser

Defined in GIScene\Control\Select.js:237

The selectedbyuser event will be triggered before the feature is highlighted. The event contains a content property with a reference to the selected object.

unhighlightall

Defined in GIScene\Control\Select.js:489

unhighlightallbyuser

Defined in GIScene\Control\Select.js:493

unhighlighted

Defined in GIScene\Control\Select.js:201

The unhighlighted event will be triggered after the feature is unhighlighted. The event contains a content property with a reference to the unhighlighted object.

unhighlightedbyuser

Defined in GIScene\Control\Select.js:208

The unhighlightedbyuser event will be triggered after the feature is unhighlighted through user interaction. The event contains a content property with a reference to the unhighlighted object.

unselectall

Defined in GIScene\Control\Select.js:503

unselectallbyuser

Defined in GIScene\Control\Select.js:507

unselected

Defined in GIScene\Control\Select.js:273

The unselected event will be triggered after the feature is unhighlighted. The event contains a content property with a reference to the unselected object.

unselectedbyuser

Defined in GIScene\Control\Select.js:280

The unselectedbyuser event will be triggered after the feature is unhighlighted. The event contains a content property with a reference to the unselected object.