mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 08:26:04 +08:00
4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
3.3 KiB
3.3 KiB
| title |
|---|
| bresenham_line |
{{< callout type="info">}}
Headers: bresenham_line.h
{{< /callout >}}
A 'pseudo' container that generates coordinates on a line between two points using the Bresenham line algorithm.
The class has an STL-like API and is a forward iterator type container.
Note: The iterator only supports pre-increment.
etl::bresenham_line<typename T>
Where T is the coordinate element type.
Member types
value_type etl::coordinate_2d<T>
size_type std::size_t
difference_type std::ptrdiff_t
const_reference const value_type&
const_pointer const value_type*
const_iterator Constant forward iterator
Constructor
etl::bresenham_line<T>();
Description
Default constructor.
Creates an empty line.
etl::bresenham_line<T>(T first_x, T first_y, T last_x, T last_y);
Description
Creates a line from pairs of coordinates.
etl::bresenham_line<T>(const etl::coordinate_2d<T>& first, const etl::coordinate_2d<T>& last);
Description
Creates a line from pairs of coordinates.
Initialisation
void reset(T first_x, T first_y, T last_x, T last_y);
Description
Creates a line from pairs of coordinates.
Overwrites any current coordinates.
void reset(const etl::coordinate_2d<T>& first, const etl::coordinate_2d<T>& last);
Description
Creates a line from pairs of coordinates.
Overwrites any current coordinates.
Element access
const_reference front() const
Return
A const reference to the first coordinate in the line.
const_reference back() const
Return
A const reference to the last coordinate in the line.
Iterators
const_iterator begin()
Return
An iterator to the beginning of the coordinate series.
This will reset the Bresenham line algorithm to the first coordinate.
const_iterator end() const
Return An iterator to the end of the coordinate series.
Capacity
size_t size() const
Return
The number of coordinates in the series.
Non-member functions
== true if the two lines are equal, otherwise false.
!= true if the two lines are not equal, otherwise false.
Examples
Plot pixels on a line
std::ostream& operator << (std::ostream& os, const etl::coordinate_2d<int>& coordinate)
{
os << "(" << coordinate.x << "," << coordinate.y << ")";
return os;
}
etl::coordinate_2d<int> first = { -3, 5 };
etl::coordinate_2d<int> last = { 3, -5 };
etl::bresenham_line<int> line(first, last);
std::cout << "There are "
<< line.size()
<< " coordinates between "
<< line.front()
<< " and "
<< line.back();
// Plot the pixels between first and last.
std::for_each(line.begin(), line.end(), PlotPixel);
Create a vector of pixels on a line
etl::coordinate_2d<int> first = { -3, 5 };
etl::coordinate_2d<int> last = { 3, -5 };
etl::bresenham_line<int> line(first, last);
std::vector<etl::coordinate_2d<int>> coordinates;
// Create the vector of points on the line between first and last.
std::copy(line.begin(), line.end(), std::back_inserter(coordinates));