src/voxelalgorithms.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include "voxel.h"
  23 #include "mapnode.h"
  24 #include "util/container.h"
  25
  26 class Map;
  27 class MapBlock;
  28 class MMVManip;
  29
  30 namespace voxalgo
  31 {
  32
  33 /*!
  34  * Updates the lighting on the map.
  35  * The result will be correct only if
  36  * no nodes were changed except the given ones.
  37  * Before calling this procedure make sure that all new nodes on
  38  * the map have zero light level!
  39  *
  40  * \param oldnodes contains the MapNodes that were replaced by the new
  41  * MapNodes and their positions
  42  * \param modified_blocks output, contains all map blocks that
  43  * the function modified
  44  */
  45 void update_lighting_nodes(
  46         Map *map,
  47         const std::vector<std::pair<v3s16, MapNode>> &oldnodes,
  48         std::map<v3s16, MapBlock*> &modified_blocks);
  49
  50 /*!
  51  * Updates borders of the given mapblock.
  52  * Only updates if the block was marked with incomplete
  53  * lighting and the neighbor is also loaded.
  54  *
  55  * \param block the block to update
  56  * \param modified_blocks output, contains all map blocks that
  57  * the function modified
  58  */
  59 void update_block_border_lighting(Map *map, MapBlock *block,
  60         std::map<v3s16, MapBlock*> &modified_blocks);
  61
  62 /*!
  63  * Copies back nodes from a voxel manipulator
  64  * to the map and updates lighting.
  65  * For server use only.
  66  *
  67  * \param modified_blocks output, contains all map blocks that
  68  * the function modified
  69  */
  70 void blit_back_with_light(Map *map, MMVManip *vm,
  71         std::map<v3s16, MapBlock*> *modified_blocks);
  72
  73 /*!
  74  * Corrects the light in a map block.
  75  * For server use only.
  76  *
  77  * \param block the block to update
  78  */
  79 void repair_block_light(Map *map, MapBlock *block,
  80         std::map<v3s16, MapBlock*> *modified_blocks);
  81
  82 /*!
  83  * This class iterates trough voxels that intersect with
  84  * a line. The collision detection does not see nodeboxes,
  85  * every voxel is a cube and is returned.
  86  * This iterator steps to all nodes exactly once.
  87  */
  88 struct VoxelLineIterator
  89 {
  90 public:
  91         //! Starting position of the line in world coordinates.
  92         v3f m_start_position;
  93         //! Direction and length of the line in world coordinates.
  94         v3f m_line_vector;
  95         /*!
  96          * Each component stores the next smallest positive number, by
  97          * which multiplying the line's vector gives a vector that ends
  98          * on the intersection of two nodes.
  99          */
 100         v3f m_next_intersection_multi { 10000.0f, 10000.0f, 10000.0f };
 101         /*!
 102          * Each component stores the smallest positive number, by which
 103          * m_next_intersection_multi's components can be increased.
 104          */
 105         v3f m_intersection_multi_inc { 10000.0f, 10000.0f, 10000.0f };
 106         /*!
 107          * Direction of the line. Each component can be -1 or 1 (if a
 108          * component of the line's vector is 0, then there will be 1).
 109          */
 110         v3s16 m_step_directions { 1, 1, 1 };
 111         //! Position of the current node.
 112         v3s16 m_current_node_pos;
 113         //! Index of the current node
 114         s16 m_current_index = 0;
 115         //! Position of the start node.
 116         v3s16 m_start_node_pos;
 117         //! Index of the last node
 118         s16 m_last_index;
 119
 120         /*!
 121          * Creates a voxel line iterator with the given line.
 122          * @param start_position starting point of the line
 123          * in voxel coordinates
 124          * @param line_vector    length and direction of the
 125          * line in voxel coordinates. start_position+line_vector
 126          * is the end of the line
 127          */
 128         VoxelLineIterator(const v3f &start_position,const v3f &line_vector);
 129
 130         /*!
 131          * Steps to the next voxel.
 132          * Updates m_current_node_pos and
 133          * m_previous_node_pos.
 134          * Note that it works even if hasNext() is false,
 135          * continuing the line as a ray.
 136          */
 137         void next();
 138
 139         /*!
 140          * Returns true if the next voxel intersects the given line.
 141          */
 142         inline bool hasNext() const
 143         {
 144                 return m_current_index < m_last_index;
 145         }
 146
 147         /*!
 148          * Returns how many times next() must be called until
 149          * voxel==m_current_node_pos.
 150          * If voxel does not intersect with the line,
 151          * the result is undefined.
 152          */
 153         s16 getIndex(v3s16 voxel);
 154 };
 155
 156 } // namespace voxalgo