Space Engineers
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes | Properties | List of all members
Sandbox.Game.Gui.MyGuiScreenHudBase Class Reference
Inheritance diagram for Sandbox.Game.Gui.MyGuiScreenHudBase:
Sandbox.Graphics.GUI.MyGuiScreenBase Sandbox.Graphics.GUI.IMyGuiControlsParent Sandbox.Graphics.GUI.IMyGuiControlsOwner Sandbox.Game.Gui.MyGuiScreenHudSpace

Public Member Functions

 MyGuiScreenHudBase ()
 
override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
override void LoadContent ()
 
override void UnloadContent ()
 
override bool Update (bool hasFocus)
 
override bool Draw ()
 
MyHudText AllocateText ()
 
void DrawTexts ()
 
MyAtlasTextureCoordinate GetTextureCoord (MyHudTexturesEnum texture)
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
delegate void ScreenHandler (MyGuiScreenBase source)
 
MyObjectBuilder_GuiScreen GetObjectBuilder ()
 
void Init (MyObjectBuilder_GuiScreen objectBuilder)
 
virtual void LoadData ()
 
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 HandleInput (bool receivedFocusInThisUpdate)
 
virtual void InputLost ()
 
virtual void HandleUnhandledInput (bool receivedFocusInThisUpdate)
 
virtual bool HandleInputAfterSimulation ()
 
virtual bool CloseScreen ()
 
virtual bool HideScreen ()
 
virtual bool UnhideScreen ()
 
virtual void CloseScreenNow ()
 
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 int GetTransitionOpeningTime ()
 
virtual int GetTransitionClosingTime ()
 
virtual void OnRemoved ()
 Called when [show]. More...
 

Static Public Member Functions

static void LoadTextureAtlas (out string atlasFile, out MyAtlasTextureCoordinate[] atlasCoords)
 
static Vector2 ConvertHudToNormalizedGuiPosition (ref Vector2 hudPos)
 
static void HandleSelectedObjectHighlight (MyHudSelectedObject selection, MyHudObjectHighlightStyleData?data)
 
static void DrawSelectedObjectHighlightDummy (MyHudSelectedObject selection, string atlasTexture, MyAtlasTextureCoordinate textureCoord)
 
static void DrawSelectionCorner (string atlasTexture, MyHudSelectedObject selection, MyAtlasTextureCoordinate textureCoord, Vector2 scale, Vector2 pos, Vector2 rightVector, float textureScale)
 

Static Protected Member Functions

static Vector2 ConvertNormalizedGuiToHud (ref Vector2 normGuiPos)
 
- Static Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
static string MakeScreenFilepath (string name)
 

Protected Attributes

string m_atlas
 
MyAtlasTextureCoordinate[] m_atlasCoords
 
float m_textScale
 
StringBuilder m_hudIndicatorText = new StringBuilder()
 
StringBuilder m_helperSB = new StringBuilder()
 
MyObjectsPoolSimple< MyHudTextm_texts
 
- 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
 

Properties

