Space Engineers
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | Events | List of all members
Sandbox.Graphics.GUI.MyGuiControlBase Class Reference
Inheritance diagram for Sandbox.Graphics.GUI.MyGuiControlBase:
Sandbox.Graphics.GUI.IMyGuiControlsOwner Sandbox.Game.Screens.Helpers.MyGuiControlComponentList Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner Sandbox.Game.Screens.Helpers.MyGuiControlNews Sandbox.Game.Screens.Helpers.MyGuiControlOnOffSwitch Sandbox.Game.Screens.Helpers.MyGuiControlStats Sandbox.Game.Screens.Helpers.MyGuiControlStats.MyGuiControlStat Sandbox.Game.Screens.Helpers.MyGuiControlToolbar Sandbox.Game.Screens.Helpers.MyGuiControlVoxelHandSettings Sandbox.Game.Screens.MyGuiControlQuestlog Sandbox.Graphics.GUI.MyGuiControlBlockInfo Sandbox.Graphics.GUI.MyGuiControlBlockProperty Sandbox.Graphics.GUI.MyGuiControlButton Sandbox.Graphics.GUI.MyGuiControlCheckbox Sandbox.Graphics.GUI.MyGuiControlColor Sandbox.Graphics.GUI.MyGuiControlCombobox Sandbox.Graphics.GUI.MyGuiControlContextMenu Sandbox.Graphics.GUI.MyGuiControlGenericFunctionalBlock Sandbox.Graphics.GUI.MyGuiControlGrid Sandbox.Graphics.GUI.MyGuiControlGridDragAndDrop Sandbox.Graphics.GUI.MyGuiControlImage Sandbox.Graphics.GUI.MyGuiControlLabel Sandbox.Graphics.GUI.MyGuiControlListbox Sandbox.Graphics.GUI.MyGuiControlMultilineText Sandbox.Graphics.GUI.MyGuiControlPanel Sandbox.Graphics.GUI.MyGuiControlParent Sandbox.Graphics.GUI.MyGuiControlProgressBar Sandbox.Graphics.GUI.MyGuiControlRadioButton Sandbox.Graphics.GUI.MyGuiControlRotatingWheel Sandbox.Graphics.GUI.MyGuiControlScrollablePanel Sandbox.Graphics.GUI.MyGuiControlSeparatorList Sandbox.Graphics.GUI.MyGuiControlSliderBase Sandbox.Graphics.GUI.MyGuiControlTable Sandbox.Graphics.GUI.MyGuiControlTextbox Sandbox.Graphics.GUI.MyGuiControlTreeView Sandbox.Graphics.GUI.MyTreeViewItemDragAndDrop Sandbox.Gui.MyGuiControlImageButton Sandbox.Gui.MyGuiControlProgressBarHud

Classes

class  Friend
 
struct  NameChangedArgs
 

Public Member Functions

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 MyGuiControlBase HandleInput ()
 Method returns true if input was captured by control, so no other controls, nor screen can use input in this update. More...
 
virtual void HideToolTip ()
 
virtual bool IsMouseOverAnyControl ()
 
virtual void ShowToolTip ()
 
virtual void Update ()
 
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)
 
virtual void OnRemoving ()
 Removes various references and clears event handlers. More...
 
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 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)
 

Public Attributes

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 Member Functions

 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 OnSizeChanged ()
 
virtual void OnVisibleChanged ()
 
virtual void OnOriginAlignChanged ()
 
virtual void OnEnabledChanged ()
 
virtual void OnColorMaskChanged ()
 
MyGuiScreenBase GetTopMostOwnerScreen ()
 
bool IsMouseOverOrKeyboardActive ()
 
virtual void DrawElements (float transitionAlpha, float backgroundTransitionAlpha)
 
MyGuiControlBase HandleInputElements ()
 
virtual void ClearEvents ()
 

Protected Attributes

bool m_mouseButtonPressed = false
 
bool m_showToolTip = false
 
Vector2 m_toolTipPosition
 

Properties

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< MyGuiControlBase, NameChangedArgsNameChanged
 
Action< MyGuiControlBaseSizeChanged
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiControlBase, bool > FocusChanged
 Called when the control enters or leaves focus. More...
 

Detailed Description

Definition at line 217 of file MyGuiControlBase.cs.

Constructor & Destructor Documentation

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 
)
inlineprotected

Definition at line 542 of file MyGuiControlBase.cs.

Member Function Documentation

static Color Sandbox.Graphics.GUI.MyGuiControlBase.ApplyColorMaskModifiers ( Vector4  sourceColorMask,
bool  enabled,
float  transitionAlpha 
)
inlinestatic

