Namespaces
	Back

	Bounce

	Circ

	Cubic

	Elastic

	Expo

	Linear

	Quad

	Quart

	Quint

	Sine

Classes
class	BaseSmoothOperator

class	Box

struct	FComplex

class	FCurve

struct	FCurvePoint

class	Rect

class	SmoothOperator

Typedefs
using	FloatFComplex = FComplex< float, float >

using	Vec2FComplex = FComplex< float, glm::vec2 >

using	Vec3FComplex = FComplex< float, glm::vec3 >

using	Vec4FComplex = FComplex< float, glm::vec4 >

using	FloatFCurve = FCurve< float, float >

using	Vec2FCurve = FCurve< float, glm::vec2 >

using	Vec3FCurve = FCurve< float, glm::vec3 >

using	Vec4FCurve = FCurve< float, glm::vec4 >

using	FloatFCurvePoint = FCurvePoint< float, float >

using	Vec2FCurvePoint = FCurvePoint< float, glm::vec2 >

using	Vec3FCurvePoint = FCurvePoint< float, glm::vec3 >

using	Vec4FCurvePoint = FCurvePoint< float, glm::vec4 >

using	FloatSmoothOperator = SmoothOperator< float >

using	DoubleSmoothOperator = SmoothOperator< double >

using	Vec2SmoothOperator = SmoothOperator< glm::vec2 >

using	Vec3SmoothOperator = SmoothOperator< glm::vec3 >

using	Vec4SmoothOperator = SmoothOperator< glm::vec4 >

Enumerations
enum	ECurveInterp : int { Bezier = 0, Linear, Stepped }

enum	EWaveform : int { SINE = 0, SQUARE, SAW, TRIANGLE }

Functions
template<typename T >
void	getValueAlongLine (const std::vector< T > &vertexData, float location, bool closed, T &outValue)

template<typename T >
int	resampleLine (std::vector< T > &vertices, std::vector< T > &buffer, int segments, bool closed)

float NAPAPI	getDistancesAlongLine (const std::vector< glm::vec3 > &vertexPositions, std::map< float, int > &outDistances, bool loop)

float NAPAPI	getVertexLerpValue (const std::map< float, int > &distanceMap, float location, int &outMinVertex, int &outMaxVertex)

template<typename T >
void	getValueAlongLine (const std::map< float, int > &distanceMap, const std::vector< T > &vertexData, float location, T &outValue)

void NAPAPI	getNormalAlongLine (const std::map< float, int > &distanceMap, const std::vector< glm::vec3 > &vertexNormals, float location, glm::vec3 &outNormal)

template<typename T >
T	fit (T value, T min, T max, T outMin, T outMax)

template<typename T >
T	lerp (const T &start, const T &end, float percent)

template<typename T >
T	clamp (T value, T min, T max)

template<typename T >
T	min (T left, T right)

template<typename T >
T	max (T left, T right)

template<typename T >
T	floor (T value)

template<typename T >
T	ceil (T value)

template<typename T >
T	power (T value, T exp)

template<typename T >
T	smoothStep (T value, T edge0, T edge1)

template<typename T >
T	abs (T value)

template<typename T >
constexpr T	epsilon ()

template<typename T >
constexpr T	max ()

template<typename T >
constexpr T	min ()

template<typename T >
T	sign (T value)

template<typename T >
T	bell (T time, T strength)

template<typename T >
T	random (T min, T max)

void NAPAPI	setRandomSeed (int value)

template<typename T >
T NAPAPI	smoothDamp (T currentValue, T targetValue, T &currentVelocity, float deltaTime, float smoothTime, float maxSpeed=math::max< float >())

template<typename T >
void NAPAPI	smooth (T &currentValue, const T &targetValue, T &currentVelocity, float deltaTime, float smoothTime, float maxSpeed)

glm::mat4 NAPAPI	composeMatrix (const glm::vec3 &translate, const glm::quat &rotate, const glm::vec3 &scale)

glm::quat NAPAPI	eulerToQuat (const glm::vec3 &eulerAngle)

glm::quat NAPAPI	eulerToQuat (float roll, float pitch, float yaw)

glm::vec3 NAPAPI	radians (const glm::vec3 &eulerDegrees)

glm::vec3 NAPAPI	radians (float roll, float pitch, float yaw)

float NAPAPI	radians (float degrees)

float NAPAPI	degrees (float radians)

glm::vec3 NAPAPI	extractPosition (const glm::mat4x4 &matrix)

glm::vec3 NAPAPI	objectToWorld (const glm::vec3 &point, const glm::mat4x4 &objectToWorldMatrix)

glm::vec3 NAPAPI	worldToObject (const glm::vec3 &point, const glm::mat4x4 &objectToWorldMatrix)

std::string NAPAPI	generateUUID ()

template<>
NAPAPI float	lerp< float > (const float &start, const float &end, float percent)

template<>
NAPAPI double	lerp< double > (const double &start, const double &end, float percent)

template<>
NAPAPI glm::vec2	lerp< glm::vec2 > (const glm::vec2 &start, const glm::vec2 &end, float percent)

template<>
NAPAPI glm::vec3	lerp< glm::vec3 > (const glm::vec3 &start, const glm::vec3 &end, float percent)

template<>
NAPAPI glm::vec4	lerp< glm::vec4 > (const glm::vec4 &start, const glm::vec4 &end, float percent)

template<>
NAPAPI float	power< float > (float value, float exp)

template<>
NAPAPI double	power< double > (double value, double exp)

template<>
NAPAPI int	power< int > (int value, int exp)

template<>
NAPAPI void	smooth (float &currentValue, const float &targetValue, float &currentVelocity, float deltaTime, float smoothTime, float maxSpeed)

template<>
NAPAPI void	smooth (double &currentValue, const double &targetValue, double &currentVelocity, float deltaTime, float smoothTime, float maxSpeed)

template<>
NAPAPI void	smooth (glm::vec2 &currentValue, const glm::vec2 &targetValue, glm::vec2 &currentVelocity, float deltaTime, float smoothTime, float maxSpeed)

template<>
NAPAPI void	smooth (glm::vec3 &currentValue, const glm::vec3 &targetValue, glm::vec3 &currentVelocity, float deltaTime, float smoothTime, float maxSpeed)

template<>
NAPAPI void	smooth (glm::vec4 &currentValue, const glm::vec4 &targetValue, glm::vec4 &currentVelocity, float deltaTime, float smoothTime, float maxSpeed)

template<>
NAPAPI uint	random (uint min, uint max)

template<>
NAPAPI int	random (int min, int max)

template<>
NAPAPI float	random (float min, float max)

template<>
NAPAPI glm::vec3	random (glm::vec3 min, glm::vec3 max)

template<>
NAPAPI glm::vec4	random (glm::vec4 min, glm::vec4 max)

template<>
NAPAPI glm::vec2	random (glm::vec2 min, glm::vec2 max)

template<>
NAPAPI glm::ivec2	random (glm::ivec2 min, glm::ivec2 max)

template<>
NAPAPI glm::ivec3	random (glm::ivec3 min, glm::ivec3 max)

template<>
NAPAPI glm::ivec4	random (glm::ivec4 min, glm::ivec4 max)

template<>
NAPAPI glm::mat4	random (glm::mat4 min, glm::mat4 max)

template<>
NAPAPI float	abs (float value)

template<>
NAPAPI int	abs (int value)

template<typename T >
T	darken (T target, T blend)

template<typename T >
T	multiply (T target, T blend)

template<typename T >
T	colorBurn (T target, T blend)

template<typename T >
T	linearBurn (T target, T blend)

template<typename T >
T	lighten (T target, T blend)

template<typename T >
T	screen (T target, T blend)

template<typename T >
T	colorDodge (T target, T blend)

template<typename T >
T	linearDodge (T target, T blend)

template<typename T >
T	overlay (T target, T blend)

template<typename T >
T	softLight (T target, T blend)

template<typename T >
T	hardLight (T target, T blend)

template<typename T >
T	vividLight (T target, T blend)

template<typename T >
T	linearLight (T target, T blend)

template<typename T >
T	pinLight (T target, T blend)

template<typename T >
T	difference (T target, T blend)

template<typename T >
T	exclusion (T target, T blend)

float NAPAPI	waveform (EWaveform type, float time, float frequency)

Variables
constexpr double	E = 2.71828182845904523536

constexpr double	LOG2E = 1.44269504088896340736

constexpr double	LOG10E = 0.434294481903251827651

