hmap::RiftFunction Class Reference

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

#include <functions.hpp>

Inheritance diagram for hmap::RiftFunction:

Collaboration diagram for hmap::RiftFunction:

Public Member Functions
	RiftFunction (float angle, float slope, float width, bool sharp_bottom, Vec2< float > center)
	Construct a new Rift Function object.
void	set_angle (float new_angle)
	Set the angle.
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	angle
	Overall rotation angle (in degrees).
float	slope
	Rift slope.
float	width
	Rift width.
bool	sharp_bottom
	Rift bottom sharpness.
Vec2< float >	center
	Primitive reference center.

Detailed Description

Rift (x, y) function class.

This class models a step function with a specified angle, slope, and reference center. It extends the base Function class.

Constructor & Destructor Documentation

RiftFunction()

hmap::RiftFunction::RiftFunction	(	float	angle,
		float	slope,
		float	width,
		bool	sharp_bottom,
		Vec2< float >	center
	)

Construct a new Rift Function object.

Parameters

angle	Overall rotation angle (in degrees).
slope	Rift slope.
width	Rift width.
sharp_bottom	Decide whether the rift bottom is sharp or not.
center	Primitive reference center.

Member Function Documentation

set_angle()

void hmap::RiftFunction::set_angle ( float  new_angle )

inline

Set the angle.

Parameters

new_angle

New angle in degrees.

Member Data Documentation

angle

float hmap::RiftFunction::angle

protected

Overall rotation angle (in degrees).

slope

float hmap::RiftFunction::slope

protected

Rift slope.

width

float hmap::RiftFunction::width

protected

Rift width.

sharp_bottom

bool hmap::RiftFunction::sharp_bottom

protected

Rift bottom sharpness.

center

Vec2<float> hmap::RiftFunction::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