Class PickingProxy

Picking proxy class.

Hierarchy

PickingProxy

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PickingProxy(pickingData: PickingData, stage: Stage): PickingProxy

- Defined in src/controls/picking-proxy.ts:65
Create picking proxy object

Parameters
- pickingData: PickingData
  
  picking data
- stage: Stage
  
  stage object
Returns PickingProxy

Properties

controls

controls: ViewerControls

instance

instance: InstanceData

mouse

mouse: MouseObserver

picker

picker: Picker

pid

pid: number

stage

stage: Stage

stage object

Accessors

altKey

get altKey(): boolean

- Defined in src/controls/picking-proxy.ts:105
If the alt key was pressed

Returns boolean

arrow

get arrow(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:210
Returns ShapePrimitive

atom

get atom(): AtomProxy

- Defined in src/controls/picking-proxy.ts:214
Returns AtomProxy

axes

get axes(): undefined | {}

- Defined in src/controls/picking-proxy.ts:218
Returns undefined | {}

bond

get bond(): BondProxy

- Defined in src/controls/picking-proxy.ts:222
Returns BondProxy

box

get box(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:226
Returns ShapePrimitive

canvasPosition

get canvasPosition(): Vector2

- Defined in src/controls/picking-proxy.ts:126
Position of the mouse on the canvas

Returns Vector2

clash

get clash(): { clash: { sele1: string; sele2: string } }

- Defined in src/controls/picking-proxy.ts:234
Returns { clash: { sele1: string; sele2: string } }
- clash: { sele1: string; sele2: string }
  - sele1: string
  - sele2: string

closeAtom

get closeAtom(): AtomProxy | undefined

- Defined in src/controls/picking-proxy.ts:179
Close-by atom

Returns AtomProxy | undefined

closestBondAtom

get closestBondAtom(): AtomProxy | undefined

- Defined in src/controls/picking-proxy.ts:156
The atom of a picked bond that is closest to the mouse

Returns AtomProxy | undefined

component

get component(): Component

- Defined in src/controls/picking-proxy.ts:132
The component the picked data is part of

Returns Component

cone

get cone(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:230
Returns ShapePrimitive

contact

get contact(): { atom1: AtomProxy; atom2: AtomProxy; type: string }

- Defined in src/controls/picking-proxy.ts:238
Returns { atom1: AtomProxy; atom2: AtomProxy; type: string }
- atom1: AtomProxy
- atom2: AtomProxy
- type: string

ctrlKey

get ctrlKey(): boolean

- Defined in src/controls/picking-proxy.ts:110
If the ctrl key was pressed

Returns boolean

cylinder

get cylinder(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:242
Returns ShapePrimitive

distance

get distance(): BondProxy

- Defined in src/controls/picking-proxy.ts:246
Returns BondProxy

ellipsoid

get ellipsoid(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:250
Returns ShapePrimitive

mesh

get mesh(): { name: string; serial: number; shape: Shape }

- Defined in src/controls/picking-proxy.ts:262
Returns { name: string; serial: number; shape: Shape }
- name: string
- serial: number
- shape: Shape

metaKey

get metaKey(): boolean

- Defined in src/controls/picking-proxy.ts:115
If the meta key was pressed

Returns boolean

object

get object(): {}

- Defined in src/controls/picking-proxy.ts:140
The picked object data

Returns {}

octahedron

get octahedron(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:254
Returns ShapePrimitive

point

get point(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:258
Returns ShapePrimitive

position

get position(): Vector3

- Defined in src/controls/picking-proxy.ts:148
The 3d position in the scene of the picked object

Returns Vector3

shiftKey

get shiftKey(): boolean

- Defined in src/controls/picking-proxy.ts:120
If the shift key was pressed

Returns boolean

slice

get slice(): { value: number; volume: Volume }

- Defined in src/controls/picking-proxy.ts:266
Returns { value: number; volume: Volume }
- value: number
- volume: Volume

sphere

get sphere(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:270
Returns ShapePrimitive

surface

get surface(): { index: number; surface: Surface }

- Defined in src/controls/picking-proxy.ts:282
Returns { index: number; surface: Surface }
- index: number
- surface: Surface

tetrahedron

get tetrahedron(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:274
Returns ShapePrimitive

torus

get torus(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:278
Returns ShapePrimitive

type

get type(): string

- Defined in src/controls/picking-proxy.ts:99
Kind of the picked data

Returns string

unitcell

get unitcell(): { structure: Structure; unitcell: Unitcell }

- Defined in src/controls/picking-proxy.ts:286
Returns { structure: Structure; unitcell: Unitcell }
- structure: Structure
- unitcell: Unitcell

unknown

get unknown(): undefined | {}

- Defined in src/controls/picking-proxy.ts:290
Returns undefined | {}

volume

get volume(): { value: number; volume: Volume }

- Defined in src/controls/picking-proxy.ts:294
Returns { value: number; volume: Volume }
- value: number
- volume: Volume

wideline

get wideline(): ShapePrimitive

- Defined in src/controls/picking-proxy.ts:298
Returns ShapePrimitive

Methods

_objectIfType

_objectIfType(type: string): undefined | {}

- Defined in src/controls/picking-proxy.ts:300
Parameters
- type: string
Returns undefined | {}

getLabel

getLabel(): string

- Defined in src/controls/picking-proxy.ts:304
Returns string

Generated using TypeDoc