constexpr double	LN2 = 0.693147180559945309417

constexpr double	LN10 = 2.30258509299404568402

constexpr double	PI = 3.14159265358979323846

constexpr double	PIX2 = 6.28318530717958647692

constexpr double	PI_2 = 1.57079632679489661923

constexpr double	PI_4 = 0.785398163397448309616

constexpr double	M1_PI = 0.318309886183790671538

constexpr double	M2_PI = 0.636619772367581343076

constexpr double	M2_SQRTPI = 1.12837916709551257390

constexpr double	SQRT2 = 1.41421356237309504880

constexpr double	SQRT1_2 = 0.707106781186547524401

constexpr glm::vec3	X_AXIS = { 1.0f, 0.0f, 0.0f }

constexpr glm::vec3	Y_AXIS = { 0.0f, 1.0f, 0.0f }

constexpr glm::vec3	Z_AXIS = { 0.0f, 0.0f, 1.0f }

constexpr glm::vec3	FORWARD = { 0.0f, 0.0f, -1.0f }

Typedef Documentation

◆ DoubleSmoothOperator

using DoubleSmoothOperator = SmoothOperator<double>

◆ FloatFComplex

using FloatFComplex = FComplex<float, float>

◆ FloatFCurve

using FloatFCurve = FCurve<float, float>

◆ FloatFCurvePoint

using FloatFCurvePoint = FCurvePoint<float, float>

◆ FloatSmoothOperator

using FloatSmoothOperator = SmoothOperator<float>

◆ Vec2FComplex

using Vec2FComplex = FComplex<float, glm::vec2>

◆ Vec2FCurve

using Vec2FCurve = FCurve<float, glm::vec2>

◆ Vec2FCurvePoint

using Vec2FCurvePoint = FCurvePoint<float, glm::vec2>

◆ Vec2SmoothOperator

using Vec2SmoothOperator = SmoothOperator<glm::vec2>

◆ Vec3FComplex

using Vec3FComplex = FComplex<float, glm::vec3>

◆ Vec3FCurve

using Vec3FCurve = FCurve<float, glm::vec3>

◆ Vec3FCurvePoint

using Vec3FCurvePoint = FCurvePoint<float, glm::vec3>

◆ Vec3SmoothOperator

using Vec3SmoothOperator = SmoothOperator<glm::vec3>

◆ Vec4FComplex

using Vec4FComplex = FComplex<float, glm::vec4>

◆ Vec4FCurve

using Vec4FCurve = FCurve<float, glm::vec4>

◆ Vec4FCurvePoint

using Vec4FCurvePoint = FCurvePoint<float, glm::vec4>

◆ Vec4SmoothOperator

using Vec4SmoothOperator = SmoothOperator<glm::vec4>

Enumeration Type Documentation

◆ ECurveInterp

enum ECurveInterp : int

strong

Possible interpolations per curve segment

