Opaque wrapper for data members.
More...
#include <meta.hpp>
|
using | size_type = typename internal::meta_data_node::size_type |
| Unsigned integer type.
|
|
|
| meta_data () noexcept=default |
| Default constructor.
|
|
| meta_data (const meta_ctx &area, const internal::meta_data_node &curr) noexcept |
| Context aware constructor for meta objects.
|
|
size_type | arity () const noexcept |
| Returns the number of setters available.
|
|
bool | is_const () const noexcept |
| Indicates whether a data member is constant or not.
|
|
bool | is_static () const noexcept |
| Indicates whether a data member is static or not.
|
|
meta_type | type () const noexcept |
| Returns the object type if any, type_id<void>() otherwise.
|
|
template<typename Type > |
bool | set (meta_handle instance, Type &&value) const |
| Sets the value of a given variable.
|
|
meta_any | get (meta_handle instance) const |
| Gets the value of a given variable.
|
|
meta_type | arg (size_type index) const noexcept |
| Returns the type accepted by the i-th setter.
|
|
meta_range< meta_prop, typename decltype(internal::meta_data_node::prop)::const_iterator > | prop () const noexcept |
| Returns a range to visit registered meta properties.
|
|
meta_prop | prop (const id_type key) const |
| Lookup utility for meta properties.
|
|
template<typename Type > |
Type | traits () const noexcept |
| Returns all meta traits for a given meta object.
|
|
meta_custom | custom () const noexcept |
| Returns user defined data for a given meta object.
|
|
| operator bool () const noexcept |
| Returns true if an object is valid, false otherwise.
|
|
bool | operator== (const meta_data &other) const noexcept |
| Checks if two objects refer to the same type.
|
|
Opaque wrapper for data members.
Definition at line 865 of file meta.hpp.
◆ size_type
Unsigned integer type.
Definition at line 867 of file meta.hpp.
◆ meta_data()
entt::meta_data::meta_data |
( |
const meta_ctx & | area, |
|
|
const internal::meta_data_node & | curr ) |
|
inlinenoexcept |
Context aware constructor for meta objects.
- Parameters
-
area | The context from which to search for meta types. |
curr | The underlying node with which to construct the instance. |
Definition at line 877 of file meta.hpp.
◆ arg()
Returns the type accepted by the i-th setter.
- Parameters
-
index | Index of the setter of which to return the accepted type. |
- Returns
- The type accepted by the i-th setter.
Definition at line 1683 of file meta.hpp.
◆ arity()
Returns the number of setters available.
- Returns
- The number of setters available.
Definition at line 885 of file meta.hpp.
◆ custom()
Returns user defined data for a given meta object.
- Returns
- User defined arbitrary data.
Definition at line 974 of file meta.hpp.
◆ get()
Gets the value of a given variable.
- Parameters
-
instance | An opaque instance of the underlying type. |
- Returns
- A wrapper containing the value of the underlying variable.
Definition at line 926 of file meta.hpp.
◆ is_const()
bool entt::meta_data::is_const |
( |
| ) |
const |
|
inlinenodiscardnoexcept |
Indicates whether a data member is constant or not.
- Returns
- True if the data member is constant, false otherwise.
Definition at line 893 of file meta.hpp.
◆ is_static()
bool entt::meta_data::is_static |
( |
| ) |
const |
|
inlinenodiscardnoexcept |
Indicates whether a data member is static or not.
- Returns
- True if the data member is static, false otherwise.
Definition at line 901 of file meta.hpp.
◆ operator bool()
entt::meta_data::operator bool |
( |
| ) |
const |
|
inlineexplicitnodiscardnoexcept |
Returns true if an object is valid, false otherwise.
- Returns
- True if the object is valid, false otherwise.
Definition at line 982 of file meta.hpp.
◆ operator==()
bool entt::meta_data::operator== |
( |
const meta_data & | other | ) |
const |
|
inlinenodiscardnoexcept |
Checks if two objects refer to the same type.
- Parameters
-
other | The object with which to compare. |
- Returns
- True if the objects refer to the same type, false otherwise.
Definition at line 987 of file meta.hpp.
◆ prop() [1/2]
meta_range< meta_prop, typename decltype(internal::meta_data_node::prop)::const_iterator > entt::meta_data::prop |
( |
| ) |
const |
|
inlinenodiscardnoexcept |
Returns a range to visit registered meta properties.
- Returns
- An iterable range to visit registered meta properties.
Definition at line 941 of file meta.hpp.
◆ prop() [2/2]
Lookup utility for meta properties.
- Parameters
-
key | The key to use to search for a property. |
- Returns
- The registered meta property for the given key, if any.
Definition at line 950 of file meta.hpp.
◆ set()
template<typename Type >
bool entt::meta_data::set |
( |
meta_handle | instance, |
|
|
Type && | value ) const |
|
inline |
Sets the value of a given variable.
- Template Parameters
-
Type | Type of value to assign. |
- Parameters
-
instance | An opaque instance of the underlying type. |
value | Parameter to use to set the underlying variable. |
- Returns
- True in case of success, false otherwise.
Definition at line 917 of file meta.hpp.
◆ traits()
template<typename Type >
Type entt::meta_data::traits |
( |
| ) |
const |
|
inlinenodiscardnoexcept |
Returns all meta traits for a given meta object.
- Template Parameters
-
Type | The type to convert the meta traits to. |
- Returns
- The registered meta traits, if any.
Definition at line 966 of file meta.hpp.
◆ type()
Returns the object type if any, type_id<void>()
otherwise.
- Returns
- The object type if any,
type_id<void>()
otherwise.
Definition at line 1679 of file meta.hpp.
The documentation for this struct was generated from the following file: