Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AxesRepresentation

Axes representation. Show principal axes and/or a box aligned with them that fits the structure or selection.

Name: axes

example

stage.loadFile( "rcsb://3pqr", { assembly: "BU1" } ).then( function( o ){ o.addRepresentation( "cartoon" ); o.addRepresentation( "axes", { sele: "RET", showAxes: false, showBox: true, radius: 0.2 } ); o.addRepresentation( "ball+stick", { sele: "RET" } ); o.addRepresentation( "axes", { sele: ":B and backbone", showAxes: false, showBox: true, radius: 0.2 } ); stage.autoView(); var pa = o.structure.getPrincipalAxes(); stage.animationControls.rotate( pa.getRotationQuaternion(), 1500 ); } );

Hierarchy

Indexable

[key: string]: any

Axes representation. Show principal axes and/or a box aligned with them that fits the structure or selection.

Name: axes

example

stage.loadFile( "rcsb://3pqr", { assembly: "BU1" } ).then( function( o ){ o.addRepresentation( "cartoon" ); o.addRepresentation( "axes", { sele: "RET", showAxes: false, showBox: true, radius: 0.2 } ); o.addRepresentation( "ball+stick", { sele: "RET" } ); o.addRepresentation( "axes", { sele: ":B and backbone", showAxes: false, showBox: true, radius: 0.2 } ); stage.autoView(); var pa = o.structure.getPrincipalAxes(); stage.animationControls.rotate( pa.getRotationQuaternion(), 1500 ); } );

Index

Constructors

constructor

Properties

Protected assembly

assembly: string

bufferList

bufferList: Buffer[]

Protected clipCenter

clipCenter: Vector3

Protected clipNear

clipNear: number

Protected clipRadius

clipRadius: number

Protected colorDomain

colorDomain: number[]

Protected colorMode

colorMode: ColorMode

Protected colorReverse

colorReverse: boolean

Protected colorScale

colorScale: string | string[]

Protected colorScheme

colorScheme: string

Protected colorValue

colorValue: number

Protected cylinderBuffer

cylinderBuffer: CylinderBuffer

Protected dataList

Protected defaultAssembly

defaultAssembly: string

Protected depthWrite

depthWrite: boolean

Protected diffuse

diffuse: number

Protected Optional diffuseInterior

diffuseInterior: undefined | false | true

Protected disableImpostor

disableImpostor: boolean

Protected disablePicking

disablePicking: boolean

Protected disposed

disposed: boolean

Protected flatShaded

flatShaded: boolean

Protected interiorColor

interiorColor: number

Protected interiorDarkening

interiorDarkening: number

lazy

lazy: boolean

lazyProps

lazyProps: { bufferParams: BufferParameters | {}; build: boolean; what: {} }

Type declaration

Protected manualAttach

manualAttach: () => any

Type declaration

    • (): any
    • Returns any

Protected matrix

matrix: Matrix4

Protected metalness

metalness: number

Protected name

name: string

Protected needsBuild

needsBuild: boolean

Protected opacity

opacity: number

Protected openEnded

openEnded: boolean

parameters

parameters: any

Protected radialSegments

radialSegments: number

Protected radiusData

radiusData: {}

Type declaration

  • [k: number]: number

Protected radiusScale

radiusScale: number

Protected radiusSize

radiusSize: number

Protected radiusType

radiusType: RadiusType

Protected roughness

roughness: number

Protected selection

selection: Selection

Protected showAxes

showAxes: boolean

Protected showBox

showBox: boolean

Protected side

Protected sphereBuffer

sphereBuffer: SphereBuffer

Protected sphereDetail

sphereDetail: number

structure

structure: Structure

structureView

structureView: StructureView

tasks

tasks: Counter

Protected toBePrepared

toBePrepared: boolean

type

type: string

Protected Optional useInteriorColor

useInteriorColor: undefined | false | true

viewer

viewer: Viewer

visible

visible: boolean

Protected wireframe

wireframe: boolean

Accessors

defaultScale

  • get defaultScale(): { bfactor: number; covalent: number; sstruc: number; vdw: number }

Methods

attach

  • attach(callback: () => void): void

build

  • build(updateWhat?: undefined | {}): void

clear

  • clear(): void

create

  • create(): void

createData

dispose

  • dispose(): void

getAssembly

getAtomParams

getAtomRadius

getAxesData

  • getAxesData(sview: StructureView): { edge: object; vertex: object }
  • Parameters

    Returns { edge: object; vertex: object }

    • edge: object
      • color: Uint8Array | Int8Array | Int16Array | Int32Array | Uint16Array | Uint32Array | Float32Array | Uint8ClampedArray | Float64Array | number[]
      • color2: Uint8Array | Int8Array | Int16Array | Int32Array | Uint16Array | Uint32Array | Float32Array | Uint8ClampedArray | Float64Array | number[]
      • picking: AxesPicker
      • position1: Float32Array
      • position2: Float32Array
      • radius: Float32Array
    • vertex: object
      • color: Uint8Array | Int8Array | Int16Array | Int32Array | Uint16Array | Uint32Array | Float32Array | Uint8ClampedArray | Float64Array | number[]
      • picking: AxesPicker
      • position: Float32Array
      • radius: Float32Array

getBondParams

getBufferParams

  • getBufferParams(p?: {}): { clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: undefined | false | true; disablePicking: boolean; flatShaded: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; roughness: number; side: "double" | "front" | "back"; useInteriorColor: undefined | false | true; wireframe: boolean } & {}
  • Parameters

    • Default value p: {} = {}
      • [k: string]: any

    Returns { clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: undefined | false | true; disablePicking: boolean; flatShaded: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; roughness: number; side: "double" | "front" | "back"; useInteriorColor: undefined | false | true; wireframe: boolean } & {}

getColorParams

getParameters

  • getParameters(): {} & { defaultAssembly: string; sele: undefined | string }

getPrincipalAxes

getQuality

  • getQuality(): "high" | "medium" | "low"

getRadiusParams

  • getRadiusParams(param?: any): { data: {}; scale: number; size: number; type: "" | "data" | "sstruc" | "bfactor" | "size" | "explicit" | "vdw" | "covalent" }
  • Parameters

    • Optional param: any

    Returns { data: {}; scale: number; size: number; type: "" | "data" | "sstruc" | "bfactor" | "size" | "explicit" | "vdw" | "covalent" }

    • data: {}
      • [k: number]: number
    • scale: number
    • size: number
    • type: "" | "data" | "sstruc" | "bfactor" | "size" | "explicit" | "vdw" | "covalent"

init

make

  • make(updateWhat?: undefined | false | true, callback?: undefined | (() => void)): void

prepare

  • prepare(cb: () => void): void

setColor

setParameters

setRadius

setSelection

  • setSelection(string: string, silent?: undefined | false | true): this

setVisibility

  • setVisibility(value: boolean, noRenderRequest?: undefined | false | true): Representation

update

updateData

updateParameters

Generated using TypeDoc