import Gui from './ui/gui.js'

public class | source

Gui

Extends:

cables-shared-client~Events → Gui

main singleton class for starting the editor

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	bookmarks: *
public	bottomInfoArea: *
public	bottomPanelHeight: *
public	bottomTabPanel: *
public	bottomTabs: *
public	canvasInfoUiHeight: number
public	canvasMagnifier: *
public	canvasManager: *
public	chat: *
public	cmdPallet: *
public	currentModal: *
public	delayedResizeCanvas: *
public	editorWidth: *
public	fileManager: *
public	fileManagerEditor: *
public	htmlEleOverlay: *
public	iconBarLeft: *
public	iconBarPatchNav: *
public	iconBarTimeline: *
public	introduction: *
public	isRemoteClient: *
public	keys: *
public	lastNotIdle: *
public	longPressConnector: *
public	mainTabs: *
public	maintabPanel: *
public	metaKeyframes: *
public	metaOpParams: *
public	metaTabs: *
public	metaTexturePreviewer: *
public	notifiedFullscreen: boolean
public	onSaveProject: *
public	opDocs: *
public	opHistory: *
public	opParams: *
public	opPortModal: *
public get	patchId: *
public	patchParamPanel: *
public	patchView: *
public	rendererHeight: *
public	rendererHeightScaled: *
public	rendererWidth: *
public	rendererWidthScaled: *
public	restriction: *
public	rightPanelWidth: *
public	savedState: *
public	serverOps: ServerOps
public get	shouldDrawOverlay: boolean
public	showingtwoMetaPanel: boolean
public	socket: *
public	theme: *
public	tips: *
public	transformOverlay: *
public	user: *
public	userSettings: *

Private Members
private	_corePatch: *
private	_currentProject: *
private	_cursor: string
private	_elBgPreview: *
private	_elBgPreviewButtonContainer: *
private	_elBreadcrumbNav: *
private	_elCablesCanvasContainer: *
private	_elCanvasFlash: *
private	_elEditor: *
private	_elEditorMaximized: *
private	_elEditorMinimized: *
private	_elGlCanvasDom: *
private	_elGlUiPreviewLayer: *
private	_elIconbarBottom: *
private	_elIconbarLeft: *
private	_elIconbarTimeline: *
private	_elInfoArea: *
private	_elInfoAreaParam: *
private	_elLibrary: *
private	_elMaintab: *
private	_elMenubar: *
private	_elMeta: *
private	_elOptions: *
private	_elPatch: *
private	_elProgressbar: *
private	_elSplitterMaintabs: *
private	_elSplitterPatch: *
private	_elSplitterRenderer: *
private	_elTLkeycontrols: *
private	_elTLoverviewtimeline: *
private	_elTLsplitterTimeline: *
private	_elTLtimelineTitle: *
private	_elTLtimetimeline: *
private	_eleBottomTabs: *
private	_eleSplitterTimeline: *
private	_eleTiming: *
private	_find: *
private	_gizmo: *[]
private	_jobs: *
private	_log: *
private	_modalLoading: *
private	_modalLoadingCount: number
private	_oldCanvasHeight: number
private	_oldCanvasWidth: number
private	_oldShowingEditor: boolean
private	_opselect: *
private	_patchLoadEndiD: *
private	_restrictionMode: *
private	_savedStateChangesBlueprintSubPatches: *[]
private	_showTiming: boolean
private	_spaceBarStart: number
private	_timeLine: *
private	_timeoutPauseProfiler: *
private	_toBottomPanel: *

Method Summary

Public Methods
public	bind(cb: *)
public	bindKeys()
public	canSaveInMultiplayer(): boolean
public	checkIdle()
public	closeModal()
public	converterStart(projectId: , fileId: , converterId: *)
public	corePatch(): *
public	createProject()
public	cycleFullscreen()
public	cyclePatchBg()
public	endModalLoading()
public	find(str: ):
public	finishedLoading(): *
public	focusFindResult(idx: , opid: , subpatch: , x: , y: *)
public	getDefaultTheme(): *
public	getFileManager(cb: , userInteraction: ): *
public	getOpDoc(opname: , html: , cb: *)
public	getParamPanelEleId(): *
public	getRestriction(): *
public	getSavedState(): *
public	getSavedStateChangesBlueprintSubPatches(): *[]
public	helperContextMenu(el: *)
public	hideBottomTabs()
public	hideElementsByRestriction(r: *)
public	hideTiming()
public	init(next: *)
public	initCoreListeners()
public	isGuestEditor(): *
public	isShowingModal(): *
public	isShowingTiming(): *
public	jobs(): *
public	metaKeyframesShowAnim(opid: , portname: )
public	notIdling()
public	onResize()
public	opSelect(): *
public	pauseInteractionSplitpanes()
public	pauseProfiling()
public	pressedEscape(e: *)
public	project(): *
public	refreshFileManager()
public	reloadDocs(cb: *)
public	rendererAspectMenu(el: *)
public	rendererContextMenu(el: *)
public	replaceNavShortcuts()
public	resumeInteractionSplitpanes()
public	savingTitleAnimEnd()
public	savingTitleAnimStart(title: *)
public	scene(): *
public	serializeForm(selector: ):
public	setBottomPanelHeight(h: *)
public	setCursor(str: *)
public	setElementBgPattern(el: *)
public	setFontSize(v: *)
public	setLayout()
public	setProject(p: *)
public	setProjectName(name: *)
public	setRestriction(r: *)
public	setStateUnsaved(options: *)
public	setTheme(theme: {}): *
public	setTransform(id: , x: , y: , z: )
public	setTransformGizmo(params: , idx: )
public	setUser(u: *)
public	showBackupSaveWarning(): boolean
public	showBottomTabs()
public	showConverter(converterId: , projectId: , fileId: , converterName: , fileName: undefined)
public	showFileManager(cb: , userInteraction: )
public	showGuestWarning(): boolean
public	showInfo(txt: *)
public	showInfoParam(txt: *)
public	showLibLoadError(libName: *)
public	showLoadingProgress(show: *)
public	showLogging()
public	showSaveWarning(): boolean
public	showSettings(userInteraction: *)
public	showTiming()
public	showTwoMetaPanels(): *
public	showUiElements()
public	showWelcomeNotifications()
public	startModalLoading(title: ):
public	texturePreview(): *
public	timeLine(): *
public	toggleTiming()
public	updateActivityFeedIcon(data: *)
public	watchArray(opid: , which: )

Private Methods
private	_switchCanvasPatchBg()
private	_switchCanvasSizeNormal()

Public Constructors

public constructor() source

Public Members

public bookmarks: * source

public bottomInfoArea: * source

public bottomPanelHeight: * source

public bottomTabPanel: * source

public bottomTabs: * source

public canvasInfoUiHeight: number source

public canvasMagnifier: * source

public canvasManager: * source

public chat: * source

public cmdPallet: * source

public currentModal: * source

public delayedResizeCanvas: * source

public editorWidth: * source

public fileManager: * source

public fileManagerEditor: * source

public htmlEleOverlay: * source

public iconBarLeft: * source

public iconBarPatchNav: * source

public iconBarTimeline: * source

public introduction: * source

public isRemoteClient: * source

public keys: * source

public lastNotIdle: * source

public longPressConnector: * source

public mainTabs: * source

public maintabPanel: * source

public metaKeyframes: * source

public metaOpParams: * source

public metaTabs: * source

public metaTexturePreviewer: * source

public notifiedFullscreen: boolean source

public onSaveProject: * source

public opDocs: * source

public opHistory: * source

public opParams: * source

public opPortModal: * source

public get patchId: * source

public patchParamPanel: * source

public patchView: * source

public rendererHeight: * source

public rendererHeightScaled: * source

public rendererWidth: * source

public rendererWidthScaled: * source

public restriction: * source

public rightPanelWidth: * source

public savedState: * source

public serverOps: ServerOps source

public get shouldDrawOverlay: boolean source

public showingtwoMetaPanel: boolean source

public socket: * source

public theme: * source

public tips: * source

public transformOverlay: * source

public user: * source

public userSettings: * source

Private Members

private _corePatch: * source

private _currentProject: * source

private _cursor: string source

private _elBgPreview: * source

private _elBgPreviewButtonContainer: * source

private _elBreadcrumbNav: * source

private _elCablesCanvasContainer: * source

private _elCanvasFlash: * source

private _elEditor: * source

private _elEditorMaximized: * source

private _elEditorMinimized: * source

private _elGlCanvasDom: * source

private _elGlUiPreviewLayer: * source

private _elIconbarBottom: * source

private _elIconbarLeft: * source

private _elIconbarTimeline: * source

private _elInfoArea: * source

private _elInfoAreaParam: * source

private _elLibrary: * source

private _elMaintab: * source

private _elMenubar: * source

private _elMeta: * source

private _elOptions: * source

private _elPatch: * source

private _elProgressbar: * source

private _elSplitterMaintabs: * source

private _elSplitterPatch: * source

private _elSplitterRenderer: * source

private _elTLkeycontrols: * source

private _elTLoverviewtimeline: * source

private _elTLsplitterTimeline: * source

private _elTLtimelineTitle: * source

private _elTLtimetimeline: * source

private _eleBottomTabs: * source

private _eleSplitterTimeline: * source

private _eleTiming: * source

private _find: * source

private _gizmo: *[] source

private _jobs: * source

private _log: * source

private _modalLoading: * source

private _modalLoadingCount: number source

private _oldCanvasHeight: number source

private _oldCanvasWidth: number source

private _oldShowingEditor: boolean source

private _opselect: * source

private _patchLoadEndiD: * source

private _restrictionMode: * source

private _savedStateChangesBlueprintSubPatches: *[] source

private _showTiming: boolean source

private _spaceBarStart: number source

private _timeLine: * source

private _timeoutPauseProfiler: * source

private _toBottomPanel: * source

Public Methods

public bind(cb: *) source

Params:

Name	Type	Attribute	Description
cb	*

public bindKeys() source

public canSaveInMultiplayer(): boolean source

Return:

boolean

public checkIdle() source

public closeModal() source

public converterStart(projectId: , fileId: , converterId: *) source

Params:

Name	Type	Attribute	Description
projectId	*
fileId	*
converterId	*

public corePatch(): * source

Return:

public createProject() source

public cycleFullscreen() source

public cyclePatchBg() source

public endModalLoading() source

public find(str: ): source

Params:

Name	Type	Attribute	Description
str	*

Return:

public finishedLoading(): * source

Return:

public focusFindResult(idx: , opid: , subpatch: , x: , y: *) source

Params:

Name	Type	Attribute	Description
idx	*
opid	*
subpatch	*
x	*
y	*

public getDefaultTheme(): * source

Return:

public getFileManager(cb: , userInteraction: ): * source

Params:

Name	Type	Attribute	Description
cb	*
userInteraction	*

Return:

public getOpDoc(opname: , html: , cb: *) source

Params:

Name	Type	Attribute	Description
opname	*
html	*
cb	*

public getParamPanelEleId(): * source

Return:

public getRestriction(): * source

Return:

public getSavedState(): * source

Return:

public getSavedStateChangesBlueprintSubPatches(): *[] source

Return:

*[]

public helperContextMenu(el: *) source

Params:

Name	Type	Attribute	Description
el	*

public hideBottomTabs() source

public hideElementsByRestriction(r: *) source

Params:

Name	Type	Attribute	Description
r	*

public hideTiming() source

public init(next: *) source

Params:

Name	Type	Attribute	Description
next	*

public initCoreListeners() source

public isGuestEditor(): * source

Return:

public isShowingModal(): * source

