Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Component

Base class for components

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Properties

Private _requestReprsRebuild

_requestReprsRebuild: boolean = false

Private _requestReprsUpdate

_requestReprsUpdate: boolean = false

annotationList

annotationList: Annotation[] = []

controls

controls: ComponentControls

matrix

matrix: Matrix4 = new Matrix4()

Readonly object

object: any

Readonly parameters

parameters: ComponentParameters

position

position: Vector3 = new Vector3()

quaternion

quaternion: Quaternion = new Quaternion()

reprList

reprList: RepresentationElement[] = []

scale

scale: Vector3 = new Vector3(1, 1, 1)

Readonly stage

stage: Stage

stage object the component belongs to

transform

transform: Matrix4 = new Matrix4()

Readonly uuid

uuid: string

Readonly viewer

viewer: Viewer

Accessors

backendOnly

  • get backendOnly(): boolean

defaultParameters

  • get defaultParameters(): { backendOnly: boolean; locked: boolean; name: string; status: string; visible: boolean }

  • Returns { backendOnly: boolean; locked: boolean; name: string; status: string; visible: boolean }

    • backendOnly: boolean

      Used for determining whether the component should have its properties visualized on UI or not.

      remark

      Catana extension

    • locked: boolean

      Flag determining whether this component will ignore transformations or not.

      remark

      Catana extension

    • name: string
    • status: string
    • visible: boolean

locked

  • get locked(): boolean

name

  • get name(): string

status

  • get status(): string

type

  • get type(): string

visible

  • get visible(): boolean

Methods

Protected _addRepresentation

  • Add a new representation to the component

    Parameters

    • type: string

      the name of the representation

    • object: any

      the object on which the representation should be based

    • params: any
    • Default value hidden: boolean = false

    Returns RepresentationElement

    the created representation wrapped into a representation element object

addAnnotation

addBufferRepresentation

  • addBufferRepresentation(buffer: any, params: any): any

Abstract addRepresentation

  • addRepresentation(type: any, params: any): any

autoView

  • autoView(duration?: undefined | number): void

dispose

  • dispose(): void

eachAnnotation

  • eachAnnotation(callback: (a: Annotation) => void): void

eachRepresentation

getBox

  • getBox(...args: any[]): Box3

getBoxUntransformed

  • getBoxUntransformed(...args: any[]): Box3

getCenter

  • getCenter(...args: any[]): Vector3

getCenterUntransformed

  • getCenterUntransformed(...args: any[]): Vector3

getZoom

  • getZoom(...args: any[]): number

hasObject

  • hasObject(object: any): boolean

  • Checks if this component stores corresponding object.

    remark

    Catana addition

    Parameters

    • object: any

      object to search for

    Returns boolean

    true if the object is part of this component in some way

hasRepresentation

localToWorldDirection

  • localToWorldDirection(dir: Vector3): Vector3

  • Converts direction from local component space to world space

    remark

    Catana extension

    Parameters

    • dir: Vector3

      local direction to transform

    Returns Vector3

    corresponding world direction

localToWorldPosition

  • localToWorldPosition(pos: Vector3): Vector3

  • Converts position from local component space to world space

    remark

    Catana extension

    Parameters

    • pos: Vector3

      local position to transform

    Returns Vector3

    corresponding world position

onUpdate

  • onUpdate(delta: number): void

rebuildRepresentations

  • rebuildRepresentations(): void

removeAllAnnotations

  • removeAllAnnotations(): void

removeAllRepresentations

  • removeAllRepresentations(): void

removeAnnotation

removeRepresentation

requestRepresentationsRebuild

  • requestRepresentationsRebuild(): void

requestRepresentationsUpdate

  • requestRepresentationsUpdate(): void

setLocked

setName

setPosition

  • setPosition(p: [number, number, number] | Vector3): this

  • Set position transform

    example

    // translate by 25 angstrom along x axis component.setPosition([ 25, 0, 0 ]);

    Parameters

    • p: [number, number, number] | Vector3

      the coordinates

    Returns this

    this object

setRotation

  • setRotation(r: [number, number, number] | Euler | Quaternion): this

  • Set local rotation transform (for global rotation use setTransform)

    example

    // rotate by 2 degree radians on x axis component.setRotation( [ 2, 0, 0 ] );

    Parameters

    • r: [number, number, number] | Euler | Quaternion

      the rotation

    Returns this

    this object

setScale

  • setScale(s: number): this

setStatus

setTransform

  • setTransform(m: Matrix4): this

  • Set general transform. Is applied before and in addition to the position, rotation and scale transformations

    example

    component.setTransform( matrix );

    Parameters

    • m: Matrix4

      the matrix

    Returns this

    this object

setVisibility

  • setVisibility(value: boolean): this

Abstract supportsColorScheme

  • supportsColorScheme(scheme: any): boolean

updateMatrix

  • updateMatrix(): void

updateRepresentationMatrices

  • updateRepresentationMatrices(): void

updateRepresentations

  • updateRepresentations(what: any): void

Object literals

Readonly signals

signals: object

Events emitted by the component

disposed

disposed: Signal<T> = new Signal()

lockedChanged

lockedChanged: Signal<T> = new Signal()

matrixChanged

matrixChanged: Signal<T> = new Signal()

nameChanged

nameChanged: Signal<T> = new Signal()

representationAdded

representationAdded: Signal<T> = new Signal()

representationRemoved

representationRemoved: Signal<T> = new Signal()

statusChanged

statusChanged: Signal<T> = new Signal()

visibilityChanged

visibilityChanged: Signal<T> = new Signal()

Generated using TypeDoc