Modifies source color mask using transition alpha and color multiplier in case a control is disabled.

Parameters
sourceColorMaskOriginal color mask of the control.
enabledIndicates whether disabled color mask should be applied.
transitionAlphaAlpha value modified during transition.
Returns

Definition at line 823 of file MyGuiControlBase.cs.

virtual bool Sandbox.Graphics.GUI.MyGuiControlBase.CheckMouseOver ( )
inlinevirtual

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)

Reimplemented in Sandbox.Graphics.GUI.MyGuiControlCombobox, Sandbox.Graphics.GUI.MyTreeViewItemDragAndDrop, and Sandbox.Graphics.GUI.MyGuiControlGridDragAndDrop.

Definition at line 757 of file MyGuiControlBase.cs.

static bool Sandbox.Graphics.GUI.MyGuiControlBase.CheckMouseOver ( Vector2  size,
Vector2  position,
MyGuiDrawAlignEnum  originAlign 
)
inlinestatic

Definition at line 915 of file MyGuiControlBase.cs.

virtual void Sandbox.Graphics.GUI.MyGuiControlBase.Clear ( )
inlinevirtual
virtual void Sandbox.Graphics.GUI.MyGuiControlBase.ClearEvents ( )
inlineprotectedvirtual

Definition at line 996 of file MyGuiControlBase.cs.

virtual void Sandbox.Graphics.GUI.MyGuiControlBase.Draw ( float  transitionAlpha,
float  backgroundTransitionAlpha 
)
inlinevirtual

Reimplemented in Sandbox.Graphics.GUI.MyGuiControlCombobox, Sandbox.Graphics.GUI.MyGuiControlGrid, Sandbox.Graphics.GUI.MyGuiControlTable, Sandbox.Graphics.GUI.MyGuiControlBlockInfo, Sandbox.Graphics.GUI.MyGuiControlListbox, Sandbox.Graphics.GUI.MyGuiControlButton, Sandbox.Graphics.GUI.MyGuiControlRadioButton, Sandbox.Graphics.GUI.MyGuiControlMultilineText, Sandbox.Graphics.GUI.MyGuiControlSliderBase, Sandbox.Game.Screens.Helpers.MyGuiControlStats, Sandbox.Graphics.GUI.MyGuiControlTextbox, Sandbox.Graphics.GUI.MyGuiControlContextMenu, Sandbox.Gui.MyGuiControlImageButton, Sandbox.Graphics.GUI.MyGuiControlScrollablePanel, Sandbox.Graphics.GUI.MyGuiControlLabel, Sandbox.Graphics.GUI.MyGuiControlTabControl, Sandbox.Graphics.GUI.MyGuiControlCheckbox, Sandbox.Graphics.GUI.MyGuiControlColor, Sandbox.Game.Screens.Helpers.MyGuiControlStats.MyGuiControlStat, Sandbox.Graphics.GUI.MyGuiControlList, Sandbox.Game.Screens.Helpers.MyGuiControlToolbar, Sandbox.Graphics.GUI.MyGuiControlGridDragAndDrop, Sandbox.Graphics.GUI.MyGuiControlBlockProperty, Sandbox.Game.Screens.MyGuiControlQuestlog, Sandbox.Graphics.GUI.MyGuiControlProgressBar, Sandbox.Graphics.GUI.MyGuiControlImage, Sandbox.Graphics.GUI.MyGuiControlSeparatorList, Sandbox.Graphics.GUI.MyGuiControlParent, Sandbox.Graphics.GUI.MyTreeViewItemDragAndDrop, Sandbox.Graphics.GUI.MyGuiControlTreeView, Sandbox.Graphics.GUI.MyGuiControlRotatingWheel, Sandbox.Graphics.GUI.MyGuiControlCountdownWheel, Sandbox.Graphics.GUI.MyGuiControlCompositePanel, Sandbox.Game.GUI.HudViewers.MyHudControlChat, Sandbox.Gui.MyGuiControlProgressBarHud, and Sandbox.Graphics.GUI.MyGuiControlLabeledGrid.

Definition at line 617 of file MyGuiControlBase.cs.

void Sandbox.Graphics.GUI.MyGuiControlBase.DrawBackground ( float  transitionAlpha)
inlineprotected

Definition at line 624 of file MyGuiControlBase.cs.

void Sandbox.Graphics.GUI.MyGuiControlBase.DrawBorder ( float  transitionAlpha)
inlineprotected

Definition at line 633 of file MyGuiControlBase.cs.

virtual void Sandbox.Graphics.GUI.MyGuiControlBase.DrawElements ( float  transitionAlpha,
float  backgroundTransitionAlpha 
)
inlineprotectedvirtual

Reimplemented in Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.

Definition at line 970 of file MyGuiControlBase.cs.

virtual MyGuiControlGridDragAndDrop Sandbox.Graphics.GUI.MyGuiControlBase.GetDragAndDropHandlingNow ( )
inlinevirtual
void Sandbox.Graphics.GUI.MyGuiControlBase.GetElementsUnderCursor ( Vector2  position,
bool  visibleOnly,
List< MyGuiControlBase controls 
)
inline

Definition at line 1019 of file MyGuiControlBase.cs.

virtual MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlBase.GetExclusiveInputHandler ( )
inlinevirtual
static MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlBase.GetExclusiveInputHandler ( MyGuiControls  controls)
inlinestatic

Definition at line 652 of file MyGuiControlBase.cs.

virtual string Sandbox.Graphics.GUI.MyGuiControlBase.GetMouseCursorTexture ( )
inlinevirtual
virtual MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlBase.GetMouseOverControl ( )
inlinevirtual

Returns first control, which has mouse over.

Reimplemented in Sandbox.Graphics.GUI.MyGuiControlParent.

Definition at line 667 of file MyGuiControlBase.cs.

virtual MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlBase.GetNextFocusControl ( MyGuiControlBase  currentFocusControl,
bool  forwardMovement 
)
inlinevirtual
virtual MyObjectBuilder_GuiControlBase Sandbox.Graphics.GUI.MyGuiControlBase.GetObjectBuilder ( )
inlinevirtual
Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.GetPositionAbsolute ( )
inline

Implements Sandbox.Graphics.GUI.IMyGuiControlsOwner.

Definition at line 857 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.GetPositionAbsoluteBottomLeft ( )
inline

Definition at line 865 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.GetPositionAbsoluteBottomRight ( )
inline

Definition at line 870 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.GetPositionAbsoluteCenter ( )
inline

Implements Sandbox.Graphics.GUI.IMyGuiControlsOwner.

Definition at line 880 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.GetPositionAbsoluteCenterLeft ( )
inline

Definition at line 875 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.GetPositionAbsoluteTopLeft ( )
inline

Implements Sandbox.Graphics.GUI.IMyGuiControlsOwner.

Definition at line 885 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.GetPositionAbsoluteTopRight ( )
inline

Definition at line 890 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.GetSize ( )
inline

Implements Sandbox.Graphics.GUI.IMyGuiControlsOwner.

Definition at line 895 of file MyGuiControlBase.cs.

MyGuiScreenBase Sandbox.Graphics.GUI.MyGuiControlBase.GetTopMostOwnerScreen ( )
inlineprotected

Definition at line 930 of file MyGuiControlBase.cs.

virtual MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlBase.HandleInput ( )
inlinevirtual

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

Reimplemented in Sandbox.Graphics.GUI.MyGuiControlGrid, Sandbox.Graphics.GUI.MyGuiControlCombobox, Sandbox.Graphics.GUI.MyGuiControlTable, Sandbox.Graphics.GUI.MyGuiControlMultilineText, Sandbox.Graphics.GUI.MyGuiControlTextbox, Sandbox.Graphics.GUI.MyGuiControlListbox, Sandbox.Graphics.GUI.MyGuiControlGenericFunctionalBlock, Sandbox.Graphics.GUI.MyGuiControlRadioButton, Sandbox.Graphics.GUI.MyGuiControlButton, Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser, Sandbox.Graphics.GUI.MyGuiControlSliderBase, Sandbox.Graphics.GUI.MyGuiControlTabControl, Sandbox.Game.Screens.Helpers.MyGuiControlNews, Sandbox.Gui.MyGuiControlImageButton, Sandbox.Graphics.GUI.MyGuiControlCheckbox, Sandbox.Graphics.GUI.MyGuiControlColor, Sandbox.Graphics.GUI.MyGuiControlScrollablePanel, Sandbox.Graphics.GUI.MyGuiControlList, Sandbox.Graphics.GUI.MyGuiControlContextMenu, Sandbox.Game.Screens.Helpers.MyGuiControlInventoryOwner, Sandbox.Graphics.GUI.MyGuiControlGridDragAndDrop, Sandbox.Game.Screens.Helpers.MyGuiControlOnOffSwitch, Sandbox.Graphics.GUI.MyGuiControlBlockProperty, Sandbox.Game.Screens.Helpers.MyGuiControlToolbar, Sandbox.Graphics.GUI.MyGuiControlParent, Sandbox.Graphics.GUI.MyTreeViewItemDragAndDrop, Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText, Sandbox.Graphics.GUI.MyGuiControlTreeView, and Sandbox.Game.Screens.Helpers.MyGuiControlVoxelHandSettings.