string TextureAtlas [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 ()
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
ScreenHandler Closed
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiScreenBaseDataLoading
 
Action< MyGuiScreenBaseDataUnloading
 

Detailed Description

Definition at line 32 of file MyGuiScreenHudBase.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyGuiScreenHudBase.MyGuiScreenHudBase ( )
inline

Definition at line 44 of file MyGuiScreenHudBase.cs.

Member Function Documentation

MyHudText Sandbox.Game.Gui.MyGuiScreenHudBase.AllocateText ( )
inline

Definition at line 290 of file MyGuiScreenHudBase.cs.

static Vector2 Sandbox.Game.Gui.MyGuiScreenHudBase.ConvertHudToNormalizedGuiPosition ( ref Vector2  hudPos)
inlinestatic

Definition at line 78 of file MyGuiScreenHudBase.cs.

static Vector2 Sandbox.Game.Gui.MyGuiScreenHudBase.ConvertNormalizedGuiToHud ( ref Vector2  normGuiPos)
inlinestaticprotected

Definition at line 91 of file MyGuiScreenHudBase.cs.

override bool Sandbox.Game.Gui.MyGuiScreenHudBase.Draw ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Reimplemented in Sandbox.Game.Gui.MyGuiScreenHudSpace.

Definition at line 210 of file MyGuiScreenHudBase.cs.

static void Sandbox.Game.Gui.MyGuiScreenHudBase.DrawSelectedObjectHighlightDummy ( MyHudSelectedObject  selection,
string  atlasTexture,
MyAtlasTextureCoordinate  textureCoord 
)
inlinestatic

Definition at line 231 of file MyGuiScreenHudBase.cs.

static void Sandbox.Game.Gui.MyGuiScreenHudBase.DrawSelectionCorner ( string  atlasTexture,
MyHudSelectedObject  selection,
MyAtlasTextureCoordinate  textureCoord,
Vector2  scale,
Vector2  pos,
Vector2  rightVector,
float  textureScale 
)
inlinestatic

Definition at line 274 of file MyGuiScreenHudBase.cs.

void Sandbox.Game.Gui.MyGuiScreenHudBase.DrawTexts ( )
inline

Definition at line 295 of file MyGuiScreenHudBase.cs.

override string Sandbox.Game.Gui.MyGuiScreenHudBase.GetFriendlyName ( )
inlinevirtual

For displaying in the list in the debug screen.

Returns

Implements Sandbox.Graphics.GUI.MyGuiScreenBase.

Reimplemented in Sandbox.Game.Gui.MyGuiScreenHudSpace.

Definition at line 55 of file MyGuiScreenHudBase.cs.

MyAtlasTextureCoordinate Sandbox.Game.Gui.MyGuiScreenHudBase.GetTextureCoord ( MyHudTexturesEnum  texture)
inline

Definition at line 317 of file MyGuiScreenHudBase.cs.

static void Sandbox.Game.Gui.MyGuiScreenHudBase.HandleSelectedObjectHighlight ( MyHudSelectedObject  selection,
MyHudObjectHighlightStyleData data 
)
inlinestatic

Definition at line 104 of file MyGuiScreenHudBase.cs.

override void Sandbox.Game.Gui.MyGuiScreenHudBase.LoadContent ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 60 of file MyGuiScreenHudBase.cs.

static void Sandbox.Game.Gui.MyGuiScreenHudBase.LoadTextureAtlas ( out string  atlasFile,
out MyAtlasTextureCoordinate[]  atlasCoords 
)
inlinestatic

Definition at line 66 of file MyGuiScreenHudBase.cs.

override void Sandbox.Game.Gui.MyGuiScreenHudBase.UnloadContent ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 71 of file MyGuiScreenHudBase.cs.

override bool Sandbox.Game.Gui.MyGuiScreenHudBase.Update ( bool  hasFocus)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Reimplemented in Sandbox.Game.Gui.MyGuiScreenHudSpace.

Definition at line 198 of file MyGuiScreenHudBase.cs.

Member Data Documentation

string Sandbox.Game.Gui.MyGuiScreenHudBase.m_atlas
protected

Definition at line 34 of file MyGuiScreenHudBase.cs.

MyAtlasTextureCoordinate [] Sandbox.Game.Gui.MyGuiScreenHudBase.m_atlasCoords
protected

Definition at line 37 of file MyGuiScreenHudBase.cs.

StringBuilder Sandbox.Game.Gui.MyGuiScreenHudBase.m_helperSB = new StringBuilder()
protected

Definition at line 40 of file MyGuiScreenHudBase.cs.

StringBuilder Sandbox.Game.Gui.MyGuiScreenHudBase.m_hudIndicatorText = new StringBuilder()
protected

Definition at line 39 of file MyGuiScreenHudBase.cs.

MyObjectsPoolSimple<MyHudText> Sandbox.Game.Gui.MyGuiScreenHudBase.m_texts
protected

Definition at line 42 of file MyGuiScreenHudBase.cs.

float Sandbox.Game.Gui.MyGuiScreenHudBase.m_textScale
protected

Definition at line 38 of file MyGuiScreenHudBase.cs.

Property Documentation

string Sandbox.Game.Gui.MyGuiScreenHudBase.TextureAtlas
get

Definition at line 35 of file MyGuiScreenHudBase.cs.


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