Skip to content

Commit

Permalink
[octree] Add reference to neighbor method
Browse files Browse the repository at this point in the history
  • Loading branch information
movabo committed Jun 26, 2021
1 parent 48249e7 commit 3fcf809
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion include/inexor/vulkan-renderer/world/cube.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,12 @@ class Cube : public std::enable_shared_from_this<Cube> {
/// @param update_invalid If true it will update invalid polygon caches.
[[nodiscard]] std::vector<PolygonCache> polygons(bool update_invalid = false) const;

/// Get the neighbor of this cube.
/// Get the (face) neighbor of this cube by using a similar implementation to Samets "OT_GTEQ_FACE_NEIGHBOR(P,I)".
/// @brief Get the (face) neighbor of this cube.
/// @param axis The axis on which to get the neighboring cube
/// @param direction Whether to get the cube which is above or below this cube on the selected axis
/// @see Samet, H. (1989) Neighbor finding in Images Represented by Octrees. Computer Vision, Graphics, and
/// Image Processing. 46 (3), 367-386. Available from: http://www.cs.umd.edu/~hjs/pubs/SameCVGIP89.pdf
[[nodiscard]] std::shared_ptr<Cube> neighbor(NeighborAxis axis, NeighborDirection direction);
};

Expand Down

0 comments on commit 3fcf809

Please sign in to comment.