Space Engineers
Classes | Public Member Functions | Static Public Member Functions | Properties | List of all members
Sandbox.Game.Screens.MyGuiScreenHighlight Class Reference

This screen serves the highlighting purposes. Instantiate it through the static methods only. Should directly overlay the screen of the referenced controls. More...

Inheritance diagram for Sandbox.Game.Screens.MyGuiScreenHighlight:
Sandbox.Graphics.GUI.MyGuiScreenBase Sandbox.Graphics.GUI.IMyGuiControlsParent Sandbox.Graphics.GUI.IMyGuiControlsOwner

Classes

struct  MyHighlightControl
 

Public Member Functions

override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
override int GetTransitionOpeningTime ()
 
override int GetTransitionClosingTime ()
 
override void HandleInput (bool receivedFocusInThisUpdate)
 
override void HandleUnhandledInput (bool receivedFocusInThisUpdate)
 
override bool Draw ()
 
override bool CloseScreen ()
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
delegate void ScreenHandler (MyGuiScreenBase source)
 
MyObjectBuilder_GuiScreen GetObjectBuilder ()
 
void Init (MyObjectBuilder_GuiScreen objectBuilder)
 
virtual void LoadContent ()
 
virtual void LoadData ()
 
virtual void UnloadContent ()
 
virtual void UnloadData ()
 
virtual void RunLoadingAction ()
 
bool IsMouseOverAnyControl ()
 
MyGuiControlBase GetMouseOverControl ()
 
virtual void GetControlsUnderMouseCursor (Vector2 position, List< MyGuiControlBase > controls, bool visibleOnly)
 
MyGuiControlBase GetNextFocusControl (MyGuiControlBase currentFocusControl, bool forwardMovement)
 
virtual void InputLost ()
 
virtual bool HandleInputAfterSimulation ()
 
virtual bool HideScreen ()
 
virtual bool UnhideScreen ()
 
virtual void CloseScreenNow ()
 
virtual bool Update (bool hasFocus)
 
void HideTooltips ()
 
Vector2 GetPositionAbsolute ()
 
Vector2 GetPositionAbsoluteCenter ()
 
Vector2 GetPositionAbsoluteTopLeft ()
 
bool GetDrawMouseCursor ()
 
bool IsTopMostScreen ()
 
bool IsAlwaysFirst ()
 
bool IsTopScreen ()
 
bool IsFirstForUnload ()
 
bool GetDrawScreenEvenWithoutFocus ()
 
Vector2 GetPosition ()
 
Vector2 GetSize ()
 
bool CanShareInput ()
 
bool CanCloseInCloseAllScreenCalls ()
 
virtual void RecreateControls (bool constructor)
 
virtual void OnRemoved ()
 Called when [show]. More...
 

Static Public Member Functions

static void HighlightControls (MyHighlightControl[] controlsData)
 Use this method to highlight the set of provided controls and their tooltips. More...
 
static void HighlightControl (MyHighlightControl control)
 This this method to highlight a single control and its tooltip. More...
 

Properties

override MyGuiControls Controls [get]
 
- Properties inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Color BackgroundFadeColor [get]
 
bool SkipTransition [get, set]
 
bool Cancelled [get]
 
bool DrawMouseCursor [get, set]
 
bool JoystickAsMouse [get, set]
 
MyGuiScreenState State [get, set]
 
bool IsLoaded [get, set]
 
bool EnabledBackgroundFade [get, protected set]
 Draw fade rectangle under top-most screen? More...
 
bool CanBeHidden [get, protected set]
 Indicates whether screen can be hidden when another screen is on top of it (assuming that screen hides screens below it). More...
 
bool CanHideOthers [get, protected set]
 Indicates whether screen can hide screens below it. This will not hide screens that cannot be hidden. More...
 
bool CanHaveFocus [get, protected set]
 Without focus, this screen will not steal input. More...
 
virtual MyGuiControls Controls [get]
 
Vector4 BackgroundColor [get, set]
 
Vector2 Size [get, set]
 
bool Visible [get]
 
Vector2 CloseButtonOffset [get, set]
 
bool CloseButtonEnabled [get, set]
 
MyGuiControlBase FocusedControl [get, set]
 
string DebugNamePath [get]
 
string Name [get]
 
IMyGuiControlsOwner Owner [get]
 
- Properties inherited from Sandbox.Graphics.GUI.IMyGuiControlsParent
MyGuiControls Controls [get]
 
- Properties inherited from Sandbox.Graphics.GUI.IMyGuiControlsOwner
string DebugNamePath [get]
 
string Name [get]
 
IMyGuiControlsOwner Owner [get]
 

Additional Inherited Members

- Public Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Action OnLoadingAction
 
readonly MyGuiControls Elements
 
- Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
 MyGuiScreenBase (Vector2?position=null, Vector4?backgroundColor=null, Vector2?size=null, bool isTopMostScreen=false, string backgroundTexture=null, float backgroundTransition=0.0f, float guiTransition=0.0f)
 
