SuperDex Physics C++ API
Loading...
Searching...
No Matches
superdex::ActorHandle Struct Reference

Unique identifier for an Actor within a Scene. More...

#include <mochi_handle.h>

Inheritance diagram for superdex::ActorHandle:
superdex::Handle

Public Member Functions

 Handle ()=default
 Handle (ValueType raw)
 Construct a handle from its raw 64-bit identifier.
Public Member Functions inherited from superdex::Handle
uint64_t GetHash () const
 Compute a hash of the handle for use in unordered containers.
 Handle ()=default
 Handle (ValueType raw)
 Construct a handle from its raw 64-bit identifier.
bool IsValid () const
 Check whether the handle is valid (i.e., its value is non-zero).
bool operator!= (Handle const &rhs) const
bool operator< (Handle const &rhs) const
bool operator== (Handle const &rhs) const

Additional Inherited Members

Public Types inherited from superdex::Handle
using ValueType = uint64_t
 Raw 64-bit identifier type.
Public Attributes inherited from superdex::Handle
ValueType value = kInvalidHandle
 Raw 64-bit identifier.

Detailed Description

Unique identifier for an Actor within a Scene.

Note
An ActorHandle can only be used with the Scene that created it.
Creating and destroying many actors in the same scene may eventually cause an ActorHandle value from a previously destroyed actor to be re-used.

Definition at line 50 of file mochi_handle.h.

Member Function Documentation

◆ Handle() [1/2]

◆ Handle() [2/2]

superdex::Handle::Handle ( ValueType raw)
inlineexplicit

Construct a handle from its raw 64-bit identifier.

Parameters
[in]rawThe raw handle identifier.

Definition at line 34 of file mochi_handle_inl.h.


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