Class SurfaceRepresentation

Surface representation

Hierarchy

Representation
- SurfaceRepresentation

Index

Constructors

constructor

Methods

Constructors

constructor

new SurfaceRepresentation(surface: any, viewer: any, params: object): SurfaceRepresentation

Overrides Representation.constructor
- Defined in src/representation/surface-representation.js:34
Create Surface representation object

Parameters
- surface: any
  
  the surface or volume to be represented
- viewer: any
  
  a viewer object
- params: object
  
  surface representation parameters
Returns SurfaceRepresentation

Methods

attach

attach(callback: any): void

Overrides Representation.attach
- Defined in src/representation/surface-representation.js:139
Parameters
- callback: any
Returns void

build

build(updateWhat: any): void

Inherited from Representation.build
- Defined in src/representation/representation.js:355
Parameters
- updateWhat: any
Returns void

clear

clear(): void

Inherited from Representation.clear
- Defined in src/representation/representation.js:570
Returns void

create

create(): void

Overrides Representation.create
- Defined in src/representation/surface-representation.js:203
Returns void

dispose

dispose(): void

Overrides Representation.dispose
- Defined in src/representation/surface-representation.js:347
Returns void

getBufferParams

getBufferParams(p: any): any

Inherited from Representation.getBufferParams
- Defined in src/representation/representation.js:292
Parameters
- p: any
Returns any

getColorParams

getColorParams(): any

Overrides Representation.getColorParams
- Defined in src/representation/surface-representation.js:339
Returns any

getParameters

getParameters(): object

Inherited from Representation.getParameters
- Defined in src/representation/representation.js:554
Returns object
- lazy: any
- quality: any
- visible: any

init

init(params: any): void

Overrides Representation.init
- Defined in src/representation/surface-representation.js:116
Parameters
- params: any
Returns void

make

make(updateWhat: any, callback: any): void

Inherited from Representation.make
- Defined in src/representation/representation.js:378
Parameters
- updateWhat: any
- callback: any
Returns void

prepare

prepare(callback: any): void

- Defined in src/representation/surface-representation.js:149
Parameters
- callback: any
Returns void

setColor

setColor(value: any, p: any): this

Inherited from Representation.setColor
- Defined in src/representation/representation.js:320
Parameters
- value: any
- p: any
Returns this

setParameters

setParameters(params: object, what: object, rebuild: boolean): SurfaceRepresentation

Overrides Representation.setParameters
- Defined in src/representation/surface-representation.js:280
Set representation parameters

alias

SurfaceRepresentation#setParameters

Parameters
- params: object
  
  surface parameter object
- what: object
- rebuild: boolean
Returns SurfaceRepresentation

this object

setVisibility

setVisibility(value: boolean, noRenderRequest: boolean): Representation

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

Parameters
- value: boolean
  
  visibility flag
- noRenderRequest: boolean
Returns Representation

this object

update

update(what: any): void

Overrides Representation.update
- Defined in src/representation/surface-representation.js:236
Parameters
- what: any
Returns void

updateParameters

updateParameters(bufferParams?: object, what: any): void

Inherited from Representation.updateParameters
- Defined in src/representation/representation.js:536
Parameters
- Default value bufferParams: object = {}
- what: any
Returns void

Generated using TypeDoc