Difference between revisions of "ImGui.Core:checkbox"
From GiderosMobile
(.deltaTime) |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 5: | Line 5: | ||
=== Description === | === Description === | ||
Displays a checkbox. | Displays a checkbox. | ||
− | < | + | <syntaxhighlight lang="lua"> |
− | ImGui:checkbox(text,flag) | + | (bool), (bool) = ImGui:checkbox(text,flag) |
− | </ | + | </syntaxhighlight> |
=== Parameters === | === Parameters === | ||
Line 13: | Line 13: | ||
'''flag''': (bool) the checkbox status, true=checked, false=unchecked<br/> | '''flag''': (bool) the checkbox status, true=checked, false=unchecked<br/> | ||
− | === | + | === Return values === |
− | < | + | '''Returns''' (bool) the new current boolean value<br/> |
+ | '''Returns''' (bool) whether a value has changed '''optional'''<br/> | ||
+ | |||
+ | === Examples === | ||
+ | '''Using a flag''' | ||
+ | <syntaxhighlight lang="lua"> | ||
+ | MyClass = Core.class(Sprite) | ||
+ | |||
+ | function MyClass:init() | ||
+ | self.imgui = ImGui.new() | ||
+ | -- we create a variable to hold our window status | ||
+ | self.window01 = true -- window01 exists at start up | ||
+ | self.isbold = false -- checkbox starting status | ||
+ | -- order | ||
+ | self:addChild(self.imgui) | ||
+ | -- LISTENERS | ||
+ | self:addEventListener("enterBegin", self.onTransitionInBegin, self) | ||
+ | end | ||
+ | |||
+ | -- LOOP | ||
+ | function MyClass:onEnterFrame(e) | ||
+ | -- 1 we start ImGui | ||
+ | self.imgui:newFrame(e.deltaTime) | ||
+ | -- 2 we build our GUI | ||
+ | if self.window01 then -- is window01 existant? | ||
+ | local windowdrawn = false -- is window01 colapsed? | ||
+ | local ischanged = false | ||
+ | self.window01, windowdrawn = self.imgui:beginWindow( | ||
+ | "Hello ImGui", -- window title | ||
+ | self.window01 -- is window01 existant? | ||
+ | ) | ||
+ | if windowdrawn then -- the variable is false when window01 is collapsed | ||
+ | self.isbold, ischanged = self.imgui:checkbox("Bold", self.isbold) | ||
+ | if ischanged then print(self.isbold) end | ||
+ | end | ||
+ | self.imgui:endWindow() | ||
+ | end | ||
+ | self.imgui:endFrame() | ||
+ | self.imgui:render() | ||
+ | end | ||
+ | |||
+ | -- EVENT LISTENERS | ||
+ | function MyClass:onTransitionInBegin() | ||
+ | self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self) | ||
+ | end | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | |||
+ | '''Without using a flag''' | ||
+ | <syntaxhighlight lang="lua"> | ||
MyClass = Core.class(Sprite) | MyClass = Core.class(Sprite) | ||
Line 35: | Line 84: | ||
if self.window01 then -- is window01 existant? | if self.window01 then -- is window01 existant? | ||
local windowdrawn = false -- is window01 colapsed? | local windowdrawn = false -- is window01 colapsed? | ||
+ | local ischanged = false | ||
self.window01, windowdrawn = self.imgui:beginWindow( | self.window01, windowdrawn = self.imgui:beginWindow( | ||
"Hello ImGui", -- window title | "Hello ImGui", -- window title | ||
Line 41: | Line 91: | ||
if windowdrawn then -- the variable is false when window01 is collapsed | if windowdrawn then -- the variable is false when window01 is collapsed | ||
self.isbold = self.imgui:checkbox("Bold", self.isbold) | self.isbold = self.imgui:checkbox("Bold", self.isbold) | ||
− | |||
end | end | ||
self.imgui:endWindow() | self.imgui:endWindow() | ||
Line 53: | Line 102: | ||
self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self) | self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self) | ||
end | end | ||
− | </ | + | </syntaxhighlight> |
{{ImGui}} | {{ImGui}} |
Latest revision as of 15:29, 13 July 2023
Available since: Gideros 2020.9
Class: ImGui
Description
Displays a checkbox.
(bool), (bool) = ImGui:checkbox(text,flag)
Parameters
text: (string) the checkbox text
flag: (bool) the checkbox status, true=checked, false=unchecked
Return values
Returns (bool) the new current boolean value
Returns (bool) whether a value has changed optional
Examples
Using a flag
MyClass = Core.class(Sprite)
function MyClass:init()
self.imgui = ImGui.new()
-- we create a variable to hold our window status
self.window01 = true -- window01 exists at start up
self.isbold = false -- checkbox starting status
-- order
self:addChild(self.imgui)
-- LISTENERS
self:addEventListener("enterBegin", self.onTransitionInBegin, self)
end
-- LOOP
function MyClass:onEnterFrame(e)
-- 1 we start ImGui
self.imgui:newFrame(e.deltaTime)
-- 2 we build our GUI
if self.window01 then -- is window01 existant?
local windowdrawn = false -- is window01 colapsed?
local ischanged = false
self.window01, windowdrawn = self.imgui:beginWindow(
"Hello ImGui", -- window title
self.window01 -- is window01 existant?
)
if windowdrawn then -- the variable is false when window01 is collapsed
self.isbold, ischanged = self.imgui:checkbox("Bold", self.isbold)
if ischanged then print(self.isbold) end
end
self.imgui:endWindow()
end
self.imgui:endFrame()
self.imgui:render()
end
-- EVENT LISTENERS
function MyClass:onTransitionInBegin()
self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self)
end
Without using a flag
MyClass = Core.class(Sprite)
function MyClass:init()
self.imgui = ImGui.new()
-- we create a variable to hold our window status
self.window01 = true -- window01 exists at start up
self.isbold = false -- checkbox starting status
-- order
self:addChild(self.imgui)
-- LISTENERS
self:addEventListener("enterBegin", self.onTransitionInBegin, self)
end
-- LOOP
function MyClass:onEnterFrame(e)
-- 1 we start ImGui
self.imgui:newFrame(e.deltaTime)
-- 2 we build our GUI
if self.window01 then -- is window01 existant?
local windowdrawn = false -- is window01 colapsed?
local ischanged = false
self.window01, windowdrawn = self.imgui:beginWindow(
"Hello ImGui", -- window title
self.window01 -- is window01 existant?
)
if windowdrawn then -- the variable is false when window01 is collapsed
self.isbold = self.imgui:checkbox("Bold", self.isbold)
end
self.imgui:endWindow()
end
self.imgui:endFrame()
self.imgui:render()
end
-- EVENT LISTENERS
function MyClass:onTransitionInBegin()
self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self)
end
- ImGui.Core
- ImGui.Core.new
- ImGui.Core:arrowButton
- ImGui.Core:beginTable
- ImGui.Core:beginWindow
- ImGui.Core:bullet
- ImGui.Core:bulletText
- ImGui.Core:button
- ImGui.Core:checkbox
- ImGui.Core:colorButton
- ImGui.Core:colorEdit3
- ImGui.Core:colorEdit4
- ImGui.Core:colorPicker3
- ImGui.Core:colorPicker4
- ImGui.Core:combo
- ImGui.Core:dragFloat
- ImGui.Core:dragFloat2
- ImGui.Core:dragFloat3
- ImGui.Core:dragFloat4
- ImGui.Core:dragFloatRange2
- ImGui.Core:dragInt
- ImGui.Core:dragInt2
- ImGui.Core:dragInt3
- ImGui.Core:dragInt4
- ImGui.Core:dragIntRange2
- ImGui.Core:dragScalar
- ImGui.Core:endFrame
- ImGui.Core:endTable
- ImGui.Core:endWindow
- ImGui.Core:filledSliderAngle
- ImGui.Core:filledSliderFloat
- ImGui.Core:filledSliderFloat2
- ImGui.Core:filledSliderFloat3
- ImGui.Core:filledSliderFloat4
- ImGui.Core:filledSliderInt
- ImGui.Core:filledSliderInt2
- ImGui.Core:filledSliderInt3
- ImGui.Core:filledSliderInt4
- ImGui.Core:getIO
- ImGui.Core:getStyle
- ImGui.Core:image
- ImGui.Core:imageButton
- ImGui.Core:imageButtonWithText
- ImGui.Core:imageFilled
- ImGui.Core:inputDouble
- ImGui.Core:inputFloat
- ImGui.Core:inputFloat2
- ImGui.Core:inputFloat3
- ImGui.Core:inputFloat4
- ImGui.Core:inputInt
- ImGui.Core:inputInt2
- ImGui.Core:inputInt3
- ImGui.Core:inputInt4
- ImGui.Core:inputScalar
- ImGui.Core:inputText
- ImGui.Core:inputTextMultiline
- ImGui.Core:inputTextWithHint
- ImGui.Core:invisibleButton
- ImGui.Core:labelText
- ImGui.Core:newFrame
- ImGui.Core:progressBar
- ImGui.Core:radioButton
- ImGui.Core:render
- ImGui.Core:scaledImage
- ImGui.Core:scaledImageButton
- ImGui.Core:scaledImageButtonWithText
- ImGui.Core:scaledImageFilled
- ImGui.Core:setClassicStyle
- ImGui.Core:setColorEditOptions
- ImGui.Core:setDarkStyle
- ImGui.Core:setLightStyle
- ImGui.Core:showAboutWindow
- ImGui.Core:showDemoWindow
- ImGui.Core:showFontSelector
- ImGui.Core:showMetricsWindow
- ImGui.Core:showStyleEditor
- ImGui.Core:showStyleSelector
- ImGui.Core:showUserGuide
- ImGui.Core:sliderAngle
- ImGui.Core:sliderFloat
- ImGui.Core:sliderFloat2
- ImGui.Core:sliderFloat3
- ImGui.Core:sliderFloat4
- ImGui.Core:sliderInt
- ImGui.Core:sliderInt2
- ImGui.Core:sliderInt3
- ImGui.Core:sliderInt4
- ImGui.Core:smallButton
- ImGui.Core:text
- ImGui.Core:textColored
- ImGui.Core:textDisabled
- ImGui.Core:textWrapped
- ImGui.Core:vFilledSliderFloat
- ImGui.Core:vFilledSliderInt
- ImGui.Core:vSliderFloat
- ImGui.Core:vSliderInt