Return:

public isShowingTiming(): * source

Return:

public jobs(): * source

Return:

public metaKeyframesShowAnim(opid: , portname: ) source

Params:

Name	Type	Attribute	Description
opid	*
portname	*

public notIdling() source

public onResize() source

public opSelect(): * source

Return:

public pauseInteractionSplitpanes() source

public pauseProfiling() source

public pressedEscape(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public project(): * source

Return:

public refreshFileManager() source

public reloadDocs(cb: *) source

Params:

Name	Type	Attribute	Description
cb	*

public rendererAspectMenu(el: *) source

Params:

Name	Type	Attribute	Description
el	*

public rendererContextMenu(el: *) source

Params:

Name	Type	Attribute	Description
el	*

public replaceNavShortcuts() source

public resumeInteractionSplitpanes() source

public savingTitleAnimEnd() source

public savingTitleAnimStart(title: *) source

Params:

Name	Type	Attribute	Description
title	*

public scene(): * source

Return:

public serializeForm(selector: ): source

Params:

Name	Type	Attribute	Description
selector	*

Return:

public setBottomPanelHeight(h: *) source

Params:

Name	Type	Attribute	Description
h	*

public setCursor(str: *) source

Params:

Name	Type	Attribute	Description
str	*

public setElementBgPattern(el: *) source

Params:

Name	Type	Attribute	Description
el	*

public setFontSize(v: *) source

Params:

Name	Type	Attribute	Description
v	*

public setLayout() source

public setProject(p: *) source

Params:

Name	Type	Attribute	Description
p	*

public setProjectName(name: *) source

Params:

Name	Type	Attribute	Description
name	*

public setRestriction(r: *) source

Params:

Name	Type	Attribute	Description
r	*

public setStateUnsaved(options: *) source

Params:

Name	Type	Attribute	Description
options	*

public setTheme(theme: {}): * source

Params:

Name	Type	Attribute	Description
theme	{}	optional default: {}

Return:

public setTransform(id: , x: , y: , z: ) source

Params:

Name	Type	Attribute	Description
id	*
x	*
y	*
z	*

public setTransformGizmo(params: , idx: ) source

Params:

Name	Type	Attribute	Description
params	*
idx	*

public setUser(u: *) source

Params:

Name	Type	Attribute	Description
u	*

public showBackupSaveWarning(): boolean source

Return:

boolean

public showBottomTabs() source

public showConverter(converterId: , projectId: , fileId: , converterName: , fileName: undefined) source

Params:

Name	Type	Attribute	Description
converterId	*
projectId	*
fileId	*
converterName	*
fileName	undefined	optional default: undefined

public showFileManager(cb: , userInteraction: ) source

Params:

Name	Type	Attribute	Description
cb	*
userInteraction	*

public showGuestWarning(): boolean source

Return:

boolean

public showInfo(txt: *) source

Params:

Name	Type	Attribute	Description
txt	*

public showInfoParam(txt: *) source

Params:

Name	Type	Attribute	Description
txt	*

public showLibLoadError(libName: *) source

Params:

Name	Type	Attribute	Description
libName	*

public showLoadingProgress(show: *) source

Params:

Name	Type	Attribute	Description
show	*

public showLogging() source

public showSaveWarning(): boolean source

Return:

boolean

public showSettings(userInteraction: *) source

Params:

Name	Type	Attribute	Description
userInteraction	*

public showTiming() source

public showTwoMetaPanels(): * source

Return:

public showUiElements() source

public showWelcomeNotifications() source

public startModalLoading(title: ): source

Params:

Name	Type	Attribute	Description
title	*

Return:

public texturePreview(): * source

Return:

public timeLine(): * source

Return:

public toggleTiming() source

public updateActivityFeedIcon(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public watchArray(opid: , which: ) source

Params:

Name	Type	Attribute	Description
opid	*
which	*

Private Methods

private _switchCanvasPatchBg() source

private _switchCanvasSizeNormal() source