Definition at line 677 of file MyGuiControlBase.cs.

MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlBase.HandleInputElements ( )
inlineprotected

Definition at line 981 of file MyGuiControlBase.cs.

virtual void Sandbox.Graphics.GUI.MyGuiControlBase.HideToolTip ( )
inlinevirtual

Reimplemented in Sandbox.Graphics.GUI.MyGuiControlParent.

Definition at line 708 of file MyGuiControlBase.cs.

virtual void Sandbox.Graphics.GUI.MyGuiControlBase.Init ( MyObjectBuilder_GuiControlBase  builder)
inlinevirtual
virtual bool Sandbox.Graphics.GUI.MyGuiControlBase.IsMouseOverAnyControl ( )
inlinevirtual

Reimplemented in Sandbox.Graphics.GUI.MyGuiControlParent.

Definition at line 713 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.IsMouseOverOrKeyboardActive ( )
inlineprotected

Definition at line 948 of file MyGuiControlBase.cs.

static bool Sandbox.Graphics.GUI.MyGuiControlBase.IsPointInside ( Vector2  queryPoint,
Vector2  size,
Vector2  position,
MyGuiDrawAlignEnum  originAlign 
)
inlinestatic

Definition at line 920 of file MyGuiControlBase.cs.

virtual void Sandbox.Graphics.GUI.MyGuiControlBase.OnColorMaskChanged ( )
inlineprotectedvirtual

Definition at line 803 of file MyGuiControlBase.cs.

virtual void Sandbox.Graphics.GUI.MyGuiControlBase.OnEnabledChanged ( )
inlineprotectedvirtual
virtual void Sandbox.Graphics.GUI.MyGuiControlBase.OnHasHighlightChanged ( )
inlineprotectedvirtual
virtual void Sandbox.Graphics.GUI.MyGuiControlBase.OnOriginAlignChanged ( )
inlineprotectedvirtual
virtual void Sandbox.Graphics.GUI.MyGuiControlBase.OnPositionChanged ( )
inlineprotectedvirtual
virtual void Sandbox.Graphics.GUI.MyGuiControlBase.OnRemoving ( )
inlinevirtual
virtual void Sandbox.Graphics.GUI.MyGuiControlBase.OnSizeChanged ( )
inlineprotectedvirtual
virtual void Sandbox.Graphics.GUI.MyGuiControlBase.OnVisibleChanged ( )
inlineprotectedvirtual
static void Sandbox.Graphics.GUI.MyGuiControlBase.ReadIfHasValue ( ref Color  target,
Vector4 source 
)
inlinestatic

Definition at line 608 of file MyGuiControlBase.cs.

static void Sandbox.Graphics.GUI.MyGuiControlBase.ReadIfHasValue< T > ( ref T  target,
T?  source 
)
inlinestatic
Type Constraints
T :struct 

Definition at line 602 of file MyGuiControlBase.cs.

void Sandbox.Graphics.GUI.MyGuiControlBase.SetToolTip ( MyToolTips  toolTip)
inline

Definition at line 900 of file MyGuiControlBase.cs.

void Sandbox.Graphics.GUI.MyGuiControlBase.SetToolTip ( String  text)
inline

Definition at line 905 of file MyGuiControlBase.cs.

void Sandbox.Graphics.GUI.MyGuiControlBase.SetToolTip ( MyStringId  text)
inline

Definition at line 910 of file MyGuiControlBase.cs.

virtual bool Sandbox.Graphics.GUI.MyGuiControlBase.ShouldHaveHighlight ( )
inlineprotectedvirtual
virtual void Sandbox.Graphics.GUI.MyGuiControlBase.ShowToolTip ( )
inlinevirtual
override string Sandbox.Graphics.GUI.MyGuiControlBase.ToString ( )
inline

Definition at line 1081 of file MyGuiControlBase.cs.

virtual void Sandbox.Graphics.GUI.MyGuiControlBase.Update ( )
inlinevirtual

Member Data Documentation

MyGuiCompositeTexture Sandbox.Graphics.GUI.MyGuiControlBase.BackgroundTexture

Definition at line 404 of file MyGuiControlBase.cs.

Vector4 Sandbox.Graphics.GUI.MyGuiControlBase.BorderColor

