Space Engineers
Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | Events | List of all members
Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner Class Reference

Composite control for inventory. Not a general-use control so don't use it for anything but inventories. Also not meant for editor or serialization. More...

Inheritance diagram for Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner:
Sandbox.Graphics.GUI.MyGuiControlBase Sandbox.Graphics.GUI.IMyGuiControlsOwner

Public Member Functions

 MyGuiControlInventoryOwner (MyEntity owner, Vector4 labelColorMask)
 
override void OnRemoving ()
 Removes various references and clears event handlers. More...
 
override MyGuiControlBase HandleInput ()
 Method returns true if input was captured by control, so no other controls, nor screen can use input in this update. More...
 
override void Update ()
 
void RefreshOwnerInventory ()
 
void RemoveInventoryEvents ()
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
virtual void Init (MyObjectBuilder_GuiControlBase builder)
 
virtual MyObjectBuilder_GuiControlBase GetObjectBuilder ()
 
virtual void Draw (float transitionAlpha, float backgroundTransitionAlpha)
 
virtual MyGuiControlGridDragAndDrop GetDragAndDropHandlingNow ()
 
virtual MyGuiControlBase GetExclusiveInputHandler ()
 
virtual MyGuiControlBase GetMouseOverControl ()
 Returns first control, which has mouse over. More...
 
virtual void HideToolTip ()
 
virtual bool IsMouseOverAnyControl ()
 
virtual void ShowToolTip ()
 
virtual bool CheckMouseOver ()
 Checks if mouse cursor is over control. GR: Update: Also check if mouse over parent controls. Slower but more solid implementation (and we get rid of a few bugs). Also there is no need for HandleMouse variable (removed) More...
 
virtual string GetMouseCursorTexture ()
 
Vector2 GetPositionAbsolute ()
 
Vector2 GetPositionAbsoluteBottomLeft ()
 
Vector2 GetPositionAbsoluteBottomRight ()
 
Vector2 GetPositionAbsoluteCenterLeft ()
 
Vector2 GetPositionAbsoluteCenter ()
 
Vector2 GetPositionAbsoluteTopLeft ()
 
Vector2 GetPositionAbsoluteTopRight ()
 
Vector2 GetSize ()
 
void SetToolTip (MyToolTips toolTip)
 
void SetToolTip (String text)
 
void SetToolTip (MyStringId text)
 
void GetElementsUnderCursor (Vector2 position, bool visibleOnly, List< MyGuiControlBase > controls)
 
virtual MyGuiControlBase GetNextFocusControl (MyGuiControlBase currentFocusControl, bool forwardMovement)
 
virtual void Clear ()
 
override string ToString ()
 

Static Public Member Functions

static void FormatItemAmount (MyPhysicalInventoryItem item, StringBuilder text)
 
static void FormatItemAmount (Type typeId, double amount, StringBuilder text)
 
static MyGuiControlGrid.Item CreateInventoryGridItem (MyPhysicalInventoryItem item)
 
- Static Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
static void ReadIfHasValue< T > (ref T target, T?source)
 
static void ReadIfHasValue (ref Color target, Vector4?source)
 
static MyGuiControlBase GetExclusiveInputHandler (MyGuiControls controls)
 
static Color ApplyColorMaskModifiers (Vector4 sourceColorMask, bool enabled, float transitionAlpha)
 Modifies source color mask using transition alpha and color multiplier in case a control is disabled. More...
 
static bool CheckMouseOver (Vector2 size, Vector2 position, MyGuiDrawAlignEnum originAlign)
 
static bool IsPointInside (Vector2 queryPoint, Vector2 size, Vector2 position, MyGuiDrawAlignEnum originAlign)
 

Protected Member Functions

override void OnSizeChanged ()
 
override void OnEnabledChanged ()
 
- Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
 MyGuiControlBase (Vector2?position=null, Vector2?size=null, Vector4?colorMask=null, String toolTip=null, MyGuiCompositeTexture backgroundTexture=null, bool isActiveControl=true, bool canHaveFocus=false, bool allowFocusingElements=false, MyGuiControlHighlightType highlightType=MyGuiControlHighlightType.WHEN_ACTIVE, MyGuiDrawAlignEnum originAlign=MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER)
 
void DrawBackground (float transitionAlpha)
 
void DrawBorder (float transitionAlpha)
 
virtual bool ShouldHaveHighlight ()
 
virtual void OnHasHighlightChanged ()
 
virtual void OnPositionChanged ()
 
virtual void OnVisibleChanged ()
 
virtual void OnOriginAlignChanged ()
 
virtual void OnColorMaskChanged ()
 
MyGuiScreenBase GetTopMostOwnerScreen ()
 
bool IsMouseOverOrKeyboardActive ()
 
virtual void DrawElements (float transitionAlpha, float backgroundTransitionAlpha)
 
MyGuiControlBase HandleInputElements ()
 
virtual void ClearEvents ()
 

Properties

MyEntity InventoryOwner [get, set]
 
List< MyGuiControlGridContentGrids [get]
 
- Properties inherited from Sandbox.Graphics.GUI.MyGuiControlBase
float Alpha [get, set]
 
string Name [get, set]
 
IMyGuiControlsOwner Owner [get]
 
MyToolTips Tooltips [get]
 
Vector2 Position [get, set]
 Position of control's center (normalized and relative to parent screen center (not left/top corner!!!)) More...
 
float PositionY [get, set]
 
float PositionX [get, set]
 
Vector2 Size [get, set]
 Size of control (normalized). More...
 
Vector2 MinSize [get, protected set]
 
Vector2 MaxSize [get, protected set]
 
Vector4 ColorMask [get, set]
 
int BorderSize [get, set]
 
bool Enabled [get, set]
 False to disable control, disabled controls are skipped when switching with Tab key etc., look implemented atm. only in MyGuiControlButton. More...
 
MyGuiDrawAlignEnum OriginAlign [get, set]
 
bool Visible [get, set]
 Says whether control is visible. Note that this is not a constant time operation (checks parents, fires events on set). More...
 
bool HasHighlight [get]
 Says whether control is currently highlighted. When control is highlit depends on HighlightType. More...
 
bool HasFocus [get]
 
bool IsMouseOver [get, set]
 
bool CanHaveFocus [get, set]
 
bool AllowFocusingElements [get, set]
 Indicates whether elements can have focus or not. More...
 
object UserData [get, set]
 Specific user data for this control. More...
 
string DebugNamePath [get]
 
- Properties inherited from Sandbox.Graphics.GUI.IMyGuiControlsOwner
string DebugNamePath [get]
 
string Name [get]
 
IMyGuiControlsOwner Owner [get]
 

Events

Action< MyGuiControlInventoryOwnerInventoryContentsChanged
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiControlBase
Action< MyGuiControlBase, NameChangedArgsNameChanged
 
Action< MyGuiControlBaseSizeChanged
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiControlBase, bool > FocusChanged
 Called when the control enters or leaves focus. More...
 

Additional Inherited Members

- Public Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlBase
readonly MyGuiControls Elements
 
MyGuiCompositeTexture BackgroundTexture
 
Vector4 BorderColor
 
bool BorderEnabled
 
bool DrawWhilePaused
 
bool ShowTooltipWhenDisabled
 
bool IsActiveControl
 There are some controls, that cannot receive any handle input(control panel for example), thus disable them with this. More...
 
MyGuiControlHighlightType HighlightType
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlBase
bool m_mouseButtonPressed = false
 
bool m_showToolTip = false
 
Vector2 m_toolTipPosition
 

Detailed Description

Composite control for inventory. Not a general-use control so don't use it for anything but inventories. Also not meant for editor or serialization.

Definition at line 36 of file MyGuiControlInventoryOwner.cs.

Constructor & Destructor Documentation

Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.MyGuiControlInventoryOwner ( MyEntity  owner,
Vector4  labelColorMask 
)
inline

Definition at line 64 of file MyGuiControlInventoryOwner.cs.

Member Function Documentation

static MyGuiControlGrid.Item Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.CreateInventoryGridItem ( MyPhysicalInventoryItem  item)
inlinestatic

Definition at line 432 of file MyGuiControlInventoryOwner.cs.

static void Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.FormatItemAmount ( MyPhysicalInventoryItem  item,
StringBuilder  text 
)
inlinestatic

Definition at line 376 of file MyGuiControlInventoryOwner.cs.

static void Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.FormatItemAmount ( Type  typeId,
double  amount,
StringBuilder  text 
)
inlinestatic

Definition at line 385 of file MyGuiControlInventoryOwner.cs.

override MyGuiControlBase Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.HandleInput ( )
inlinevirtual

Method returns true if input was captured by control, so no other controls, nor screen can use input in this update.

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 137 of file MyGuiControlInventoryOwner.cs.

override void Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.OnEnabledChanged ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 131 of file MyGuiControlInventoryOwner.cs.

override void Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.OnRemoving ( )
inlinevirtual

Removes various references and clears event handlers.

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 113 of file MyGuiControlInventoryOwner.cs.

override void Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.OnSizeChanged ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 124 of file MyGuiControlInventoryOwner.cs.

void Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.RefreshOwnerInventory ( )
inline

Definition at line 462 of file MyGuiControlInventoryOwner.cs.

void Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.RemoveInventoryEvents ( )
inline

Definition at line 474 of file MyGuiControlInventoryOwner.cs.

override void Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.Update ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 148 of file MyGuiControlInventoryOwner.cs.

Property Documentation

List<MyGuiControlGrid> Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.ContentGrids
get

Definition at line 58 of file MyGuiControlInventoryOwner.cs.

MyEntity Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.InventoryOwner
getset

Definition at line 48 of file MyGuiControlInventoryOwner.cs.

Event Documentation

Action<MyGuiControlInventoryOwner> Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner.InventoryContentsChanged

Definition at line 62 of file MyGuiControlInventoryOwner.cs.


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