Class CgPicker

Picker classes are designed for picking functionality, i.e., selection of objects by clicking on them via canvas.

Hierarchy

Picker
- CgPicker
  - CgMonomerPicker
  - CgMonomerBondPicker

Index

Constructors

constructor

Properties

Accessors

data
type

Methods

Constructors

constructor

new CgPicker(array: number[] | TypedArray, polymers: CgPolymer[], polCounts: number[]): CgPicker

Overrides Picker.constructor
- Defined in backend/src/catana/picker/cg-picker.ts:12
Parameters
- array: number[] | TypedArray
  
  Array with indices corresponding to individual picking IDs
- polymers: CgPolymer[]
  
  list of polymers referencing individual picked elements (in order)
- polCounts: number[]
  
  portion of "array" covered by each polymer
Returns CgPicker

Properties

Protected _polCounts

_polCounts: number[]

Protected _polymers

_polymers: CgPolymer[]

array

array: number[] | TypedArray | undefined

Accessors

data

get data(): CgPolymer[]

Overrides Picker.data
- Defined in backend/src/catana/picker/cg-picker.ts:31
override

Returns CgPolymer[]

type

get type(): string

Overrides Picker.type
- Defined in backend/src/catana/picker/cg-picker.ts:28
override

Returns string

Methods

_applyTransformations

_applyTransformations(vector: Vector3, instance: any, component: Component): Vector3

Inherited from LatticeCellPicker._applyTransformations
- Defined in backend/src/utils/picker.ts:71
Parameters
- vector: Vector3
- instance: any
- component: Component
Returns Vector3

Abstract _getPosition

_getPosition(pid: number): Vector3

Overrides Picker._getPosition
- Defined in backend/src/catana/picker/cg-picker.ts:39
override

Parameters
- pid: number
Returns Vector3

getIndex

getIndex(pid: number): number

Inherited from LatticeCellPicker.getIndex
- Defined in backend/src/utils/picker.ts:57
Get the index for the given picking id

Parameters
- pid: number
  
  the picking id
Returns number

the index

Abstract getObject

getObject(pid: number): any

Overrides Picker.getObject
- Defined in backend/src/catana/picker/cg-picker.ts:36
override

Parameters
- pid: number
Returns any

Protected getParent

getParent(pid: number): CgPolymer

- Defined in backend/src/catana/picker/cg-picker.ts:47
Returns parent polymer for given picking ID.

Parameters
- pid: number
  
  picking id
Returns CgPolymer

coarse-grained polymer containing the object with this ID

getPosition

getPosition(pid: number, instance: any, component: Component): Vector3

Inherited from LatticeCellPicker.getPosition
- Defined in backend/src/utils/picker.ts:98
Get position for the given picking id

Parameters
- pid: number
  
  the picking id
- instance: any
  
  the instance that should be applied
- component: Component
  
  the component of the picked object
Returns Vector3

the position

Generated using TypeDoc