bool HandleKeyboardActiveIndex (bool forwardMovement)
 
bool IsMouseOver ()
 
MyGuiControlLabel AddCaption (MyStringId textEnum, Vector4?captionTextColor=null, Vector2?captionOffset=null, float captionScale=MyGuiConstants.DEFAULT_TEXT_SCALE)
 
MyGuiControlLabel AddCaption (String text, Vector4?captionTextColor=null, Vector2?captionOffset=null, float captionScale=MyGuiConstants.DEFAULT_TEXT_SCALE)
 
virtual void Canceling ()
 Called when user presses ESC or clicks on CANCEL - hook to this method so you can do gui-screen-specific event More...
 
Color ApplyTransitionAlpha (Vector4 color, float transition)
 
virtual void OnShow ()
 Called when [show]. More...
 
virtual void OnHide ()
 Called when [show]. More...
 
virtual void OnClosed ()
 Called when [show]. More...
 
void MakeXAndYEqual (ref Vector2 val)
 Computes ratio of width and height in GUI coordinates to make X and Y of equal value represent same distance on screen as well. Then multiplies Y using this ratio. More...
 
Vector2 MakeXAndYEqual (Vector2 val)
 
void SetDefaultCloseButtonOffset ()
 
- Static Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
static string MakeScreenFilepath (string name)
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Action OnEnterCallback
 
float m_transitionAlpha
 
float m_backgroundTransition
 
float m_guiTransition
 
Vector2 m_position
 
Color m_backgroundFadeColor
 
bool m_isTopMostScreen = false
 
bool m_isAlwaysFirst = false
 
bool m_isTopScreen = false
 
bool m_isFirstForUnload = false
 
Vector4 m_backgroundColor
 
string m_backgroundTexture
 
bool m_canCloseInCloseAllScreenCalls = true
 
Vector2 m_size
 
bool m_closeOnEsc = true
 
bool m_joystickAsMouse = true
 
bool m_defaultJoystickDpadUse = true
 
bool m_defaultJoystickCancelUse = true
 
bool m_drawEvenWithoutFocus = false
 
bool m_canShareInput = false
 
bool m_allowUnhidePreviousScreen
 
GuiSounds m_openingCueEnum
 
GuiSounds m_closingCueEnum
 
MyGuiControlGridDragAndDrop m_gridDragAndDropHandlingNow
 
MyGuiControlBase m_comboboxHandlingNow
 
MyGuiControlBase m_lastHandlingControl
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
ScreenHandler Closed
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiScreenBaseDataLoading
 
Action< MyGuiScreenBaseDataUnloading
 

Detailed Description

This screen serves the highlighting purposes. Instantiate it through the static methods only. Should directly overlay the screen of the referenced controls.

Definition at line 13 of file MyGuiScreenHighlight.cs.

Member Function Documentation

override bool Sandbox.Game.Screens.MyGuiScreenHighlight.CloseScreen ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 232 of file MyGuiScreenHighlight.cs.

override bool Sandbox.Game.Screens.MyGuiScreenHighlight.Draw ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 143 of file MyGuiScreenHighlight.cs.

override string Sandbox.Game.Screens.MyGuiScreenHighlight.GetFriendlyName ( )
inlinevirtual

For displaying in the list in the debug screen.

Returns

Implements Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 34 of file MyGuiScreenHighlight.cs.

override int Sandbox.Game.Screens.MyGuiScreenHighlight.GetTransitionClosingTime ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 44 of file MyGuiScreenHighlight.cs.

override int Sandbox.Game.Screens.MyGuiScreenHighlight.GetTransitionOpeningTime ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 39 of file MyGuiScreenHighlight.cs.

override void Sandbox.Game.Screens.MyGuiScreenHighlight.HandleInput ( bool  receivedFocusInThisUpdate)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 104 of file MyGuiScreenHighlight.cs.

override void Sandbox.Game.Screens.MyGuiScreenHighlight.HandleUnhandledInput ( bool  receivedFocusInThisUpdate)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 137 of file MyGuiScreenHighlight.cs.

static void Sandbox.Game.Screens.MyGuiScreenHighlight.HighlightControl ( MyHighlightControl  control)
inlinestatic

This this method to highlight a single control and its tooltip.

Parameters
controlControl to be highlighted.
colorColor of the highlight.

Definition at line 65 of file MyGuiScreenHighlight.cs.

static void Sandbox.Game.Screens.MyGuiScreenHighlight.HighlightControls ( MyHighlightControl[]  controlsData)
inlinestatic

Use this method to highlight the set of provided controls and their tooltips.

Parameters
controlsArray of controls to be highlighted.
colorColor of the highlight.

Definition at line 54 of file MyGuiScreenHighlight.cs.

Property Documentation

override MyGuiControls Sandbox.Game.Screens.MyGuiScreenHighlight.Controls
get

Definition at line 100 of file MyGuiScreenHighlight.cs.


The documentation for this class was generated from the following file: