MySpace Namespace Reference

Functions
template<class T, class S>
auto	calculateOffset (T value, T min_val, T max_val, S len, bool clip) -> S
	Calculates the offset for a given range and set point.
template<class T>
auto	clip (const T value, const T min_val, const T max_val) -> T
	Returns clipped value of v between a and b where a < b.

Detailed Description

Just a file and namespace to demonstrate the Doxygen manual generation.

Go to the Main page

Function Documentation

calculateOffset()

template<class T, class S>

auto MySpace::calculateOffset	(	T	value,
		T	min_val,
		T	max_val,
		S	len,
		bool	clip ) -> S

Calculates the offset for a given range and set point.

Template Parameters

T	Type of the passed arguments for scaling.
S	The type of the to be scaled argument.

Parameters

value	Value in the range.
min_val	Minimum value of the range.
max_val	Maximum value of the range.
len	Length to be scaled according the value and range.
clip	Determines if the length needs to be clipped withing the set range.

Returns

Resulted scaled value.

clip()

template<class T>

auto MySpace::clip ( const T value, const T min_val, const T max_val ) -> T

inline

Returns clipped value of v between a and b where a < b.

Template Parameters

T	Type of the values

Parameters

value	Value needing to be clipped,
min_val	Begin value of the range.
max_val	End value of the range.

Returns

Clipped value.