Space Engineers
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
Sandbox.Graphics.GUI.MyGuiControlSliderBase Class Reference
Inheritance diagram for Sandbox.Graphics.GUI.MyGuiControlSliderBase:
Sandbox.Graphics.GUI.MyGuiControlBase Sandbox.Graphics.GUI.IMyGuiControlsOwner Sandbox.Graphics.GUI.MyGuiControlSlider

Classes

class  StyleDefinition
 

Public Member Functions

 MyGuiControlSliderBase (Vector2?position=null, float width=464f/1600f, MyGuiSliderProperties props=null, float?defaultRatio=null, Vector4?color=null, float labelScale=MyGuiConstants.DEFAULT_TEXT_SCALE, float labelSpaceWidth=0f, string labelFont=MyFontEnum.White, String toolTip=null, MyGuiControlSliderStyleEnum visualStyle=MyGuiControlSliderStyleEnum.Default, MyGuiDrawAlignEnum originAlign=MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER)
 
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 Draw (float transitionAlpha, float backgroundTransitionAlpha)
 
void ApplyStyle (StyleDefinition style)
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
virtual void Init (MyObjectBuilder_GuiControlBase builder)
 
virtual MyObjectBuilder_GuiControlBase GetObjectBuilder ()
 
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...
 
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 StyleDefinition GetVisualStyle (MyGuiControlSliderStyleEnum 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

Action< MyGuiControlSliderBaseValueChanged
 
float DefaultRatio
 
Func< MyGuiControlSliderBase, bool > SliderClicked
 
- 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

virtual void OnValueChange ()
 
virtual bool OnSliderClicked ()
 
override void OnSizeChanged ()
 
override void OnHasHighlightChanged ()
 
- 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 OnPositionChanged ()
 
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 ()
 

Properties

MyGuiControlSliderStyleEnum VisualStyle [get, set]
 
MyGuiSliderProperties Propeties [get, set]
 
float Ratio [get, set]
 This is values selected on slider in original units, e.g. meters, so it can be for example 1000 meters. More...
 
float DebugScale [get, set]
 
float Value [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]
 

Additional Inherited Members

- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlBase
bool m_mouseButtonPressed = false
 
bool m_showToolTip = false
 
Vector2 m_toolTipPosition
 
- 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 64 of file MyGuiControlSliderBase.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiControlSliderBase.MyGuiControlSliderBase ( Vector2 position = null,
float  width = 464f/1600f,
MyGuiSliderProperties  props = null,
float?  defaultRatio = null,
Vector4 color = null,
float  labelScale = MyGuiConstants.DEFAULT_TEXT_SCALE,
float  labelSpaceWidth = 0f,
string  labelFont = MyFontEnum.White,
String  toolTip = null,
MyGuiControlSliderStyleEnum  visualStyle = MyGuiControlSliderStyleEnum.Default,
MyGuiDrawAlignEnum  originAlign = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER 
)
inline

Definition at line 185 of file MyGuiControlSliderBase.cs.

Member Function Documentation

void Sandbox.Graphics.GUI.MyGuiControlSliderBase.ApplyStyle ( StyleDefinition  style)
inline

Definition at line 398 of file MyGuiControlSliderBase.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 310 of file MyGuiControlSliderBase.cs.

static StyleDefinition Sandbox.Graphics.GUI.MyGuiControlSliderBase.GetVisualStyle ( MyGuiControlSliderStyleEnum  style)
inlinestatic

Definition at line 94 of file MyGuiControlSliderBase.cs.

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

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 329 of file MyGuiControlSliderBase.cs.

override void Sandbox.Graphics.GUI.MyGuiControlSliderBase.OnRemoving ( )
inlinevirtual

Removes various references and clears event handlers.

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 232 of file MyGuiControlSliderBase.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 323 of file MyGuiControlSliderBase.cs.

virtual bool Sandbox.Graphics.GUI.MyGuiControlSliderBase.OnSliderClicked ( )
inlineprotectedvirtual

Reimplemented in Sandbox.Graphics.GUI.MyGuiControlSlider.

Definition at line 303 of file MyGuiControlSliderBase.cs.

virtual void Sandbox.Graphics.GUI.MyGuiControlSliderBase.OnValueChange ( )
inlineprotectedvirtual

Reimplemented in Sandbox.Graphics.GUI.MyGuiControlSlider.

Definition at line 163 of file MyGuiControlSliderBase.cs.

Member Data Documentation

float Sandbox.Graphics.GUI.MyGuiControlSliderBase.DefaultRatio

Definition at line 110 of file MyGuiControlSliderBase.cs.

Func<MyGuiControlSliderBase, bool> Sandbox.Graphics.GUI.MyGuiControlSliderBase.SliderClicked

Definition at line 169 of file MyGuiControlSliderBase.cs.

Action<MyGuiControlSliderBase> Sandbox.Graphics.GUI.MyGuiControlSliderBase.ValueChanged

Definition at line 100 of file MyGuiControlSliderBase.cs.

Property Documentation

float Sandbox.Graphics.GUI.MyGuiControlSliderBase.DebugScale
getset

Definition at line 173 of file MyGuiControlSliderBase.cs.

MyGuiSliderProperties Sandbox.Graphics.GUI.MyGuiControlSliderBase.Propeties
getset

Control properties of the slider.

Definition at line 130 of file MyGuiControlSliderBase.cs.

float Sandbox.Graphics.GUI.MyGuiControlSliderBase.Ratio
getset

This is values selected on slider in original units, e.g. meters, so it can be for example 1000 meters.

Definition at line 147 of file MyGuiControlSliderBase.cs.

float Sandbox.Graphics.GUI.MyGuiControlSliderBase.Value
getset

Definition at line 408 of file MyGuiControlSliderBase.cs.

MyGuiControlSliderStyleEnum Sandbox.Graphics.GUI.MyGuiControlSliderBase.VisualStyle
getset

Definition at line 113 of file MyGuiControlSliderBase.cs.


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