Base class for type-specific property inspectors in the editor. More...
#include <inspector.h>
Public Types | |
| using | attribute_getter = std::function<entt::meta_any(const char*)> |
| Function type for retrieving meta attributes by name. | |
Public Member Functions | |
| virtual | ~inspector ()=default |
| Virtual destructor for proper cleanup. | |
| virtual void | before_inspect (const entt::meta_data &prop) |
| Called before inspecting a property to set up layout. | |
| virtual void | after_inspect (const entt::meta_data &prop) |
| Called after inspecting a property to clean up layout. | |
| virtual auto | inspect (rtti::context &ctx, entt::meta_any &var, const meta_any_proxy &var_proxy, const var_info &info, const entt::meta_custom &custom) -> inspect_result=0 |
| Pure virtual method to render and handle interaction for a variable. | |
 Public Member Functions inherited from crtp_meta_type< inspector > | |
| virtual auto | get_meta_type () const -> entt::meta_type |
| auto | is () const -> bool |
| auto | is (const entt::meta_type &type) const -> bool |
| virtual auto | as_derived () -> entt::meta_any |
Static Public Member Functions | |
| template<typename T > | |
| static void | create_and_register (const entt::meta_type &inspected_type, std::unordered_map< entt::id_type, std::shared_ptr< inspector > > &type_map) |
| Factory method to create and register inspector instances. | |
| Static Public Member Functions inherited from crtp_meta_type< inspector > | |
| static auto | get_static_meta_type () -> entt::meta_type |
Protected Attributes | |
| std::unique_ptr< property_layout > | layout_ |
| Layout manager for this inspector's UI. | |
| bool | open_ {} |
| Whether this inspector's UI section is expanded. | |
Detailed Description
Base class for type-specific property inspectors in the editor.
Inspectors provide custom UI for editing different data types in the inspector panel. Each inspector handles rendering and interaction for a specific type (e.g., floats, vectors, textures).
Definition at line 240 of file inspector.h.
Member Typedef Documentation
◆ attribute_getter
| using unravel::inspector::attribute_getter = std::function<entt::meta_any(const char*)> |
Function type for retrieving meta attributes by name.
Definition at line 256 of file inspector.h.
Constructor & Destructor Documentation
◆ ~inspector()
|
virtualdefault |
Virtual destructor for proper cleanup.
Member Function Documentation
◆ after_inspect()
|
virtual |
Called after inspecting a property to clean up layout.
- Parameters
-
prop Meta property that was inspected
Definition at line 244 of file inspector.cpp.
◆ before_inspect()
|
virtual |
Called before inspecting a property to set up layout.
- Parameters
-
prop Meta property being inspected
Definition at line 239 of file inspector.cpp.
◆ create_and_register()
|
inlinestatic |
Factory method to create and register inspector instances.
- Template Parameters
-
T Inspector type to create
- Parameters
-
inspected_type Type that this inspector handles type_map Registry map to store the inspector instance
Definition at line 249 of file inspector.h.
◆ inspect()
|
pure virtual |
Pure virtual method to render and handle interaction for a variable.
- Parameters
-
ctx Runtime type information context var Variable being inspected var_proxy Proxy for accessing the variable info Metadata about the variable custom Custom attributes for the variable
- Returns
- Result indicating what changes occurred
Member Data Documentation
◆ layout_
|
protected |
Layout manager for this inspector's UI.
Definition at line 292 of file inspector.h.
◆ open_
|
protected |
Whether this inspector's UI section is expanded.
Definition at line 294 of file inspector.h.
The documentation for this struct was generated from the following files:
- C:/Workspace/github/UnravelEngine/UnravelEngine/editor/editor/hub/panels/inspector_panel/inspectors/inspector.h
- C:/Workspace/github/UnravelEngine/UnravelEngine/editor/editor/hub/panels/inspector_panel/inspectors/inspector.cpp
