ProtectedconstructorOptionalisInternalConstructor: booleanProtected_Protected_Protected_ProtectedonFocuses the active scene.
ProtectedonSelects a viewport mesh.
StatictoolbarThe names of all toolbar buttons of the main toolbar.
Static ReadonlywindowThe default window content padding to be used for editor windows.
Static ReadonlywindowThe default window padding.
Returns the bounds of the window in pixels, relative to its parent container in points.
Returns the bounds of the window in pixels, relative to its parent container in pixels.
Gets the parent editor window this window is docked in. Can be null (for example when window is in the process of dragging and not visible).
Returns the bounds of the contents of the window in pixels, regardless of whether the window is docked or not.
Returns the height of the window contents in points.
Returns the height of the window contents in pixels.
Returns the width of the window contents in points.
Returns the width of the window contents in pixels.
The scene objects that are currently selected by the scene gizmos.
Returns the height of the window in points.
Sets the height of the window in pixels.
Gets the icon for the window.
Gets the icon for the window.
Checks whether the window the currently active window in its container. This means the window's tab is active or the window is the only one in its container.
Determines whether the window has been destroyed or not.
Makes the window in or out focus. Surface can only be made in focus if it is active.
Checks whether the window currently has keyboard focus.
Checks has the TypeScript window been initialized.
Determines is the mouse pointer currently hovering over the editor window.
Returns the X position of the window in screen coordinates in points.
Specifies the local shortcut context. This context will be automatically disabled whenever the user switches focus from the context.
Gets a unique name for this window. This name will be used for referencing the window by other systems.
Gets the parent EditorWindow.
Gets the preview scene content root.
Gets the preview scene renderer.
Gets the RenderWindow associated with this EditorWindow.
The ResourceHandle used for the preview.
Gets the scene gizmos.
Gets the preview scene instance.
Returns the bounds of the window in pixels, relative to its parent container in pixels.
Specifies the global shortcut context. This context will be always enabled as long as the window is active.
Checks if the window should handle input. This can be used by window implementations to check before handling input events.
Determines the size of the keu window.
Sets the stylesheet for this window's UI surface.
Sets the stylesheet for this window's UI surface.
The main toolbar.
Returns the X position of the window in screen coordinates in points.
Get the local undo redo of the window.
Gets the viewport camera.
Returns the width of the window in points.
Sets the width of the window in pixels.
Makes the window active in its container. This means the windows tab is active and the window is visible.
Add support to the given Drop data type.
The type of the data from OS to support.
The text representing the action of dropping into this window.
Applies the specified camera settings.
Centers the window within it's parent window.
Closes the window but keeps it on the dock manager. Calling raise will make it visible again.
Gets the action name for the given OS drop type. Only relevant if window supports the type.
The OS type of the drag and drop to get the action name from.
The screen on which this window is displayed.
ProtectedinitializeProtectedinitializeInitializes the main toolbar of the window
Determines if the window is currently closed. *
Determines if the window is currently docked. *
Determines if the window is currently undocked and floating. *
Returns whether or not this window supports the given OS data type drop.
Loads the preview scene template at the specified index.
Virtual
Method to override to implement destruction of custom windows. Called by the engine before the window is destroyed.
ProtectedonHandles a drag and drop window event.
Virtual
Method to override to implement custom behavior of a window, called by the engine once per frame.
ProtectedonVirtual
Method to override to implement custom behavior of a window, called by the engine once per frame,
once all the windows had their onEditorUpdate() method called.
Virtual
Method to override to implement initialization of custom windows. Called by the engine after window creation.
Virtual
Triggered whenever the window's screen dpi changes.
Virtual
Triggered whenever the window gains or loses focus.
True if focus was gained, false otherwise.
Virtual
Triggered whenever the window size changes.
New width of the window in pixels.
New height of the window in pixels.
Brings the editor window to focus. If it is docked, it's dock container will switch to the window's tab or if undocked the floating window will gain focus.
Rebuilds the currently loaded scene.
Switches active preview preset. Check ProjectSettings.getPreviewScenePreset for reference.
Preset index
Defines the window maximum width and height in points.
Defines the window minimum width and height in points.
The minimum width of the window in points.
The minimum height of the window in points.
Moves the window on the desktop. Coordinates are in screen space using points.
Moves the window on the desktop. Coordinates are in screen space using pixels.
Resizes the window using a width and height in points.
Resizes the window using a width and height in pixels.
StaticopenOpens the preview window.
StaticopenOpens an editor window. If window is already open it returns the existing instance.
Type of window to open.
Instance of the open window.
StaticopenPreview element with given path. Creates a new window if one does not exist.
The ResourceEntry or an identifier path.
ReadonlyonThe event is invoked when the preview scene has been fully initialized.
ReadonlyonTriggered whenever window size changes.
ReadonlyonTriggered whenever window's screen dpi changes.
ReadonlyonTriggered whenever window position changes.
ReadonlyonTriggered whenever window receives or loses focus.
ReadonlyonTriggered when the user do a OS drag on top of this window.
ReadonlyonTriggered when the user leaves the mouse from a OS drop.
ReadonlyonTriggered when the user actually drops something on top of this window.
Readonlyon
The ResourcePreviewWindow implements a DockableEditorWindow that can be used to preview scene relevant Resource such as meshes and materials under different lighting presets in editor.
The window provides a toolbar with buttons to switch between different presets and to focus the scene. Essentially, this window is a wrapper around the UIPreviewSceneRenderer class.