Enumerator
Bezier	Bezier style interpolation.
Linear	Linear style interpolation.
Stepped	Stepped interpolated (hold previous value until next curve point.

◆ EWaveform

enum EWaveform : int

strong

Various available waveforms

Enumerator
SINE	Sine.
SQUARE	Square.
SAW	Saw.
TRIANGLE	Triangle.

Function Documentation

◆ abs() [1/3]

NAPAPI float nap::math::abs ( float value )

◆ abs() [2/3]

NAPAPI int nap::math::abs ( int value )

◆ abs() [3/3]

T nap::math::abs ( T value )

Returns: absolute value.

◆ bell()

T bell	(	T	time,
		T	strength
	)

Returns: a bell shaped curve based on value T (0-1)

Parameters

time	sample value, from 0-1.
strength	exponent of the bell curve

◆ ceil()

T ceil ( T value )

Rounds value upward, returning the smallest integral value that is not less than x. For example: 2.3 -> 3.0, -2.3 -> 2.0

Parameters

value value to ceil

Returns: The smallest integral value that is not less than x (as a floating-point value).

◆ clamp()

T clamp	(	T	value,
		T	min,
		T	max
	)

Clamp a value between min and max. The value will never exceed max parameter or fall below min.

Parameters

value	value to clamp.
min	lower limit of value.
max	upper limit of value.

Returns: value clamped to min and max.

◆ colorBurn()

T colorBurn	(	T	target,
		T	blend
	)

Color Burn

Non-Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ colorDodge()

T colorDodge	(	T	target,
		T	blend
	)

Color Dodge

Non-Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ composeMatrix()

glm::mat4 NAPAPI nap::math::composeMatrix	(	const glm::vec3 &	translate,
		const glm::quat &	rotate,
		const glm::vec3 &	scale
	)

Composes a 4x4 matrix based on individual transformation, rotation and scale values

Parameters

translate	a vector describing the objects position
rotate	quaternion describing the objects rotation
scale	a vector describing the objects scale

Returns: the composed 4x4 matrix

◆ darken()

T darken	(	T	target,
		T	blend
	)

Darken

Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ degrees()

float NAPAPI nap::math::degrees ( float radians )

Converts radians to degrees.

Parameters

radians angle in radians

Returns: angle in degrees

◆ difference()

T difference	(	T	target,
		T	blend
	)

Difference

Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ epsilon()

constexpr T epsilon ( )

constexpr

Returns the machine epsilon, that is, the difference between 1.0 and the next value representable by the floating-point type T. Only works for non-integral types.

Returns: epsilon of type T.

◆ eulerToQuat() [1/2]

glm::quat NAPAPI nap::math::eulerToQuat ( const glm::vec3 & eulerAngle )

Converts euler angles in to a quaternion The euler angle axis are interpreted as: roll(x), pitch(y), yaw(z),

Parameters

eulerAngle the individual euler angles in radians

Returns: the composed quaternion

◆ eulerToQuat() [2/2]

glm::quat NAPAPI nap::math::eulerToQuat	(	float	roll,
		float	pitch,
		float	yaw
	)

Converts euler angles in to a quaternion The euler angle axis are interpreted as: roll(x), pitch(y), yaw(z),

Parameters

roll	the x axis rotation value in radians
pitch	the y axis rotation value in radians
yaw	the z axis rotation value in radians

Returns: the composed quaternion

◆ exclusion()

T exclusion	(	T	target,
		T	blend
	)

Exclusion

Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ extractPosition()

glm::vec3 NAPAPI nap::math::extractPosition ( const glm::mat4x4 & matrix )

Extracts the position component from a 4x4 matrix. This call assumes the matrix is column major, the outermost array dimension is a column.

Parameters

matrix column major matrix

Returns: the position component from a 4x4 matrix

◆ fit()

T fit	(	T	value,
		T	min,
		T	max,
		T	outMin,
		T	outMax
	)

Maps a value from min/max to outMin/outMax. For example: fit<float>(10.0f, 0.0f, 20.0f, 100.0f, 200.0f) -> returns 150.0f. Input is clamped, ensuring output is always in outMin and outMax range.

Parameters

value	the value to map
min	the min input value
max	the max input value
outMin	min output value
outMax	max output value

Returns: mapped value

◆ floor()

T floor ( T value )

Rounds value downward, returning the largest integral value that is not greater than value. For example: 2.3 -> 2.0, -3.8 -> -4.0

Parameters

value value to floor.

Returns: floored value of T

◆ generateUUID()

std::string NAPAPI nap::math::generateUUID ( )

Generate a UUID4, random every time, based on host device and random distribution

◆ getDistancesAlongLine()

float NAPAPI nap::math::getDistancesAlongLine	(	const std::vector< glm::vec3 > &	vertexPositions,
		std::map< float, int > &	outDistances,
		bool	loop
	)

Utility function to retrieve distances along a line This function will calculate the distance of a vertex along the line based on the total length of that line The distance map allows you to easily retrieve the closest vertex associated with a certain distance

Parameters

vertexPositions	the vertex position data
outDistances	a map that has a distance entry for every vertex of the line
loop	if the last vertex should be connected to the first vertex, creating a loop

Returns: the total length of the line

◆ getNormalAlongLine()

void NAPAPI nap::math::getNormalAlongLine	(	const std::map< float, int > &	distanceMap,
		const std::vector< glm::vec3 > &	vertexNormals,
		float	location,
		glm::vec3 &	outNormal
	)

Utility function that returns the interpolated normal value along a line This function accurately blends a normal based on the position of a vertex on the line Note that normals with a length of 0 will result in an invalid normal as we can't rotate along a normal with no value

Parameters

distanceMap	the per vertex line distance map that can be acquired using the getDistancesAlongLine function
vertexNormals	the normal data associated with a line
location	parametric normalized location along the spline, this value needs to be within the 0-1 range
outNormal	the interpolated normal

◆ getValueAlongLine() [1/2]

void getValueAlongLine	(	const std::map< float, int > &	distanceMap,
		const std::vector< T > &	vertexData,
		float	location,
		T &	outValue
	)

Utility function that returns an interpolated attribute value along a line This function is more accurate but requires an extra step to perform the interpolation

Parameters

distanceMap	the per vertex line distance map that can be acquired using the getDistancesAlongLine() function
vertexData	the polyline attribute to sample
location	parametric normalized location along the spline, this value needs to be within the 0-1 range
outValue	the interpolated attribute value

◆ getValueAlongLine() [2/2]

void getValueAlongLine	(	const std::vector< T > &	vertexData,
		float	location,
		bool	closed,
		T &	outValue
	)

Returns an interpolated value along the line based on the given location Note that this function works best with equally distributed vertices, ie: segments of equal length. For more accurate results use the getDistancesAlongLine() function, based on actual distance.

Parameters

vertexData	the polyline attribute to sample, ie position, normal etc.
location	parametric normalized (0-1) location along the spline
closed	if the line is closed or not
outValue	the interpolated attribute value

◆ getVertexLerpValue()

float NAPAPI nap::math::getVertexLerpValue	(	const std::map< float, int > &	distanceMap,
		float	location,
		int &	outMinVertex,
		int &	outMaxVertex
	)

Utility function that returns a normalized blend value between two line vertices based on a position along the line

Parameters

distanceMap	the per vertex line distance map that can be acquired using the getDistancesAlongLine() function
location	parametric normalized location along the spline, this value needs to be within the 0-1 range
outMinVertex	the lower bound vertex id
outMaxVertex	the upper bound vertex id

Returns: the blend value between the lower and upper vertex

◆ hardLight()

T hardLight	(	T	target,
		T	blend
	)

Hard Light

Non-Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ lerp()

T nap::math::lerp	(	const T &	start,
		const T &	end,
		float	percent
	)

Blends a value between start and end value based on percentage (0-1).

Parameters

start	begin value
end	end value
percent	the amount to blend between start and end, in between 0 and 1.

Returns: interpolated value.

◆ lerp< double >()

NAPAPI double nap::math::lerp< double >	(	const double &	start,
		const double &	end,
		float	percent
	)

◆ lerp< float >()

NAPAPI float nap::math::lerp< float >	(	const float &	start,
		const float &	end,
		float	percent
	)

◆ lerp< glm::vec2 >()

NAPAPI glm::vec2 nap::math::lerp< glm::vec2 >	(	const glm::vec2 &	start,
		const glm::vec2 &	end,
		float	percent
	)

◆ lerp< glm::vec3 >()

NAPAPI glm::vec3 nap::math::lerp< glm::vec3 >	(	const glm::vec3 &	start,
		const glm::vec3 &	end,
		float	percent
	)

◆ lerp< glm::vec4 >()

NAPAPI glm::vec4 nap::math::lerp< glm::vec4 >	(	const glm::vec4 &	start,
		const glm::vec4 &	end,
		float	percent
	)

◆ lighten()

T lighten	(	T	target,
		T	blend
	)

Lighten

Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ linearBurn()

T linearBurn	(	T	target,
		T	blend
	)

Linear Burn

Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ linearDodge()

T linearDodge	(	T	target,
		T	blend
	)

Linear Dodge

Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ linearLight()

T linearLight	(	T	target,
		T	blend
	)

Linear Light

Non-Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ max() [1/2]

constexpr T max ( )

constexpr

Returns: the maximum possible value of type T

◆ max() [2/2]

T max	(	T	left,
		T	right
	)

Returns the highest of 2 values.

Parameters

left	first value.
right	second value.

Returns: the highest value.

◆ min() [1/2]

constexpr T min ( )

constexpr

Returns: the lowest finite value of type T

◆ min() [2/2]

T min	(	T	left,
		T	right
	)

Returns the lowest of 2 values.

Parameters

left	first value.
right	second value.

Returns: the lowest value.

◆ multiply()

T multiply	(	T	target,
		T	blend
	)

Multiply

Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ objectToWorld()

glm::vec3 NAPAPI nap::math::objectToWorld	(	const glm::vec3 &	point,
		const glm::mat4x4 &	objectToWorldMatrix
	)

Converts a point in object space to world space using the given object to world matrix.

Parameters

point	the point in object space
objectToWorldMatrix	local to world space transformation matrix

Returns: point in world space

◆ overlay()

T overlay	(	T	target,
		T	blend
	)

Overlay

Non-Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ pinLight()

T pinLight	(	T	target,
		T	blend
	)

Pin Light

Non-Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ power()

T nap::math::power	(	T	value,
		T	exp
	)

Parameters

value	parameter to raise.
exp	power exponent.

Returns: Return base raised to the power exponent.

◆ power< double >()

NAPAPI double nap::math::power< double >	(	double	value,
		double	exp
	)

◆ power< float >()

NAPAPI float nap::math::power< float >	(	float	value,
		float	exp
	)

◆ power< int >()

NAPAPI int nap::math::power< int >	(	int	value,
		int	exp
	)

◆ radians() [1/3]

glm::vec3 NAPAPI nap::math::radians ( const glm::vec3 & eulerDegrees )

Converts an euler rotation in degrees to radians

Parameters

eulerDegrees the euler rotation roll(x), pitch(y), yaw(z) in degrees

Returns: the euler rotation in radians

◆ radians() [2/3]

float NAPAPI nap::math::radians ( float degrees )

Converts degrees to radians.

Parameters

degrees angle in degrees

Returns: angle as radians

◆ radians() [3/3]

glm::vec3 NAPAPI nap::math::radians	(	float	roll,
		float	pitch,
		float	yaw
	)

Converts an euler rotation in degrees to radians The arguments are interpreted as floats

Parameters

roll	the x axis rotation in degrees
pitch	the y axis rotation in degrees
yaw	the z axis rotation in degrees

Returns: the euler rotation in radians

◆ random() [1/11]

NAPAPI float nap::math::random	(	float	min,
		float	max
	)

◆ random() [2/11]

NAPAPI glm::ivec2 nap::math::random	(	glm::ivec2	min,
		glm::ivec2	max
	)

◆ random() [3/11]

NAPAPI glm::ivec3 nap::math::random	(	glm::ivec3	min,
		glm::ivec3	max
	)

◆ random() [4/11]

NAPAPI glm::ivec4 nap::math::random	(	glm::ivec4	min,
		glm::ivec4	max
	)

◆ random() [5/11]

NAPAPI glm::mat4 nap::math::random	(	glm::mat4	min,
		glm::mat4	max
	)

◆ random() [6/11]

NAPAPI glm::vec2 nap::math::random	(	glm::vec2	min,
		glm::vec2	max
	)

◆ random() [7/11]

NAPAPI glm::vec3 nap::math::random	(	glm::vec3	min,
		glm::vec3	max
	)

◆ random() [8/11]

NAPAPI glm::vec4 nap::math::random	(	glm::vec4	min,
		glm::vec4	max
	)

◆ random() [9/11]

NAPAPI int nap::math::random	(	int	min,
		int	max
	)

◆ random() [10/11]

T nap::math::random	(	T	min,
		T	max
	)

Returns a random number of type T in the range of the given min / max value. Note that the random number is based on the seed set by setRandomSeed.

Returns: a random number in range min / max.

Parameters

min	min random number
max	max random number

Returns: the generated random number.

◆ random() [11/11]

NAPAPI uint nap::math::random	(	uint	min,
		uint	max
	)

◆ resampleLine()

int resampleLine	(	std::vector< T > &	vertices,
		std::vector< T > &	buffer,
		int	segments,
		bool	closed
	)

Utility function to up-sample a polyline to the given number of segments This function distributes the vertices equally among every segment, something that is not desirable with more uneven, complex lines A weighted distribution method is preferred but for now this will do.

Parameters

vertices	the original mesh vertices
buffer	the buffer that will hold the re-sampled vertices
segments	the amount of segments the poly line should have, a segment is the line between two vertices
closed	if the line is closed or not, if a line is not closed it will contain one extra point to maintain the last vertex

Returns: the total number of generated vertices

◆ screen()

T screen	(	T	target,
		T	blend
	)

Screen

Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ setRandomSeed()

void NAPAPI nap::math::setRandomSeed ( int value )

Sets the seed for all subsequent random calls.

Parameters

value the new seed value

◆ sign()

T sign ( T value )

Parameters

value requested sign value

Returns: the sign of the given value, 1 for values > 0, -1 for values < 0, 0 for values of exactly 0.

◆ smooth() [1/6]

NAPAPI void nap::math::smooth	(	double &	currentValue,
		const double &	targetValue,
		double &	currentVelocity,
		float	deltaTime,
		float	smoothTime,
		float	maxSpeed
	)

◆ smooth() [2/6]

NAPAPI void nap::math::smooth	(	float &	currentValue,
		const float &	targetValue,
		float &	currentVelocity,
		float	deltaTime,
		float	smoothTime,
		float	maxSpeed
	)

◆ smooth() [3/6]

NAPAPI void nap::math::smooth	(	glm::vec2 &	currentValue,
		const glm::vec2 &	targetValue,
		glm::vec2 &	currentVelocity,
		float	deltaTime,
		float	smoothTime,
		float	maxSpeed
	)

◆ smooth() [4/6]

NAPAPI void nap::math::smooth	(	glm::vec3 &	currentValue,
		const glm::vec3 &	targetValue,
		glm::vec3 &	currentVelocity,
		float	deltaTime,
		float	smoothTime,
		float	maxSpeed
	)

◆ smooth() [5/6]

NAPAPI void nap::math::smooth	(	glm::vec4 &	currentValue,
		const glm::vec4 &	targetValue,
		glm::vec4 &	currentVelocity,
		float	deltaTime,
		float	smoothTime,
		float	maxSpeed
	)

◆ smooth() [6/6]

void NAPAPI nap::math::smooth	(	T &	currentValue,
		const T &	targetValue,
		T &	currentVelocity,
		float	deltaTime,
		float	smoothTime,
		float	maxSpeed
	)

Smoothly interpolates a value of type T over time to a target using a dampening model. The smoothTime argument is the expected time in seconds to reach the target assuming the current value changes at maximum velocity. This is a specialization of the default smoothDamp() function.

Parameters

currentValue	the current blend value, will be updated after calling
targetValue	the value to blend to
currentVelocity	the current velocity used to blend to target
deltaTime	time in seconds between cooks
smoothTime	approximately the time it will take to reach the target in seconds. A smaller value will reach the target faster.
maxSpeed	allows you to clamp the maximum speed

Returns: the blended current value

◆ smoothDamp()

T NAPAPI nap::math::smoothDamp	(	T	currentValue,
		T	targetValue,
		T &	currentVelocity,
		float	deltaTime,
		float	smoothTime,
		float	maxSpeed = `math::max< float >()`
	)

Interpolates a float value over time to a targetValue using a dampening model The smoothTime argument is the expected time in seconds to reach the targetValue assuming the currentValue value changes at maximum currentVelocity. The weights of this function are tuned for the range 0-1. Based on Chapter 1.10 of "Game Programming Gems 4".

Parameters

currentValue	the current blend value, often the return value
targetValue	the value to blend to
currentVelocity	the current velocity used to blend to target
deltaTime	time in seconds between cooks
smoothTime	approximately the time it will take to reach the target in seconds. A smaller value will reach the target faster.
maxSpeed	allows you to clamp the maximum speed

Returns: the blended currentValue value

◆ smoothStep()

T smoothStep	(	T	value,
		T	edge0,
		T	edge1
	)

Smoothly interpolates, using a Hermite polynomial, between 0 and 1

Parameters

value	value to interpolate
edge0	returns 0 if input is less than this value
edge1	returns 1 if input is higher than this value

◆ softLight()

T softLight	(	T	target,
		T	blend
	)

Soft Light

Non-Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ vividLight()

T vividLight	(	T	target,
		T	blend
	)

Vivid Light

Non-Commutative

Parameters

target	Base value
blend	Value to combine with

Returns: The result

◆ waveform()

float NAPAPI nap::math::waveform	(	EWaveform	type,
		float	time,
		float	frequency
	)

Returns: a normalized value (0-1) associated with a specific type of waveform

Parameters

type	the waveform type to query
time	point in time to sample the waveform
frequency	the waveform frequency

Returns: a normalized (0-1) waveform value

◆ worldToObject()

glm::vec3 NAPAPI nap::math::worldToObject	(	const glm::vec3 &	point,
		const glm::mat4x4 &	objectToWorldMatrix
	)

Converts a point in world space to a point in object space using the given object to world matrix Note that this call internally uses matrix inversion, a rather costly operation

Parameters

point	in world space
objectToWorldMatrix	the object to world transformation matrix

Returns: point in object space

Variable Documentation

◆ E

constexpr double E = 2.71828182845904523536

constexpr

◆ FORWARD

constexpr glm::vec3 FORWARD = { 0.0f, 0.0f, -1.0f }

constexpr

◆ LN10

constexpr double LN10 = 2.30258509299404568402

constexpr

◆ LN2

constexpr double LN2 = 0.693147180559945309417

constexpr

◆ LOG10E

constexpr double LOG10E = 0.434294481903251827651

constexpr

◆ LOG2E

constexpr double LOG2E = 1.44269504088896340736

constexpr

◆ M1_PI

constexpr double M1_PI = 0.318309886183790671538

constexpr

◆ M2_PI

constexpr double M2_PI = 0.636619772367581343076

constexpr

◆ M2_SQRTPI

constexpr double M2_SQRTPI = 1.12837916709551257390

constexpr

◆ PI

constexpr double PI = 3.14159265358979323846

constexpr

◆ PI_2

constexpr double PI_2 = 1.57079632679489661923

constexpr

◆ PI_4

constexpr double PI_4 = 0.785398163397448309616

constexpr

◆ PIX2

constexpr double PIX2 = 6.28318530717958647692

constexpr

◆ SQRT1_2

constexpr double SQRT1_2 = 0.707106781186547524401

constexpr

◆ SQRT2

constexpr double SQRT2 = 1.41421356237309504880

constexpr

◆ X_AXIS

constexpr glm::vec3 X_AXIS = { 1.0f, 0.0f, 0.0f }

constexpr

◆ Y_AXIS

constexpr glm::vec3 Y_AXIS = { 0.0f, 1.0f, 0.0f }

constexpr

◆ Z_AXIS

constexpr glm::vec3 Z_AXIS = { 0.0f, 0.0f, 1.0f }

constexpr

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ DoubleSmoothOperator

◆ FloatFComplex

◆ FloatFCurve

◆ FloatFCurvePoint

◆ FloatSmoothOperator

◆ Vec2FComplex

◆ Vec2FCurve

◆ Vec2FCurvePoint

◆ Vec2SmoothOperator

◆ Vec3FComplex

◆ Vec3FCurve

◆ Vec3FCurvePoint

◆ Vec3SmoothOperator

◆ Vec4FComplex

◆ Vec4FCurve

◆ Vec4FCurvePoint

◆ Vec4SmoothOperator

Enumeration Type Documentation

◆ ECurveInterp

◆ EWaveform

Function Documentation

◆ abs() [1/3]

◆ abs() [2/3]

◆ abs() [3/3]

◆ bell()

◆ ceil()

◆ clamp()

◆ colorBurn()

◆ colorDodge()

◆ composeMatrix()

◆ darken()

◆ degrees()

◆ difference()

◆ epsilon()

◆ eulerToQuat() [1/2]

◆ eulerToQuat() [2/2]

◆ exclusion()

◆ extractPosition()

◆ fit()

◆ floor()

◆ generateUUID()

◆ getDistancesAlongLine()

◆ getNormalAlongLine()

◆ getValueAlongLine() [1/2]

◆ getValueAlongLine() [2/2]

◆ getVertexLerpValue()

◆ hardLight()

◆ lerp()

◆ lerp< double >()

◆ lerp< float >()

◆ lerp< glm::vec2 >()

◆ lerp< glm::vec3 >()

◆ lerp< glm::vec4 >()

◆ lighten()

◆ linearBurn()

◆ linearDodge()

◆ linearLight()

◆ max() [1/2]

◆ max() [2/2]

◆ min() [1/2]

◆ min() [2/2]

◆ multiply()

◆ objectToWorld()

◆ overlay()

◆ pinLight()

◆ power()

◆ power< double >()

◆ power< float >()

◆ power< int >()

◆ radians() [1/3]

◆ radians() [2/3]

◆ radians() [3/3]

◆ random() [1/11]