sygaldry::array< name_str, N, desc, T, min, max, init, Tags > Struct Template Reference

A multi-dimensional numeric endpoint with user customizeable range and persistent value semantics. More...

Inheritance diagram for sygaldry::array< name_str, N, desc, T, min, max, init, Tags >:

Public Types
using	type = T
Public Types inherited from sygaldry::persistent< T >
using	type = T
	The underlying type.

Public Member Functions
constexpr const auto &	operator[] (std::size_t i) const noexcept
constexpr auto &	operator[] (std::size_t i) noexcept
Public Member Functions inherited from sygaldry::persistent< T >
constexpr	persistent () noexcept
	Default constuctor defers to T's empty initializer.
constexpr	persistent (T &&t) noexcept
	Move constructor from T
constexpr	persistent (const T &t) noexcept
	Copy constructor from T
constexpr auto &	operator= (T &&t) noexcept
	Move assignment from T
constexpr auto &	operator= (const T &t) noexcept
	Copy assignment from T
constexpr	operator T& () noexcept
	Conversion to a mutable reference to the underlying value.
constexpr	operator const T & () const noexcept
	Conversion to a constant reference to the underlying value.

Static Public Member Functions
static _consteval auto	size () noexcept
Static Public Member Functions inherited from sygaldry::name_< name_str >
static _consteval auto	name ()
Static Public Member Functions inherited from sygaldry::description_< str >
static _consteval auto	description ()
Static Public Member Functions inherited from sygaldry::range_< _min, _max, _init >
static _consteval auto	range ()
	Returns a struct with min, max, and init members containing the range.
static _consteval auto	min ()
	Returns the minimum value of the range.
static _consteval auto	max ()
	Returns the maximum value of the range.
static _consteval auto	init ()
	Returns the initial value of the range.

Additional Inherited Members
Public Attributes inherited from sygaldry::persistent< T >
T	value
	The wrapped value.

Detailed Description

template<string_literal name_str, std::size_t N, string_literal desc = "", typename T = float, num_literal< T > min = 0.0f, num_literal< T > max = 1.0f, num_literal< T > init = min, typename ... Tags>
struct sygaldry::array< name_str, N, desc, T, min, max, init, Tags >

A multi-dimensional numeric endpoint with user customizeable range and persistent value semantics.

Example: array<"acceleration", 3, "Acceleration due to gravity and motion", float, -1.0f, 1.0f> accl;

Template Parameters

name_str	The name of the endpoint. Required.
N	The number of elements in the array. Required.
desc	A description of the endpoint. Defaults to an empty string.
T	Underlying value type of the endpoint. Defaults to float.
min	Expected minimum value of the endpoint. Defaults to 0.0f.
max	Expected maximum value of the endpoint. Defaults to 1.0f.
init	The initial value of the endpoint. Defaults to min.
Tags	Tag helper classes to apply to the endpoint. None by default.

---

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

• sygaldry/sygah-endpoints/sygah-endpoints.hpp