EnTT 3.13.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
entt::meta_handle Struct Reference

Opaque pointers to instances of any type. More...

#include <meta.hpp>

Public Member Functions

 meta_handle () noexcept
 
 meta_handle (meta_ctx_arg_t, const meta_ctx &area) noexcept
 Context aware constructor.
 
 meta_handle (meta_any &value) noexcept
 Creates a handle that points to an unmanaged object.
 
 meta_handle (const meta_any &value) noexcept
 Creates a handle that points to an unmanaged object.
 
template<typename Type , typename = std::enable_if_t<!std::is_same_v<std::decay_t<Type>, meta_handle>>>
 meta_handle (const meta_ctx &ctx, Type &value) noexcept
 Creates a handle that points to an unmanaged object.
 
template<typename Type , typename = std::enable_if_t<!std::is_same_v<std::decay_t<Type>, meta_handle>>>
 meta_handle (Type &value) noexcept
 Creates a handle that points to an unmanaged object.
 
 meta_handle (const meta_ctx &area, const meta_handle &other)
 Context aware copy constructor.
 
 meta_handle (const meta_ctx &area, meta_handle &&other)
 Context aware move constructor.
 
 meta_handle (const meta_handle &)=delete
 Default copy constructor, deleted on purpose.
 
 meta_handle (meta_handle &&)=default
 Default move constructor.
 
meta_handleoperator= (const meta_handle &)=delete
 Default copy assignment operator, deleted on purpose.
 
meta_handleoperator= (meta_handle &&)=default
 Default move assignment operator.
 
 operator bool () const noexcept
 Returns false if a handle is invalid, true otherwise.
 
bool operator== (const meta_handle &other) const noexcept
 Checks if two wrappers differ in their content.
 
bool operator!= (const meta_handle &other) const noexcept
 Checks if two wrappers differ in their content.
 
meta_anyoperator-> ()
 Access operator for accessing the contained opaque object.
 
const meta_anyoperator-> () const
 Access operator for accessing the contained opaque object.
 

Detailed Description

Opaque pointers to instances of any type.

A handle doesn't perform copies and isn't responsible for the contained object. It doesn't prolong the lifetime of the pointed instance.

Definition at line 658 of file meta.hpp.

Constructor & Destructor Documentation

◆ meta_handle() [1/8]

entt::meta_handle::meta_handle ( )
inlinenoexcept

Default constructor.

Definition at line 660 of file meta.hpp.

◆ meta_handle() [2/8]

entt::meta_handle::meta_handle ( meta_ctx_arg_t  ,
const meta_ctx area 
)
inlinenoexcept

Context aware constructor.

Parameters
areaThe context from which to search for meta types.

Definition at line 667 of file meta.hpp.

◆ meta_handle() [3/8]

entt::meta_handle::meta_handle ( meta_any value)
inlinenoexcept

Creates a handle that points to an unmanaged object.

Parameters
valueAn instance of an object to use to initialize the handle.

Definition at line 674 of file meta.hpp.

◆ meta_handle() [4/8]

entt::meta_handle::meta_handle ( const meta_any value)
inlinenoexcept

Creates a handle that points to an unmanaged object.

Parameters
valueAn instance of an object to use to initialize the handle.

Definition at line 681 of file meta.hpp.

◆ meta_handle() [5/8]

template<typename Type , typename = std::enable_if_t<!std::is_same_v<std::decay_t<Type>, meta_handle>>>
entt::meta_handle::meta_handle ( const meta_ctx ctx,
Type &  value 
)
inlinenoexcept

Creates a handle that points to an unmanaged object.

Template Parameters
TypeType of object to use to initialize the handle.
Parameters
ctxThe context from which to search for meta types.
valueAn instance of an object to use to initialize the handle.

Definition at line 691 of file meta.hpp.

◆ meta_handle() [6/8]

template<typename Type , typename = std::enable_if_t<!std::is_same_v<std::decay_t<Type>, meta_handle>>>
entt::meta_handle::meta_handle ( Type &  value)
inlinenoexcept

Creates a handle that points to an unmanaged object.

Template Parameters
TypeType of object to use to initialize the handle.
Parameters
valueAn instance of an object to use to initialize the handle.

Definition at line 700 of file meta.hpp.

◆ meta_handle() [7/8]

entt::meta_handle::meta_handle ( const meta_ctx area,
const meta_handle other 
)
inline

Context aware copy constructor.

Parameters
areaThe context from which to search for meta types.
otherThe instance to copy from.

Definition at line 708 of file meta.hpp.

◆ meta_handle() [8/8]

entt::meta_handle::meta_handle ( const meta_ctx area,
meta_handle &&  other 
)
inline

Context aware move constructor.

Parameters
areaThe context from which to search for meta types.
otherThe instance to move from.

Definition at line 716 of file meta.hpp.

Member Function Documentation

◆ operator bool()

entt::meta_handle::operator bool ( ) const
inlineexplicitnoexcept

Returns false if a handle is invalid, true otherwise.

Returns
False if the handle is invalid, true otherwise.

Definition at line 741 of file meta.hpp.

◆ operator!=()

bool entt::meta_handle::operator!= ( const meta_handle other) const
inlinenoexcept

Checks if two wrappers differ in their content.

Parameters
otherWrapper with which to compare.
Returns
True if the two objects differ in their content, false otherwise.

Definition at line 751 of file meta.hpp.

◆ operator->() [1/2]

meta_any * entt::meta_handle::operator-> ( )
inline

Access operator for accessing the contained opaque object.

Returns
A wrapper that shares a reference to an unmanaged object.

Definition at line 759 of file meta.hpp.

◆ operator->() [2/2]

const meta_any * entt::meta_handle::operator-> ( ) const
inline

Access operator for accessing the contained opaque object.

Returns
A wrapper that shares a reference to an unmanaged object.

Definition at line 764 of file meta.hpp.

◆ operator=() [1/2]

meta_handle & entt::meta_handle::operator= ( const meta_handle )
delete

Default copy assignment operator, deleted on purpose.

Returns
This meta handle.

◆ operator=() [2/2]

meta_handle & entt::meta_handle::operator= ( meta_handle &&  )
default

Default move assignment operator.

Returns
This meta handle.

◆ operator==()

bool entt::meta_handle::operator== ( const meta_handle other) const
inlinenoexcept

Checks if two wrappers differ in their content.

Parameters
otherWrapper with which to compare.
Returns
False if the two objects differ in their content, true otherwise.

Definition at line 746 of file meta.hpp.


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