Engine.UISceneClient

Extends

UIRoot

Modifiers

native ( UserInterface ) abstract inherits ( FExec , FCallbackEventDevice ) transient

Serves as the interface between a UIScene and scene owners. Provides scenes with all data necessary for operation and routes rendering to the scenes. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UISceneClient

Direct Known Subclasses:

EditorUISceneClient, GameUISceneClient

Functions Summary
	bool	ChangeActiveSkin (UISkin NewActiveSkin)
	bool	ChangeMouseCursor (name CursorName)
	bool	CloseScene (UIScene Scene)
	UIScene	GetActiveScene ()))
	matrix	GetCanvasToScreen (optional const UIObject Widget ) con)
	matrix	GetInverseCanvasToScreen (optional const UIObject Widget ) con)
	bool	InitializeScene (UIScene Scene, optional LocalPlayer SceneOwner, optional out UIScene InitializedScene)
	bool	IsSceneInitialized (UIScene Scene ) con)
	bool	IsUIActive (optional int Flags=0 ) con)
	bool	OpenScene (UIScene Scene, optional LocalPlayer SceneOwner, optional out UIScene OpenedScene)
		SetMousePosition (int NewMouseX, int NewMouseY)
		UpdateCanvasToScreen ()

ActiveControl Source code

Represents the widget/scene that is currently under the mouse cursor. @fixme splitscreen

ActiveSkin Source code

The active UISkin. Only one UISkin can be active at a time. The special data store name 'Styles' always corresponds to the ActiveSkin.

bEnablePostProcess Source code

if TRUE then post processing is enabled using the UIScenePostProcess

CanvasToScreen Source code

Stores the 3D projection matrix being used to render the UI.

DataStoreManager Source code

Manager all persistent global data stores. Set by the object that creates the scene client.

InvCanvasToScreen Source code

MousePosition Source code

the location of the mouse @fixme splitscreen

OpacityParameter Source code

Material instance parameter for UI widget opacity.

OpacityParameterName Source code

Name of the opacity parameter.

RenderViewport Source code

the viewport to use for rendering scenes

UIScenePostProcess Source code

Post process chain to be applied when rendering UI Scenes

ChangeActiveSkin Source code

Changes the active skin to the skin specified, initializes the skin and performs all necessary cleanup and callbacks. This method should only be called from script.
@param NewActiveScene The skin to activate
@return TRUE if the skin was successfully changed.

ChangeMouseCursor Source code

Changes the resource that is currently being used as the mouse cursor. Called by widgets as they changes states, or when some action occurs which affects the mouse cursor.
@param CursorName the name of the mouse cursor resource to use. Should correspond to a name from the active UISkin's MouseCursorMap
@return TRUE if the cursor was successfully changed.

CloseScene Source code

Deactivates the specified scene, as well as all scenes which occur after the specified scene in the list of active scenes.
@param Scene the scene to deactivate
@return true if the scene was successfully deactivated

GetActiveScene Source code

Returns the currently active scene

GetCanvasToScreen Source code

Returns the current canvas to screen projection matrix.
@param Widget if specified, the returned matrix will include the widget's tranformation matrix as well.
@return a matrix which can be used to project 2D pixel coordines into 3D screen coordinates. ??

GetInverseCanvasToScreen Source code

Returns the inverse of the local to world screen projection matrix.
@param Widget if specified, the returned matrix will include the widget's tranformation matrix as well.
@return a matrix which can be used to transform normalized device coordinates (i.e. origin at center of screen) into into 0,0 based pixel coordinates. ??

InitializeScene Source code

Initializes the specified scene without opening it.
@param Scene the scene to initialize; if the scene specified is contained in a content package, a copy of the scene will be created, and that scene will be initialized instead.
@param SceneOwner the player that should be associated with the new scene. Will be assigned to the scene's PlayerOwner property.
@param InitializedScene the scene that was actually initialized. If Scene is located in a content package, InitializedScene will be the copy of the scene that was created. Otherwise, InitializedScene will be the same as the scene passed in.
@return TRUE if the scene was successfully initialized
@note - noexport to handle the optional out parameter correctly

IsSceneInitialized Source code

Returns whether the specified scene has been fully initialized. Different from UUIScene::IsInitialized() in that this method returns true only once all objects related to this scene have been created and initialized (e.g. in the UI editor only returns TRUE once the editor window for this scene has finished creation).
@param Scene the scene to check.
@note: noexport because the C++ version is a pure virtual

IsUIActive Source code

Returns true if there is an unhidden fullscreen UI active
@param Flags a bitmask of values which alter the result of this method; the bits are derived from the ESceneFilterTypes enum (which is native-only); script callers must pass these values literally
@return TRUE if the UI is currently active

OpenScene Source code

Initializes and activates the specified scene.
@param Scene the scene to open; if the scene specified is contained in a content package, a copy of the scene will be created and the copy will be opened instead.
@param SceneOwner the player that should be associated with the new scene. Will be assigned to the scene's PlayerOwner property.
@param OpenedScene the scene that was actually opened. If Scene is located in a content package, OpenedScene will be the copy of the scene that was created. Otherwise, OpenedScene will be the same as the scene passed in.
@return TRUE if the scene was successfully opened
@note - noexport to handle the optional out parameter correctly

SetMousePosition Source code

Set the mouse position to the coordinates specified
@param NewX the X position to move the mouse cursor to (in pixels)
@param NewY the Y position to move the mouse cursor to (in pixels)

UpdateCanvasToScreen Source code

Changes the matrix for projecting local (pixel) coordinates into world screen (normalized device) coordinates. This method should be called anytime the viewport size or origin changes.

defaultproperties
{
   Name="Default__UISceneClient"
   ObjectArchetype=UIRoot'Engine.Default__UIRoot'
}