Skip to main content

VectorOverlay

megane-viewer

megane-viewer / VectorOverlay

Class: VectorOverlay

Defined in: pipeline/builder.ts:382

Configure per-atom vector visualization (e.g. forces, velocities).

Ports: inp.vector — vector data in out.vector — configured vector data

Extends​

  • PipelineNode

Constructors​

Constructor​

new VectorOverlay(__namedParameters?): VectorOverlay

Defined in: pipeline/builder.ts:389

Parameters​

__namedParameters?​
scale?​

number = 1.0

Returns​

VectorOverlay

Overrides​

PipelineNode.constructor

Properties​

_id​

_id: string | null = null

Defined in: pipeline/builder.ts:83

Inherited from​

PipelineNode._id

_inpPorts​

protected readonly _inpPorts: object

Defined in: pipeline/builder.ts:385

vector​

vector: string = "vector"

Overrides​

PipelineNode._inpPorts

_outPorts​

protected readonly _outPorts: object

Defined in: pipeline/builder.ts:384

vector​

vector: string = "vector"

Overrides​

PipelineNode._outPorts

nodeType​

readonly nodeType: "vector_overlay" = "vector_overlay"

Defined in: pipeline/builder.ts:383

Overrides​

PipelineNode.nodeType

scale​

scale: number

Defined in: pipeline/builder.ts:387

Accessors​

inp​

Get Signature​

get inp(): PortAccessor

Defined in: pipeline/builder.ts:91

Input port namespace. Access ports via node.inp.portName

Returns​

PortAccessor

Inherited from​

PipelineNode.inp

out​

Get Signature​

get out(): PortAccessor

Defined in: pipeline/builder.ts:86

Output port namespace. Access ports via node.out.portName

Returns​

PortAccessor

Inherited from​

PipelineNode.out

Methods​

_toSerializedParams()​

_toSerializedParams(): object

Defined in: pipeline/builder.ts:394

Serialize node parameters to the SerializedPipeline v3 node dict.

Returns​

object

scale​

scale: number

type​

type: string

Overrides​

PipelineNode._toSerializedParams