Home Reference Source
import Snap from './ui/glpatch/snap.js'
public class | source

Snap

Extends:

Events → Snap

snapping of ops/ports etc to an invisible grid

Constructor Summary

Public Constructor
public

constructor(_cgl: CglContext, glPatch: GlPatch, instancer: GlRectInstancer)

Member Summary

Public Members
public

enabled: boolean

public

rect: *

Private Members
private
private
private

_rectWidth: number

private
private

_xCoords: *[]

Method Summary

Public Methods
public

render(mouseDown: Boolean)

public

snapOpX(_x: number, op: import("../core_extend_op.js").UiOp, dist: number): *

public

snapX(_x: Number): *

public

snapY(y: Number, force: boolean): Number

public

update()

Private Methods
private

_snapPortX(_x: number, port: Port, _index: number, dist: number): *

Public Constructors

public constructor(_cgl: CglContext, glPatch: GlPatch, instancer: GlRectInstancer) source

Params:

NameTypeAttributeDescription
_cgl CglContext
glPatch GlPatch
instancer GlRectInstancer

Public Members

public enabled: boolean source

public rect: * source

Private Members

private _glPatch: GlPatch source

private _instancer: GlRectInstancer source

private _rectWidth: number source

private _timeout: * source

private _xCoords: *[] source

Public Methods

public render(mouseDown: Boolean) source

Params:

NameTypeAttributeDescription
mouseDown Boolean

public snapOpX(_x: number, op: import("../core_extend_op.js").UiOp, dist: number): * source

Params:

NameTypeAttributeDescription
_x number
op import("../core_extend_op.js").UiOp
dist number
  • optional

Return:

*

public snapX(_x: Number): * source

Params:

NameTypeAttributeDescription
_x Number

Return:

*

public snapY(y: Number, force: boolean): Number source

Params:

NameTypeAttributeDescription
y Number
force boolean

Return:

Number

public update() source

Private Methods

private _snapPortX(_x: number, port: Port, _index: number, dist: number): * source

Params:

NameTypeAttributeDescription
_x number
port Port
_index number
dist number

Return:

*