Space Engineers
Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
Sandbox.Game.Gui.MyTerminalControlSlider< TBlock > Class Template Reference
Inheritance diagram for Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >:
Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, float > Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalValueControl< float > Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip

Public Member Functions

delegate float FloatFunc (TBlock block, float val)
 
 MyTerminalControlSlider (string id, MyStringId title, MyStringId tooltip)
 
void CompactWriterMethod (TBlock block, StringBuilder appendTo)
 
void SetLimits (float min, float max)
 Allows you to set the upper and lower limits of the slider More...
 
void SetLogLimits (float min, float max)
 Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale More...
 
void SetDualLogLimits (float absMin, float absMax, float centerBand)
 Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale at both ends More...
 
void SetLimits (GetterDelegate minGetter, GetterDelegate maxGetter)
 
void SetLogLimits (GetterDelegate minGetter, GetterDelegate maxGetter)
 
void SetDualLogLimits (GetterDelegate minGetter, GetterDelegate maxGetter, float centerBand)
 
void EnableActions (string increaseIcon, string decreaseIcon, StringBuilder increaseName, StringBuilder decreaseName, float step, string resetIcon=null, StringBuilder resetName=null, Func< TBlock, bool > enabled=null)
 
override void SetValue (TBlock block, float value)
 
override float GetDefaultValue (TBlock block)
 
override float GetMinimum (TBlock block)
 
override float GetMaximum (TBlock block)
 
override float GetValue (TBlock block)
 
- Public Member Functions inherited from Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, float >
delegate TValue GetterDelegate (TBlock block)
 
delegate void SetterDelegate (TBlock block, TValue value)
 
delegate void SerializerDelegate (BitStream stream, ref TValue value)
 
delegate void ExternalSetterDelegate (IMyTerminalBlock block, TValue value)
 
 MyTerminalValueControl (string id)
 
TValue GetValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
virtual void SetValue (TBlock block, TValue value)
 
void SetValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block, TValue value)
 
virtual void Serialize (BitStream stream, TBlock block)
 
void Serialize (BitStream stream, MyTerminalBlock block)
 (De)serializes block data. More...
 
TValue GetDefaultValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
TValue GetMininum (TBlock block)
 
