HighMap library (C++)
Loading...
Searching...
No Matches
hmap::StepFunction Class Reference

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

#include <functions.hpp>

Inheritance diagram for hmap::StepFunction:
Collaboration diagram for hmap::StepFunction:

Public Member Functions

 StepFunction (float angle, float slope, Vec2< float > center)
 Construct a new Step 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
 Step slope.
 
Vec2< float > center
 Primitive reference center.
 

Detailed Description

Step (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

◆ StepFunction()

hmap::StepFunction::StepFunction ( float  angle,
float  slope,
Vec2< float >  center 
)

Construct a new Step Function object.

Parameters
angleOverall rotation angle (in degrees).
slopeStep slope.
centerPrimitive reference center.

Member Function Documentation

◆ set_angle()

void hmap::StepFunction::set_angle ( float  new_angle)
inline

Set the angle.

Parameters
new_angleNew angle in degrees.

Member Data Documentation

◆ angle

float hmap::StepFunction::angle
protected

Overall rotation angle (in degrees).

◆ slope

float hmap::StepFunction::slope
protected

Step slope.

◆ center

Vec2<float> hmap::StepFunction::center
protected

Primitive reference center.


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