Typedef

Static Public Summary
public	AnimCfg: * configuration object for loading a patch
public	AnimUiAttribs: *
public	CblRequestOptions: *
public	CoreOp: *
public	CorePatch: *
public	DeserializeOptions: *
public	HeavyEvent: *
public	HistoryObject: *
public	HistoryUserObject: *
public	KeyUiAttribs: *
public	LinkTimeRules: *
public	LoadingTask: *
public	OpAttribs: *
public	OpId: * a unique op id of One op, like OpName
public	OpInstanceId: * a op id of a single of many that are living in a patch
public	OpName: * a full opname, e.g.
public	OpTempData: *
public	OpUiAttribs: *
public	OpUiAttribs: import("./core_op.js").OpUiAttribs
public	PatchConfig: *
public	PortAttribs: *
public	PortUiAttribs: *
public	PortUiAttribsDisplay: "bool" \| "boolnum" \| "button" \| "buttons" \| "createOpHelper" \| "curve" \| "dropdown" \| "editor" \| "file" \| "gradient" \| "multiport" \| "range" \| "readonly" \| "reroute" \| "sg" \| "sg_vec" \| "spreadsheet" \| "switch" \| "text" \| "texture"
public	ProfilerItem: *
public	SerializedAnim: *
public	SerializedKey: *
public	Translation: *
public	TranslationTemp: *
public	UUID: String
public	UiAttrArea: *
public	UiError: *
public	UiErrorOptions: *

Static Public

public AnimCfg: * source

configuration object for loading a patch

Properties:

Name	Type	Attribute	Description
defaultEasing	number	optional	use easing index as default
name	string	optional	anim name

public AnimUiAttribs: * source

Properties:

Name	Type	Attribute	Description
height	number	optional
muted	number	optional
readOnly	boolean	optional

public CblRequestOptions: * source

Properties:

Name	Type	Attribute	Description
url	String
cb	Function	optional
method	String	optional
data	String	optional
contenttype	String	optional
sync	Boolean	optional
credentials	string	optional
jsonP	Boolean	optional
post	Boolean	optional
asynch	Boolean	optional
headers	Object	optional

public CoreOp: * source

public CorePatch: * source

public DeserializeOptions: * source

Properties:

Name	Type	Attribute	Description
genIds	boolean	optional
createRef	boolean	optional
onLoadedValueSet	Function	optional
opsCreated	Function	optional

public HeavyEvent: * source

Properties:

Name	Type	Attribute	Description
event	String
info	String
date	number

public HistoryObject: * source

Properties:

Name	Type	Attribute	Description
lastInteractionBy	HistoryUserObject	optional
lastInteractionAt	number	optional

public HistoryUserObject: * source

Properties:

Name	Type	Attribute	Description
name	string	optional

public KeyUiAttribs: * source

Properties:

Name	Type	Attribute	Description
text	string	optional
bezFree	number	optional
color	string	optional

public LinkTimeRules: * source

Properties:

Name	Type	Attribute	Description
needsLinkedToWork	Port[]
needsStringToWork	Port[]
needsParentOp	string
forbiddenParent	string
forbiddenParentType	number

public LoadingTask: * source

Properties:

Name	Type	Attribute	Description
op	Op	optional
id	string	optional
name	string	optional
type	string	optional

public OpAttribs: * source

Properties:

Name	Type	Attribute	Description
tags	string[]	optional	tags
area	string	optional	area

public OpId: * source

a unique op id of One op, like OpName

public OpInstanceId: * source

a op id of a single of many that are living in a patch

public OpName: * source

a full opname, e.g. Ops.Gl.Mainloop

public OpTempData: * source

Properties:

Name	Type	Attribute	Description
origData	Object	optional
scopeAreaEndOp	Object	optional
scopeAreaStartOp	Object	optional
shaderNode	import("../corelibs/shadergraph/shadergraphprogram.js").ShaderNode	optional

public OpUiAttribs: * source

