Class CgCustomColorMaker

Uses colors stored as a property of coarse-grained polymers. Useful mainly for cadnano-imported files.

Hierarchy

Colormaker
- CgCustomColorMaker

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CgCustomColorMaker(params?: Partial<ColormakerParameters>): CgCustomColorMaker

Inherited from EntitytypeColormaker.constructor
- Defined in backend/src/color/colormaker.ts:52
Create a colormaker instance

Parameters
- Default value params: Partial<ColormakerParameters> = {}
  
  colormaker parameter
Returns CgCustomColorMaker

Properties

Optional atomProxy

atomProxy: AtomProxy

parameters

parameters: ColormakerParameters

Methods

Optional atomColor

atomColor(atom: AtomProxy): number

Inherited from ElectrostaticColormaker.atomColor
- Defined in backend/src/color/colormaker.ts:112
Parameters
- atom: AtomProxy
Returns number

atomColorToArray

atomColorToArray(atom: AtomProxy, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.atomColorToArray
- Defined in backend/src/color/colormaker.ts:121
safe a atom color to an array

Parameters
- atom: AtomProxy
  
  atom to get color for
- array: NumberArray
  
  destination
- offset: number
  
  index into the array
Returns NumberArray

the destination array

bondColor

bondColor(bond: BondProxy, fromTo: boolean): number

Inherited from AtomindexColormaker.bondColor
- Defined in backend/src/color/colormaker.ts:133
return the color for an bond

Parameters
- bond: BondProxy
  
  bond to get color for
- fromTo: boolean
  
  whether to use the first or second atom of the bond
Returns number

hex bond color

bondColorToArray

bondColorToArray(bond: BondProxy, fromTo: boolean, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.bondColorToArray
- Defined in backend/src/color/colormaker.ts:150
safe a bond color to an array

Parameters
- bond: BondProxy
  
  bond to get color for
- fromTo: boolean
  
  whether to use the first or second atom of the bond
- array: NumberArray
  
  destination
- offset: number
  
  index into the array
Returns NumberArray

the destination array

colorToArray

colorToArray(color: number, array?: NumberArray, offset?: number): NumberArray

Inherited from AtomindexColormaker.colorToArray
- Defined in backend/src/color/colormaker.ts:104
safe a color to an array

Parameters
- color: number
  
  hex color value
- Default value array: NumberArray = []
  
  destination
- Default value offset: number = 0
  
  index into the array
Returns NumberArray

the destination array

generateColors

generateColors(howMany: number, params?: Partial<ScaleParameters>): string[]

Inherited from AtomindexColormaker.generateColors
- Defined in backend/src/color/colormaker.ts:76
Parameters
- howMany: number
- Default value params: Partial<ScaleParameters> = {}
Returns string[]

getScale

getScale(params?: Partial<ScaleParameters>): Scale<any>

Inherited from AtomindexColormaker.getScale
- Defined in backend/src/color/colormaker.ts:70
Parameters
- Default value params: Partial<ScaleParameters> = {}
Returns Scale<any>

monomerBondColor

monomerBondColor(b: CgMonomerBondProxy): number

Overrides AtomindexColormaker.monomerBondColor
- Defined in backend/src/catana/color/cg-custom-color-maker.ts:15
Parameters
- b: CgMonomerBondProxy
Returns number

monomerBondColorToArray

monomerBondColorToArray(m: CgMonomerBondProxy, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.monomerBondColorToArray
- Defined in backend/src/color/colormaker.ts:196
Parameters
- m: CgMonomerBondProxy
- array: NumberArray
- offset: number
Returns NumberArray

monomerColor

monomerColor(m: CgMonomerProxy): number

Overrides AtomindexColormaker.monomerColor
- Defined in backend/src/catana/color/cg-custom-color-maker.ts:11
Parameters
- m: CgMonomerProxy
Returns number

monomerColorToArray

monomerColorToArray(m: CgMonomerProxy, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.monomerColorToArray
- Defined in backend/src/color/colormaker.ts:190
Parameters
- m: CgMonomerProxy
- array: NumberArray
- offset: number
Returns NumberArray

Optional positionColor

positionColor(position: Vector3): number

Inherited from AtomindexColormaker.positionColor
- Defined in backend/src/color/colormaker.ts:171
Parameters
- position: Vector3
Returns number

positionColorToArray

positionColorToArray(coords: Vector3, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.positionColorToArray
- Defined in backend/src/color/colormaker.ts:180
safe a color for coordinates in space to an array

Parameters
- coords: Vector3
  
  xyz coordinates
- array: NumberArray
  
  destination
- offset: number
  
  index into the array
Returns NumberArray

the destination array

Optional volumeColor

volumeColor(index: number): number

Inherited from AtomindexColormaker.volumeColor
- Defined in backend/src/color/colormaker.ts:156
Parameters
- index: number
Returns number

volumeColorToArray

volumeColorToArray(index: number, array: NumberArray, offset: number): NumberArray

Inherited from AtomindexColormaker.volumeColorToArray
- Defined in backend/src/color/colormaker.ts:165
safe a volume cell color to an array

Parameters
- index: number
  
  volume cell index
- array: NumberArray
  
  destination
- offset: number
  
  index into the array
Returns NumberArray

the destination array

Generated using TypeDoc