import SurfaceRepresentation from 'ngl/src/representation/surface-representation.js'

public class | source

SurfaceRepresentation

Extends:

Representation → SurfaceRepresentation

Surface representation

Constructor Summary

Public Constructor
public	constructor(surface: Surface \| Volume, viewer: Viewer, params: SurfaceRepresentationParameters) Create Surface representation object

Member Summary

Public Members
public	background
public	box
public	boxCenter
public	boxSize
public	colorVolume
public	contour
public	isolevel
public	isolevelType
public	negateIsolevel
public	opaqueBack
public	parameters
public	smooth
public	surface
public	type
public	useWorker
public	volume
public	wrap

Private Members
private	__box
private	__boxCenter
private	__boxSize
private	__contour
private	__isolevel
private	__smooth
private	__wrap
private	_position

Method Summary

Public Methods
public	attach()
public	create()
public	dispose()
public	getColorParams()
public	init()
public	prepare()
public	setParameters(params: SurfaceRepresentationParameters, what: Object, rebuild: Boolean): SurfaceRepresentation Set representation parameters
public	update()

Inherited Summary

From class Representation
public	[name]
public	clipCenter
public	clipNear
public	clipRadius
public	colorDomain
public	colorMode
public	colorReverse
public	colorScale
public	colorScheme
public	colorValue
public	depthWrite
public	diffuse
public	disableImpostor
public	disablePicking
public	disposed
public	flatShaded
public	lazy
public	lazyProps
public	matrix
public	metalness
public	opacity
public	openEnded
public	parameters
public	quality
public	radialSegments
public	roughness
public	side
public	sphereDetail
public	tasks: Counter Counter that keeps track of tasks related to the creation of the representation, including surface calculations.
public	type
public	viewer: Viewer
public	visible
public	wireframe
private	bufferList: Array
private	queue: Queue
public	attach()
public	build()
public	clear()
public	create()
public	dispose()
public	getBufferParams()
public	getColorParams()
public	getParameters()
public	init()
public	make()
public	setColor()
public	setParameters(params: RepresentationParameters, what: Object, rebuild: Boolean): Representation Set the visibility of the representation
public	setVisibility(value: Boolean, noRenderRequest: Boolean): Representation Set the visibility of the representation
public	update()
public	updateParameters()

Public Constructors

public constructor(surface: Surface | Volume, viewer: Viewer, params: SurfaceRepresentationParameters) source

Create Surface representation object

Override:

Representation#constructor

Params:

Name	Type	Attribute	Description
surface	Surface \| Volume		the surface or volume to be represented
viewer	Viewer		a viewer object
params	SurfaceRepresentationParameters		surface representation parameters

Public Members

public background source

public box source

public boxCenter source

public boxSize source

public colorVolume source

public contour source

public isolevel source

public isolevelType source

public negateIsolevel source

public opaqueBack source

public parameters source

Override:

Representation#parameters

public smooth source

public surface source

public type source

Override:

Representation#type

public useWorker source

public volume source

public wrap source

Private Members

private __box source

private __boxCenter source

private __boxSize source

private __contour source

private __isolevel source

private __smooth source

private __wrap source

private _position source

Public Methods

public attach() source

Override:

Representation#attach

public create() source

Override:

Representation#create

public dispose() source

Override:

Representation#dispose

public getColorParams() source

Override:

Representation#getColorParams

public init() source

Override:

Representation#init

public prepare() source

public setParameters(params: SurfaceRepresentationParameters, what: Object, rebuild: Boolean): SurfaceRepresentation source

Set representation parameters

Override:

Representation#setParameters

Params:

Name	Type	Attribute	Description
params	SurfaceRepresentationParameters		surface parameter object
what	Object	optional	buffer data attributes to be updated, note that this needs to be implemented in the derived classes. Generally it allows more fine-grained control over updating than forcing a rebuild.
what.position	Boolean		update position data
what.color	Boolean		update color data
rebuild	Boolean	optional	whether or not to rebuild the representation

Return:

SurfaceRepresentation

this object

public update() source

Override:

Representation#update