SurfaceRepresentation

Create Surface representation object

Hierarchy

Representation
- SurfaceRepresentation

Indexable

[key: string]: any

Create Surface representation object

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SurfaceRepresentation(surface: Surface, viewer: Viewer, params: Partial<SurfaceRepresentationParameters>): SurfaceRepresentation

Overrides Representation.constructor
- Defined in src/representation/surface-representation.ts:85
Parameters
- surface: Surface
- viewer: Viewer
- params: Partial<SurfaceRepresentationParameters>
Returns SurfaceRepresentation

Properties

Protected __box

__box: Box3

Protected __boxCenter

__boxCenter: Vector3

Protected __boxSize

__boxSize: number

Protected __contour

__contour: boolean

Protected __isolevel

__isolevel: number

Protected __smooth

__smooth: number

Protected __wrap

__wrap: boolean

Protected _position

_position: Vector3

Protected background

background: boolean

Protected box

box: Box3

Protected boxCenter

boxCenter: Vector3

Protected boxSize

boxSize: number

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 colorVolume

colorVolume: Volume

Protected contour

contour: boolean

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

Protected inverseMatrix

inverseMatrix: Matrix4

Protected isolevel

isolevel: number

Protected isolevelScroll

isolevelScroll: boolean

Protected isolevelType

isolevelType: "value" | "sigma"

lazy

lazy: boolean

lazyProps

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

Type declaration

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

Protected manualAttach

manualAttach: () => any

Type declaration

- (): any
- Returns any

Protected matrix

matrix: Matrix4

Protected metalness

metalness: number

Protected name

name: string

Protected negateIsolevel

negateIsolevel: boolean

Protected opacity

opacity: number

Protected opaqueBack

opaqueBack: boolean

Protected openEnded

openEnded: boolean

parameters

parameters: any

Protected radialSegments

radialSegments: number

Protected roughness

roughness: number

setBox

setBox: () => void

Type declaration

- (): void
- Returns void

Protected side

side: BufferSide

Protected smooth

smooth: number

Protected sphereDetail

sphereDetail: number

Protected surface

surface: Surface | Volume | undefined

tasks

tasks: Counter

Protected toBePrepared

toBePrepared: boolean

type

type: string

Protected Optional useInteriorColor

useInteriorColor: undefined | false | true

Protected useWorker

useWorker: boolean

viewer

viewer: Viewer

visible

visible: boolean

Protected volume

volume: Volume | undefined

Protected wireframe

wireframe: boolean

Protected wrap

wrap: boolean

Methods

attach

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

Overrides Representation.attach
- Defined in src/representation/surface-representation.ts:192
Parameters
- callback: () => void
  - - (): void
    - Returns void
Returns void

build

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

Inherited from Representation.build
- Defined in src/representation/representation.ts:447
Parameters
- Optional updateWhat: undefined | {}
Returns void

clear

clear(): void

Inherited from Representation.clear
- Defined in src/representation/representation.ts:663
Returns void

create

create(): void

Overrides Representation.create
- Defined in src/representation/surface-representation.ts:256
Returns void

dispose

dispose(): void

Overrides Representation.dispose
- Defined in src/representation/surface-representation.ts:406
Returns void

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 } & {}

Inherited from Representation.getBufferParams
- Defined in src/representation/representation.ts:382
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

getColorParams(): { scheme: string } & ColormakerParameters

Overrides Representation.getColorParams
- Defined in src/representation/surface-representation.ts:398
Returns { scheme: string } & ColormakerParameters

getParameters

getParameters(): {}

Inherited from Representation.getParameters
- Defined in src/representation/representation.ts:647
Returns {}

init

init(params: Partial<SurfaceRepresentationParameters>): void

Overrides Representation.init
- Defined in src/representation/surface-representation.ts:167
Parameters
- params: Partial<SurfaceRepresentationParameters>
Returns void

make

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

Inherited from Representation.make
- Defined in src/representation/representation.ts:470
Parameters
- Optional updateWhat: undefined | false | true
- Optional callback: undefined | (() => void)
Returns void

prepare

prepare(callback: () => void): void

Overrides Representation.prepare
- Defined in src/representation/surface-representation.ts:202
Parameters
- callback: () => void
  - - (): void
    - Returns void
Returns void

setColor

setColor(value: number | string | Color | undefined, p?: Partial<RepresentationParameters>): this

Inherited from Representation.setColor
- Defined in src/representation/representation.ts:410
Parameters
- value: number | string | Color | undefined
- Optional p: Partial<RepresentationParameters>
Returns this

setParameters

setParameters(params: Partial<SurfaceRepresentationParameters>, what?: SurfaceDataFields, rebuild?: undefined | false | true): this

Overrides Representation.setParameters
- Defined in src/representation/surface-representation.ts:335
Set representation parameters

alias

SurfaceRepresentation#setParameters

Parameters
- params: Partial<SurfaceRepresentationParameters>
  
  surface parameter object
- Optional what: SurfaceDataFields
- Optional rebuild: undefined | false | true
Returns this

this object

setVisibility

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

Inherited from Representation.setVisibility
- Defined in src/representation/representation.ts:514
Set the visibility of the representation

Parameters
- value: boolean
  
  visibility flag
- Optional noRenderRequest: undefined | false | true
Returns Representation

this object

update

update(what: SurfaceDataFields): void

Overrides Representation.update
- Defined in src/representation/surface-representation.ts:291
Parameters
- what: SurfaceDataFields
Returns void

updateParameters

updateParameters(bufferParams?: BufferParameters | {}, what?: any): void

Inherited from Representation.updateParameters
- Defined in src/representation/representation.ts:629
Parameters
- Default value bufferParams: BufferParameters | {} = {}
- Optional what: any
Returns void

Hierarchy

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

surface: Surface

viewer: Viewer

params: Partial<SurfaceRepresentationParameters>

Returns SurfaceRepresentation

Properties

Protected __box

Protected __boxCenter

Protected __boxSize

Protected __contour

Protected __isolevel

Protected __smooth

Protected __wrap

Protected _position

Protected background

Protected box

Protected boxCenter

Protected boxSize

bufferList

Protected clipCenter

Protected clipNear

Protected clipRadius

Protected colorDomain

Protected colorMode

Protected colorReverse

Protected colorScale

Protected colorScheme

Protected colorValue

Protected colorVolume

Protected contour

Protected depthWrite

Protected diffuse

Protected Optional diffuseInterior

Protected disableImpostor

Protected disablePicking

Protected disposed

Protected flatShaded

Protected interiorColor

Protected interiorDarkening

Protected inverseMatrix

Protected isolevel

Protected isolevelScroll

Protected isolevelType

lazy

lazyProps

Type declaration

bufferParams: BufferParameters | {}

build: boolean

what: {}

Protected manualAttach

Type declaration

Returns any

Protected matrix

Protected metalness

Protected name

Protected negateIsolevel

Protected opacity

Protected opaqueBack

Protected openEnded

parameters

Protected radialSegments

Protected roughness

setBox

Type declaration

Returns void

Protected side

Protected smooth

Protected sphereDetail

Protected surface

tasks

Protected toBePrepared

type