import PatchView from './ui/components/patchview.js'

public class | source

PatchView

Extends:

Events → PatchView

manage patch view and helper functions

Static Method Summary

Static Public Methods
public static	getElement(): *

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	boundingRect: *
public get	element: *
public	hasOldOps: boolean
public	hasUiErrors: boolean
public	isPasting: boolean
public get	patchRenderer: *
public get	rendererName: *
public	store: *

Private Members
private	_checkErrorTimeout: *
private	_eleSubpatchNav: *
private	_element: *
private	_lastTempOP: *
private	_log: *
private	_p: *
private	_patchRenderer: *
private	_pvRenderers: {}
private	_showingNavHelperEmpty: boolean

Method Summary

Public Methods
public	addAssetOpAuto(filename: , event: )
public	addBlueprintInfo(op: , outerOp: ): *
public	addOp(opname: , options: )
public	addOpAndLink(opname: , opid: , portname: , cb: )
public	addSpaceBetweenOpsX()
public	addSpaceBetweenOpsY()
public	alignOps(selectedOps: ):
public	alignSelectedOpsHor(ops: ):
public	alignSelectedOpsVert(ops: ):
public	centerSelectOp(opid: *)
public	centerSubPatchBounds(subPatch: *)
public	centerView(x: , y: )
public	checkPatchErrors()
public	checkPatchErrorsSoon()
public	checkPatchOutdated()
public	cleanOps(ops: *)
public	clearPatch()
public	clickSubPatchNav(subPatchId: *)
public	clipboardCopyOps(e: *)
public	clipboardCutOps(e: *)
public	clipboardPaste(e: , oldSub: , mouseX: , mouseY: , next: *)
public	compressSelectedOps(ops: *)
public	copyOpInputPorts(origOp: , newOp: )
public	createAreaFromSelection()
public	createSubPatchFromSelection(version: number, next: undefined, options: {})
public	cursorNavOps(x: , y: )
public	deleteSelectedOps()
public	downGradeOp(opid: , opname: )
public	focus()
public	focusOp(opid: *)
public	focusOpAnim(opid: *)
public	focusSubpatchOp(subPatchId: *)
public	focusSubpatchOp(subPatchId: *)
public	getAllOpsInBlueprint(subid: ):
public	getAllSubPatchOps(subid: ):
public	getBlueprintOpFromBlueprintSubpatchId(bpSubpatchId: ):
public	getBlueprintOpsForSubPatches(subpatchIds: , localOnly: boolean):
public	getClosestOp(): *
public	getCurrentSubPatch(): *
public	getDistScore(primAxis: , secAxis: , primAxisB: , secAxisB: ): *
public	getOpBounds(ops: , options: {}):
public	getPatchOpsUsedInPatch(): *
public	getSelectedOps(): *
public	getSelectedOpsIds(): *
public	getSelectionBounds(minWidth: ):
public	getSubPatchBounds(subPatchId: ):
public	getSubPatchExposedPorts(subid: , dir: ): *
public	getSubPatchIdFromBlueprintOpId(opid: ):
public	getSubPatchName(subpatch: ):
public	getSubPatchOuterOp(subPatchId: ):
public	getSubPatches(sort: ):
public	getSubpatchPathArray(subId: , arr: ): *
public	getUserOpsUsedInPatch(): *
public	hasFocus(): *
public	highlightExamplePatchOps()
public	insertOpInLink(oldLink: , op: , x: , y: )
public	isCurrentOp(op: ):
public	isCurrentOpId(opid: ):
public	linkPortToOp(e: , opid: , pid: , op2id: )
public	linkPorts(opid: , pid: , op2id: , p2id: , event: *)
public	linkPortsToOp(e: , opid: , opids: , portnames: )
public	localizeBlueprints()
public	pause()
public	pauseInteraction()
public	refreshCurrentOpParamsByPort(p1: , p2: )
public	removeLostSubpatches()
public	replaceOp(opid: , newOpObjName: , cb: undefined)
public	replaceOpCheck(opid: , newOpObjName: )
public	replacePortValues(ops: , portName: , valueNew: , valueOld: )
public	resetOpValues(opid: , portname: )
public	resume()
public	resumeInteraction()
public	saveUndoSelectedOpsPositions(selectedOps: *)
public	selectAllOpsSubPatch(subPatch: , noUnselect: )
public	selectChilds(id: *)
public	selectOpId(id: *)
public	serialize(dataUi: *)
public	serializeOps(selectedOps: , options: {}): {"ops": }
public	setCurrentSubPatch(subpatch: , next: )
public	setExposedPortOrder(port: , dir: )
public	setOpColor(col: ):
public	setOpPos(op: , x: , y: *)
public	setPatchRenderer(id: , pr: )
public	setPortTitle(opId: , portName: , oldtitle: *)
public	setPositionSubPatchInputOutputOps(patchId: *)
public	setProject(proj: , cb: )
public	setSelectedOpById(opid: *)
public	setSize(x: , y: , w: , h: )
public	setUnsaved()
public	setVisibility(b: *)
public	showDefaultPanel()
public	showSelectedOpsPanel()
public	suggestionBetweenTwoOps(op1: , op2: )
public	switch(id: *)
public	testCollision(op: *)
public	toggleVisibility()
public	unlinkPort(opid: , portid: )
public	unlinkSelectedOps(firstOnly: *)
public	unselectAllOps()
public	unselectOpsFromOtherSubpatches()
public	updateBlueprints(blueprintOps: *[])
public	updateBoundingRect()
public	updateSubPatchBreadCrumb(currentSubPatch: *)
public	warnLargestPort()
public	zoomStep(step: *)

