Nebula
Loading...
Searching...
No Matches
componentinspection.h
Go to the documentation of this file.
1#pragma once
2//------------------------------------------------------------------------------
13//------------------------------------------------------------------------------
14#include "util/delegate.h"
15#include "util/stringatom.h"
16#include "game/entity.h"
17#include "game/componentid.h"
22#include "util/bitfield.h"
23#include "util/color.h"
24#include "imgui.h"
25
26namespace Game
27{
28
30{
31public:
32 using DrawFunc = void(*)(Game::Entity, Game::ComponentId, void*, bool*);
33
35 static void Destroy();
36
37 template<typename COMPONENT_TYPE>
38 static void Register(ComponentId component);
39
40 static void DrawInspector(Game::Entity owner, ComponentId component, void* data, bool* commit);
41
43 static void OverrideInspector(ComponentId component, DrawFunc func);
44
45 // set to true if you want full information to be displayed in the inspector
46 bool debug = false;
47
48private:
51
53
55};
56
57//------------------------------------------------------------------------------
60template<typename TYPE>
61inline void
62ComponentDrawFuncT(Game::Entity owner, ComponentId component, void* data, bool* commit);
63
64//------------------------------------------------------------------------------
67template<typename TYPE, std::size_t i = 0>
68inline void
69InspectorDrawField(Game::Entity owner, ComponentId component, void* data, bool* commit)
70{
71 if constexpr (i < TYPE::Traits::num_fields)
72 {
73 if (TYPE::Traits::field_hide_in_inspector[i] && !ComponentInspection::Instance()->debug)
74 {
75 // Just move to the next field
76 InspectorDrawField<TYPE, i + 1>(owner, component, data, commit);
77 }
78 else
79 {
80 using field_tuple = typename TYPE::Traits::field_types;
81 using field_type = typename std::tuple_element<i, field_tuple>::type;
82 Util::String fieldName = TYPE::Traits::field_names[i];
83 fieldName.CamelCaseToWords();
84 fieldName.Capitalize();
85 ImGui::TableSetColumnIndex(0);
86 ImGui::AlignTextToFramePadding();
87 ImGui::TextDisabled(fieldName.AsCharPtr());
88 if (TYPE::Traits::field_descriptions[i] != nullptr)
89 {
90 if (ImGui::IsItemHovered(ImGuiHoveredFlags_AllowWhenDisabled))
91 {
92 if (ImGui::BeginTooltip())
93 {
94 ImGui::TextDisabled(TYPE::Traits::field_typenames[i]);
95 ImGui::Text(TYPE::Traits::field_descriptions[i]);
96 ImGui::EndTooltip();
97 }
98 }
99 }
100 ImGui::TableSetColumnIndex(1);
101
102 ImGui::PushID(component.id + 0x125233 + reinterpret_cast<intptr_t>(data));
103 ImGui::PushID((int)i);
104
105 if constexpr (std::is_enum<field_type>())
106 {
107 void* fieldData = (byte*)data + TYPE::Traits::field_byte_offsets[i];
108 const char* const* names = TYPE::Traits::field_enum_names[i];
109 int count = (int)TYPE::Traits::field_enum_counts[i];
110
111 if (names != nullptr && count > 0)
112 {
113 const int* const values = TYPE::Traits::field_enum_values[i];
114 const int current = (int)*(field_type*)fieldData;
115
116 // the field holds the enum value, the combo works on indices into the sorted
117 // name and value arrays, which only match for enums that are contiguous from zero
118 int currentIdx = 0;
119 for (int k = 1; k < count; k++)
120 {
121 if (values[k] == current)
122 {
123 currentIdx = k;
124 break;
125 }
126 }
127
128 if (ImGui::Combo("##enum_input", &currentIdx, names, count))
129 {
130 *commit = true;
131 *(field_type*)fieldData = (field_type)values[currentIdx];
132 }
133 }
134 else
135 {
136 // an enum we have no value names for
137 int value = (int)*(field_type*)fieldData;
138 if (ImGui::DragInt("##enum_input", &value))
139 {
140 *commit = true;
141 *(field_type*)fieldData = (field_type)value;
142 }
143 }
144 }
145 else
146 {
147 ComponentDrawFuncT<field_type>(owner, component, (byte*)data + TYPE::Traits::field_byte_offsets[i], commit);
148 }
149
150 ImGui::PopID();
151 ImGui::PopID();
152
153 if constexpr (i < TYPE::Traits::num_fields - 1)
154 {
155 ImGui::TableNextRow();
156 InspectorDrawField<TYPE, i + 1>(owner, component, data, commit);
157 }
158 }
159 }
160}
161
162//------------------------------------------------------------------------------
165template<typename TYPE>
166inline void
167ComponentDrawFuncT(Game::Entity owner, ComponentId component, void* data, bool* commit)
168{
169 if constexpr (requires { &TYPE::Traits::num_fields; })
170 {
171 if constexpr (TYPE::Traits::num_fields > 0 && !std::is_enum<TYPE>())
172 {
173 InspectorDrawField<TYPE>(owner, component, data, commit);
174 }
175 }
176 return;
177}
178
179template<> void ComponentDrawFuncT<Game::Entity>(Game::Entity, ComponentId, void*, bool*);
180template<> void ComponentDrawFuncT<bool>(Game::Entity, ComponentId, void*, bool*);
181template<> void ComponentDrawFuncT<int>(Game::Entity, ComponentId, void*, bool*);
182template<> void ComponentDrawFuncT<int64_t>(Game::Entity, ComponentId, void*, bool*);
183template<> void ComponentDrawFuncT<uint>(Game::Entity, ComponentId, void*, bool*);
184template<> void ComponentDrawFuncT<uint64_t>(Game::Entity, ComponentId, void*, bool*);
185template<> void ComponentDrawFuncT<uint16_t>(Game::Entity, ComponentId, void*, bool*);
186template<> void ComponentDrawFuncT<int16_t>(Game::Entity, ComponentId, void*, bool*);
187template<> void ComponentDrawFuncT<float>(Game::Entity, ComponentId, void*, bool*);
188extern void (*StringAtomComponentDrawOverride) (Game::Entity, ComponentId, void*, bool*);
190template<> void ComponentDrawFuncT<Math::mat4>(Game::Entity, ComponentId, void*, bool*);
191template<> void ComponentDrawFuncT<Math::vec3>(Game::Entity, ComponentId, void*, bool*);
192template<> void ComponentDrawFuncT<Math::vec4>(Game::Entity, ComponentId, void*, bool*);
193template<> void ComponentDrawFuncT<Math::quat>(Game::Entity, ComponentId, void*, bool*);
194template<> void ComponentDrawFuncT<Game::Position>(Game::Entity, ComponentId, void*, bool*);
196template<> void ComponentDrawFuncT<Game::Scale>(Game::Entity, ComponentId, void*, bool*);
197template<> void ComponentDrawFuncT<Util::Color>(Game::Entity, ComponentId, void*, bool*);
198template<> void ComponentDrawFuncT<Util::BitField<16>>(Game::Entity, ComponentId, void*, bool*);
199template<> void ComponentDrawFuncT<Util::BitField<32>>(Game::Entity, ComponentId, void*, bool*);
200template<> void ComponentDrawFuncT<Util::BitField<64>>(Game::Entity, ComponentId, void*, bool*);
201
202//------------------------------------------------------------------------------
205template<typename COMPONENT_TYPE>
206void
208{
210 while (reg->inspectors.Size() <= component.id)
211 {
212 IndexT first = reg->inspectors.Size();
213 reg->inspectors.Grow();
215 reg->inspectors.Fill(first, reg->inspectors.Size() - first, nullptr);
216 }
217
218 n_assert(reg->inspectors[component.id] == nullptr);
220}
221
222} // namespace Game
Util::Array< DrawFunc > inspectors
Definition componentinspection.h:54
ComponentInspection()
Definition componentinspection.cc:97
void(*)(Game::Entity, Game::ComponentId, void *, bool *) DrawFunc
Definition componentinspection.h:32
static void Register(ComponentId component)
Definition componentinspection.h:207
static ComponentInspection * Singleton
Definition componentinspection.h:52
bool debug
Definition componentinspection.h:46
static void Destroy()
This static method is used to destroy the registry object and should be called right before the main ...
Definition componentinspection.cc:50
static void OverrideInspector(ComponentId component, DrawFunc func)
Set a custom component inspector draw function.
Definition componentinspection.cc:78
static ComponentInspection * Instance()
The registry's constructor is called by the Instance() method, and nobody else.
Definition componentinspection.cc:31
static void DrawInspector(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:63
Nebula's dynamic array class.
Definition array.h:61
void Fill(IndexT first, SizeT num, const TYPE &elm)
fill array range with element
Definition array.h:1471
const SizeT Capacity() const
get overall allocated size of array in number of elements
Definition array.h:954
void Grow()
grow array with grow value
Definition array.h:600
void Resize(SizeT num)
Set size. Grows array if num is greater than capacity. Calls destroy on all objects at index > num!
Definition array.h:1711
const SizeT Size() const
get number of elements in array
Definition array.h:934
Nebula's universal string class.
Definition string.h:50
void Capitalize()
convert first char of string to upper case
Definition string.cc:967
const char * AsCharPtr() const
return contents as character pointer
Definition string.h:579
void CamelCaseToWords()
insert spaces before each capital letter in the string.
Definition string.cc:977
#define n_assert(exp)
Definition debug.h:58
Game::EditorState.
Definition graphicsmanager.h:66
MemDb::AttributeId ComponentId
Definition componentid.h:15
void ComponentDrawFuncT< int64_t >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:202
void ComponentDrawFuncT< Util::Color >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:526
void ComponentDrawFuncT< Math::vec4 >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:369
void ComponentDrawFuncT< Game::Position >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:395
void ComponentDrawFuncT< uint16_t >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:232
void ComponentDrawFuncT< Game::Entity >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:115
void ComponentDrawFuncT< int16_t >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:249
void ComponentDrawFuncT< Math::mat4 >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:337
void ComponentDrawFuncT< Math::vec3 >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:356
void ComponentDrawFuncT< Util::StringAtom >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:297
void(*) StringAtomComponentDrawOverride(Game::Entity, ComponentId, void *, bool *)
Definition componentinspection.cc:291
void ComponentDrawFuncT< uint64_t >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:266
void ComponentDrawFuncT< Game::Orientation >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:412
void ComponentDrawFuncT< int >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:189
void ComponentDrawFuncT< Math::quat >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:382
void ComponentDrawFuncT< uint >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:215
void ComponentDrawFuncT< Game::Scale >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:491
void ComponentDrawFuncT< bool >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:176
void ComponentDrawFuncT(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.h:167
void InspectorDrawField(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.h:69
void ComponentDrawFuncT< float >(Game::Entity owner, ComponentId component, void *data, bool *commit)
Definition componentinspection.cc:283
An entity is essentially just an Id with some utility functions attached.
Definition entity.h:35
int IndexT
Definition types.h:49