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.MyGuiControlButton Class Reference
Inheritance diagram for Sandbox.Graphics.GUI.MyGuiControlButton:
Sandbox.Graphics.GUI.MyGuiControlBase Sandbox.Graphics.GUI.IMyGuiControlsOwner

Classes

class  StyleDefinition
 

Public Member Functions

 MyGuiControlButton ()
 
 MyGuiControlButton (Vector2?position=null, MyGuiControlButtonStyleEnum visualStyle=MyGuiControlButtonStyleEnum.Default, Vector2?size=null, Vector4?colorMask=null, MyGuiDrawAlignEnum originAlign=MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER, String toolTip=null, StringBuilder text=null, float textScale=MyGuiConstants.DEFAULT_TEXT_SCALE, MyGuiDrawAlignEnum textAlignment=MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER, MyGuiControlHighlightType highlightType=MyGuiControlHighlightType.WHEN_ACTIVE, Action< MyGuiControlButton > onButtonClick=null, GuiSounds cueEnum=GuiSounds.MouseClick, float buttonScale=1.0f, int?buttonIndex=null, bool activateOnMouseRelease=false)
 
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 string GetMouseCursorTexture ()
 
override void Draw (float transitionAlpha, float backgroundTransitionAlpha)
 
override MyObjectBuilder_GuiControlBase GetObjectBuilder ()
 
override void Init (MyObjectBuilder_GuiControlBase objectBuilder)
 
void SetCustomStyle (StyleDefinition buttonStyle)
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
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 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...
 
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 StyleDefinition GetVisualStyle (MyGuiControlButtonStyleEnum style)
 
- 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)
 

Public Attributes

bool Selected = false
 
MyGuiDrawAlignEnum TextAlignment = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER
 
string TextFont
 
bool DrawCrossTextureWhenDisabled = false
 
MyGuiHighlightTexture Icon
 
MyGuiDrawAlignEnum IconOriginAlign = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER
 
- 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 Member Functions

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

Protected Attributes

GuiSounds m_cueEnum
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlBase
bool m_mouseButtonPressed = false
 
bool m_showToolTip = false
 
Vector2 m_toolTipPosition
 

Properties

float IconRotation [get, set]
 
bool Checked [get, set]
 
bool ActivateOnMouseRelease [get, set]
 
int Index [get]
 
string Text [get, set]
 
MyStringId TextEnum [get, set]
 
GuiSounds CueEnum [get, set]
 
float TextScale [get, set]
 
float ButtonScale [get, set]
 
float TextScaleWithLanguage [get]
 
MyGuiControlButtonStyleEnum VisualStyle [get, set]
 
- 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< MyGuiControlButtonButtonClicked
 
- 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...
 

Detailed Description

Definition at line 24 of file MyGuiControlButton.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiControlButton.MyGuiControlButton ( )
inline

Definition at line 269 of file MyGuiControlButton.cs.

Sandbox.Graphics.GUI.MyGuiControlButton.MyGuiControlButton ( Vector2 position = null,
MyGuiControlButtonStyleEnum  visualStyle = MyGuiControlButtonStyleEnum.Default,
Vector2 size = null,
Vector4 colorMask = null,
MyGuiDrawAlignEnum  originAlign = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER,
String  toolTip = null,
StringBuilder  text = null,
float  textScale = MyGuiConstants.DEFAULT_TEXT_SCALE,
MyGuiDrawAlignEnum  textAlignment = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER,
MyGuiControlHighlightType  highlightType = MyGuiControlHighlightType.WHEN_ACTIVE,
Action< MyGuiControlButton onButtonClick = null,
GuiSounds  cueEnum = GuiSounds.MouseClick,
float  buttonScale = 1.0f,
int?  buttonIndex = null,
bool  activateOnMouseRelease = false 
)
inline

Definition at line 271 of file MyGuiControlButton.cs.

Member Function Documentation

override void Sandbox.Graphics.GUI.MyGuiControlButton.Draw ( float  transitionAlpha,
float  backgroundTransitionAlpha 
)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 371 of file MyGuiControlButton.cs.

override string Sandbox.Graphics.GUI.MyGuiControlButton.GetMouseCursorTexture ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 353 of file MyGuiControlButton.cs.

override MyObjectBuilder_GuiControlBase Sandbox.Graphics.GUI.MyGuiControlButton.GetObjectBuilder ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 523 of file MyGuiControlButton.cs.

