imgui

Class ImGuiStorage

java.lang.Object

imgui.binding.ImGuiStruct

imgui.binding.ImGuiStructDestroyable

imgui.ImGuiStorage

public final class ImGuiStorage
extends ImGuiStructDestroyable

Helper: Key-Value storage Typically you don't have to worry about this since a storage is held within each Window. We use it to e.g. store collapse state for a tree (Int 0/1) This is optimized for efficient lookup (dichotomy into a contiguous buffer) and rare insertion (typically tied to user interactions aka max once a frame) You can use it as custom user storage for temporary values. Declare your own storage if, for example: - You want to manipulate the open/close state of a particular sub-tree in your interface (tree node uses Int 0/1 to store their state). - You want to store custom debug data easily without adding or editing structures in your code (probably not efficient, but convenient) Types are NOT stored, so it is up to you to make sure your Key don't collide with different types.

Field Summary

Fields inherited from class imgui.binding.ImGuiStruct

ptr

Constructor Summary

Constructors

Constructor and Description
ImGuiStorage()
ImGuiStorage(long ptr)

Method Summary

Modifier and Type	Method and Description
void	buildSortByKey() For quicker full rebuild of a storage (instead of an incremental one), you may add all your contents and then sort once.
void	clear()
protected long	create()
boolean	getBool(int imGuiID)
boolean	getBool(int imGuiID, boolean defaultVal)
float	getFloat(int imGuiID)
float	getFloat(int imGuiID, float defaultVal)
int	getInt(int imGuiID)
int	getInt(int imGuiID, int defaultVal)
void	setAllInt(int val) Use on your own storage if you know only integer are being stored (open/close all tree nodes)
void	setBool(int imGuiID, boolean val)
void	setFloat(int imGuiID, float val)
void	setInt(int imGuiID, int val)

Methods inherited from class imgui.binding.ImGuiStructDestroyable

destroy

Methods inherited from class imgui.binding.ImGuiStruct

isNotValidPtr, isValidPtr

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImGuiStorage

public ImGuiStorage()

ImGuiStorage

public ImGuiStorage(long ptr)

Method Detail

create

protected long create()

Specified by:

create in class ImGuiStructDestroyable

clear

public void clear()

getInt

public int getInt(int imGuiID)

getInt

public int getInt(int imGuiID,
                  int defaultVal)

setInt

public void setInt(int imGuiID,
                   int val)

getBool

public boolean getBool(int imGuiID)

getBool

public boolean getBool(int imGuiID,
                       boolean defaultVal)

setBool

public void setBool(int imGuiID,
                    boolean val)

getFloat

public float getFloat(int imGuiID)

getFloat

public float getFloat(int imGuiID,
                      float defaultVal)

setFloat

public void setFloat(int imGuiID,
                     float val)

setAllInt

public void setAllInt(int val)

Use on your own storage if you know only integer are being stored (open/close all tree nodes)

buildSortByKey

public void buildSortByKey()

For quicker full rebuild of a storage (instead of an incremental one), you may add all your contents and then sort once.