HighMap library (C++)
Loading...
Searching...
No Matches
boundary.hpp
Go to the documentation of this file.
1/* Copyright (c) 2023 Otto Link. Distributed under the terms of the GNU General
2 Public License. The full license is in the file LICENSE, distributed with
3 this software. */
4
17#pragma once
18#include "highmap/array.hpp"
19#include "highmap/math.hpp"
20
21namespace hmap
22{
23
28// clang-format off
35// clang-format on
36
56void extrapolate_borders(Array &array, int nbuffer = 1, float sigma = 0.f);
57
86void falloff(Array &array,
87 float strength = 1.f,
89 const Array *p_noise = nullptr,
90 Vec4<float> bbox = {0.f, 1.f, 0.f, 1.f});
91
105void fill_borders(Array &array);
106
107void fill_borders(Array &array, int nbuffer);
108
128Array generate_buffered_array(const Array &array,
129 Vec4<int> buffers,
130 bool zero_padding = false);
131
151void make_periodic(
152 Array &array,
153 int nbuffer,
154 const PeriodicityType &periodicity_type = PeriodicityType::PERIODICITY_XY);
155
181Array make_periodic_stitching(const Array &array, float overlap);
182
207Array make_periodic_tiling(const Array &array, float overlap, Vec2<int> tiling);
208
230void set_borders(Array &array,
231 Vec4<float> border_values,
232 Vec4<int> buffer_sizes);
233
247void set_borders(Array &array, float border_values, int buffer_sizes);
248
262void sym_borders(Array &array, Vec4<int> buffer_sizes);
263
276void zeroed_borders(Array &array);
277
304void zeroed_edges(Array &array,
305 float sigma = 1.f,
307 const Array *p_noise = nullptr,
308 Vec4<float> bbox = {0.f, 1.f, 0.f, 1.f});
309
310} // namespace hmap
Declaration of the Array class for 2D floating-point arrays with various mathematical operations and ...
Provides core mathematical utilities for procedural generation, including trigonometry,...
Definition algebra.hpp:28
void fill_borders(Array &array)
Fills the border values of an array (e.g., i = 0, j = 0, etc.) based on the values of the first neigh...
Definition boundary.cpp:117
Array make_periodic_stitching(const Array &array, float overlap)
Creates a periodic array in both directions using a stitching operation that minimizes errors at the ...
Definition boundary.cpp:262
void falloff(Array &array, float strength=1.f, DistanceFunction dist_fct=DistanceFunction::EUCLIDIAN, const Array *p_noise=nullptr, Vec4< float > bbox={0.f, 1.f, 0.f, 1.f})
Applies a falloff effect to the input array based on distance.
Definition boundary.cpp:78
void make_periodic(Array &array, int nbuffer, const PeriodicityType &periodicity_type=PeriodicityType::PERIODICITY_XY)
Adjusts the input array to be periodic in both directions by transitioning smoothly at the boundaries...
Definition boundary.cpp:193
PeriodicityType
Describes the periodicity mode applied along map axes.
Definition boundary.hpp:30
@ PERIODICITY_XY
Periodic along both the X and Y axes.
Definition boundary.hpp:33
@ PERIODICITY_X
Periodic only along the X axis.
Definition boundary.hpp:31
@ PERIODICITY_Y
Periodic only along the Y axis.
Definition boundary.hpp:32
Array generate_buffered_array(const Array &array, Vec4< int > buffers, bool zero_padding=false)
Creates and returns a new array with additional buffer zones at the boundaries, where the buffer valu...
Definition boundary.cpp:155
void sym_borders(Array &array, Vec4< int > buffer_sizes)
Fills the values at the domain borders using symmetry over a specified buffer depth.
Definition boundary.cpp:411
DistanceFunction
Distance function type.
Definition math.hpp:43
@ EUCLIDIAN
Euclidian.
Definition math.hpp:45
void set_borders(Array &array, Vec4< float > border_values, Vec4< int > buffer_sizes)
Enforces specific values at the boundaries of the array.
Definition boundary.cpp:355
void extrapolate_borders(Array &array, int nbuffer=1, float sigma=0.f)
Performs linear extrapolation of values at the borders of an array (e.g., i = 0, j = 0,...
Definition boundary.cpp:17
Array make_periodic_tiling(const Array &array, float overlap, Vec2< int > tiling)
Creates a tiled, periodic array by applying a transition with overlap in both directions.
Definition boundary.cpp:330
void zeroed_borders(Array &array)
Fills the border values (e.g., i = 0, j = 0, etc.) of the array with zeros.
Definition boundary.cpp:436
void zeroed_edges(Array &array, float sigma=1.f, DistanceFunction dist_fct=DistanceFunction::EUCLIDIAN, const Array *p_noise=nullptr, Vec4< float > bbox={0.f, 1.f, 0.f, 1.f})
Applies a smooth transition to zero at the array borders.
Definition boundary.cpp:454