hmap::GaussianPulseFunction Class Reference

GaussianPulse (x, y) function class. More...

#include <functions.hpp>

Inheritance diagram for hmap::GaussianPulseFunction:

Collaboration diagram for hmap::GaussianPulseFunction:

Public Member Functions
	GaussianPulseFunction (float sigma, Vec2< float > center)
	Construct a new GaussianPulse Function object.
void	set_sigma (float new_sigma)
	Set the half-width.
Public Member Functions inherited from hmap::Function
	Function ()
	Default constructor. Initializes the delegate function to a default that returns 0.
virtual	~Function ()=default
	Virtual destructor to ensure proper cleanup in derived classes.
	Function (HMAP_FCT_XY_TYPE delegate)
	Constructor to initialize with a specific delegate function.
HMAP_FCT_XY_TYPE	get_delegate () const
	Get the current delegate function.
float	get_value (float x, float y, float ctrl_param) const
	Call the delegate function with given arguments.
void	set_delegate (HMAP_FCT_XY_TYPE new_delegate)
	Set a new delegate function.

Protected Attributes
float	sigma
	Pulse half-width.
Vec2< float >	center
	Primitive reference center.

Detailed Description

GaussianPulse (x, y) function class.

This class models a gaussian pulse function. It extends the base Function class.

Constructor & Destructor Documentation

GaussianPulseFunction()

hmap::GaussianPulseFunction::GaussianPulseFunction	(	float	sigma,
		Vec2< float >	center
	)

Construct a new GaussianPulse Function object.

Parameters

sigma	Pulse half-width (with respect to a unit domain).
center	Primitive reference center.

Member Function Documentation

set_sigma()

void hmap::GaussianPulseFunction::set_sigma ( float  new_sigma )

inline

Set the half-width.

Parameters

new_sigma

New half-width.

Member Data Documentation

sigma

float hmap::GaussianPulseFunction::sigma

protected

Pulse half-width.

center

Vec2<float> hmap::GaussianPulseFunction::center

protected

Primitive reference center.

---

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

• HighMap/include/highmap/functions.hpp
• HighMap/src/primitives/functions/functions.cpp