TValue GetMininum (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
TValue GetMinimum (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
TValue GetMaximum (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
- Public Member Functions inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
void RedrawControl ()
 Recreates the control GUI. This allows you to update the Title of some controls. More...
 
void UpdateVisual ()
 This updates a control that is currently displayed, allowing you to refresh it's state More...
 

Public Attributes

MyStringId Title
 
MyStringId Tooltip
 
bool AmountDialogEnabled = true
 
WriterDelegate Writer
 
WriterDelegate CompactWriter
 
FloatFunc Normalizer = (b, f) => f
 
FloatFunc Denormalizer = (b, f) => f
 
GetterDelegate DefaultValueGetter
 
- Public Attributes inherited from Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, float >
SerializerDelegate Serializer
 Serializer which (de)serializes the value. More...
 

Protected Member Functions

override MyGuiControlBase CreateGui ()
 
override void OnUpdateVisual ()
 

Properties

float DefaultValue [set]
 
string Formatter [set]
 
- Properties inherited from Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, float >
GetterDelegate Getter [get, set]
 Getter which gets value from block. Can be set by anyone, but used only by MyTerminalValueControl. If you need to get the value, use GetValue method. More...
 
SetterDelegate Setter [get, set]
 Setter which sets value to block. Can be set by anyone, but used only by MyTerminalValueControl. If you need to set the value, use SetValue method, which does handles notification. More...
 
Expression< Func< TBlock, TValue > > MemberExpression [set]
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider
Action< IMyTerminalBlock, StringBuilder > Writer [get, set]
 This is triggered when a slider value is modified. Appending to the stringbuilder allows you to modify the text that is displayed along side the slider when it updates. More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
string Id [get]
 Identifier of control More...
 
Func< IMyTerminalBlock, bool > Enabled [set]
 Allows you to set if the control is enabled More...
 
Func< IMyTerminalBlock, bool > Visible [set]
 Allows you to set if the control is visible More...
 
bool SupportsMultipleBlocks [get, set]
 Allows you to set if the control is visible when the block is selected as a group More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalValueControl< float >
Func< IMyTerminalBlock, TValue > Getter [get, set]
 This is triggered when the value of the control is required. More...
 
Action< IMyTerminalBlock, TValue > Setter [get, set]
 This is triggered when the value of the control is set by the user. Depending on the control, this may be called a lot. More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip
MyStringId Title [get, set]
 Allows you to get or set the Label that appears on the control More...
 
MyStringId Tooltip [get, set]
 Allows you to get or set the tooltip that appears when you hover over the control More...
 

Detailed Description

Type Constraints
TBlock :MyTerminalBlock 

Definition at line 20 of file MyTerminalControlSlider.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.MyTerminalControlSlider ( string  id,
MyStringId  title,
MyStringId  tooltip 
)
inline

Definition at line 64 of file MyTerminalControlSlider.cs.

Member Function Documentation

void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.CompactWriterMethod ( TBlock  block,
StringBuilder  appendTo 
)
inline

Definition at line 93 of file MyTerminalControlSlider.cs.

override MyGuiControlBase Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.CreateGui ( )
inlineprotected

Definition at line 76 of file MyTerminalControlSlider.cs.

void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.EnableActions ( string  increaseIcon,
string  decreaseIcon,
StringBuilder  increaseName,
StringBuilder  decreaseName,
float  step,
string  resetIcon = null,
StringBuilder  resetName = null,
Func< TBlock, bool >  enabled = null 
)
inline

Definition at line 322 of file MyTerminalControlSlider.cs.

delegate float Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.FloatFunc ( TBlock  block,
float  val 
)
override float Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.GetDefaultValue ( TBlock  block)
inlinevirtual
override float Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.GetMaximum ( TBlock  block)
inlinevirtual
override float Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.GetMinimum ( TBlock  block)
inlinevirtual
override float Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.GetValue ( TBlock  block)
inlinevirtual
override void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.OnUpdateVisual ( )
inlineprotected

Definition at line 236 of file MyTerminalControlSlider.cs.

void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.SetDualLogLimits ( float  absMin,
float  absMax,
float  centerBand 
)
inline

Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale at both ends

Parameters
min
max

Implements Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.

Definition at line 143 of file MyTerminalControlSlider.cs.

void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.SetDualLogLimits ( GetterDelegate  minGetter,
GetterDelegate  maxGetter,
float  centerBand 
)
inline

Definition at line 213 of file MyTerminalControlSlider.cs.

void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.SetLimits ( float  min,
float  max 
)
inline

Allows you to set the upper and lower limits of the slider

Parameters
minMinimum value
maxMaximum value

Implements Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.

Definition at line 131 of file MyTerminalControlSlider.cs.

void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.SetLimits ( GetterDelegate  minGetter,
GetterDelegate  maxGetter 
)
inline

Definition at line 167 of file MyTerminalControlSlider.cs.

void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.SetLogLimits ( float  min,
float  max 
)
inline

Allows you to set the upper and lower limits of the slider, interpolating on a logarithmic scale

Parameters
min
max

Implements Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlSlider.

Definition at line 137 of file MyTerminalControlSlider.cs.

void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.SetLogLimits ( GetterDelegate  minGetter,
GetterDelegate  maxGetter 
)
inline

Definition at line 190 of file MyTerminalControlSlider.cs.

override void Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.SetValue ( TBlock  block,
float  value 
)
inline

Definition at line 332 of file MyTerminalControlSlider.cs.

Member Data Documentation

bool Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.AmountDialogEnabled = true

Definition at line 32 of file MyTerminalControlSlider.cs.

WriterDelegate Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.CompactWriter

Definition at line 35 of file MyTerminalControlSlider.cs.

Definition at line 40 of file MyTerminalControlSlider.cs.

FloatFunc Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.Denormalizer = (b, f) => f

Definition at line 38 of file MyTerminalControlSlider.cs.

FloatFunc Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.Normalizer = (b, f) => f

Definition at line 37 of file MyTerminalControlSlider.cs.

Definition at line 25 of file MyTerminalControlSlider.cs.

Definition at line 26 of file MyTerminalControlSlider.cs.

WriterDelegate Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.Writer

Definition at line 34 of file MyTerminalControlSlider.cs.

Property Documentation

float Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.DefaultValue
set

Definition at line 47 of file MyTerminalControlSlider.cs.

string Sandbox.Game.Gui.MyTerminalControlSlider< TBlock >.Formatter
set

Definition at line 55 of file MyTerminalControlSlider.cs.


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