Definition at line 406 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.BorderEnabled

Definition at line 414 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.DrawWhilePaused

Definition at line 416 of file MyGuiControlBase.cs.

readonly MyGuiControls Sandbox.Graphics.GUI.MyGuiControlBase.Elements

Definition at line 296 of file MyGuiControlBase.cs.

MyGuiControlHighlightType Sandbox.Graphics.GUI.MyGuiControlBase.HighlightType

Definition at line 474 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.IsActiveControl

There are some controls, that cannot receive any handle input(control panel for example), thus disable them with this.

Definition at line 440 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.m_mouseButtonPressed = false
protected

Definition at line 259 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.m_showToolTip = false
protected

Definition at line 261 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.m_toolTipPosition
protected

Definition at line 265 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.ShowTooltipWhenDisabled

Definition at line 435 of file MyGuiControlBase.cs.

Property Documentation

bool Sandbox.Graphics.GUI.MyGuiControlBase.AllowFocusingElements
getsetprotected

Indicates whether elements can have focus or not.

Definition at line 514 of file MyGuiControlBase.cs.

float Sandbox.Graphics.GUI.MyGuiControlBase.Alpha
getset

Definition at line 234 of file MyGuiControlBase.cs.

int Sandbox.Graphics.GUI.MyGuiControlBase.BorderSize
getset

Definition at line 409 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.CanHaveFocus
getset

Definition at line 505 of file MyGuiControlBase.cs.

Vector4 Sandbox.Graphics.GUI.MyGuiControlBase.ColorMask
getset

Definition at line 392 of file MyGuiControlBase.cs.

string Sandbox.Graphics.GUI.MyGuiControlBase.DebugNamePath
get

Definition at line 534 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.Enabled
getset

False to disable control, disabled controls are skipped when switching with Tab key etc., look implemented atm. only in MyGuiControlButton.

Definition at line 422 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.HasFocus
get

Definition at line 494 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.HasHighlight
get

Says whether control is currently highlighted. When control is highlit depends on HighlightType.

Definition at line 480 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.IsMouseOver
getset

Definition at line 499 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.MaxSize
getprotected set

Definition at line 378 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.MinSize
getprotected set

Definition at line 365 of file MyGuiControlBase.cs.

string Sandbox.Graphics.GUI.MyGuiControlBase.Name
getset

Definition at line 269 of file MyGuiControlBase.cs.

MyGuiDrawAlignEnum Sandbox.Graphics.GUI.MyGuiControlBase.OriginAlign
getset

Definition at line 443 of file MyGuiControlBase.cs.

IMyGuiControlsOwner Sandbox.Graphics.GUI.MyGuiControlBase.Owner
get

Definition at line 291 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.Position
getset

Position of control's center (normalized and relative to parent screen center (not left/top corner!!!))

Definition at line 304 of file MyGuiControlBase.cs.

float Sandbox.Graphics.GUI.MyGuiControlBase.PositionX
getset

Definition at line 330 of file MyGuiControlBase.cs.

float Sandbox.Graphics.GUI.MyGuiControlBase.PositionY
getset

Definition at line 317 of file MyGuiControlBase.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlBase.Size
getset

Size of control (normalized).

Definition at line 348 of file MyGuiControlBase.cs.

MyToolTips Sandbox.Graphics.GUI.MyGuiControlBase.Tooltips
get

Definition at line 298 of file MyGuiControlBase.cs.

object Sandbox.Graphics.GUI.MyGuiControlBase.UserData
getset

Specific user data for this control.

Definition at line 528 of file MyGuiControlBase.cs.

bool Sandbox.Graphics.GUI.MyGuiControlBase.Visible
getset

Says whether control is visible. Note that this is not a constant time operation (checks parents, fires events on set).

Definition at line 460 of file MyGuiControlBase.cs.

Event Documentation

Action<MyGuiControlBase, bool> Sandbox.Graphics.GUI.MyGuiControlBase.FocusChanged

Called when the control enters or leaves focus.

Definition at line 522 of file MyGuiControlBase.cs.

Action<MyGuiControlBase, NameChangedArgs> Sandbox.Graphics.GUI.MyGuiControlBase.NameChanged

Definition at line 288 of file MyGuiControlBase.cs.

Action<MyGuiControlBase> Sandbox.Graphics.GUI.MyGuiControlBase.SizeChanged

Definition at line 362 of file MyGuiControlBase.cs.

VisibleChangedDelegate Sandbox.Graphics.GUI.MyGuiControlBase.VisibleChanged

Definition at line 472 of file MyGuiControlBase.cs.


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