Frictional Game Wiki

<h1>helper_imgui.hps</h1> <div class="level1"> <p> Helpers for creating immediate GUIs </p> <hr /> </div> <h5>ImGui_ClearStates</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> ImGui_ClearStates<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Clears all states, timers, variables, etc. </p> <hr /> </div> <h5>ImGui_InFocus</h5> <div class="level5"> <pre class="code c++">bool ImGui_InFocus<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If the current ImGui is in focus. </p> <hr /> </div> <h5>ImGui_BecameInFocus</h5> <div class="level5"> <pre class="code c++">bool ImGui_BecameInFocus<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If the current ImGui just got focus </p> <hr /> </div> <h5>ImGui_WasInFocus</h5> <div class="level5"> <pre class="code c++">bool ImGui_WasInFocus<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If the current ImGui had focus the previous update </p> <hr /> </div> <h5>ImGui_Exit</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> ImGui_Exit<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If am in-game gui exit, then the current gui is exited. Do not need to be called in a OnGui function. </p> <hr /> </div> <h5>ImGui_ClickedMouseOutside</h5> <div class="level5"> <pre class="code c++">bool ImGui_ClickedMouseOutside<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <b>Returns</b>: true if the mouse is clicked outside the current ImGui </p> <hr /> </div> <h5>ImGui_SetTransCategory</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> ImGui_SetTransCategory<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCat<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> This sets the current translation category, if _ckgedit_QUOT<u>ckgedit> then all text params will used as text, else as entry names in a Translate(cat, entry) —- == ImGui_GetTransCategory == <code c++> tString ImGui_GetTransCategory() </code> <span class='np_break'> </span> This gets the current translation category. —- == ImGui_Translate == <code c++> tWString ImGui_Translate(const tString &in asEntry) </code> <span class='np_break'> </span> Translate using the currently set trans category —- == ImGui_SetTextOverride == <code c++> void ImGui_SetTextOverride(const tWString &in asText) </code> <span class='np_break'> </span> This sets a literal text to use in place of any empty strings. —- == ImGui_ClearTextOverride == <code c++> void ImGui_ClearTextOverride() </code> <span class='np_break'> </span> Just clears the currently set text override. —- == _ImGui_GetTextString == <code c++> tWString _ImGui_GetTextString(const tString &in asText) </code> <span class='np_break'> </span> Internal —- == ImGui_GetSize == <code c++> cVector2f ImGui_GetSize() </code> <span class='np_break'> </span> Get the size (in pixels) of the GUI screen —- == ImGui_NrmPos == <code c++> cVector3f ImGui_NrmPos(const cVector3f &in avPos) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a position in screen space is returned. —- == ImGui_NrmPos == <code c++> cVector3f ImGui_NrmPos(float afX, float afY, float afZ) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a position in screen space is returned. —- == ImGui_NrmPos2 == <code c++> cVector2f ImGui_NrmPos2(float afX, float afY) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a position in screen space is returned. —- == ImGui_NrmSize == <code c++> cVector2f ImGui_NrmSize(const cVector2f &in avSize) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in screen space is returned. —- == ImGui_NrmSize == <code c++> cVector2f ImGui_NrmSize(float afX, float afY) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in screen space is returned. —- == ImGui_NrmPosGroup == <code c++> cVector3f ImGui_NrmPosGroup(const cVector3f &in avPos, bool abOffsetInsideGroup=false) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a position in the current group space is returned. —- == ImGui_NrmPosGroup == <code c++> cVector3f ImGui_NrmPosGroup(float afX, float afY, float afZ, bool abOffsetInsideGroup=false) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in the current group space is returned. —- == ImGui_NrmPos2Group == <code c++> cVector2f ImGui_NrmPos2Group(float afX, float afY, bool abOffsetInsideGroup=false) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in the current group space is returned. —- == ImGui_NrmSizeGroup == <code c++> cVector2f ImGui_NrmSizeGroup(const cVector2f &in avSize) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in the current group space is returned. —- == ImGui_NrmSizeGroup == <code c++> cVector2f ImGui_NrmSizeGroup(float afX, float afY) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in the current group space is returned. —- == ImGui_NrmSizeKeepRatio == <code c++> cVector2f ImGui_NrmSizeKeepRatio(const cVector2f &in avSize) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in screen space is returned. —- == ImGui_NrmSizeKeepRatio == <code c++> cVector2f ImGui_NrmSizeKeepRatio(float afX, float afY) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in screen space is returned. —- == ImGui_NrmSizeGroupKeepRatio == <code c++> cVector2f ImGui_NrmSizeGroupKeepRatio(const cVector2f &in avSize) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in screen space is returned. —- == ImGui_NrmSizeGroupKeepRatio == <code c++> cVector2f ImGui_NrmSizeGroupKeepRatio(float afX, float afY) </code> <span class='np_break'> </span> Input should be normalized, 0-1, and a size in screen space is returned. —- == ImGui_GetRatioCorrectSizeByWidth == <code c++> cVector2f ImGui_GetRatioCorrectSizeByWidth(const cImGuiGfx &in aGfx, float afWidth) </code> <span class='np_break'> </span> Given an input width and a Gfx object, a size in screen space is returned, being aspect ratio correct according to input Gfx object. —- == ImGui_GetRatioCorrectSizeByNrmWidth == <code c++> cVector2f ImGui_GetRatioCorrectSizeByNrmWidth(const cImGuiGfx &in aGfx, float afWidth) </code> <span class='np_break'> </span> Input width should be normalized, 0-1, and a size in screen space is returned, being aspect ratio correct according to input Gfx object. —- == ImGui_GetRatioCorrectSizeByHeight == <code c++> cVector2f ImGui_GetRatioCorrectSizeByHeight(const cImGuiGfx &in aGfx, float afHeight) </code> <span class='np_break'> </span> Given an input height and a Gfx object, a size in screen space is returned, being aspect ratio correct according to input Gfx object. —- == ImGui_GetRatioCorrectSizeByNrmHeight == <code c++> cVector2f ImGui_GetRatioCorrectSizeByNrmHeight(const cImGuiGfx &in aGfx, float afHeight) </code> <span class='np_break'> </span> Input height should be normalized, 0-1, and a size in screen space is returned, being aspect ratio correct according to input Gfx object. —- == ImGui_GetRatioCorrectSizeByRect == <code c++> cVector2f ImGui_GetRatioCorrectSizeByRect(const cImGuiGfx &in aGfx, const cVector2f &in aRect, bool abCompensateForUV=false) </code> <span class='np_break'> </span> Given an input rect and a Gfx object, the maximum size in screen space to fit within said rect is returned, being aspect ratio correct according to input Gfx object. —- == ImGui_SetupWidgetRect == <code c++> void ImGui_SetupWidgetRect(const cVector3f &in avInPos, const cVector2f &in avInSize, cVector3f &out avOutPos, cVector2f &out avOutSize, const cVector2f &in avDefaultSize, const cImGuiGfx &in aGfx) </code> <span class='np_break'> </span> —- == ImGui_ActionTriggered == <code c++> bool ImGui_ActionTriggered(eImGuiAction aAction, bool abCheckIfUsed=false) </code> <span class='np_break'> </span> See if an action (sent to ImGui by game) has been triggered (just became down). * <b>aAction</b>: The action type. * <b>abCheckIfUsed</b>: If true, then false is returned if any other class for this action have been made. —- == ImGui_ActionIsDown == <code c++> bool ImGui_ActionIsDown(eImGuiAction aAction, bool abCheckIfUsed=false) </code> <span class='np_break'> </span> See if an action (sent to ImGui by game) is down. * <b>aAction</b>: The action type. * <b>abCheckIfUsed</b>: If true, then false is returned if any other class for this action have been made. —- == ImGui_GetMouseRel == <code c++> cVector2f ImGui_GetMouseRel() </code> <span class='np_break'> </span> the relative mouse movement. —- == ImGui_GetMouseRel3D == <code c++> cVector3f ImGui_GetMouseRel3D() </code> <span class='np_break'> </span> The relative mouse movement as 3D vector (z=0) —- == ImGui_GetMousePosition == <code c++> cVector2f ImGui_GetMousePosition() </code> <span class='np_break'> </span> The absolute mouse position —- == ImGui_GetMousePosition3D == <code c++> cVector3f ImGui_GetMousePosition3D() </code> <span class='np_break'> </span> The absolute mouse position as 3D vector (z=0) —- == ImGui_CheckMouseHasMoved == <code c++> bool ImGui_CheckMouseHasMoved() </code> <span class='np_break'> </span> Returns true if the mouse has been moved. —- == ImGui_SetFocus == <code c++> void ImGui_SetFocus(const tString &in asWidgetName) </code> <span class='np_break'> </span> Sets the widget that should be in focus. —- == ImGui_SetAlignment == <code c++> void ImGui_SetAlignment(eImGuiAlign aAlign) </code> <span class='np_break'> </span> Sets the alignment of the widget regarding the postion (if positon is top-left corner, center, etc). Applies to any widget declared after this call. —- == ImGui_SetUIMoveGroupFlags == <code c++> void ImGui_SetUIMoveGroupFlags(int alGroupFlags) </code> <span class='np_break'> </span> This sets what move group(s) the widget will belong to. When using keyboard/gamepad movement, it is only possible to move between widget that share the same group. This is a bitflag, that it is not the number, but binary bits that matter. To set it, use one or more, eFlagBit_* combined with the bitwise-or-opterator "|". Example: SetUIMoveGroupFlags(eFlagBit_0 | eFlagBit_2); <em>This will make widgets belong to group 0 and 2. Applies to any widget declared after this call. —- == ImGui_SetUIMoveWrapMode == <code c++> void ImGui_SetUIMoveWrapMode(eImGuiWrap aWrap) </code> <span class='np_break'> </span> Sets the keyboard/gamepad movement wrap mode, ie what happens when "off the edge". This is takes effect to any widgets that are defined after it is called. Default is always XY at the start of an OnGui call! —- == ImGui_GetStateInt == <code c++> int ImGui_GetStateInt(const tString &in asVarName, int alDefault=0) </code> <span class='np_break'> </span> —- == ImGui_GetStateFloat == <code c++> float ImGui_GetStateFloat(const tString &in asVarName, float afDefault=0.0f) </code> <span class='np_break'> </span> —- == ImGui_GetStateVector3f == <code c++> cVector3f ImGui_GetStateVector3f(const tString &in asVarName, const cVector3f &in avDefault) </code> <span class='np_break'> </span> —- == ImGui_GetStateColor == <code c++> cColor ImGui_GetStateColor(const tString &in asVarName, const cColor &in aDefault) </code> <span class='np_break'> </span> —- == ImGui_GetStateBool == <code c++> bool ImGui_GetStateBool(const tString &in asVarName, bool abDefault) </code> <span class='np_break'> </span> —- == ImGui_SetStateInt == <code c++> void ImGui_SetStateInt(const tString &in asVarName, int alVal) </code> <span class='np_break'> </span> —- == ImGui_SetStateFloat == <code c++> void ImGui_SetStateFloat(const tString &in asVarName, float afVal) </code> <span class='np_break'> </span> —- == ImGui_SetStateVector3f == <code c++> void ImGui_SetStateVector3f(const tString &in asVarName, const cVector3f &in avVal) </code> <span class='np_break'> </span> —- == ImGui_SetStateColor == <code c++> void ImGui_SetStateColor(const tString &in asVarName, const cColor &in aVal) </code> <span class='np_break'> </span> —- == ImGui_SetStateBool == <code c++> void ImGui_SetStateBool(const tString &in asVarName, bool abVal) </code> <span class='np_break'> </span> —- == ImGui_IncStateInt == <code c++> void ImGui_IncStateInt(const tString &in asVarName, int alVal) </code> <span class='np_break'> </span> —- == ImGui_IncStateFloat == <code c++> void ImGui_IncStateFloat(const tString &in asVarName, float afVal) </code> <span class='np_break'> </span> —- == ImGui_IncStateVector3f == <code c++> void ImGui_IncStateVector3f(const tString &in asVarName, const cVector3f &in avVal) </code> <span class='np_break'> </span> —- == ImGui_IncStateColor == <code c++> void ImGui_IncStateColor(const tString &in asVarName, const cColor &in aVal) </code> <span class='np_break'> </span> —- == ImGui_FadeStateFloat == <code c++> void ImGui_FadeStateFloat(const tString &in asVarName, float afGoalVal, float afTime, eEasing aType=eEasing_QuadInOut, bool abReplaceIfExist=true) </code> <span class='np_break'> </span> Adds a fade that will fade a float variable from its current value to goal over time. * <b>asVarName</b>: The name of the state var. * <b>afGoalVal</b>: The goal value to fade to. * <b>afTime</b>: How long the fade will take. * <b>aType</b>: the type of fade, meaning in what way the transiation will be. Sigmoid is default as this means the starts and ends smoothly. * <b>abReplaceIfExist</b>: if the variable is currently fading, that fade is replaced if true, else the function call will have no effect. —- == ImGui_FadeStateVector3f == <code c++> void ImGui_FadeStateVector3f(const tString &in asVarName, const cVector3f &in avGoalVal, float afTime, eEasing aType=eEasing_QuadInOut, bool abReplaceIfExist=true) </code> <span class='np_break'> </span> Adds a fade that will fade a Vector3f variable from its current value to goal over time. * <b>asVarName</b>: The name of the state var. * <b>avGoalVal</b>: The goal value to fade to. * <b>afTime</b>: How long the fade will take. * <b>aType</b>: the type of fade, meaning in what way the transiation will be. Sigmoid is default as this means the starts and ends smoothly. * <b>abReplaceIfExist</b>: if the variable is currently fading, that fade is replaced if true, else the function call will have no effect. —- == ImGui_FadeStateColor == <code c++> void ImGui_FadeStateColor(const tString &in asVarName, const cColor &in aGoalVal, float afTime, eEasing aType=eEasing_QuadInOut, bool abReplaceIfExist=true) </code> <span class='np_break'> </span> Adds a fade that will fade a Color variable from its current value to goal over time. * <b>asVarName</b>: The name of the state var. * <b>aGoalVal</b>: The goal value to fade to. * <b>afTime</b>: How long the fade will take. * <b>aType</b>: the type of fade, meaning in what way the transiation will be. Sigmoid is default as this means the starts and ends smoothly. * <b>abReplaceIfExist</b>: if the variable is currently fading, that fade is replaced if true, else the function call will have no effect. —- == ImGui_StopFade == <code c++> void ImGui_StopFade(const tString &in asVarName) </code> <span class='np_break'> </span> Stops the fading in the fader. —- == ImGui_IsFading == <code c++> bool ImGui_IsFading(const tString &in asVarName) </code> <span class='np_break'> </span> Checks if the fader is fading. —- == ImGui_FadeOver == <code c++> bool ImGui_FadeOver(const tString &in asName) </code> <span class='np_break'> </span> See if a fader ended this update. Mainly to do what ever event happens when FadeState is over. —- == ImGui_FadeOscillateFloat == <code c++> float ImGui_FadeOscillateFloat(const tString &in asVarName, float afStart, float afGoal, float afTime, eEasing aType=eEasing_QuadInOut) </code> <span class='np_break'> </span> This will fade a float state var value back and forth between two values and returns the current value. * <b>asVarName</b>: The name of the state var. * <b>afStart</b>: The start value * <b>afGoal</b>: The goal value * <b>afTime</b>: the time it takes to go from Start to Goal (or the opposite) * <b>aType</b>: The type of fade between the values. —- == ImGui_FadeOscillateVector3f == <code c++> cVector3f ImGui_FadeOscillateVector3f(const tString &in asVarName, const cVector3f &in avStart, const cVector3f &in avGoal, float afTime, eEasing aType=eEasing_QuadInOut) </code> <span class='np_break'> </span> This will fade a float * <b>asVarName</b>: The name of the state var. * <b>avStart</b>: The start value * <b>avGoal</b>: The goal value * <b>afTime</b>: the time it takes to go from Start to Goal (or the opposite) * <b>aType</b>: The type of fade between the values. —- == ImGui_FadeOscillateColor == <code c++> cColor ImGui_FadeOscillateColor(const tString &in asVarName, const cColor &in aStart, const cColor &in aGoal, float afTime, eEasing aType=eEasing_QuadInOut) </code> <span class='np_break'> </span> This will fade a float * <b>asVarName</b>: The name of the state var. * <b>aStart</b>: The start value * <b>aGoal</b>: The goal value * <b>afTime</b>: the time it takes to go from Start to Goal (or the opposite) * <b>aType</b>: The type of fade between the values. —- == ImGui_AddTimer == <code c++> void ImGui_AddTimer(const tString &in asName, float afTime) </code> <span class='np_break'> </span> Adds a timer, that ends of afTime time —- == ImGui_RepeatTimer == <code c++> bool ImGui_RepeatTimer(const tString &in asName, float afTime) </code> <span class='np_break'> </span> This will create a timer that is recreated when over. It returns true whenver the timer ends. Example: if(ImGui_RepeatTimer("mytime", 2)){EventThatHappensEvery2Secs();} —- == ImGui_StopTimer == <code c++> void ImGui_StopTimer(const tString &in asName) </code> <span class='np_break'> </span> Stops an active timer. —- == ImGui_TimerOver == <code c++> bool ImGui_TimerOver(const tString &in asName) </code> <span class='np_break'> </span> See if a timer ended this update. Mainly to do what ever event happens when AddTimer is over. —- == ImGui_TimerExists == <code c++> bool ImGui_TimerExists(const tString &in asName) </code> <span class='np_break'> </span> See if a timer is running. —- == ImGui_SetModColorMul == <code c++> void ImGui_SetModColorMul(const cColor &in aCol) </code> <span class='np_break'> </span> Sets a color modifier to any widgets defined below. Default: (1,1,1,1) —- == ImGui_SetModTextColorMul == <code c++> void ImGui_SetModTextColorMul(const cColor &in aCol) </code> <span class='np_break'> </span> Sets a text color modifier to any widgets defined below. Default: (1,1,1,1) —- == ImGui_SetModUseUIPos == <code c++> void ImGui_SetModUseUIPos(bool abX) </code> <span class='np_break'> </span> Sets if the widgets below should be possible to navigate to using keyboard/gamepad movement. Default: true —- == ImGui_SetModUISizeHoriExpansion == <code c++> void ImGui_SetModUISizeHoriExpansion(float afNeg, float afPos) </code> <span class='np_break'> </span> Expands (or contracts, use negative values) the size of the UI Pos size horitzontally. Use this to make a small UI element reachable with keyboard/gamepad movement, but by making the UI box line up with the other widgets. Turn on the debug feature Draw GUI debug to see the boxes. —- == ImGui_SetModUISizeVertExpansion == <code c++> void ImGui_SetModUISizeVertExpansion(float afNeg, float afPos) </code> <span class='np_break'> </span> Expands (or contracts, use negative values) the size of the UI Pos size vertically. Use this to make a small UI element reachable with keyboard/gamepad movement, but by making the UI box line up with the other widgets. Turn on the debug feature Draw GUI debug to see the boxes. —- == ImGui_SetModUseInput == <code c++> void ImGui_SetModUseInput(bool abX) </code> <span class='np_break'> </span> Sets if the widgets below should use any input. Default: true —- == ImGui_SetModRotateAngle == <code c++> void ImGui_SetModRotateAngle(float afX) </code> <span class='np_break'> </span> Sets the rotatation angle for any widgets below. Default: 0. Applies to ImGui_DrawGfx too —- == ImGui_SetModRotateCustomPivot == <code c++> void ImGui_SetModRotateCustomPivot(bool abX) </code> <span class='np_break'> </span> Sets if a custom pivot should be used for widget below when rotating. Default: false. Applies to ImGui_DrawGfx too —- == ImGui_SetModRotatePivot == <code c++> void ImGui_SetModRotatePivot(const cVector2f &in avPivot) </code> <span class='np_break'> </span> Sets the custom pivot used for widget below when rotating. Default: false. Applies to ImGui_DrawGfx too ImGui_SetModRotateCustomPivot must be true for it to have effect. —- == ImGui_SetModGfx == <code c++> void ImGui_SetModGfx(const cImGuiGfx &in aGfx) </code> <span class='np_break'> </span> Sets an additional image to widgets below, only used by Buttons so far. Default _ckgedit_QUOT<u>ckgedit>. —- == ImGui_ResetModifiers == <code c++> void ImGui_ResetModifiers() </code> <span class='np_break'> </span> Resets all modifiers to default values. —- == ImGui_PushModifiers == <code c++> void ImGui_PushModifiers() </code> <span class='np_break'> </span> Saves the currently set modifiers on a stack. —- == ImGui_PopModifiers == <code c++> void ImGui_PopModifiers() </code> <span class='np_break'> </span> Reverts all SetMod* settings to the latest one pushed on the stack. —- == ImGui_PrevPressed == <code c++> bool ImGui_PrevPressed() </code> <span class='np_break'> </span> Checks if the previously defined widget is being pressed. —- == ImGui_PrevBecamePressed == <code c++> bool ImGui_PrevBecamePressed() </code> <span class='np_break'> </span> Checks if the previously defined widget just became pressed. —- == ImGui_PrevInFocus == <code c++> bool ImGui_PrevInFocus() </code> <span class='np_break'> </span> Checks if the previously defined widget is in focus. —- == ImGui_PrevPosition == <code c++> cVector3f ImGui_PrevPosition() </code> <span class='np_break'> </span> Gets the previously defined widget final position (might not be what is supplied as argument) —- == ImGui_PrevSize == <code c++> cVector2f ImGui_PrevSize() </code> <span class='np_break'> </span> Gets the previously defined widget final size (might not be what is supplied as argument) —- == ImGui_PrevBecameInFocus == <code c++> bool ImGui_PrevBecameInFocus() </code> <span class='np_break'> </span> Checks if the previously defined widget just became in focus. —- == ImGui_PrevWasInFocus == <code c++> bool ImGui_PrevWasInFocus() </code> <span class='np_break'> </span> Checks if the previously defined widget just lost focus —- == ImGui_PrevMouseOver == <code c++> bool ImGui_PrevMouseOver() </code> <span class='np_break'> </span> Checks if the previously defined widget has the mouse over it. —- == ImGui_PrevUpdated == <code c++> bool ImGui_PrevUpdated() </code> <span class='np_break'> </span> Checks if the previously defined widget's internal values was updated somehow. —- == ImGui_ClearPrevData == <code c++> void ImGui_ClearPrevData() </code> <span class='np_break'> </span> This resets any data retrieved by ImGui_Prev* to the default values. Mostly used when creating custom Widget types. —- == ImGui_GroupBegin == <code c++> void ImGui_GroupBegin(const cVector3f &in avPos, const cVector2f &in avSize=cVector2f_MinusOne, bool abClip=false) </code> <span class='np_break'> </span> Begins the definition of a group which all subsequent Widgets will be relative to. Must be ended with ImGui_GroupEnd Nested groups are possible * <b>avPos</b>: the position of the group (relative to any groups and layout already defined) * <b>avSize</b>: The size of the group. Mostly useful when adding groups in a layout or when clipping. * <b>abClip</b>: if the widgets inside the group should be clipped. —- == ImGui_GroupEnd == <code c++> void ImGui_GroupEnd() </code> <span class='np_break'> </span> Ends a group started with ImGui_GroupBegin —- == ImGui_GetCurrentGroupPos == <code c++> cVector3f ImGui_GetCurrentGroupPos() </code> <span class='np_break'> </span> —- == ImGui_GetCurrentGroupSize == <code c++> cVector2f ImGui_GetCurrentGroupSize() </code> <span class='np_break'> </span> —- == ImGui_LayoutBegin == <code c++> void ImGui_LayoutBegin(eImGuiLayout aType, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne, const cVector2f &in avSpacing=cVector2f_Zero) </code> <span class='np_break'> </span> Begins the definition of a layout which will affect the placement of all subsequence Widgets. Must be ended with ImGui_LayoutEnd Nested groups are possible * <b>aType</b>: the type of the layout. X=Align horizontally, Y=Align Vertically, XY=Align left to right and go down when widget does not fit width * <b>avPos</b>: the position of the layout. (relative to any groups and layout already defined) * <b>avSize</b>: the size of the group. Mostly useful for XY-type or when inside another layout. * <b>avSpacing</b>: spacing between the widgets in the layout. —- == ImGui_LayoutEnd == <code c++> void ImGui_LayoutEnd() </code> <span class='np_break'> </span> Ends a layout started with ImGui_LayoutBegin —- == ImGui_AddLayoutHorizontalSpace == <code c++> void ImGui_AddLayoutHorizontalSpace(float afWidth, float afHeight=0) </code> <span class='np_break'> </span> Adds a horizontal space in a layout. Height is useful in XY-type of layout. —- == ImGui_AddLayoutVerticalSpace == <code c++> void ImGui_AddLayoutVerticalSpace(float afHeight) </code> <span class='np_break'> </span> Adds a horizontal space in a layout —- == ImGui_AddItemStringW == <code c++> void ImGui_AddItemStringW(const tWString &in asStr) </code> <span class='np_break'> </span> Adds a string item to a list. Used by some widgets like MultiToggle and MultiSelect —- == ImGui_AddItemString == <code c++> void ImGui_AddItemString(const tString &in asStr) </code> <span class='np_break'> </span> Adds a string item to a list. Used by some widgets like MultiToggle and MultiSelect * <b>asStr</b>: The text to use, if ImGui_SetTransCategory _ckgedit_QUOT</u>ckgedit> the actual string is used, else it is taken form the current tranlation file —- == ImGui_AddItemStringList == <code c++> void ImGui_AddItemStringList(const tWString &in asStrList) </code> <span class='np_break'> </span> Adds many strings as single list. Seperate items by space or comma. —- == ImGui_AddItemGfx == <code c++> void ImGui_AddItemGfx(const cImGuiGfx &in aGfx) </code> <span class='np_break'> </span> Adds a gfx item to list. Used by some widgets like MultiToggle —- == ImGui_ClearItems == <code c++> void ImGui_ClearItems() </code> <span class='np_break'> </span> Clears all item list. Done automatically by widgets, so should mostly be used for custom widgets only. —- == ImGui_DoMouse == <code c++> void ImGui_DoMouse(const cImGuiGfx &in aGfx, const cVector3f &in avOffset=0, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draws the mouse. If not called and ShowMouseAutomatically the default mouse will be shown. * <b>aGfx</b>: the image to draw * <b>avOffset</b>: the offset in regards to the current mouse postion. * <b>avSize</b>: size of the mouse, if negative then size of image is used. —- == ImGui_DoButtonExt == <code c++> bool ImGui_DoButtonExt(const tString &in asName, const tString &in asText, const cImGuiButtonData &in aData, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Button Widget. Returns true if it became pressed. * <b>asName</b>: name of widger, must be unique. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT<u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>aData</b>: properties of the button * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoButton == <code c++> bool ImGui_DoButton(const tString &in asName, const tString &in asText, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Button Widget using default data. Returns true if it became pressed. * <b>asName</b>: name of widger, must be unique. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT</u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoRepeatButtonExt == <code c++> bool ImGui_DoRepeatButtonExt(const tString &in asName, const tString &in asText, const cImGuiButtonData &in aData, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Repeat Button Widget. Returns true while the button is pressed. * <b>asName</b>: name of widger, must be unique. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT<u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>aData</b>: properties of the button * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoRepeatButton == <code c++> bool ImGui_DoRepeatButton(const tString &in asName, const tString &in asText, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Repeat Button Widget using default data. Returns true while the button is pressed. * <b>asName</b>: name of widger, must be unique. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT</u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoToggleButtonExt == <code c++> bool ImGui_DoToggleButtonExt(const tString &in asName, const tString &in asText, bool abDefaultChecked, const cImGuiButtonData &in aData, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and does logic for a Toggle Button Widget. Returns true if button is toggled on else false. * <b>asName</b>: name of widger, must be unique. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT<u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>abDefaultChecked</b>: The default toggle value * <b>aData</b>: properties of the widget * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoToggleButton == <code c++> bool ImGui_DoToggleButton(const tString &in asName, const tString &in asText, bool abDefaultChecked, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Toggle Button Widget using default data. Returns true if button is toggled on else false. * <b>asName</b>: name of widger, must be unique. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT</u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>abDefaultChecked</b>: The default toggle value * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoSliderHorizontalExt == <code c++> float ImGui_DoSliderHorizontalExt(const tString &in asName, float afDefaultValue, float afMin, float afMax, float afStepSize, const cImGuiSliderData &in aData, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Horizontal Slider Widget. Returns the current value. * <b>asName</b>: name of widger, must be unique. * <b>afDefaultValue</b>: the default value used on the slider. * <b>afMin</b>: The default toggle value * <b>afMax</b>: The max value of the slider. * <b>afStepSize</b>: the steps the values will change if using keyboard/gamepad. * <b>aData</b>: properties for the widget. * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoSliderHorizontal == <code c++> float ImGui_DoSliderHorizontal(const tString &in asName, float afDefaultValue, float afMin, float afMax, float afStepSize=-1, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Horizontal Slider Widget using default data. Returns the current value. * <b>asName</b>: name of widger, must be unique. * <b>afDefaultValue</b>: the default value used on the slider. * <b>afMin</b>: The default toggle value * <b>afMax</b>: The max value of the slider. * <b>afStepSize</b>: the steps the values will change if using keyboard/gamepad. * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoSliderVerticalExt == <code c++> float ImGui_DoSliderVerticalExt(const tString &in asName, float afDefaultValue, float afMin, float afMax, float afStepSize, const cImGuiSliderData &in aData, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Vertical Slider Widget. Returns the current value. * <b>asName</b>: name of widger, must be unique. * <b>afDefaultValue</b>: the default value used on the slider. * <b>afMin</b>: The default toggle value * <b>afMax</b>: The max value of the slider. * <b>afStepSize</b>: the steps the values will change if using keyboard/gamepad. * <b>aData</b>: properties for the widget. * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoSliderVertical == <code c++> float ImGui_DoSliderVertical(const tString &in asName, float afDefaultValue, float afMin, float afMax, float afStepSize=-1, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Vertical Slider Widget using default data. Returns the current value. * <b>asName</b>: name of widger, must be unique. * <b>afDefaultValue</b>: the default value used on the slider. * <b>afMin</b>: The default toggle value * <b>afMax</b>: The max value of the slider. * <b>afStepSize</b>: the steps the values will change if using keyboard/gamepad. * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoLabelExt == <code c++> void ImGui_DoLabelExt(const tString &in asText, const cImGuiLabelData &in aData, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne, float afFontSizeMul=1) </code> <span class='np_break'> </span> Draw and do logic for a Label Widget. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT<u>ckgedit> the actual string is used, else the text string is taken from the translation file * <b>aData</b>: properties for the widget * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. * <b>afFontSizeMul</b>: Multiplier for font size —- == ImGui_DoLabel == <code c++> void ImGui_DoLabel(const tString &in asText, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne, float afFontSizeMul=1) </code> <span class='np_break'> </span> Draw and do logic for a Label Widget using default data. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT</u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. * <b>afFontSizeMul</b>: Multiplier for font size —- == ImGui_DoImage == <code c++> void ImGui_DoImage(const cImGuiGfx &in aGfxImage, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for an Image Widget * <b>aGfxImage</b>: graphics image displayed. * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the size of aGfxImage is used. —- == ImGui_DoImageCorrectAspect == <code c++> void ImGui_DoImageCorrectAspect(const cImGuiGfx &in aGfxImage, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for an Image Widget with the image's native aspect ratio, fitting it into the specified size. * <b>aGfxImage</b>: graphics image displayed. * <b>avPos</b>: Position of the rectangle that the image sgould fit into. Image will be centered in the rectangle. * <b>avSize</b>: Size of rectangle that the image should fit within. —- == ImGui_DoMultiToggleExt == <code c++> int ImGui_DoMultiToggleExt(const tString &in asName, int alDefaultSelectedItem, uint alColumnNum, const cVector2f &in avSpacing, const cImGuiButtonData &in aData, const cVector3f &in avPos, const cVector2f &in avSize) </code> <span class='np_break'> </span> Draw and do logic for a Multi Toggle Widget. Returns currently selected button. use ImGui_AddItem and/or ImGui_AddGfx to add text and/or images to the buttons in the grid. * <b>asName</b>: name of widger, must be unique. * <b>alDefaultSelectedItem</b>: default button to be active. * <b>alColumnNum</b>: number of buttons per row. * <b>avSpacing</b>: the spacing between the buttons * <b>aData</b>: properties for the buttons that make up the grid. * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget (negative not allowed) —- == ImGui_DoMultiToggle == <code c++> int ImGui_DoMultiToggle(const tString &in asName, int alDefaultSelectedItem, uint alColumnNum, const cVector2f &in avSpacing, const cVector3f &in avPos, const cVector2f &in avSize) </code> <span class='np_break'> </span> Draw and do logic for a Multi Toggle Widget using default button data. Returns currently selected button. use ImGui_AddItem and/or ImGui_AddGfx to add text and/or images to the buttons in the grid. * <b>asName</b>: name of widger, must be unique. * <b>alDefaultSelectedItem</b>: default button to be active. * <b>alColumnNum</b>: number of buttons per row. * <b>avSpacing</b>: the spacing between the buttons * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget (negative not allowed) —- == ImGui_DoCheckBoxExt == <code c++> bool ImGui_DoCheckBoxExt(const tString &in asName, const tString &in asText, bool abDefaultChecked, const cImGuiCheckBoxData &in aData, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Check Box Widget. Return if checked or not. * <b>asName</b>: name of widger, must be unique. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT<u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>abDefaultChecked</b>: the default state of the widget * <b>aData</b>: properties for the widget * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoCheckBox == <code c++> bool ImGui_DoCheckBox(const tString &in asName, const tString &in asText, bool abDefaultChecked, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Check Box Widget using default data. Return if checked or not. * <b>asName</b>: name of widger, must be unique. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT</u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>abDefaultChecked</b>: the default state of the widget * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoTextFrameExt == <code c++> float ImGui_DoTextFrameExt(const tString &in asText, const cVector2f &in avEdgeSpacing, float afRowSpace, float afStartRowOffset, const cImGuiTextFrameData &in aData, const cVector3f &in avPos, const cVector2f &in avSize) </code> <span class='np_break'> </span> Draw and do logic for a Text Frame Widget. Returns the number of rows (might be fractional) that does not fit the frame, useful when making scroll slider. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT<u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>avEdgeSpacing</b>: The spacing around the edges of the frame * <b>afRowSpace</b>: Space between the row * <b>afStartRowOffset</b>: The offset for when the first row begins (can be negative, which is useful for scrolling text) * <b>aData</b>: properties for the widget * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, (must be postive) —- == ImGui_DoTextFrame == <code c++> float ImGui_DoTextFrame(const tString &in asText, const cVector2f &in avEdgeSpacing, float afRowSpace, float afStartRowOffset, const cVector3f &in avPos, const cVector2f &in avSize) </code> <span class='np_break'> </span> Draw and do logic for a Text Frame Widget using default data. Returns the number of rows (might be fractional) that does not fit the frame, useful when making scroll slider. * <b>asText</b>: The text to display, if ImGui_SetTransCategory _ckgedit_QUOT</u>ckgedit> the actual string is used, else it is taken form the current tranlation file * <b>avEdgeSpacing</b>: The spacing around the edges of the frame * <b>afRowSpace</b>: Space between the row * <b>afStartRowOffset</b>: The offset for when the first row begins (can be negative, which is useful for scrolling text) * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, (must be postive) —- == ImGui_DoMultiSelectExt == <code c++> int ImGui_DoMultiSelectExt(const tString &in asName, int alDefaultSelectedItem, const cImGuiMultiSelectData &in aData, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Multi Select Widget. Returns currently selected item. use ImGui_AddItem* to add selection options. * <b>asName</b>: name of widger, must be unique. * <b>alDefaultSelectedItem</b>: the default state of the widget * <b>aData</b>: properties for the widget * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoMultiSelect == <code c++> int ImGui_DoMultiSelect(const tString &in asName, int alDefaultSelectedItem, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a Multi Select Widget using default data. Returns currently selected item. use ImGui_AddItem* to add selection options. * <b>asName</b>: name of widger, must be unique. * <b>alDefaultSelectedItem</b>: the default state of the widget * <b>aData</b>: properties for the widget * <b>avPos</b>: Position of the widget (will be relative if gruoup or layout is declared) * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_DoWindowStart == <code c++> void ImGui_DoWindowStart(const tString &in asCaption, const cImGuiWindowData &in aData, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne, bool abClip=true, bool abForceCaptionFit=true) </code> <span class='np_break'> </span> Begins the definition of a Window which will affect the placement of all subsequence Widgets. Must be ended with ImGui_DoWindowEnd * <b>asCaption</b>: the window caption. * <b>aData</b>: properties for the widget. * <b>avPos</b>: position of the widget (will be relative if group or layout is declared). * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. * <b>abClip</b>: true = the window will clip any widgets declared between the window start and end that lie outside its boundaries - false = every widget will be drawn. * <b>abForceCaptionFit</b>: (?). —- == ImGui_DoWindowEnd == <code c++> void ImGui_DoWindowEnd() </code> <span class='np_break'> </span> Draw and do logic for a Window. Must be previously started with ImGui_DoWindowStart. —- == ImGui_DoGauge == <code c++> void ImGui_DoGauge(const cImGuiGaugeData &in aData, float afFillAmount, const cVector3f &in avPos=cVector3f_Zero, const cVector2f &in avSize=cVector2f_MinusOne) </code> <span class='np_break'> </span> Draw and do logic for a gauge (progress bar). * <b>aData</b>: properties for the widget. * <b>afFillAmount</b>: Value in the [0,1] range that sets how full the bar will be drawn * <b>avPos</b>: position of the widget (will be relative if group or layout is declared). * <b>avSize</b>: Size of widget, if negative the default size declared in data is used. —- == ImGui_SetDefaultButton == <code c++> void ImGui_SetDefaultButton(const cImGuiButtonData &in aData) </code> <span class='np_break'> </span> —- == ImGui_GetDefaultButton == <code c++> cImGuiButtonData ImGui_GetDefaultButton() </code> <span class='np_break'> </span> —- == ImGui_SetDefaultSliderHorizontal == <code c++> void ImGui_SetDefaultSliderHorizontal(const cImGuiSliderData &in aData) </code> <span class='np_break'> </span> —- == ImGui_GetDefaultSliderHorizontal == <code c++> cImGuiSliderData ImGui_GetDefaultSliderHorizontal() </code> <span class='np_break'> </span> —- == ImGui_SetDefaultSliderVertical == <code c++> void ImGui_SetDefaultSliderVertical(const cImGuiSliderData &in aData) </code> <span class='np_break'> </span> —- == ImGui_GetDefaultSliderVertical == <code c++> cImGuiSliderData ImGui_GetDefaultSliderVertical() </code> <span class='np_break'> </span> —- == ImGui_SetDefaultLabel == <code c++> void ImGui_SetDefaultLabel(const cImGuiLabelData &in aData) </code> <span class='np_break'> </span> —- == ImGui_GetDefaultLabel == <code c++> cImGuiLabelData ImGui_GetDefaultLabel() </code> <span class='np_break'> </span> —- == ImGui_SetDefaultCheckBox == <code c++> void ImGui_SetDefaultCheckBox(const cImGuiCheckBoxData &in aData) </code> <span class='np_break'> </span> —- == ImGui_GetDefaultCheckBox == <code c++> cImGuiCheckBoxData ImGui_GetDefaultCheckBox() </code> <span class='np_break'> </span> —- == ImGui_SetDefaultTextFrame == <code c++> void ImGui_SetDefaultTextFrame(const cImGuiTextFrameData &in aData) </code> <span class='np_break'> </span> —- == ImGui_GetDefaultTextFrame == <code c++> cImGuiTextFrameData ImGui_GetDefaultTextFrame() </code> <span class='np_break'> </span> —- == ImGui_SetDefaultMultiSelect == <code c++> void ImGui_SetDefaultMultiSelect(const cImGuiMultiSelectData &in aData) </code> <span class='np_break'> </span> —- == ImGui_GetDefaultMultiSelect == <code c++> cImGuiMultiSelectData ImGui_GetDefaultMultiSelect() </code> <span class='np_break'> </span> —- == ImGui_SetDefaultMouse == <code c++> void ImGui_SetDefaultMouse(const cImGuiGfx &in aGfx) </code> <span class='np_break'> </span> —- == ImGui_SetDefaultFont == <code c++> void ImGui_SetDefaultFont(const cImGuiFont &in aFont) </code> <span class='np_break'> </span> —- == ImGui_GetName == <code c++> tString ImGui_GetName() </code> <span class='np_break'> </span> Get name of the ImGui —- == ImGui_SetShowMouseAutomatically == <code c++> void ImGui_SetShowMouseAutomatically(bool abX) </code> <span class='np_break'> </span> Set if default mouse should be drawn if not rendered with DoMouse —- == ImGui_GetShowMouseAutomatically == <code c++> bool ImGui_GetShowMouseAutomatically() </code> <span class='np_break'> </span> Get if default mouse should be drawn if not rendered with DoMouse —- == ImGui_IsFirstRun == <code c++> bool ImGui_IsFirstRun() </code> <span class='np_break'> </span> Get if this is the first update for the ImGui —- == ImGui_GetTimeStep == <code c++> float ImGui_GetTimeStep() </code> <span class='np_break'> </span> Get the current timestep —- == ImGui_GetTimeCount == <code c++> float ImGui_GetTimeCount() </code> <span class='np_break'> </span> Get the time that has passed since first run. —- == ImGui_GetMouseVisible == <code c++> bool ImGui_GetMouseVisible() </code> <span class='np_break'> </span> Get if the mouse is currently visible —- == ImGui_DrawLine == <code c++> void ImGui_DrawLine(const cVector2f &in avStart, const cVector2f &in avEnd, float afZ, float afThickness=1.0f, const cColor &in aCol=cColor_White) </code> <span class='np_break'> </span> Draw a line between two positions. Is not affected by Layout or Group. * <b>avStart</b>: start position. * <b>avEnd</b>: end position. * <b>afZ</b>: the z value * <b>afThickness</b>: the thicnkess of the line * <b>aCol</b>: color of the line —- == ImGui_DrawLineExt == <code c++> void ImGui_DrawLineExt(const cVector2f &in avStart, const cVector2f &in avEnd, float afZ, float afThickness, const cColor &in aCol, const cImGuiGfx &in aGfx) </code> <span class='np_break'> </span> Draw a line between two positions. Is not affected by Layout or Group. * <b>avStart</b>: start position. * <b>avEnd</b>: end position. * <b>afZ</b>: the z value * <b>afThickness</b>: the thicnkess of the line * <b>aCol</b>: color of the line * <b>aGfx</b>: an Image streched across the line. It is aligned horizontally. —- == ImGui_AddLineStripVertex == <code c++> void ImGui_AddLineStripVertex(const cVector2f &in avVertex) </code> <span class='np_break'> </span> Add a vertex to a line strip for drawing. Is not affected by Layout or Group. * <b>avVertex</b>: line vertex. —- == ImGui_AddLineStripNrmVertex == <code c++> void ImGui_AddLineStripNrmVertex(const cVector2f &in avVertex) </code> <span class='np_break'> </span> Add a vertex to a line strip for drawing in normalized coords. Is not affected by Layout or Group. * <b>avVertex</b>: line vertex. —- == ImGui_DrawAndClearLineStrip == <code c++> void ImGui_DrawAndClearLineStrip(float afZ, float afThickness, const cColor &in aCol=cColor_White, const cImGuiGfx &in aGfx=cImGuiGfx()) </code> <span class='np_break'> </span> Draws and clears the current line strip set up through AddLineStripVertex. Is not affected by Layout or Group. * <b>afZ</b>: Z coord for the line. * <b>afThickness</b>: the thicnkess of the line * <b>aCol</b>: Color multiplier * <b>aGfx</b>: the gfx used for a line segment —- == ImGui_DrawGfx == <code c++> void ImGui_DrawGfx(const cImGuiGfx &in aGfx, const cVector3f &in avPos, const cVector2f &in avSize=cVector2f_MinusOne, const cColor &in aCol=cColor_White) </code> <span class='np_break'> </span> Draw an image. Is not affected by Alignment, Layout or Group. * <b>aGfx</b>: the image to be displayed * <b>avPos</b>: The position of the images upper left corner. * <b>avSize</b>: The size of the image, if negative then size of aGfx is used. * <b>aCol</b>: Color multiplier —- == ImGui_DrawAlignedGfx == <code c++> void ImGui_DrawAlignedGfx(const cImGuiGfx &in aGfx, const cVector3f &in avPos, eImGuiAlign aAlignment, const cVector2f &in avSize=cVector2f_MinusOne, const cColor &in aCol=cColor_White) </code> <span class='np_break'> </span> Draw an aligned image. Is not affected by Alignment, Layout or Group. * <b>aGfx</b>: the image to be displayed * <b>avPos</b>: The position of the pivot the image will be aligned to. * <b>aAlignment</b>: Alignment mode * <b>avSize</b>: The size of the image, if negative then size of aGfx is used. * <b>aCol</b>: Color multiplier —- == ImGui_DrawFontW == <code c++> void ImGui_DrawFontW(const tWString &in asText, const cImGuiFont &in aFont, const cVector3f &in avPos, eFontAlign aAlign, const cVector2f &in avSizeMul=1, const cColor &in aColMul=1.0f) </code> <span class='np_break'> </span> Draw font. Is not affected by Alignment, Layout or Group. * <b>asText</b>: the text to be displayed. * <b>aFont</b>: the font to displayed the text with * <b>avPos</b>: The position of the images upper right corner. * <b>aAlign</b>: The alignment of the text. * <b>avSizeMul</b>: A size multiplier for the text. * <b>aColMul</b>: Color multiplier —- == ImGui_DrawFontW == <code c++> void ImGui_DrawFontW(const tString &in asText, const cImGuiFont &in aFont, const cVector3f &in avPos, eFontAlign aAlign, const cVector2f &in avSizeMul=1, const cColor &in aColMul=1.0f) </code> <span class='np_break'> </span> Draw font. Is not affected by Alignment, Layout or Group. * <b>asText</b>: the text to be displayed. * <b>aFont</b>: the font to displayed the text with * <b>avPos</b>: The position of the images upper right corner. * <b>aAlign</b>: The alignment of the text. * <b>avSizeMul</b>: A size multiplier for the text. * <b>aColMul</b>: Color multiplier —- == ImGui_DrawFrame == <code c++> void ImGui_DrawFrame(const cImGuiFrameGfx &in aGfx, const cVector3f &in avPos, const cVector2f &in avSize=cVector2f_MinusOne, const cColor &in aCol=cColor_White) </code> <span class='np_break'> </span> Draw frame. Is not affected by Alignment, Layout or Group. * <b>aGfx</b>: The * <b>avPos</b>: The position of the frame's upper left corner. * <b>avSize</b>: Size of the frame to draw. * <b>aCol</b>: Color multiplier —- == CheckCurrentWidgetBecamePressed == <code c++> bool CheckCurrentWidgetBecamePressed(const tString &in asName, bool abCheckConfirm, bool abCheckMouseLeft) </code> <span class='np_break'> </span> Check if a widget has been just pressed by confirm and/or mouse, sets internal vars for this too —- == CheckCurrentWidgetIsPressed == <code c++> bool CheckCurrentWidgetIsPressed(const tString &in asName, bool abCheckConfirm, bool abCheckMouseLeft) </code> <span class='np_break'> </span> Check if a widget is being pressed by confirm and/or mouse, sets internal vars for this too —- == CheckIsPressedAction == <code c++> bool CheckIsPressedAction(bool abCheckConfirm, bool abCheckMouseLeft) </code> <span class='np_break'> </span> Quick way to check if confirm and/or mouse was just pressed. —- == CheckBecamePressedAction == <code c++> bool CheckBecamePressedAction(bool abCheckConfirm, bool abCheckMouseLeft) </code> <span class='np_break'> </span> Quick way to check if confirm and/or mouse is being pressed. —- == GetDefaultOrCurrentInt == <code c++> int GetDefaultOrCurrentInt(uint64 alDefaultVarId, uint64 alCurrentVarId, int alDefaultValue) </code> <span class='np_break'> </span> Gets the int value from the CurrentVar, if the value in default equals alDefaultVarId, else alDefaultVarId is returned. Used as a helper to have default param values. —- == GetDefaultOrCurrentFloat == <code c++> float GetDefaultOrCurrentFloat(uint64 alDefaultVarId, uint64 alCurrentVarId, float afDefaultValue) </code> <span class='np_break'> </span> Gets the float value from the CurrentVar, if the value in default equals alDefaultVarId, else alDefaultVarId is returned. Used as a helper to have default param values. —- == LockMouseFocus == <code c++> void LockMouseFocus() </code> <span class='np_break'> </span> When this is called, the focus will not change during this or the next update. —- == MouseFocusIsLocked == <code c++> bool MouseFocusIsLocked() </code> <span class='np_break'> </span> See if mouse is locked —- == CalcWidgetSize == <code c++> cVector2f CalcWidgetSize(const cVector2f &in avArgSize, const cVector2f &in avDefaultSize) </code> <span class='np_break'> </span> If an element in ArgSize is negative, the output for the element will have the value of DefaultSize instead. —- == SetupWidgetRect == <code c++> void SetupWidgetRect(const cVector3f &in avInPos, const cVector2f &in avInSize, cVector3f &out avOutPos, cVector2f &out avOutSize, const cVector2f &in avDefaultSize, const cImGuiGfx &in aGfx) </code> <span class='np_break'> </span> Gets the final postion and size for a widget taking into account aligntment, groups, layout, etc. —- == GetUsedGfxSize == <code c++> cVector2f GetUsedGfxSize(const cImGuiGfx &in aGfx, const cVector2f &in avCustomSize) </code> <span class='np_break'> </span> Get the size of a graphics by using axis value of aGfx instead of custom, if the custom value is negative. —- == GetGfxSize == <code c++> cVector2f GetGfxSize(const cImGuiGfx &in aGfx) </code> <span class='np_break'> </span> Get the size of a gfx. —- == GetFontLengthW == <code c++> float GetFontLengthW(const cImGuiFont &in aFont, float afSizeMul, const tWString &in asText) </code> <span class='np_break'> </span> Get the length that a string will be given a certain font. —- == GetFontLengthW == <code c++> float GetFontLengthW(const cImGuiFont &in aFont, float afSizeMul, const tString &in asText) </code> <span class='np_break'> </span> Get the length that a string will be given a certain font. —- == GetFontWordWrapRows == <code c++> void GetFontWordWrapRows(const cImGuiFont &in aFont, float afSizeMul, const tString &in asText, float afLineWidth, array< tWString > &out avLines) </code> <span class='np_break'> </span> Get an array containing each line of a text using word wrap. —- == GetFontWordWrapRowsW == <code c++> void GetFontWordWrapRowsW(const cImGuiFont &in aFont, float afSizeMul, const tWString &in asText, float afLineWidth, array< tWString > &out avLines) </code> <span class='np_break'> </span> Get an array containing each line of a text using word wrap. —- == ImGui_ResizeFontToFit == <code c++> float ImGui_ResizeFontToFit(const tString &in asText, cImGuiFont &aFont, float afMaxWidth=-1, float afSizeMultiplier=1.0f) </code> <span class='np_break'> </span> Modifies the size of the font so that it will fit within the specified width. —- == ImGui_ResizeFontToFit == <code c++> float ImGui_ResizeFontToFit(const tWString &in asText, cImGuiFont &aFont, float afMaxWidth=-1, float afSizeMultiplier=1.0f) </code> <span class='np_break'> </span> Modifies the size of the font so that it will fit within the specified width. —- == CheckMouseOver == <code c++> bool CheckMouseOver(const cVector3f &in avPos, const cVector2f &in avSize) </code> <span class='np_break'> </span> Check if mouse if over a certain rect. This will take rotation into account. —- == GetIdFromNameAndCheckCollision == <code c++> uint64 GetIdFromNameAndCheckCollision(const tString &in asName, int alTableIdx) </code> <span class='np_break'> </span> This gets the id for a name while also checking for hash collision. Used when you want get ids directly. Table index is the type of id you want: 0: gfx, 1: font, 2: widget, 3: state var —- == ImGui_DrawReadableBackground == <code c++> void ImGui_DrawReadableBackground(cVector3f vPos, cVector2f vSize, float fAlpha) </code> <span class='np_break'> </span> —- == ImGui_DrawReadableLabel == <code c++> void ImGui_DrawReadableLabel(const tString &in asText, cVector3f vPos, cVector2f vSize, float fAlpha, cColor aColor=cColor(1, 1, 1), float afFontSize=20.0f) </code> <span class='np_break'> </span> —- == ImGui_DrawReadableTextFrame == <code c++> void ImGui_DrawReadableTextFrame(const tString &in asText, cVector3f vPos, cVector2f vSize, float fAlpha, cColor aColor=cColor(1, 1, 1), float afFontSize=20.0f) </code> <span class='np_break'> </span> —- == ImGui_PreloadImage == <code c++> void ImGui_PreloadImage(const tString &in asFile, eImGuiGfx aType=eImGuiGfx_Image) </code> <span class='np_break'> </span> Preloads an image * <b>asFile</b>: image file to preload * <b>aType</b>: Type of the image —- == Gui_CreateCameraTexture == <code c++> void Gui_CreateCameraTexture(tString asName, cVector2l avSize, uint alFrameRate, float afFOV, float afNearPlane, float afFarPlane) </code> <span class='np_break'> </span> asName, Name of the special texture avSize, Resolution of the camera alFrameRatem, Frame rate of the camera, never higher than the games frame rate afFOV, Field of view afNearPlane, Near plane used for culling afFarPlane, Max distance the camera can render, lower = faster! —- == Gui_DestroyCameraTexture == <code c++> void Gui_DestroyCameraTexture(tString asName) </code> <span class='np_break'> </span> Destroys camera texture —- == Gui_SetCameraTextureMatrix == <code c++> void Gui_SetCameraTextureMatrix(tString asName, cMatrixf a_mtxCamera) </code> <span class='np_break'> </span> Use a matrix to set the location and rotation of the camera —- == Gui_AttachCameraTextureToEntity == <code c++> void Gui_AttachCameraTextureToEntity(tString asName, tString asEntity) </code> <span class='np_break'> </span> asName, Name of the texture asEntity, Name of the entity to attach to, works with CameraAnimationAreas! —- </p> </div>