Properties:

Name	Type	Attribute	Description
title	string	optional	overwrite op title
hidePort	string	optional	hidePort
title	string	optional	overwrite op title
title	String	optional default: ''	overwrite title of port (by default this is portname)
extendTitle	string	optional	extended op title, shown in grey next to op name
storage	object	optional
working	boolean	optional
bookmarked	boolean	optional
selected	boolean	optional
disabled	boolean	optional
loading	boolean	optional
resizable	boolean	optional
hidden	boolean	optional
uierrors	UiError[]	optional
color	string	optional
area	UiAttrArea	optional
areaCollapsed	boolean	optional
comment	string	optional
height	number	optional
width	number	optional
translate	Translation	optional
translateTemp	TranslationTemp	optional
subPatch	string	optional
subPatchOp	object	optional
tempSubOldOpId	string	optional
comment_title	string	optional
highlighted	boolean	optional
highlightedMore	boolean	optional
mathTitle	string	optional
extendTitlePort	string	optional
display	string	optional
hasArea	boolean	optional
scopeArea	boolean	optional
resizableX	boolean	optional
resizableY	boolean	optional
moveableOnlyY	boolean	optional
tlOrder	number	optional
heatmapIntensity	number	optional
commentOverwrite	string	optional
comment_text	string	optional
history	HistoryObject	optional
createdLocally	boolean	optional
stretchPorts	boolean	optional
vizLayerMaxZoom	number	optional
widthOnlyGrow	boolean	optional
forceAspect	number	optional
vizLayerFullOpSize	boolean	optional

public OpUiAttribs: import("./core_op.js").OpUiAttribs source

public PatchConfig: * source

Properties:

Name	Type	Attribute	Description
prefixAssetPath	String	optional default: ''	prefix for path to assets
assetPath	String	optional default: ''	path to assets
jsPath	String	optional default: ''	path to javascript files
glCanvasId	String	optional default: 'glcanvas'	dom element id of canvas element
onError	Function	optional default: null	called when an error occurs
onFinishedLoading	Function	optional default: null	called when patch finished loading all assets
onFirstFrameRendered	Function	optional default: null	called when patch rendered it's first frame
glCanvasResizeToWindow	Boolean	optional default: false	resize canvas automatically to window size
glCanvasResizeToParent	Boolean	optional	resize canvas automatically to parent element
doRequestAnimation	Boolean	optional default: true	do requestAnimationFrame set to false if you want to trigger exec() from outside (only do if you know what you are doing)
clearCanvasColor	Boolean	optional default: true	clear canvas in transparent color every frame
clearCanvasDepth	Boolean	optional default: true	clear depth every frame
glValidateShader	Boolean	optional default: true	enable/disable validation of shaders *
silent	Boolean	optional default: false
fpsLimit	Number	optional default: 0	0 for maximum possible frames per second
glslPrecision	String	optional default: 'mediump'	default precision for glsl shader
prefixJsPath	String	optional
onPatchLoaded	Function	optional
canvas	Object	optional
patch	Object	optional
patchFile	String	optional
subPatch	String	optional	internal use
masterVolume	Number	optional	0 for maximum possible frames per second
glCanvas	HTMLCanvasElement	optional
containerElement	HTMLElement	optional
editorMode	boolean	optional
variables	Object	optional	object of key value pairs, that initialize variables

public PortAttribs: * source

Properties:

Name	Type	Attribute	Description
sg	string	optional

public PortUiAttribs: * source

Properties:

