HPL3/Amnesia: Rebirth/Scripting/cImGui

From Frictional Wiki
Jump to navigation Jump to search

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Contents

Fields

cImGui has no public fields.

Functions

Return Type Function And Description
bool ActionIsDown(eImGuiAction aAction, bool abCheckIfUsed = false)
bool ActionTriggered(eImGuiAction aAction, bool abCheckIfUsed = false)
void AddItemGfx(const cImGuiGfx &in aGfx)
void AddItemString(const tWString &in asStr)
void AddItemStringList(const tWString &in asStrList)
void AddLayoutHorizontalSpace(float afWidth, float afHeight = 0)
void AddLayoutVerticalSpace(float afHeight)
void AddLineStripVertex(const cVector2f &in avVertex)
void AddTimer(const tString &in asName, float afTime)
void Begin(float afTimeStep)
cVector2f CalcWidgetSize(const cVector2f &in avArgSize, const cVector2f &in avDefaultSize)
bool CheckBecamePressedAction(bool abCheckConfirm, bool abCheckMouseLeft)
bool CheckCurrentWidgetBecamePressed(const tString &in asName, bool abCheckConfirm, bool abCheckMouseLeft)
bool CheckCurrentWidgetIsPressed(const tString &in asName, bool abCheckConfirm, bool abCheckMouseLeft)
bool CheckIsPressedAction(bool abCheckConfirm, bool abCheckMouseLeft)
bool CheckMouseHasMoved()
bool CheckMouseOver(const cVector3f &in avPos, const cVector2f &in avSize)
void ClearItems()
void ClearPrevData()
void ClearStates()
void ClipAreaBegin(const cVector3f &in avPos, const cVector2f &in avSize)
void ClipAreaEnd()
void DestroyAssets()
bool DoButton(const tString &in asName, const tWString &in asText, const cImGuiButtonData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
bool DoButton(const tString &in asName, const tWString &in asText, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
bool DoCheckBox(const tString &in asName, const tWString &in asText, bool abDefaultChecked, const cImGuiCheckBoxData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
bool DoCheckBox(const tString &in asName, const tWString &in asText, bool abDefaultChecked, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
void DoFrame(const cImGuiFrameData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
void DoFrame(const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
void DoGauge(const cImGuiGaugeData &in aData, float afFillAmount, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
void DoGauge(float afFillAmount, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
void DoImage(const cImGuiGfx &in aGfxImage, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
void DoLabel(const tWString &in asText, const cImGuiLabelData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1, float afFontSizeMul = 1)
void DoLabel(const tWString &in asText, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1, float afFontSizeMul = 1)
void DoMouse(const cImGuiGfx &in aGfx, const cVector3f &in avOffset = 0, const cVector2f &in avSize = -1)
int DoMultiSelect(const tString &in asName, int alDefaultSelectedItem, const cImGuiMultiSelectData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
int DoMultiSelect(const tString &in asName, int alDefaultSelectedItem, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
int DoMultiToggle(const tString &in asName, int alDefaultSelectedItem, uint alColumnNum, const cVector2f &in avSpacing, const cImGuiButtonData &in aData, const cVector3f &in avPos, const cVector2f &in avSize)
int DoMultiToggle(const tString &in asName, int alDefaultSelectedItem, uint alColumnNum, const cVector2f &in avSpacing, const cVector3f &in avPos, const cVector2f &in avSize)
bool DoRepeatButton(const tString &in asName, const tWString &in asText, const cImGuiButtonData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
bool DoRepeatButton(const tString &in asName, const tWString &in asText, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
float DoSliderHorizontal(const tString &in asName, float afDefaultValue, float afMin, float afMax, float afStepSize, const cImGuiSliderData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
float DoSliderHorizontal(const tString &in asName, float afDefaultValue, float afMin, float afMax, float afStepSize = -1, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
float DoSliderVertical(const tString &in asName, float afDefaultValue, float afMin, float afMax, float afStepSize, const cImGuiSliderData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
float DoSliderVertical(const tString &in asName, float afDefaultValue, float afMin, float afMax, float afStepSize = -1, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
float DoTextFrame(const tWString &in asText, const cVector2f &in avEdgeSpacing, float afRowSpace, float afStartRowOffset, const cImGuiTextFrameData &in aData, const cVector3f &in avPos, const cVector2f &in avSize)
float DoTextFrame(const tWString &in asText, const cVector2f &in avEdgeSpacing, float afRowSpace, float afStartRowOffset, const cVector3f &in avPos, const cVector2f &in avSize)
bool DoToggleButton(const tString &in asName, const tWString &in asText, bool abDefaultChecked, const cImGuiButtonData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
bool DoToggleButton(const tString &in asName, const tWString &in asText, bool abDefaultChecked, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1)
void DoWindowEnd()
void DoWindowStart(const tWString &in asCaption, const cImGuiWindowData &in aData, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1, bool abClip = true)
void DoWindowStart(const tWString &in asCaption, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1, bool abClip = true)
void DrawAlignedGfx(const cImGuiGfx &in aGfx, const cVector3f &in avPos, eImGuiAlign aAlignment, const cVector2f &in avSize = -1, const cColor &in aCol = cColor, ../ 1, ../ 1, const cColor &in aColTopLeft = cColor, ../ 1, ../ 1, const cColor &in aColTopRight = cColor, ../ 1, ../ 1, const cColor &in aColBotRight = cColor, ../ 1, ../ 1, const cColor &in aColBotLeft = cColor, ../ 1, ../ 1)
void DrawAll()
void DrawAndClearLineStrip(float afZ, float afThickness, const cColor &in aCol = cColor_White, const cImGuiGfx &in aGfx = cImGuiGfx)
void DrawFont(const tWString &in asText, const cImGuiFont &in aFont, const cVector3f &in avPos, eFontAlign aAlign, const cVector2f &in avSizeMul = 1, const cColor &in aColMul = cColor, ../ 1, ../ 1)
void DrawFrame(const cImGuiFrameGfx &in aGfx, const cVector3f &in avPos, const cVector2f &in avSize = -1, const cColor &in aCol = cColor, ../ 1, ../ 1)
void DrawGfx(const cImGuiGfx &in aGfx, const cVector3f &in avPos, const cVector2f &in avSize = -1, const cColor &in aCol = cColor, ../ 1, ../ 1, const cColor &in aColTopLeft = cColor, ../ 1, ../ 1, const cColor &in aColTopRight = cColor, ../ 1, ../ 1, const cColor &in aColBotRight = cColor, ../ 1, ../ 1, const cColor &in aColBotLeft = cColor, ../ 1, ../ 1)
void DrawLine(const cVector2f &in avStart, const cVector2f &in avEnd, float afZ, float afThickness = 1.0f, const cColor &in aCol = cColor, ../ 1, ../ 1, const cImGuiGfx &in aGfx = cImGuiGfx)
void End()
cColor FadeOscillateColor(const tString &in asVarName, const cColor &in aStart, const cColor &in aGoal, float afTime, eEasing aType = eEasing_QuadInOut)
float FadeOscillateFloat(const tString &in asVarName, float afStart, float afGoal, float afTime, eEasing aType = eEasing_QuadInOut)
cVector3f FadeOscillateVector3f(const tString &in asVarName, const cVector3f &in avStart, const cVector3f &in avGoal, float afTime, eEasing aType = eEasing_QuadInOut)
bool FadeOver(const tString &in asVarName)
void FadeStateColor(const tString &in asVarName, const cColor &in aGoalVal, float afTime, eEasing aType = eEasing_QuadInOut, bool abReplaceIfExist = true)
void FadeStateFloat(const tString &in asVarName, float afGoalVal, float afTime, eEasing aType = eEasing_QuadInOut, bool abReplaceIfExist = true)
void FadeStateVector3f(const tString &in asVarName, const cVector3f &in avGoalVal, float afTime, eEasing aType = eEasing_QuadInOut, bool abReplaceIfExist = true)
cVector3f GetCurrentGroupPos()
cVector2f GetCurrentGroupSize()
cImGuiButtonData GetDefaultButton()
cImGuiCheckBoxData GetDefaultCheckBox()
cImGuiFrameData GetDefaultFrame()
cImGuiGaugeData GetDefaultGauge()
cImGuiLabelData GetDefaultLabel()
cImGuiMultiSelectData GetDefaultMultiSelect()
float GetDefaultOrCurrentFloat(uint64 alDefaultVarId, uint64 alCurrentVarId, float afDefaultValue)
int GetDefaultOrCurrentInt(uint64 alDefaultVarId, uint64 alCurrentVarId, int alDefaultValue)
cImGuiSliderData GetDefaultSliderHorizontal()
cImGuiSliderData GetDefaultSliderVertical()
cImGuiTextFrameData GetDefaultTextFrame()
cImGuiWindowData GetDefaultWindow()
float GetFontLength(const cImGuiFont &in aFont, float afSizeMul, const tWString &in asText)
void GetFontWordWrapRows(const cImGuiFont &in aFont, float afSizeMul, const tWString &in asText, float afLineWidth, array<tWString> avLines, array<bool> avRowEndedWithNewLine = array<bool>)
cVector2f GetGfxSize(const cImGuiGfx &in aGfx)
uint64 GetIdFromNameAndCheckCollision(const tString &in asName, int alTableIdx)
bool GetModUseInput()
cVector2f GetMousePosition()
cVector3f GetMousePosition3D()
cVector2f GetMouseRel()
cVector3f GetMouseRel3D()
tString GetName()
cGuiSet GetSet()
bool GetShowMouse()
bool GetShowMouseAutomatically()
cColor GetStateColor(uint64 alId, const cColor &in aDefault = cColor, ../ 1, ../ 1)
cColor GetStateColor(const tString &in asVarName, const cColor &in aDefault = cColor, ../ 1, ../ 1)
float GetStateFloat(uint64 alId, float afDefault = 0.0f)
float GetStateFloat(const tString &in asVarName, float afDefault = 0.0f)
int GetStateInt(uint64 alId, int alDefault = 0)
int GetStateInt(const tString &in asVarName, int alDefault = 0)
cVector3f GetStateVector3f(uint64 alId, const cVector3f &in avDefault = 0.0f)
cVector3f GetStateVector3f(const tString &in asVarName, const cVector3f &in avDefault = cVector3f, ../ 0.0f)
float GetTimeCount()
float GetTimeStep()
cVector2f GetUsedFontSize(const cImGuiFont &in aFont)
cVector2f GetUsedGfxSize(const cImGuiGfx &in aGfx, const cVector2f &in avCustomSize)
void GroupBegin(const cVector3f &in avPos, const cVector2f &in avSize = 0, bool abClip = false)
void GroupEnd()
void IncStateColor(uint64 alId, const cColor &in aVal)
void IncStateColor(const tString &in asVarName, const cColor &in aVal)
void IncStateFloat(uint64 alId, float afVal)
void IncStateFloat(const tString &in asVarName, float afVal)
void IncStateInt(uint64 alId, int alVal)
void IncStateInt(const tString &in asVarName, int alVal)
void IncStateVector3f(uint64 alId, const cVector3f &in avVal)
void IncStateVector3f(const tString &in asVarName, const cVector3f &in avVal)
bool IsFading(const tString &in asVarName)
bool IsFirstRun()
void LayoutBegin(eImGuiLayout aType, const cVector3f &in avPos = 0, const cVector2f &in avSize = -1, const cVector2f &in avSpacing = 0)
void LayoutEnd()
void LockMouseFocus()
bool MouseFocusIsLocked()
void PopModifiers()
bool PrevBecameInFocus()
bool PrevBecamePressed()
bool PrevInFocus()
bool PrevMouseOver()
cVector3f PrevPosition()
bool PrevPressed()
cVector2f PrevSize()
bool PrevUpdated()
bool PrevWasInFocus()
void PushModifiers()
bool RepeatTimer(const tString &in asName, float afTime)
void ResetModifiers()
void SendAction(eImGuiAction aAction, bool abDown, bool abTriggered)
void SendMousePosition(const cVector2l &in avPos, const cVector2l &in avRel)
void SendMouseVirtualPosition(const cVector2f &in avPos, const cVector2f &in avRel)
void SetAlignment(eImGuiAlign aAlign)
void SetDefaultButton(const cImGuiButtonData &in aData)
void SetDefaultCheckBox(const cImGuiCheckBoxData &in aData)
void SetDefaultFont(const cImGuiFont &in aFont)
void SetDefaultFrame(const cImGuiFrameData &in aData)
void SetDefaultGauge(const cImGuiGaugeData &in aData)
void SetDefaultLabel(const cImGuiLabelData &in aData)
void SetDefaultMouse(const cImGuiGfx &in aGfx, const cVector2f &in avSize = -1)
void SetDefaultMultiSelect(const cImGuiMultiSelectData &in aData)
void SetDefaultSliderHorizontal(const cImGuiSliderData &in aData)
void SetDefaultSliderVertical(const cImGuiSliderData &in aData)
void SetDefaultTextFrame(const cImGuiTextFrameData &in aData)
void SetDefaultWindow(const cImGuiWindowData &in aData)
void SetDrawUIDebugBoxes(bool abX)
void SetFocus(const tString &in asWidgetName)
void SetModColorMul(const cColor &in aCol)
void SetModGfx(const cImGuiGfx &in aGfx)
void SetModRotateAngle(float afX)
void SetModRotateCustomPivot(bool abX)
void SetModRotatePivot(const cVector2f &in avPivot)
void SetModTextColorMul(const cColor &in aCol)
void SetModUISizeHoriExpansion(float afNeg, float afPos)
void SetModUISizeVertExpansion(float afNeg, float afPos)
void SetModUseInput(bool abX)
void SetModUseUIPos(bool abX)
void SetMoveRepeatActive(bool abX)
float SetMoveRepeatSpeed(float fX)
void SetMoveRepeatStartDelay(float afX)
void SetShowMouse(bool abX)
void SetShowMouseAutomatically(bool abX)
void SetStateColor(uint64 alId, const cColor &in aVal)
void SetStateColor(const tString &in asVarName, const cColor &in aVal)
void SetStateFloat(uint64 alId, float afVal)
void SetStateFloat(const tString &in asVarName, float afVal)
void SetStateInt(uint64 alId, int alVal)
void SetStateInt(const tString &in asVarName, int alVal)
void SetStateVector3f(uint64 alId, const cVector3f &in avVal)
void SetStateVector3f(const tString &in asVarName, const cVector3f &in avVal)
void SetUIMoveGroupFlags(int alGroupFlags)
void SetUIMoveWrapMode(eImGuiWrap aWrap)
void SetUpAlignment(const cVector3f &in avPos, const cVector2f &in avSize, cVector3f &out avAlignedPos, eImGuiAlign aAlignment)
void SetupWidgetRect(const cVector3f &in avInPos, const cVector2f &in avInSize, cVector3f &out avOutPos, cVector2f &out avOutSize, const cVector2f &in avDefaultSize, const cImGuiGfx &in aGfx)
void StopFade(const tString &in asVarName)
void StopTimer(const tString &in asName)
bool TimerExists(const tString &in asName)
bool TimerOver(const tString &in asName)

Details

ActionIsDown

bool ActionIsDown(eImGuiAction aAction,
                  bool abCheckIfUsed = false)


Parameters

Returns:

  • bool

ActionTriggered

bool ActionTriggered(eImGuiAction aAction,
                     bool abCheckIfUsed = false)


Parameters

Returns:

  • bool

AddItemGfx

void AddItemGfx(const cImGuiGfx &in aGfx)


Parameters

Returns:

  • void

AddItemString

void AddItemString(const tWString &in asStr)


Parameters

Returns:

  • void

AddItemStringList

void AddItemStringList(const tWString &in asStrList)


Parameters

Returns:

  • void

AddLayoutHorizontalSpace

void AddLayoutHorizontalSpace(float afWidth,
                              float afHeight = 0)


Parameters

  • afWidth (float) —
  • afHeight (float) —

Returns:

  • void

AddLayoutVerticalSpace

void AddLayoutVerticalSpace(float afHeight)


Parameters

  • afHeight (float) —

Returns:

  • void

AddLineStripVertex

void AddLineStripVertex(const cVector2f &in avVertex)


Parameters

Returns:

  • void

AddTimer

void AddTimer(const tString &in asName,
              float afTime)


Parameters

  • asName (tString) —
  • afTime (float) —

Returns:

  • void

Begin

void Begin(float afTimeStep)


Parameters

  • afTimeStep (float) —

Returns:

  • void

CalcWidgetSize

cVector2f CalcWidgetSize(const cVector2f &in avArgSize,
                         const cVector2f &in avDefaultSize)


Parameters

Returns:

  • cVector2f

CheckBecamePressedAction

bool CheckBecamePressedAction(bool abCheckConfirm,
                              bool abCheckMouseLeft)


Parameters

  • abCheckConfirm (bool) —
  • abCheckMouseLeft (bool) —

Returns:

  • bool

CheckCurrentWidgetBecamePressed

bool CheckCurrentWidgetBecamePressed(const tString &in asName,
                                     bool abCheckConfirm,
                                     bool abCheckMouseLeft)


Parameters

  • asName (tString) —
  • abCheckConfirm (bool) —
  • abCheckMouseLeft (bool) —

Returns:

  • bool

CheckCurrentWidgetIsPressed

bool CheckCurrentWidgetIsPressed(const tString &in asName,
                                 bool abCheckConfirm,
                                 bool abCheckMouseLeft)


Parameters

  • asName (tString) —
  • abCheckConfirm (bool) —
  • abCheckMouseLeft (bool) —

Returns:

  • bool

CheckIsPressedAction

bool CheckIsPressedAction(bool abCheckConfirm,
                          bool abCheckMouseLeft)


Parameters

  • abCheckConfirm (bool) —
  • abCheckMouseLeft (bool) —

Returns:

  • bool

CheckMouseHasMoved

bool CheckMouseHasMoved()

Returns:

  • bool

CheckMouseOver

bool CheckMouseOver(const cVector3f &in avPos,
                    const cVector2f &in avSize)


Parameters

Returns:

  • bool

ClearItems

void ClearItems()

Returns:

  • void

ClearPrevData

void ClearPrevData()

Returns:

  • void

ClearStates

void ClearStates()

Returns:

  • void

ClipAreaBegin

void ClipAreaBegin(const cVector3f &in avPos,
                   const cVector2f &in avSize)


Parameters

Returns:

  • void

ClipAreaEnd

void ClipAreaEnd()

Returns:

  • void

DestroyAssets

void DestroyAssets()

Returns:

  • void

DoButton

bool DoButton(const tString &in asName,
              const tWString &in asText,
              const cImGuiButtonData &in aData,
              const cVector3f &in avPos = 0,
              const cVector2f &in avSize = -1)


Parameters

Returns:

  • bool

DoButton

bool DoButton(const tString &in asName,
              const tWString &in asText,
              const cVector3f &in avPos = 0,
              const cVector2f &in avSize = -1)


Parameters

Returns:

  • bool

DoCheckBox

bool DoCheckBox(const tString &in asName,
                const tWString &in asText,
                bool abDefaultChecked,
                const cImGuiCheckBoxData &in aData,
                const cVector3f &in avPos = 0,
                const cVector2f &in avSize = -1)


Parameters

Returns:

  • bool

DoCheckBox

bool DoCheckBox(const tString &in asName,
                const tWString &in asText,
                bool abDefaultChecked,
                const cVector3f &in avPos = 0,
                const cVector2f &in avSize = -1)


Parameters

Returns:

  • bool

DoFrame

void DoFrame(const cImGuiFrameData &in aData,
             const cVector3f &in avPos = 0,
             const cVector2f &in avSize = -1)


Parameters

Returns:

  • void

DoFrame

void DoFrame(const cVector3f &in avPos = 0,
             const cVector2f &in avSize = -1)


Parameters

Returns:

  • void

DoGauge

void DoGauge(const cImGuiGaugeData &in aData,
             float afFillAmount,
             const cVector3f &in avPos = 0,
             const cVector2f &in avSize = -1)


Parameters

Returns:

  • void

DoGauge

void DoGauge(float afFillAmount,
             const cVector3f &in avPos = 0,
             const cVector2f &in avSize = -1)


Parameters

Returns:

  • void

DoImage

void DoImage(const cImGuiGfx &in aGfxImage,
             const cVector3f &in avPos = 0,
             const cVector2f &in avSize = -1)


Parameters

Returns:

  • void

DoLabel

void DoLabel(const tWString &in asText,
             const cImGuiLabelData &in aData,
             const cVector3f &in avPos = 0,
             const cVector2f &in avSize = -1,
             float afFontSizeMul = 1)


Parameters

Returns:

  • void

DoLabel

void DoLabel(const tWString &in asText,
             const cVector3f &in avPos = 0,
             const cVector2f &in avSize = -1,
             float afFontSizeMul = 1)


Parameters

Returns:

  • void

DoMouse

void DoMouse(const cImGuiGfx &in aGfx,
             const cVector3f &in avOffset = 0,
             const cVector2f &in avSize = -1)


Parameters

Returns:

  • void

DoMultiSelect

int DoMultiSelect(const tString &in asName,
                  int alDefaultSelectedItem,
                  const cImGuiMultiSelectData &in aData,
                  const cVector3f &in avPos = 0,
                  const cVector2f &in avSize = -1)


Parameters

Returns:

  • int

DoMultiSelect

int DoMultiSelect(const tString &in asName,
                  int alDefaultSelectedItem,
                  const cVector3f &in avPos = 0,
                  const cVector2f &in avSize = -1)


Parameters

Returns:

  • int

DoMultiToggle

int DoMultiToggle(const tString &in asName,
                  int alDefaultSelectedItem,
                  uint alColumnNum,
                  const cVector2f &in avSpacing,
                  const cImGuiButtonData &in aData,
                  const cVector3f &in avPos,
                  const cVector2f &in avSize)


Parameters

Returns:

  • int

DoMultiToggle

int DoMultiToggle(const tString &in asName,
                  int alDefaultSelectedItem,
                  uint alColumnNum,
                  const cVector2f &in avSpacing,
                  const cVector3f &in avPos,
                  const cVector2f &in avSize)


Parameters

Returns:

  • int

DoRepeatButton

bool DoRepeatButton(const tString &in asName,
                    const tWString &in asText,
                    const cImGuiButtonData &in aData,
                    const cVector3f &in avPos = 0,
                    const cVector2f &in avSize = -1)


Parameters

Returns:

  • bool

DoRepeatButton

bool DoRepeatButton(const tString &in asName,
                    const tWString &in asText,
                    const cVector3f &in avPos = 0,
                    const cVector2f &in avSize = -1)


Parameters

Returns:

  • bool

DoSliderHorizontal

float DoSliderHorizontal(const tString &in asName,
                         float afDefaultValue,
                         float afMin,
                         float afMax,
                         float afStepSize,
                         const cImGuiSliderData &in aData,
                         const cVector3f &in avPos = 0,
                         const cVector2f &in avSize = -1)


Parameters

Returns:

  • float

DoSliderHorizontal

float DoSliderHorizontal(const tString &in asName,
                         float afDefaultValue,
                         float afMin,
                         float afMax,
                         float afStepSize = -1,
                         const cVector3f &in avPos = 0,
                         const cVector2f &in avSize = -1)


Parameters

  • asName (tString) —
  • afDefaultValue (float) —
  • afMin (float) —
  • afMax (float) —
  • afStepSize (float) —
  • avPos (cVector3f) —
  • avSize (cVector2f) —

Returns:

  • float

DoSliderVertical

float DoSliderVertical(const tString &in asName,
                       float afDefaultValue,
                       float afMin,
                       float afMax,
                       float afStepSize,
                       const cImGuiSliderData &in aData,
                       const cVector3f &in avPos = 0,
                       const cVector2f &in avSize = -1)


Parameters

Returns:

  • float

DoSliderVertical

float DoSliderVertical(const tString &in asName,
                       float afDefaultValue,
                       float afMin,
                       float afMax,
                       float afStepSize = -1,
                       const cVector3f &in avPos = 0,
                       const cVector2f &in avSize = -1)


Parameters

  • asName (tString) —
  • afDefaultValue (float) —
  • afMin (float) —
  • afMax (float) —
  • afStepSize (float) —
  • avPos (cVector3f) —
  • avSize (cVector2f) —

Returns:

  • float

DoTextFrame

float DoTextFrame(const tWString &in asText,
                  const cVector2f &in avEdgeSpacing,
                  float afRowSpace,
                  float afStartRowOffset,
                  const cImGuiTextFrameData &in aData,
                  const cVector3f &in avPos,
                  const cVector2f &in avSize)


Parameters

Returns:

  • float

DoTextFrame

float DoTextFrame(const tWString &in asText,
                  const cVector2f &in avEdgeSpacing,
                  float afRowSpace,
                  float afStartRowOffset,
                  const cVector3f &in avPos,
                  const cVector2f &in avSize)


Parameters

Returns:

  • float

DoToggleButton

bool DoToggleButton(const tString &in asName,
                    const tWString &in asText,
                    bool abDefaultChecked,
                    const cImGuiButtonData &in aData,
                    const cVector3f &in avPos = 0,
                    const cVector2f &in avSize = -1)


Parameters

Returns:

  • bool

DoToggleButton

bool DoToggleButton(const tString &in asName,
                    const tWString &in asText,
                    bool abDefaultChecked,
                    const cVector3f &in avPos = 0,
                    const cVector2f &in avSize = -1)


Parameters

Returns:

  • bool

DoWindowEnd

void DoWindowEnd()

Returns:

  • void

DoWindowStart

void DoWindowStart(const tWString &in asCaption,
                   const cImGuiWindowData &in aData,
                   const cVector3f &in avPos = 0,
                   const cVector2f &in avSize = -1,
                   bool abClip = true)


Parameters

Returns:

  • void

DoWindowStart

void DoWindowStart(const tWString &in asCaption,
                   const cVector3f &in avPos = 0,
                   const cVector2f &in avSize = -1,
                   bool abClip = true)


Parameters

Returns:

  • void

DrawAlignedGfx

void DrawAlignedGfx(const cImGuiGfx &in aGfx,
                    const cVector3f &in avPos,
                    eImGuiAlign aAlignment,
                    const cVector2f &in avSize = -1,
                    const cColor &in aCol = cColor,
                     1,
                     1,
                    const cColor &in aColTopLeft = cColor,
                     1,
                     1,
                    const cColor &in aColTopRight = cColor,
                     1,
                     1,
                    const cColor &in aColBotRight = cColor,
                     1,
                     1,
                    const cColor &in aColBotLeft = cColor,
                     1,
                     1)


Parameters

Returns:

  • void

DrawAll

void DrawAll()

Returns:

  • void

DrawAndClearLineStrip

void DrawAndClearLineStrip(float afZ,
                           float afThickness,
                           const cColor &in aCol = cColor_White,
                           const cImGuiGfx &in aGfx = cImGuiGfx)


Parameters

  • afZ (float) —
  • afThickness (float) —
  • aCol (cColor) —
  • aGfx (cImGuiGfx) —

Returns:

  • void

DrawFont

void DrawFont(const tWString &in asText,
              const cImGuiFont &in aFont,
              const cVector3f &in avPos,
              eFontAlign aAlign,
              const cVector2f &in avSizeMul = 1,
              const cColor &in aColMul = cColor,
               1,
               1)


Parameters

Returns:

  • void

DrawFrame

void DrawFrame(const cImGuiFrameGfx &in aGfx,
               const cVector3f &in avPos,
               const cVector2f &in avSize = -1,
               const cColor &in aCol = cColor,
                1,
                1)


Parameters

Returns:

  • void

DrawGfx

void DrawGfx(const cImGuiGfx &in aGfx,
             const cVector3f &in avPos,
             const cVector2f &in avSize = -1,
             const cColor &in aCol = cColor,
              1,
              1,
             const cColor &in aColTopLeft = cColor,
              1,
              1,
             const cColor &in aColTopRight = cColor,
              1,
              1,
             const cColor &in aColBotRight = cColor,
              1,
              1,
             const cColor &in aColBotLeft = cColor,
              1,
              1)


Parameters

Returns:

  • void

DrawLine

void DrawLine(const cVector2f &in avStart,
              const cVector2f &in avEnd,
              float afZ,
              float afThickness = 1.0f,
              const cColor &in aCol = cColor,
               1,
               1,
              const cImGuiGfx &in aGfx = cImGuiGfx)


Parameters

Returns:

  • void

End

void End()

Returns:

  • void

FadeOscillateColor

cColor FadeOscillateColor(const tString &in asVarName,
                          const cColor &in aStart,
                          const cColor &in aGoal,
                          float afTime,
                          eEasing aType = eEasing_QuadInOut)


Parameters

Returns:

  • cColor

FadeOscillateFloat

float FadeOscillateFloat(const tString &in asVarName,
                         float afStart,
                         float afGoal,
                         float afTime,
                         eEasing aType = eEasing_QuadInOut)


Parameters

  • asVarName (tString) —
  • afStart (float) —
  • afGoal (float) —
  • afTime (float) —
  • aType (eEasing) —

Returns:

  • float

FadeOscillateVector3f

cVector3f FadeOscillateVector3f(const tString &in asVarName,
                                const cVector3f &in avStart,
                                const cVector3f &in avGoal,
                                float afTime,
                                eEasing aType = eEasing_QuadInOut)


Parameters

Returns:

  • cVector3f

FadeOver

bool FadeOver(const tString &in asVarName)


Parameters

Returns:

  • bool

FadeStateColor

void FadeStateColor(const tString &in asVarName,
                    const cColor &in aGoalVal,
                    float afTime,
                    eEasing aType = eEasing_QuadInOut,
                    bool abReplaceIfExist = true)


Parameters

  • asVarName (tString) —
  • aGoalVal (cColor) —
  • afTime (float) —
  • aType (eEasing) —
  • abReplaceIfExist (bool) —

Returns:

  • void

FadeStateFloat

void FadeStateFloat(const tString &in asVarName,
                    float afGoalVal,
                    float afTime,
                    eEasing aType = eEasing_QuadInOut,
                    bool abReplaceIfExist = true)


Parameters

  • asVarName (tString) —
  • afGoalVal (float) —
  • afTime (float) —
  • aType (eEasing) —
  • abReplaceIfExist (bool) —

Returns:

  • void

FadeStateVector3f

void FadeStateVector3f(const tString &in asVarName,
                       const cVector3f &in avGoalVal,
                       float afTime,
                       eEasing aType = eEasing_QuadInOut,
                       bool abReplaceIfExist = true)


Parameters

  • asVarName (tString) —
  • avGoalVal (cVector3f) —
  • afTime (float) —
  • aType (eEasing) —
  • abReplaceIfExist (bool) —

Returns:

  • void

GetCurrentGroupPos

const cVector3f& GetCurrentGroupPos()

Returns:

  • const cVector3f&

GetCurrentGroupSize

const cVector2f& GetCurrentGroupSize()

Returns:

  • const cVector2f&

GetDefaultButton

const cImGuiButtonData& GetDefaultButton()

Returns:

  • const cImGuiButtonData&

GetDefaultCheckBox

const cImGuiCheckBoxData& GetDefaultCheckBox()

Returns:

  • const cImGuiCheckBoxData&

GetDefaultFrame

const cImGuiFrameData& GetDefaultFrame()

Returns:

  • const cImGuiFrameData&

GetDefaultGauge

const cImGuiGaugeData& GetDefaultGauge()

Returns:

  • const cImGuiGaugeData&

GetDefaultLabel

const cImGuiLabelData& GetDefaultLabel()

Returns:

  • const cImGuiLabelData&

GetDefaultMultiSelect

const cImGuiMultiSelectData& GetDefaultMultiSelect()

Returns:

  • const cImGuiMultiSelectData&

GetDefaultOrCurrentFloat

float GetDefaultOrCurrentFloat(uint64 alDefaultVarId,
                               uint64 alCurrentVarId,
                               float afDefaultValue)


Parameters

  • alDefaultVarId (uint64) —
  • alCurrentVarId (uint64) —
  • afDefaultValue (float) —

Returns:

  • float

GetDefaultOrCurrentInt

int GetDefaultOrCurrentInt(uint64 alDefaultVarId,
                           uint64 alCurrentVarId,
                           int alDefaultValue)


Parameters

  • alDefaultVarId (uint64) —
  • alCurrentVarId (uint64) —
  • alDefaultValue (int) —

Returns:

  • int

GetDefaultSliderHorizontal

const cImGuiSliderData& GetDefaultSliderHorizontal()

Returns:

  • const cImGuiSliderData&

GetDefaultSliderVertical

const cImGuiSliderData& GetDefaultSliderVertical()

Returns:

  • const cImGuiSliderData&

GetDefaultTextFrame

const cImGuiTextFrameData& GetDefaultTextFrame()

Returns:

  • const cImGuiTextFrameData&

GetDefaultWindow

const cImGuiWindowData& GetDefaultWindow()

Returns:

  • const cImGuiWindowData&

GetFontLength

float GetFontLength(const cImGuiFont &in aFont,
                    float afSizeMul,
                    const tWString &in asText)


Parameters

Returns:

  • float

GetFontWordWrapRows

void GetFontWordWrapRows(const cImGuiFont &in aFont,
                         float afSizeMul,
                         const tWString &in asText,
                         float afLineWidth,
                         tWString avLines,
                         bool avRowEndedWithNewLine = array<bool>)


Parameters

  • aFont (cImGuiFont) —
  • afSizeMul (float) —
  • asText (tWString) —
  • afLineWidth (float) —
  • avLines (tWString) —
  • avRowEndedWithNewLine (bool) —

Returns:

  • void

GetGfxSize

cVector2f GetGfxSize(const cImGuiGfx &in aGfx)


Parameters

Returns:

  • cVector2f

GetIdFromNameAndCheckCollision

uint64 GetIdFromNameAndCheckCollision(const tString &in asName,
                                      int alTableIdx)


Parameters

  • asName (tString) —
  • alTableIdx (int) —

Returns:

  • uint64

GetModUseInput

bool GetModUseInput()

Returns:

  • bool

GetMousePosition

const cVector2f& GetMousePosition()

Returns:

  • const cVector2f&

GetMousePosition3D

cVector3f GetMousePosition3D()

Returns:

  • cVector3f

GetMouseRel

const cVector2f& GetMouseRel()

Returns:

  • const cVector2f&

GetMouseRel3D

cVector3f GetMouseRel3D()

Returns:

  • cVector3f

GetName

const tString& GetName()

Returns:

  • const tString&

GetSet

cGuiSet@ GetSet()

Returns:

  • cGuiSet@

GetShowMouse

bool GetShowMouse()

Returns:

  • bool

GetShowMouseAutomatically

bool GetShowMouseAutomatically()

Returns:

  • bool

GetStateColor

cColor GetStateColor(uint64 alId,
                     const cColor &in aDefault = cColor,
                      1,
                      1)


Parameters

  • alId (uint64) —
  • aDefault (cColor) —
  • 1 (../) —
  • 1 (../) —

Returns:

  • cColor

GetStateColor

cColor GetStateColor(const tString &in asVarName,
                     const cColor &in aDefault = cColor,
                      1,
                      1)


Parameters

Returns:

  • cColor

GetStateFloat

float GetStateFloat(uint64 alId,
                    float afDefault = 0.0f)


Parameters

  • alId (uint64) —
  • afDefault (float) —

Returns:

  • float

GetStateFloat

float GetStateFloat(const tString &in asVarName,
                    float afDefault = 0.0f)


Parameters

  • asVarName (tString) —
  • afDefault (float) —

Returns:

  • float

GetStateInt

int GetStateInt(uint64 alId,
                int alDefault = 0)


Parameters

  • alId (uint64) —
  • alDefault (int) —

Returns:

  • int

GetStateInt

int GetStateInt(const tString &in asVarName,
                int alDefault = 0)


Parameters

  • asVarName (tString) —
  • alDefault (int) —

Returns:

  • int

GetStateVector3f

cVector3f GetStateVector3f(uint64 alId,
                           const cVector3f &in avDefault = 0.0f)


Parameters

Returns:

  • cVector3f

GetStateVector3f

cVector3f GetStateVector3f(const tString &in asVarName,
                           const cVector3f &in avDefault = cVector3f,
                            0.0f)


Parameters

Returns:

  • cVector3f

GetTimeCount

float GetTimeCount()

Returns:

  • float

GetTimeStep

float GetTimeStep()

Returns:

  • float

GetUsedFontSize

const cVector2f& GetUsedFontSize(const cImGuiFont &in aFont)


Parameters

Returns:

  • const cVector2f&

GetUsedGfxSize

cVector2f GetUsedGfxSize(const cImGuiGfx &in aGfx,
                         const cVector2f &in avCustomSize)


Parameters

Returns:

  • cVector2f

GroupBegin

void GroupBegin(const cVector3f &in avPos,
                const cVector2f &in avSize = 0,
                bool abClip = false)


Parameters

Returns:

  • void

GroupEnd

void GroupEnd()

Returns:

  • void

IncStateColor

void IncStateColor(uint64 alId,
                   const cColor &in aVal)


Parameters

  • alId (uint64) —
  • aVal (cColor) —

Returns:

  • void

IncStateColor

void IncStateColor(const tString &in asVarName,
                   const cColor &in aVal)


Parameters

Returns:

  • void

IncStateFloat

void IncStateFloat(uint64 alId,
                   float afVal)


Parameters

  • alId (uint64) —
  • afVal (float) —

Returns:

  • void

IncStateFloat

void IncStateFloat(const tString &in asVarName,
                   float afVal)


Parameters

  • asVarName (tString) —
  • afVal (float) —

Returns:

  • void

IncStateInt

void IncStateInt(uint64 alId,
                 int alVal)


Parameters

  • alId (uint64) —
  • alVal (int) —

Returns:

  • void

IncStateInt

void IncStateInt(const tString &in asVarName,
                 int alVal)


Parameters

  • asVarName (tString) —
  • alVal (int) —

Returns:

  • void

IncStateVector3f

void IncStateVector3f(uint64 alId,
                      const cVector3f &in avVal)


Parameters

Returns:

  • void

IncStateVector3f

void IncStateVector3f(const tString &in asVarName,
                      const cVector3f &in avVal)


Parameters

Returns:

  • void

IsFading

bool IsFading(const tString &in asVarName)


Parameters

Returns:

  • bool

IsFirstRun

bool IsFirstRun()

Returns:

  • bool

LayoutBegin

void LayoutBegin(eImGuiLayout aType,
                 const cVector3f &in avPos = 0,
                 const cVector2f &in avSize = -1,
                 const cVector2f &in avSpacing = 0)


Parameters

Returns:

  • void

LayoutEnd

void LayoutEnd()

Returns:

  • void

LockMouseFocus

void LockMouseFocus()

Returns:

  • void

MouseFocusIsLocked

bool MouseFocusIsLocked()

Returns:

  • bool

PopModifiers

void PopModifiers()

Returns:

  • void

PrevBecameInFocus

bool PrevBecameInFocus()

Returns:

  • bool

PrevBecamePressed

bool PrevBecamePressed()

Returns:

  • bool

PrevInFocus

bool PrevInFocus()

Returns:

  • bool

PrevMouseOver

bool PrevMouseOver()

Returns:

  • bool

PrevPosition

const cVector3f& PrevPosition()

Returns:

  • const cVector3f&

PrevPressed

bool PrevPressed()

Returns:

  • bool

PrevSize

const cVector2f& PrevSize()

Returns:

  • const cVector2f&

PrevUpdated

bool PrevUpdated()

Returns:

  • bool

PrevWasInFocus

bool PrevWasInFocus()

Returns:

  • bool

PushModifiers

void PushModifiers()

Returns:

  • void

RepeatTimer

bool RepeatTimer(const tString &in asName,
                 float afTime)


Parameters

  • asName (tString) —
  • afTime (float) —

Returns:

  • bool

ResetModifiers

void ResetModifiers()

Returns:

  • void

SendAction

void SendAction(eImGuiAction aAction,
                bool abDown,
                bool abTriggered)


Parameters

  • aAction (eImGuiAction) —
  • abDown (bool) —
  • abTriggered (bool) —

Returns:

  • void

SendMousePosition

void SendMousePosition(const cVector2l &in avPos,
                       const cVector2l &in avRel)


Parameters

Returns:

  • void

SendMouseVirtualPosition

void SendMouseVirtualPosition(const cVector2f &in avPos,
                              const cVector2f &in avRel)


Parameters

Returns:

  • void

SetAlignment

void SetAlignment(eImGuiAlign aAlign)


Parameters

Returns:

  • void

SetDefaultButton

void SetDefaultButton(const cImGuiButtonData &in aData)


Parameters

Returns:

  • void

SetDefaultCheckBox

void SetDefaultCheckBox(const cImGuiCheckBoxData &in aData)


Parameters

Returns:

  • void

SetDefaultFont

void SetDefaultFont(const cImGuiFont &in aFont)


Parameters

Returns:

  • void

SetDefaultFrame

void SetDefaultFrame(const cImGuiFrameData &in aData)


Parameters

Returns:

  • void

SetDefaultGauge

void SetDefaultGauge(const cImGuiGaugeData &in aData)


Parameters

Returns:

  • void

SetDefaultLabel

void SetDefaultLabel(const cImGuiLabelData &in aData)


Parameters

Returns:

  • void

SetDefaultMouse

void SetDefaultMouse(const cImGuiGfx &in aGfx,
                     const cVector2f &in avSize = -1)


Parameters

Returns:

  • void

SetDefaultMultiSelect

void SetDefaultMultiSelect(const cImGuiMultiSelectData &in aData)


Parameters

Returns:

  • void

SetDefaultSliderHorizontal

void SetDefaultSliderHorizontal(const cImGuiSliderData &in aData)


Parameters

Returns:

  • void

SetDefaultSliderVertical

void SetDefaultSliderVertical(const cImGuiSliderData &in aData)


Parameters

Returns:

  • void

SetDefaultTextFrame

void SetDefaultTextFrame(const cImGuiTextFrameData &in aData)


Parameters

Returns:

  • void

SetDefaultWindow

void SetDefaultWindow(const cImGuiWindowData &in aData)


Parameters

Returns:

  • void

SetDrawUIDebugBoxes

void SetDrawUIDebugBoxes(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFocus

void SetFocus(const tString &in asWidgetName)


Parameters

Returns:

  • void

SetModColorMul

void SetModColorMul(const cColor &in aCol)


Parameters

Returns:

  • void

SetModGfx

void SetModGfx(const cImGuiGfx &in aGfx)


Parameters

Returns:

  • void

SetModRotateAngle

void SetModRotateAngle(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetModRotateCustomPivot

void SetModRotateCustomPivot(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetModRotatePivot

void SetModRotatePivot(const cVector2f &in avPivot)


Parameters

Returns:

  • void

SetModTextColorMul

void SetModTextColorMul(const cColor &in aCol)


Parameters

Returns:

  • void

SetModUISizeHoriExpansion

void SetModUISizeHoriExpansion(float afNeg,
                               float afPos)


Parameters

  • afNeg (float) —
  • afPos (float) —

Returns:

  • void

SetModUISizeVertExpansion

void SetModUISizeVertExpansion(float afNeg,
                               float afPos)


Parameters

  • afNeg (float) —
  • afPos (float) —

Returns:

  • void

SetModUseInput

void SetModUseInput(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetModUseUIPos

void SetModUseUIPos(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetMoveRepeatActive

void SetMoveRepeatActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetMoveRepeatSpeed

float SetMoveRepeatSpeed(float fX)


Parameters

  • fX (float) —

Returns:

  • float

SetMoveRepeatStartDelay

void SetMoveRepeatStartDelay(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetShowMouse

void SetShowMouse(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetShowMouseAutomatically

void SetShowMouseAutomatically(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetStateColor

void SetStateColor(uint64 alId,
                   const cColor &in aVal)


Parameters

  • alId (uint64) —
  • aVal (cColor) —

Returns:

  • void

SetStateColor

void SetStateColor(const tString &in asVarName,
                   const cColor &in aVal)


Parameters

Returns:

  • void

SetStateFloat

void SetStateFloat(uint64 alId,
                   float afVal)


Parameters

  • alId (uint64) —
  • afVal (float) —

Returns:

  • void

SetStateFloat

void SetStateFloat(const tString &in asVarName,
                   float afVal)


Parameters

  • asVarName (tString) —
  • afVal (float) —

Returns:

  • void

SetStateInt

void SetStateInt(uint64 alId,
                 int alVal)


Parameters

  • alId (uint64) —
  • alVal (int) —

Returns:

  • void

SetStateInt

void SetStateInt(const tString &in asVarName,
                 int alVal)


Parameters

  • asVarName (tString) —
  • alVal (int) —

Returns:

  • void

SetStateVector3f

void SetStateVector3f(uint64 alId,
                      const cVector3f &in avVal)


Parameters

Returns:

  • void

SetStateVector3f

void SetStateVector3f(const tString &in asVarName,
                      const cVector3f &in avVal)


Parameters

Returns:

  • void

SetUIMoveGroupFlags

void SetUIMoveGroupFlags(int alGroupFlags)


Parameters

  • alGroupFlags (int) —

Returns:

  • void

SetUIMoveWrapMode

void SetUIMoveWrapMode(eImGuiWrap aWrap)


Parameters

Returns:

  • void

SetUpAlignment

void SetUpAlignment(const cVector3f &in avPos,
                    const cVector2f &in avSize,
                    cVector3f &out avAlignedPos,
                    eImGuiAlign aAlignment)


Parameters

Returns:

  • void

SetupWidgetRect

void SetupWidgetRect(const cVector3f &in avInPos,
                     const cVector2f &in avInSize,
                     cVector3f &out avOutPos,
                     cVector2f &out avOutSize,
                     const cVector2f &in avDefaultSize,
                     const cImGuiGfx &in aGfx)


Parameters

Returns:

  • void

StopFade

void StopFade(const tString &in asVarName)


Parameters

Returns:

  • void

StopTimer

void StopTimer(const tString &in asName)


Parameters

Returns:

  • void

TimerExists

bool TimerExists(const tString &in asName)


Parameters

Returns:

  • bool

TimerOver

bool TimerOver(const tString &in asName)


Parameters

Returns:

  • bool

References

See all references...