static StyleDefinition Sandbox.Graphics.GUI.MyGuiControlButton.GetVisualStyle ( MyGuiControlButtonStyleEnum  style)
inlinestatic

Definition at line 214 of file MyGuiControlButton.cs.

override MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlButton.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 316 of file MyGuiControlButton.cs.

override void Sandbox.Graphics.GUI.MyGuiControlButton.Init ( MyObjectBuilder_GuiControlBase  objectBuilder)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 537 of file MyGuiControlButton.cs.

override void Sandbox.Graphics.GUI.MyGuiControlButton.OnHasHighlightChanged ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 561 of file MyGuiControlButton.cs.

override void Sandbox.Graphics.GUI.MyGuiControlButton.OnOriginAlignChanged ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 567 of file MyGuiControlButton.cs.

override void Sandbox.Graphics.GUI.MyGuiControlButton.OnSizeChanged ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 573 of file MyGuiControlButton.cs.

void Sandbox.Graphics.GUI.MyGuiControlButton.RaiseButtonClicked ( )
inlineprotected

Definition at line 365 of file MyGuiControlButton.cs.

void Sandbox.Graphics.GUI.MyGuiControlButton.SetCustomStyle ( StyleDefinition  buttonStyle)
inline

Definition at line 632 of file MyGuiControlButton.cs.

override bool Sandbox.Graphics.GUI.MyGuiControlButton.ShouldHaveHighlight ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 553 of file MyGuiControlButton.cs.

Member Data Documentation

bool Sandbox.Graphics.GUI.MyGuiControlButton.DrawCrossTextureWhenDisabled = false

Definition at line 501 of file MyGuiControlButton.cs.

MyGuiHighlightTexture Sandbox.Graphics.GUI.MyGuiControlButton.Icon

Definition at line 515 of file MyGuiControlButton.cs.

MyGuiDrawAlignEnum Sandbox.Graphics.GUI.MyGuiControlButton.IconOriginAlign = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER

Definition at line 517 of file MyGuiControlButton.cs.

GuiSounds Sandbox.Graphics.GUI.MyGuiControlButton.m_cueEnum
protected

Definition at line 245 of file MyGuiControlButton.cs.

bool Sandbox.Graphics.GUI.MyGuiControlButton.Selected = false

Definition at line 263 of file MyGuiControlButton.cs.

MyGuiDrawAlignEnum Sandbox.Graphics.GUI.MyGuiControlButton.TextAlignment = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER

Definition at line 497 of file MyGuiControlButton.cs.

string Sandbox.Graphics.GUI.MyGuiControlButton.TextFont

Definition at line 499 of file MyGuiControlButton.cs.

Property Documentation

bool Sandbox.Graphics.GUI.MyGuiControlButton.ActivateOnMouseRelease
getset

Definition at line 255 of file MyGuiControlButton.cs.

float Sandbox.Graphics.GUI.MyGuiControlButton.ButtonScale
getsetprotected

Definition at line 482 of file MyGuiControlButton.cs.

bool Sandbox.Graphics.GUI.MyGuiControlButton.Checked
getset

Definition at line 249 of file MyGuiControlButton.cs.

GuiSounds Sandbox.Graphics.GUI.MyGuiControlButton.CueEnum
getset

Definition at line 466 of file MyGuiControlButton.cs.

float Sandbox.Graphics.GUI.MyGuiControlButton.IconRotation
getset

Definition at line 232 of file MyGuiControlButton.cs.

int Sandbox.Graphics.GUI.MyGuiControlButton.Index
get

Definition at line 440 of file MyGuiControlButton.cs.

string Sandbox.Graphics.GUI.MyGuiControlButton.Text
getset

Definition at line 446 of file MyGuiControlButton.cs.

MyStringId Sandbox.Graphics.GUI.MyGuiControlButton.TextEnum
getset

Definition at line 456 of file MyGuiControlButton.cs.

float Sandbox.Graphics.GUI.MyGuiControlButton.TextScale
getset

Definition at line 472 of file MyGuiControlButton.cs.

float Sandbox.Graphics.GUI.MyGuiControlButton.TextScaleWithLanguage
get

Definition at line 492 of file MyGuiControlButton.cs.

MyGuiControlButtonStyleEnum Sandbox.Graphics.GUI.MyGuiControlButton.VisualStyle
getset

Definition at line 504 of file MyGuiControlButton.cs.

Event Documentation

Action<MyGuiControlButton> Sandbox.Graphics.GUI.MyGuiControlButton.ButtonClicked

Definition at line 237 of file MyGuiControlButton.cs.


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