Name	Type	Attribute	Description
title	String	optional	overwrite title of port (by default this is portname)
display	PortUiAttribsDisplay	optional	how the port is displayed and interacted in the paramerer panel
greyout	Boolean	optional	port paramater will appear greyed out, can not be
hidePort	Boolean	optional	port will be hidden from op
hideParam	Boolean	optional	port params will be hidden from parameter panel
showIndex	Boolean	optional	only for dropdowns - show value index (e.g. `0 - normal` )
editorSyntax	String	optional	set syntax highlighting theme for editor port
ignoreObjTypeErrors	Boolean	optional	do not auto check object types
group	string	optional	do not set manually - group ports, usually set by op.setPortGroup...
isAnimated	Boolean	optional	internal: do not set manually
useVariable	Boolean	optional	internal: do not set manually
variableName	string	optional	internal: do not set manually
order	Number	optional	internal: do not set manually
stride	Number	optional	internal: do not set manually
expose	Boolean	optional	internal: do not set manually
increment	String	optional	internal: do not set manually
editorDiagnostics	import("../../../cables_ui/src/ui/api/opsserver.js").LinterDiag[]	optional	diagnostics
axis	String	optional	internal: do not set manually
type	String	optional	internal: do not set manually
objType	String	optional	internal: do not set manually
filter	String	optional	internal: do not set manually
hideFormatButton	boolean	optional	internal: do not set manually
editShortcut	boolean	optional	internal: do not set manually
filter	String	optional	internal: do not set manually
preview	boolean	optional	internal: do not set manually
colorPick	boolean	optional
values	Array<String>	optional	internal: do not set manually
boundToVar	boolean	optional	internal: do not set manually
addPort	boolean	optional	internal: do not set manually
notWorking	boolean	optional	internal: do not set manually
glPortIndex	number	optional	internal: do not set manually
readOnly	boolean	optional	internal: do not set manually
multiPortManual	Boolean	optional	internal: do not set manually
multiPortNum	Number	optional	internal: do not set manually
multiPort	boolean	optional	internal: do not set manually
longPort	number	optional
tlDrawKeys	boolean	optional
tlEase	number	optional	default easing when animating parameter
hover	boolean	optional
ignoreBigPort	boolean	optional
multiPort2	boolean	optional
stringTrim	boolean	optional

public PortUiAttribsDisplay: "bool" | "boolnum" | "button" | "buttons" | "createOpHelper" | "curve" | "dropdown" | "editor" | "file" | "gradient" | "multiport" | "range" | "readonly" | "reroute" | "sg" | "sg_vec" | "spreadsheet" | "switch" | "text" | "texture" source

public ProfilerItem: * source

Properties:

Name	Type	Attribute	Description
title	String	optional	overwrite title of port (by default this is portname)
numTriggers	*		{number}
timeUsed	*		{number}
timeUsedFrame	*		{number}
opid	*		{string}
subPatch	*		{string}
timePsMsAvg	*		{number}
timePsMs	*		{number}
timePsCount	*		{number}
_timePsCount	*		{number}
_timePsStart	*		{number}
_timePsMs	*		{number}

public SerializedAnim: * source

Properties:

Name	Type	Attribute	Description
loop	number
tlActive	boolean
keys	SerializedKey[]

public SerializedKey: * source

Properties:

Name	Type	Attribute	Description
v	number	optional
t	number	optional
e	number	optional
clipId	string	optional
uiAttribs	KeyUiAttribs	optional
cb	Function	optional
anim	import("./anim.js").Anim	optional	do not use
value	number	optional	do not use
time	number	optional	do not use
cp1	number[]	optional
cp2	number[]	optional

public Translation: * source

Properties:

Name	Type	Attribute	Description
x	number	optional
y	number	optional

public TranslationTemp: * source

Properties:

Name	Type	Attribute	Description
x	number	optional
y	number	optional
w	number	optional
h	number	optional

public UUID: String source

public UiAttrArea: * source

Properties:

Name	Type	Attribute	Description
id	String	optional
x	number	optional
y	number	optional
w	number	optional
h	number	optional
origW	number	optional
origH	number	optional

public UiError: * source

Properties:

Name	Type	Attribute	Description
txt	string
level	number
id	string
options	UiErrorOptions

public UiErrorOptions: * source

Properties:

Name	Type	Attribute	Description
button	string
buttonCb	Function