Class NucleicAcidStrandCreator

This class stores information about the nucleic acid strand being created from point A to B via the 3D modeling interface.

Hierarchy

NucleicAcidStrandCreator

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new NucleicAcidStrandCreator(startPos?: Vector3, endPos?: Vector3, dnaForm?: DnaForm, maxLength?: undefined | number): NucleicAcidStrandCreator

- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:12
Parameters
- Default value startPos: Vector3 = new Vector3(0, 0, 0)
  
  starting position of the new strand
- Default value endPos: Vector3 = new Vector3(0, 0, 0)
  
  ending position of the new strand
- Default value dnaForm: DnaForm = BDnaIdealisticForm
  
  DNA form of the created strand
- Optional maxLength: undefined | number
  
  maximum allowed length of the strand (in nr. of nucleotides)
Returns NucleicAcidStrandCreator

Properties

Private _dnaForm

_dnaForm: DnaForm

Private _helicalAxisEnd

_helicalAxisEnd: Vector3

Private _helicalAxisStart

_helicalAxisStart: Vector3

Private _maxLengthInAngstroms

_maxLengthInAngstroms: number | undefined

Accessors

dnaForm

get dnaForm(): DnaForm
set dnaForm(form: DnaForm): void

- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:79
Sets new DNA form for the created strand

Returns DnaForm

DNA form of the created strand
- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:86
Sets new DNA form for the created strand

Parameters
- form: DnaForm
Returns void

DNA form of the created strand

helicalAxisDirection

get helicalAxisDirection(): Vector3

- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:93
Returns Vector3

the direction of the helical axis

helicalAxisEnd

get helicalAxisEnd(): Vector3
set helicalAxisEnd(endPos: Vector3): void

- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:50
Sets new end position for the created strand. If maximum allowed length of the strand was set, the new strand end will be shortened to not exceed this value.

Returns Vector3

end position for the created strand
- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:65
Sets new end position for the created strand. If maximum allowed length of the strand was set, the new strand end will be shortened to not exceed this value.

Parameters
- endPos: Vector3
Returns void

end position for the created strand

helicalAxisStart

get helicalAxisStart(): Vector3
set helicalAxisStart(startPos: Vector3): void

- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:36
Sets new starting position for the created strand

Returns Vector3

start position of the created strand
- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:43
Sets new starting position for the created strand

Parameters
- startPos: Vector3
Returns void

start position of the created strand

lengthInAngstroms

get lengthInAngstroms(): number

- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:107
Returns number

length of the strand in angstroms

nucleotideRise

get nucleotideRise(): number

- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:72
Returns number

nucleotide rise (depending on the provided DNA form)

numOfNucleotides

get numOfNucleotides(): number

- Defined in backend/src/catana/nanomodeling/nucleic-acid-strand-creator.ts:100
Returns number

number of nucleotides to be created

Generated using TypeDoc