Private Methods
private	_initListeners()
private	_onDeleteOpUndo(op: *)
private	_portValidate(p1: , p2: )

Inherited Summary

From class Events
public	off: *
public	on: *
private	_eventCallbacks: {}
private	_listeners: {}
private	_log: *
private	_logEvents: boolean
private	_logName: string
public	addEventListener(which: , cb: , idPrefix: string): string add event listener
public	emitEvent(which: string, param1: , param2: , param3: , param4: , param5: , param6: ) emit event
public	hasEventListener(id: , cb: ): boolean check event listener registration
public	hasListenerForEventName(eventName: *): boolean check event listener by name
public	logEvents(enabled: boolean, logName: string) enable/disable logging of events for the class
public	removeEventListener(id: , cb: ) rempve event listener registration

Static Public Methods

public static getElement(): * source

Return:

Public Constructors

public constructor() source

Override:

Events#constructor

Public Members

public boundingRect: * source

public get element: * source

public hasOldOps: boolean source

public hasUiErrors: boolean source

public isPasting: boolean source

public get patchRenderer: * source

public get rendererName: * source

public store: * source

Private Members

private _checkErrorTimeout: * source

private _eleSubpatchNav: * source

private _element: * source

private _lastTempOP: * source

private _log: * source

Override:

Events#_log

private _p: * source

private _patchRenderer: * source

private _pvRenderers: {} source

private _showingNavHelperEmpty: boolean source

Public Methods

public addAssetOpAuto(filename: , event: ) source

Params:

Name	Type	Attribute	Description
filename	*
event	*

public addBlueprintInfo(op: , outerOp: ): * source

Params:

Name	Type	Attribute	Description
op	*
outerOp	*

Return:

public addOp(opname: , options: ) source

Params:

Name	Type	Attribute	Description
opname	*
options	*

public addOpAndLink(opname: , opid: , portname: , cb: ) source

Params:

Name	Type	Attribute	Description
opname	*
opid	*
portname	*
cb	*

public addSpaceBetweenOpsX() source

public addSpaceBetweenOpsY() source

public alignOps(selectedOps: ): source

Params:

Name	Type	Attribute	Description
selectedOps	*

Return:

public alignSelectedOpsHor(ops: ): source

Params:

Name	Type	Attribute	Description
ops	*

Return:

public alignSelectedOpsVert(ops: ): source

Params:

Name	Type	Attribute	Description
ops	*

Return:

public centerSelectOp(opid: *) source

Params:

Name	Type	Attribute	Description
opid	*

public centerSubPatchBounds(subPatch: *) source

Params:

Name	Type	Attribute	Description
subPatch	*

public centerView(x: , y: ) source

Params:

Name	Type	Attribute	Description
x	*
y	*

public checkPatchErrors() source

public checkPatchErrorsSoon() source

public checkPatchOutdated() source

public cleanOps(ops: *) source

Params:

Name	Type	Attribute	Description
ops	*

