#include <Random.h>

Inheritance diagram for nc::Random:

Public Member Functions
	Random () noexcept
	Default construct a new Random object.

	Random (size_t seed) noexcept
	Construct a new Random object from a seed. More...

auto	Fork () noexcept
	Returns a new Random instance seeded with the next generator value. More...

void	Seed (size_t seed) noexcept
	Seed the generator. More...

auto	Seed () const noexcept
	Get the current seed. More...

auto	Get () noexcept -> float
	Generate a random float in the range [0, 1]. More...

auto	GetU64 () noexcept -> size_t
	Generate a random size_t in the range [0, std::numeric_limits<size_t>::max()]. More...

auto	GetVector2 () noexcept -> Vector2
	Generate a random Vector2 with components in the range [0, 1]. More...

auto	GetVector3 () noexcept -> Vector3
	Generate a random Vector3 with components in the range [0, 1]. More...

auto	GetVector4 () noexcept -> Vector4
	Generate a random Vector4 with components in the range [0, 1]. More...

auto	Between (float min, float max) noexcept -> float
	Generate a random float in the range [min, max]. More...

auto	Between (size_t min, size_t max) noexcept -> size_t
	Generate a random size_t in the range [min, max]. More...

auto	Between (const Vector2 &min, const Vector2 &max) noexcept -> Vector2
	Generate a random Vector2 with components in the range [min, max]. More...

auto	Between (const Vector3 &min, const Vector3 &max) noexcept -> Vector3
	Generate a random Vector3 with components in the range [min, max]. More...

auto	Between (const Vector4 &min, const Vector4 &max) noexcept -> Vector4
	Generate a random Vector4 with components in the range [min, max]. More...

Public Member Functions inherited from nc::Module
	Module (size_t id=0) noexcept
	Constructor for the Module interface. More...

auto	Id () const noexcept
	Get the module's unique id.

virtual void	OnBuildTaskGraph (task::UpdateTasks &, task::RenderTasks &)
	Called on registered modules when the task graphs are constructed.

virtual void	OnBeforeSceneLoad (const Scene &)
	Called on registered modules prior to loading a new scene. More...

virtual void	OnBeforeSceneFragmentLoad ()
	Called on registered modules immediately before loading a SceneFragment file.

virtual void	OnAfterSceneFragmentLoad ()
	Called on registered modules immediately after loading a SceneFragment file.

virtual void	Clear () noexcept
	Called on registered modules prior to clearing the Registry. This includes Scene::Unload() and NcEngine::Shutdown().

Friends
bool	operator== (const Random &lhs, const Random &rhs) noexcept
	Check if two generators have the same state. More...

bool	operator!= (const Random &lhs, const Random &rhs) noexcept
	Check if two generators have different states. More...

Detailed Description

Random number generator.

A shared Random instance can be retrieved from the NcEngine pointer. Additional instances can be constructed, copied, and forked as needed.

Constructor & Destructor Documentation

◆ Random()

nc::Random::Random ( size_t seed )

inlineexplicitnoexcept

Construct a new Random object from a seed.

Parameters

seed	A 64 bit seed value

Member Function Documentation

◆ Between() [1/5]

auto nc::Random::Between	(	const Vector2 &	min,
		const Vector2 &	max
	)		-> Vector2

inlinenoexcept

Generate a random Vector2 with components in the range [min, max].

Parameters

min	The component-wise minimum range values.
max	The component-wise maximum range values.

Returns: Vector2

◆ Between() [2/5]

auto nc::Random::Between	(	const Vector3 &	min,
		const Vector3 &	max
	)		-> Vector3

inlinenoexcept

Generate a random Vector3 with components in the range [min, max].

Parameters

min	The component-wise minimum range values.
max	The component-wise maximum range values.

Returns: Vector3

◆ Between() [3/5]

auto nc::Random::Between	(	const Vector4 &	min,
		const Vector4 &	max
	)		-> Vector4

inlinenoexcept

Generate a random Vector4 with components in the range [min, max].

Parameters

min	The component-wise minimum range values.
max	The component-wise maximum range values.

Returns: Vector4

◆ Between() [4/5]

auto nc::Random::Between	(	float	min,
		float	max
	)		-> float

inlinenoexcept

Generate a random float in the range [min, max].

Parameters

min	The minimum range value.
max	The maximum range value.

Returns: float

◆ Between() [5/5]

auto nc::Random::Between	(	size_t	min,
		size_t	max
	)		-> size_t

inlinenoexcept

Generate a random size_t in the range [min, max].

Parameters

min	The minimum range value.
max	The maximum range value.

Returns: size_t

◆ Fork()

auto nc::Random::Fork ( )

inlinenoexcept

Returns a new Random instance seeded with the next generator value.

Returns: size_t

◆ Get()

auto nc::Random::Get ( ) -> float

inlinenoexcept

Generate a random float in the range [0, 1].

Returns: float

◆ GetU64()

auto nc::Random::GetU64 ( ) -> size_t

inlinenoexcept

Generate a random size_t in the range [0, std::numeric_limits<size_t>::max()].

Returns: size_t

◆ GetVector2()

auto nc::Random::GetVector2 ( ) -> Vector2

inlinenoexcept

Generate a random Vector2 with components in the range [0, 1].

Returns: Vector2

◆ GetVector3()

auto nc::Random::GetVector3 ( ) -> Vector3

inlinenoexcept

Generate a random Vector3 with components in the range [0, 1].

Returns: Vector3

◆ GetVector4()

auto nc::Random::GetVector4 ( ) -> Vector4

inlinenoexcept

Generate a random Vector4 with components in the range [0, 1].

Returns: Vector4

◆ Seed() [1/2]

auto nc::Random::Seed ( ) const

inlinenoexcept

Get the current seed.

Returns: size_t

◆ Seed() [2/2]

void nc::Random::Seed ( size_t seed )

inlinenoexcept

Seed the generator.

Parameters

seed	A 64 bit seed value.

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	const Random &	lhs,
		const Random &	rhs
	)

friend

Check if two generators have different states.

Returns: bool

◆ operator==

bool operator==	(	const Random &	lhs,
		const Random &	rhs
	)

friend

Check if two generators have the same state.

Returns: bool

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

include/ncengine/math/Random.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Random()

Member Function Documentation

◆ Between() [1/5]

◆ Between() [2/5]

◆ Between() [3/5]

◆ Between() [4/5]

◆ Between() [5/5]

◆ Fork()

◆ Get()

◆ GetU64()

◆ GetVector2()

◆ GetVector3()

◆ GetVector4()

◆ Seed() [1/2]

◆ Seed() [2/2]

Friends And Related Function Documentation

◆ operator!=

◆ operator==