Lattice | catana-backend

Describes a generic lattice where each cell can be accessed with unique X and Y coordinates

Hierarchy

Lattice
- HoneycombLattice
- SquareLattice

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:34
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 Lattice

Properties

Protected _cellDiameter

_cellDiameter: number

Private _cells

_cells: null[][] = []

[rows][columns] or:

    col0   col1

row0: [ value, value, ... ] row1: [ value, value, ... ] ...

Protected _end

_end: Vector3

Protected _height

_height: number = Lattice.DEFAULT_HEIGHT

Protected _matrix

_matrix: Matrix4

Protected _parentComponent

_parentComponent: LatticeComponent | undefined

Protected _start

_start: Vector3

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

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

height

get height(): number

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

latticeType

get latticeType(): LatticeType

- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:46
Returns LatticeType

parentComponent

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

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

type

get type(): string

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

width

get width(): number

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

Methods

Private getAxis

getAxis(axis: "y" | "row" | "x" | "column" | "z" | "normal", applyCompTransf?: boolean): Vector3

- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:137
Parameters
- axis: "y" | "row" | "x" | "column" | "z" | "normal"
- Default value applyCompTransf: boolean = true
Returns Vector3

getColumnAxis

getColumnAxis(applyCompTransf?: boolean): Vector3

- 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): {}

- 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

- 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

- 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

- 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

- 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

- 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 Abstract getX

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

- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:43
Parameters
- rowIndex: number
- colIndex: number
Returns number

Protected Abstract getY

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

- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:44
Parameters
- rowIndex: number
- colIndex: number
Returns number

Protected getZ

getZ(depth: number): number

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

moveOriginToNewLocation

moveOriginToNewLocation(newOrigin: Vector3): void

- 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

- 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

Abstract resizeFromLengths

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

- Defined in backend/src/catana/nanomodeling/lattices/lattice.ts:45
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 Lattice

Properties

Protected _cellDiameter

Private _cells

Protected _end

Protected _height

Protected _matrix

Protected _parentComponent

Protected _start

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

latticeType

Returns LatticeType

parentComponent

Returns LatticeComponent | undefined

Parameters

comp: LatticeComponent | undefined

Returns void

type

Returns string

width

Returns number

Methods

Private getAxis

Parameters

axis: "y" | "row" | "x" | "column" | "z" | "normal"

Default value applyCompTransf: boolean = true

Returns Vector3

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