public clearPatch() source

public clickSubPatchNav(subPatchId: *) source

Params:

Name	Type	Attribute	Description
subPatchId	*

public clipboardCopyOps(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public clipboardCutOps(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public clipboardPaste(e: , oldSub: , mouseX: , mouseY: , next: *) source

Params:

Name	Type	Attribute	Description
e	*
oldSub	*
mouseX	*
mouseY	*
next	*

public compressSelectedOps(ops: *) source

Params:

Name	Type	Attribute	Description
ops	*

public copyOpInputPorts(origOp: , newOp: ) source

Params:

Name	Type	Attribute	Description
origOp	*
newOp	*

public createAreaFromSelection() source

public createSubPatchFromSelection(version: number, next: undefined, options: {}) source

Params:

Name	Type	Attribute	Description
version	number	optional default: 0
next	undefined	optional default: undefined
options	{}	optional default: {}

public cursorNavOps(x: , y: ) source

Params:

Name	Type	Attribute	Description
x	*
y	*

public deleteSelectedOps() source

public downGradeOp(opid: , opname: ) source

Params:

Name	Type	Attribute	Description
opid	*
opname	*

public focus() source

public focusOp(opid: *) source

Params:

Name	Type	Attribute	Description
opid	*

public focusOpAnim(opid: *) source

Params:

Name	Type	Attribute	Description
opid	*

public focusSubpatchOp(subPatchId: *) source

Params:

Name	Type	Attribute	Description
subPatchId	*

public focusSubpatchOp(subPatchId: *) source

Params:

Name	Type	Attribute	Description
subPatchId	*

public getAllOpsInBlueprint(subid: ): source

Params:

Name	Type	Attribute	Description
subid	*

Return:

public getAllSubPatchOps(subid: ): source

Params:

Name	Type	Attribute	Description
subid	*

Return:

public getBlueprintOpFromBlueprintSubpatchId(bpSubpatchId: ): source

Params:

Name	Type	Attribute	Description
bpSubpatchId	*

Return:

public getBlueprintOpsForSubPatches(subpatchIds: , localOnly: boolean): source

Params:

Name	Type	Attribute	Description
subpatchIds	*
localOnly	boolean	optional default: false

Return:

public getClosestOp(): * source

Return:

public getCurrentSubPatch(): * source

Return:

public getDistScore(primAxis: , secAxis: , primAxisB: , secAxisB: ): * source

Params:

Name	Type	Attribute	Description
primAxis	*
secAxis	*
primAxisB	*
secAxisB	*

Return:

public getOpBounds(ops: , options: {}): source

Params:

Name	Type	Attribute	Description
ops	*
options	{}	optional default: {}

Return:

public getPatchOpsUsedInPatch(): * source

Return:

public getSelectedOps(): * source

Return:

public getSelectedOpsIds(): * source

Return:

public getSelectionBounds(minWidth: ): source

Params:

Name	Type	Attribute	Description
minWidth	*

Return:

public getSubPatchBounds(subPatchId: ): source

Params:

Name	Type	Attribute	Description
subPatchId	*

Return:

public getSubPatchExposedPorts(subid: , dir: ): * source

Params:

Name	Type	Attribute	Description
subid	*
dir	*

Return:

public getSubPatchIdFromBlueprintOpId(opid: ): source

Params:

Name	Type	Attribute	Description
opid	*

Return:

public getSubPatchName(subpatch: ): source

Params:

Name	Type	Attribute	Description
subpatch	*

Return:

public getSubPatchOuterOp(subPatchId: ): source

Params:

Name	Type	Attribute	Description
subPatchId	*

Return:

public getSubPatches(sort: ): source

Params:

Name	Type	Attribute	Description
sort	*

Return:

public getSubpatchPathArray(subId: , arr: ): * source

Params:

Name	Type	Attribute	Description
subId	*
arr	*

Return:

public getUserOpsUsedInPatch(): * source

Return:

public hasFocus(): * source

Return:

public highlightExamplePatchOps() source

public insertOpInLink(oldLink: , op: , x: , y: ) source

Params:

Name	Type	Attribute	Description
oldLink	*
op	*
x	*
y	*

public isCurrentOp(op: ): source

Params:

Name	Type	Attribute	Description
op	*

Return:

public isCurrentOpId(opid: ): source

Params:

Name	Type	Attribute	Description
opid	*

Return:

public linkPortToOp(e: , opid: , pid: , op2id: ) source

Params:

Name	Type	Attribute	Description
e	*
opid	*
pid	*
op2id	*

public linkPorts(opid: , pid: , op2id: , p2id: , event: *) source

Params:

Name	Type	Attribute	Description
opid	*
pid	*
op2id	*
p2id	*
event	*

public linkPortsToOp(e: , opid: , opids: , portnames: ) source

Params:

Name	Type	Attribute	Description
e	*
opid	*
opids	*
portnames	*

public localizeBlueprints() source

public pause() source

public pauseInteraction() source

public refreshCurrentOpParamsByPort(p1: , p2: ) source

Params:

Name	Type	Attribute	Description
p1	*
p2	*

public removeLostSubpatches() source

public replaceOp(opid: , newOpObjName: , cb: undefined) source

Params:

Name	Type	Attribute	Description
opid	*
newOpObjName	*
cb	undefined	optional default: undefined

public replaceOpCheck(opid: , newOpObjName: ) source

Params:

Name	Type	Attribute	Description
opid	*
newOpObjName	*

public replacePortValues(ops: , portName: , valueNew: , valueOld: ) source

Params:

Name	Type	Attribute	Description
ops	*
portName	*
valueNew	*
valueOld	*	optional default: undefined

public resetOpValues(opid: , portname: ) source

Params:

Name	Type	Attribute	Description
opid	*
portname	*

public resume() source

public resumeInteraction() source

public saveUndoSelectedOpsPositions(selectedOps: *) source

Params:

Name	Type	Attribute	Description
selectedOps	*

public selectAllOpsSubPatch(subPatch: , noUnselect: ) source

Params:

Name	Type	Attribute	Description
subPatch	*
noUnselect	*

public selectChilds(id: *) source

Params:

Name	Type	Attribute	Description
id	*

public selectOpId(id: *) source

Params:

Name	Type	Attribute	Description
id	*

public serialize(dataUi: *) source

Params:

Name	Type	Attribute	Description
dataUi	*

public serializeOps(selectedOps: , options: {}): {"ops": } source

Params:

Name	Type	Attribute	Description
selectedOps	*
options	{}	optional default: {}

Return:

{"ops": *}

public setCurrentSubPatch(subpatch: , next: ) source

Params:

Name	Type	Attribute	Description
subpatch	*
next	*

public setExposedPortOrder(port: , dir: ) source

Params:

Name	Type	Attribute	Description
port	*
dir	*

public setOpColor(col: ): source

Params:

Name	Type	Attribute	Description
col	*

Return:

public setOpPos(op: , x: , y: *) source

Params:

Name	Type	Attribute	Description
op	*
x	*
y	*

public setPatchRenderer(id: , pr: ) source

Params:

Name	Type	Attribute	Description
id	*
pr	*

public setPortTitle(opId: , portName: , oldtitle: *) source

Params:

Name	Type	Attribute	Description
opId	*
portName	*
oldtitle	*

public setPositionSubPatchInputOutputOps(patchId: *) source

Params:

Name	Type	Attribute	Description
patchId	*

public setProject(proj: , cb: ) source

Params:

Name	Type	Attribute	Description
proj	*
cb	*

public setSelectedOpById(opid: *) source

Params:

Name	Type	Attribute	Description
opid	*

public setSize(x: , y: , w: , h: ) source

Params:

Name	Type	Attribute	Description
x	*
y	*
w	*
h	*

public setUnsaved() source

public setVisibility(b: *) source

Params:

Name	Type	Attribute	Description
b	*

public showDefaultPanel() source

public showSelectedOpsPanel() source

public suggestionBetweenTwoOps(op1: , op2: ) source

Params:

Name	Type	Attribute	Description
op1	*
op2	*

public switch(id: *) source

Params:

Name	Type	Attribute	Description
id	*

public testCollision(op: *) source

Params:

Name	Type	Attribute	Description
op	*

public toggleVisibility() source

public unlinkPort(opid: , portid: ) source

Params:

Name	Type	Attribute	Description
opid	*
portid	*

public unlinkSelectedOps(firstOnly: *) source

Params:

Name	Type	Attribute	Description
firstOnly	*

public unselectAllOps() source

public unselectOpsFromOtherSubpatches() source

public updateBlueprints(blueprintOps: *[]) source

Params:

Name	Type	Attribute	Description
blueprintOps	*[]	optional default: []

public updateBoundingRect() source

public updateSubPatchBreadCrumb(currentSubPatch: *) source

Params:

Name	Type	Attribute	Description
currentSubPatch	*

public warnLargestPort() source

public zoomStep(step: *) source

Params:

Name	Type	Attribute	Description
step	*

Private Methods

private _initListeners() source

private _onDeleteOpUndo(op: *) source

Params:

Name	Type	Attribute	Description
op	*

private _portValidate(p1: , p2: ) source

Params:

Name	Type	Attribute	Description
p1	*
p2	*

PatchView

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static getElement(): * source

Return:

Public Constructors

public constructor() source

Override:

Public Members

public boundingRect: * source

public get element: * source

public hasOldOps: boolean source

public hasUiErrors: boolean source

public isPasting: boolean source

public get patchRenderer: * source

public get rendererName: * source

public store: * source

Private Members

private _checkErrorTimeout: * source

private _eleSubpatchNav: * source

private _element: * source

private _lastTempOP: * source

private _log: * source

Override:

private _p: * source

private _patchRenderer: * source

private _pvRenderers: {} source

private _showingNavHelperEmpty: boolean source

Public Methods

public addAssetOpAuto(filename: *, event: *) source

Params:

public addBlueprintInfo(op: *, outerOp: *): * source

Params:

Return:

public addOp(opname: *, options: *) source

Params:

public addOpAndLink(opname: *, opid: *, portname: *, cb: *) source

Params:

public addSpaceBetweenOpsX() source

public addSpaceBetweenOpsY() source

public alignOps(selectedOps: *): * source

Params:

Return:

public alignSelectedOpsHor(ops: *): * source

Params:

Return:

public alignSelectedOpsVert(ops: *): * source

Params:

Return:

public centerSelectOp(opid: *) source

Params:

public centerSubPatchBounds(subPatch: *) source

Params:

public centerView(x: *, y: *) source

Params:

public checkPatchErrors() source

public checkPatchErrorsSoon() source

public checkPatchOutdated() source

public cleanOps(ops: *) source

Params:

public clearPatch() source

public clickSubPatchNav(subPatchId: *) source

Params:

public clipboardCopyOps(e: *) source

Params:

public clipboardCutOps(e: *) source

Params:

public clipboardPaste(e: *, oldSub: *, mouseX: *, mouseY: *, next: *) source

Params:

public compressSelectedOps(ops: *) source

Params:

public copyOpInputPorts(origOp: *, newOp: *) source

Params:

public createAreaFromSelection() source

public createSubPatchFromSelection(version: number, next: undefined, options: {}) source

public addAssetOpAuto(filename: , event: ) source

public addBlueprintInfo(op: , outerOp: ): * source

public addOp(opname: , options: ) source

public addOpAndLink(opname: , opid: , portname: , cb: ) source

public alignOps(selectedOps: ): source

public alignSelectedOpsHor(ops: ): source

public alignSelectedOpsVert(ops: ): source

public centerView(x: , y: ) source

public clipboardPaste(e: , oldSub: , mouseX: , mouseY: , next: *) source

public copyOpInputPorts(origOp: , newOp: ) source

public cursorNavOps(x: , y: ) source

public downGradeOp(opid: , opname: ) source

public getAllOpsInBlueprint(subid: ): source

public getAllSubPatchOps(subid: ): source

public getBlueprintOpFromBlueprintSubpatchId(bpSubpatchId: ): source

public getBlueprintOpsForSubPatches(subpatchIds: , localOnly: boolean): source

public getDistScore(primAxis: , secAxis: , primAxisB: , secAxisB: ): * source

public getOpBounds(ops: , options: {}): source

public getSelectionBounds(minWidth: ): source

public getSubPatchBounds(subPatchId: ): source

public getSubPatchExposedPorts(subid: , dir: ): * source

public getSubPatchIdFromBlueprintOpId(opid: ): source

public getSubPatchName(subpatch: ): source

public getSubPatchOuterOp(subPatchId: ): source

public getSubPatches(sort: ): source

public getSubpatchPathArray(subId: , arr: ): * source