HandleBase

Fully qualified name: omni::graph::core::HandleBase

template<typename T, typename SUBCLASS>
class HandleBase

Template class for defining handles to various OmniGraph data types.

Template Parameters:

• T – The underlying type of the handle being defined

• SUBCLASS – The handle subclass being defined

Public Functions

HandleBase() = default

Default constructor, gives an invalid handle.

HandleBase(const HandleBase&) = default

Default copy constructor, bitwise copy of handle data.

inline explicit HandleBase(const T &h)

Construct a handle from the underlying data it represents.

HandleBase &operator=(const HandleBase&) = default

Default assignment operator, bitwise copy of the handle data.

inline explicit operator T() const

Cast to the underlying data type of the handle.

inline bool isValid() const

Returns true if the handle is currently valid.

inline bool operator==(HandleBase rhs) const

Equality operator - only identical handles are equal.

inline bool operator!=(HandleBase rhs) const

Inequality operator - only identical handles are equal.

Public Static Functions

static inline constexpr SUBCLASS invalidHandle()

Constant representing a unique invalid handle for this instantiation.

Protected Attributes

T handle

Instantiation of the underlying type of the handle.