EnTT 3.13.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
entt::meta_factory< Type > Class Template Reference

Basic meta factory to be used for reflection purposes. More...

#include <factory.hpp>

Public Member Functions

 meta_factory () noexcept
 Default constructor.
 
 meta_factory (meta_ctx &area) noexcept
 Context aware constructor.
 
auto type (const id_type id) noexcept
 Assigns a custom unique identifier to a meta type.
 
template<typename Base >
auto base () noexcept
 Assigns a meta base to a meta type.
 
template<auto Candidate>
auto conv () noexcept
 Assigns a meta conversion function to a meta type.
 
template<typename To >
auto conv () noexcept
 Assigns a meta conversion function to a meta type.
 
template<auto Candidate, typename Policy = as_is_t>
auto ctor () noexcept
 Assigns a meta constructor to a meta type.
 
template<typename... Args>
auto ctor () noexcept
 Assigns a meta constructor to a meta type.
 
template<auto Func>
auto dtor () noexcept
 Assigns a meta destructor to a meta type.
 
template<auto Data, typename Policy = as_is_t>
auto data (const id_type id) noexcept
 Assigns a meta data to a meta type.
 
template<auto Setter, auto Getter, typename Policy = as_is_t>
auto data (const id_type id) noexcept
 Assigns a meta data to a meta type by means of its setter and getter.
 
template<typename Setter , auto Getter, typename Policy = as_is_t>
auto data (const id_type id) noexcept
 Assigns a meta data to a meta type by means of its setters and getter.
 
template<auto Candidate, typename Policy = as_is_t>
auto func (const id_type id) noexcept
 Assigns a meta function to a meta type.
 
template<typename... Value>
meta_factory prop (id_type id, Value &&...value)
 Assigns a property to the last meta object created.
 

Detailed Description

template<typename Type>
class entt::meta_factory< Type >

Basic meta factory to be used for reflection purposes.

Template Parameters
TypeReflected type for which the factory was created.

Definition at line 63 of file factory.hpp.

Constructor & Destructor Documentation

◆ meta_factory() [1/2]

template<typename Type >
entt::meta_factory< Type >::meta_factory ( )
inlinenoexcept

Default constructor.

Definition at line 87 of file factory.hpp.

◆ meta_factory() [2/2]

template<typename Type >
entt::meta_factory< Type >::meta_factory ( meta_ctx & area)
inlinenoexcept

Context aware constructor.

Parameters
areaThe context into which to construct meta types.

Definition at line 94 of file factory.hpp.

Member Function Documentation

◆ base()

template<typename Type >
template<typename Base >
auto entt::meta_factory< Type >::base ( )
inlinenoexcept

Assigns a meta base to a meta type.

A reflected base class must be a real base class of the reflected type.

Template Parameters
BaseType of the base class to assign to the meta type.
Returns
A meta factory for the parent type.

Definition at line 129 of file factory.hpp.

◆ conv() [1/2]

template<typename Type >
template<auto Candidate>
auto entt::meta_factory< Type >::conv ( )
inlinenoexcept

Assigns a meta conversion function to a meta type.

Conversion functions can be either free functions or member functions.
In case of free functions, they must accept a const reference to an instance of the parent type as an argument. In case of member functions, they should have no arguments at all.

Template Parameters
CandidateThe actual function to use for the conversion.
Returns
A meta factory for the parent type.

Definition at line 150 of file factory.hpp.

◆ conv() [2/2]

template<typename Type >
template<typename To >
auto entt::meta_factory< Type >::conv ( )
inlinenoexcept

Assigns a meta conversion function to a meta type.

The given type must be such that an instance of the reflected type can be converted to it.

Template Parameters
ToType of the conversion function to assign to the meta type.
Returns
A meta factory for the parent type.

Definition at line 168 of file factory.hpp.

◆ ctor() [1/2]

template<typename Type >
template<auto Candidate, typename Policy = as_is_t>
auto entt::meta_factory< Type >::ctor ( )
inlinenoexcept

Assigns a meta constructor to a meta type.

Both member functions and free function can be assigned to meta types in the role of constructors. All that is required is that they return an instance of the underlying type.
From a client's point of view, nothing changes if a constructor of a meta type is a built-in one or not.

Template Parameters
CandidateThe actual function to use as a constructor.
PolicyOptional policy (no policy set by default).
Returns
A meta factory for the parent type.

Definition at line 190 of file factory.hpp.

◆ ctor() [2/2]

template<typename Type >
template<typename... Args>
auto entt::meta_factory< Type >::ctor ( )
inlinenoexcept

