HoneycombLattice | catana-backend

Hierarchy

Lattice
- HoneycombLattice
  - DummyHoneycombLattice

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new HoneycombLattice(width?: number, height?: number, cellDiameter?: number, matrix?: Matrix4): HoneycombLattice

Overrides SquareLattice.constructor
- Defined in backend/src/catana/nanomodeling/lattices/honeycomb-lattice.ts:6
Parameters
- Default value width: number = Lattice.DEFAULT_WIDTH
- Default value height: number = Lattice.DEFAULT_HEIGHT
- Default value cellDiameter: number = 20
- Default value matrix: Matrix4 = new Matrix4()
Returns HoneycombLattice

Properties

Protected _cellDiameter

_cellDiameter: number

Protected _end

_end: Vector3

Protected _height

_height: number = Lattice.DEFAULT_HEIGHT

Private _hoffset

_hoffset: number

Protected _matrix

_matrix: Matrix4

Protected _parentComponent

_parentComponent: LatticeComponent | undefined

Protected _start

_start: Vector3

Private _voffset

_voffset: number

Protected _width

_width: number = Lattice.DEFAULT_WIDTH

Static Protected Readonly DEFAULT_HEIGHT

DEFAULT_HEIGHT: number = 8

Static Protected Readonly DEFAULT_HEIGHT_MAX

DEFAULT_HEIGHT_MAX: number = 128

Static Protected Readonly DEFAULT_WIDTH

DEFAULT_WIDTH: number = 8

Static Protected Readonly DEFAULT_WIDTH_MAX

DEFAULT_WIDTH_MAX: number = 128

Static Protected Readonly LATTICE_COLUMN

LATTICE_COLUMN: Vector3 = new Vector3(1, 0, 0)

Static Protected Readonly LATTICE_NORMAL

LATTICE_NORMAL: Vector3 = new Vector3(0, 0, 1)

Static Protected Readonly LATTICE_ROW

LATTICE_ROW: Vector3 = new Vector3(0, 1, 0)

Accessors

cellDiameter

get cellDiameter(): number

Inherited from HoneycombLattice.cellDiameter
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:209
Returns number

height

get height(): number

Inherited from HoneycombLattice.height
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:205
Returns number

Protected hoffset

get hoffset(): number

- Defined in backend/src/catana/nanomodeling/lattices/honeycomb-lattice.ts:19
Returns number

latticeType

get latticeType(): LatticeType

Overrides Lattice.latticeType
- Defined in backend/src/catana/nanomodeling/lattices/honeycomb-lattice.ts:15
Returns LatticeType

parentComponent

get parentComponent(): LatticeComponent | undefined
set parentComponent(comp: LatticeComponent | undefined): void

Inherited from HoneycombLattice.parentComponent
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:56
Returns LatticeComponent | undefined
Inherited from HoneycombLattice.parentComponent
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:60
Parameters
- comp: LatticeComponent | undefined
Returns void

type

get type(): string

Inherited from HoneycombLattice.type
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:52
Returns string

Protected voffset

get voffset(): number

- Defined in backend/src/catana/nanomodeling/lattices/honeycomb-lattice.ts:23
Returns number

width

get width(): number

Inherited from HoneycombLattice.width
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:201
Returns number

Methods

getColumnAxis

getColumnAxis(applyCompTransf?: boolean): Vector3

Inherited from HoneycombLattice.getColumnAxis
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:124
Returns a unit vector pointing in the direction along which the column index increases (+x) _ | | -> |_|

Parameters
- Default value applyCompTransf: boolean = true
Returns Vector3

getCoordinatesFromIndex

getCoordinatesFromIndex(index: number): {}

Inherited from HoneycombLattice.getCoordinatesFromIndex
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:94
Get a lattice cell's row and columns indexes based on its unique index

Parameters
- index: number
Returns {}
- [p: string]: number

getIndex

getIndex(rowIndex: number, colIndex: number): number

Inherited from HoneycombLattice.getIndex
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:87
Get a lattice cell's unique index from its row and column indeexes

Parameters
- rowIndex: number
- colIndex: number
Returns number

getNormal

getNormal(applyCompTransf?: boolean): Vector3

Inherited from HoneycombLattice.getNormal
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:114
Returns a unit vector pointing in the direction of the lattice normal

Parameters
- Default value applyCompTransf: boolean = true
Returns Vector3

getPosition

getPosition(rowIndex: number, colIndex: number, depth?: number, applyCompTransf?: boolean): Vector3

Inherited from HoneycombLattice.getPosition
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:71
Given the coordinates of a lattice cell (rowIndex and colIndex), return the 3D position of that cell

Parameters
- rowIndex: number
  
  The row index of the lattice cell
- colIndex: number
  
  The row index of the lattice cell
- Default value depth: number = 0
- Default value applyCompTransf: boolean = true
Returns Vector3

getPositionFromIndex

getPositionFromIndex(index: number): Vector3

Inherited from HoneycombLattice.getPositionFromIndex
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:106
Get a lattice cell's 3D position based on its unique index

Parameters
- index: number
Returns Vector3

getRowAxis

getRowAxis(applyCompTransf?: boolean): Vector3

Inherited from HoneycombLattice.getRowAxis
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:134
Returns a unit vector pointing in the direction along which the row index increases (+y) _ | | ^ |_| |

Parameters
- Default value applyCompTransf: boolean = true
Returns Vector3

Protected getX

getX(rowIndex: number, colIndex: number): number

Overrides Lattice.getX
- Defined in backend/src/catana/nanomodeling/lattices/honeycomb-lattice.ts:27
Parameters
- rowIndex: number
- colIndex: number
Returns number

Protected getY

getY(rowIndex: number, colIndex: number): number

Overrides Lattice.getY
- Defined in backend/src/catana/nanomodeling/lattices/honeycomb-lattice.ts:31
Parameters
- rowIndex: number
- colIndex: number
Returns number

Protected getZ

getZ(depth: number): number

Inherited from HoneycombLattice.getZ
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:48
Parameters
- depth: number
Returns number

moveOriginToNewLocation

moveOriginToNewLocation(newOrigin: Vector3): void

Inherited from HoneycombLattice.moveOriginToNewLocation
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:184
Moves origin ([0, 0] lattice index) to the new location

Parameters
- newOrigin: Vector3
Returns void

resize

resize(newWidth: number, newHeight: number): void

Inherited from HoneycombLattice.resize
- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:158
Changes the size of the lattice

Parameters
- newWidth: number
  
  Number of lattice columns
- newHeight: number
  
  Number of lattice rows
Returns void

resizeFromLengths

resizeFromLengths(widthLength: number, heightLength: number): void

Overrides Lattice.resizeFromLengths
- Defined in backend/src/catana/nanomodeling/lattices/honeycomb-lattice.ts:44
Parameters
- widthLength: number
- heightLength: number
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Default value width: number = Lattice.DEFAULT_WIDTH

Default value height: number = Lattice.DEFAULT_HEIGHT

Default value cellDiameter: number = 20

Default value matrix: Matrix4 = new Matrix4()

Returns HoneycombLattice

Properties

Protected _cellDiameter

Protected _end

Protected _height

Private _hoffset

Protected _matrix

Protected _parentComponent

Protected _start

Private _voffset

Protected _width

Static Protected Readonly DEFAULT_HEIGHT

Static Protected Readonly DEFAULT_HEIGHT_MAX

Static Protected Readonly DEFAULT_WIDTH

Static Protected Readonly DEFAULT_WIDTH_MAX

Static Protected Readonly LATTICE_COLUMN

Static Protected Readonly LATTICE_NORMAL

Static Protected Readonly LATTICE_ROW

Accessors

cellDiameter

Returns number

height

Returns number

Protected hoffset

Returns number

latticeType

Returns LatticeType

parentComponent

Returns LatticeComponent | undefined

Parameters

comp: LatticeComponent | undefined

Returns void

type

Returns string

Protected voffset

Returns number

width

Returns number

Methods

getColumnAxis

Parameters

Default value applyCompTransf: boolean = true

Returns Vector3

getCoordinatesFromIndex

Parameters

index: number

Returns {}

[p: string]: number

getIndex

Parameters

rowIndex: number

colIndex: number

Returns number

getNormal

Parameters

Default value applyCompTransf: boolean = true

Returns Vector3

getPosition

Parameters

rowIndex: number

colIndex: number

Default value depth: number = 0

Default value applyCompTransf: boolean = true

Returns Vector3

getPositionFromIndex

Parameters

index: number