Assigns a meta constructor to a meta type.

A meta constructor is uniquely identified by the types of its arguments and is such that there exists an actual constructor of the underlying type that can be invoked with parameters whose types are those given.

Template Parameters
ArgsTypes of arguments to use to construct an instance.
Returns
A meta factory for the parent type.

Definition at line 210 of file factory.hpp.

◆ data() [1/3]

template<typename Type >
template<auto Data, typename Policy = as_is_t>
auto entt::meta_factory< Type >::data ( const id_type id)
inlinenoexcept

Assigns a meta data to a meta type.

Both data members and static and global variables, as well as constants of any kind, can be assigned to a meta type.
From a client's point of view, all the variables associated with the reflected object will appear as if they were part of the type itself.

Template Parameters
DataThe actual variable to attach to the meta type.
PolicyOptional policy (no policy set by default).
Parameters
idUnique identifier.
Returns
A meta factory for the parent type.

Definition at line 262 of file factory.hpp.

◆ data() [2/3]

template<typename Type >
template<auto Setter, auto Getter, typename Policy = as_is_t>
auto entt::meta_factory< Type >::data ( const id_type id)
inlinenoexcept

Assigns a meta data to a meta type by means of its setter and getter.

Setters and getters can be either free functions, member functions or a mix of them.
In case of free functions, setters and getters must accept a reference to an instance of the parent type as their first argument. A setter has then an extra argument of a type convertible to that of the parameter to set.
In case of member functions, getters have no arguments at all, while setters has an argument of a type convertible to that of the parameter to set.

Template Parameters
SetterThe actual function to use as a setter.
GetterThe actual function to use as a getter.
PolicyOptional policy (no policy set by default).
Parameters
idUnique identifier.
Returns
A meta factory for the parent type.

Definition at line 327 of file factory.hpp.

◆ data() [3/3]

template<typename Type >
template<typename Setter , auto Getter, typename Policy = as_is_t>
auto entt::meta_factory< Type >::data ( const id_type id)
inlinenoexcept

Assigns a meta data to a meta type by means of its setters and getter.

Multi-setter support for meta data members. All setters are tried in the order of definition before returning to the caller.
Setters can be either free functions, member functions or a mix of them and are provided via a value_list type.

See also
data
Template Parameters
SetterThe actual functions to use as setters.
GetterThe actual getter function.
PolicyOptional policy (no policy set by default).
Parameters
idUnique identifier.
Returns
A meta factory for the parent type.

Definition at line 384 of file factory.hpp.

◆ dtor()

template<typename Type >
template<auto Func>
auto entt::meta_factory< Type >::dtor ( )
inlinenoexcept

Assigns a meta destructor to a meta type.

Both free functions and member functions can be assigned to meta types in the role of destructors.
The signature of a free function should be identical to the following:

void(Type &);
constexpr Type make_obj_using_allocator(const Allocator &allocator, Args &&...args)
Uses-allocator construction utility (waiting for C++20).
Definition memory.hpp:258

Member functions should not take arguments instead.
The purpose is to give users the ability to free up resources that require special treatment before an object is actually destroyed.

Template Parameters
FuncThe actual function to use as a destructor.
Returns
A meta factory for the parent type.

Definition at line 240 of file factory.hpp.

◆ func()

template<typename Type >
template<auto Candidate, typename Policy = as_is_t>
auto entt::meta_factory< Type >::func ( const id_type id)
inlinenoexcept

Assigns a meta function to a meta type.

Both member functions and free functions can be assigned to a meta type.
From a client's point of view, all the functions associated with the reflected object will appear as if they were part of the type itself.

Template Parameters
CandidateThe actual function to attach to the meta type.
PolicyOptional policy (no policy set by default).
Parameters
idUnique identifier.
Returns
A meta factory for the parent type.

Definition at line 403 of file factory.hpp.

◆ prop()

template<typename Type >
template<typename... Value>
meta_factory entt::meta_factory< Type >::prop ( id_type id,
Value &&... value )
inline

Assigns a property to the last meta object created.

Both the key and the value (if any) must be at least copy constructible.

Template Parameters
ValueOptional type of the property value.
Parameters
idProperty key.
valueOptional property value.
Returns
A meta factory for the parent type.

Definition at line 432 of file factory.hpp.

◆ type()

template<typename Type >
auto entt::meta_factory< Type >::type ( const id_type id)
inlinenoexcept

Assigns a custom unique identifier to a meta type.

Parameters
idA custom unique identifier.
Returns
A meta factory for the given type.

Definition at line 112 of file factory.hpp.


The documentation for this class was generated from the following file: