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 ServerMap;
  28 class MapBlock;
  29 class MMVManip;
  30
  31 namespace voxalgo
  32 {
  33
  34 // TODO: Move unspreadLight and spreadLight from VoxelManipulator to here
  35
  36 void setLight(VoxelManipulator &v, VoxelArea a, u8 light,
  37                 INodeDefManager *ndef);
  38
  39 void clearLightAndCollectSources(VoxelManipulator &v, VoxelArea a,
  40                 enum LightBank bank, INodeDefManager *ndef,
  41                 std::set<v3s16> & light_sources,
  42                 std::map<v3s16, u8> & unlight_from);
  43
  44 struct SunlightPropagateResult
  45 {
  46         bool bottom_sunlight_valid;
  47
  48         SunlightPropagateResult(bool bottom_sunlight_valid_):
  49                 bottom_sunlight_valid(bottom_sunlight_valid_)
  50         {}
  51 };
  52
  53 SunlightPropagateResult propagateSunlight(VoxelManipulator &v, VoxelArea a,
  54                 bool inexistent_top_provides_sunlight,
  55                 std::set<v3s16> & light_sources,
  56                 INodeDefManager *ndef);
  57
  58 /*!
  59  * Updates the lighting on the map.
  60  * The result will be correct only if
  61  * no nodes were changed except the given ones.
  62  * Before calling this procedure make sure that all new nodes on
  63  * the map have zero light level!
  64  *
  65  * \param oldnodes contains the MapNodes that were replaced by the new
  66  * MapNodes and their positions
  67  * \param modified_blocks output, contains all map blocks that
  68  * the function modified
  69  */
  70 void update_lighting_nodes(
  71         Map *map,
  72         std::vector<std::pair<v3s16, MapNode> > &oldnodes,
  73         std::map<v3s16, MapBlock*> &modified_blocks);
  74
  75 /*!
  76  * Updates borders of the given mapblock.
  77  * Only updates if the block was marked with incomplete
  78  * lighting and the neighbor is also loaded.
  79  *
  80  * \param block the block to update
  81  * \param modified_blocks output, contains all map blocks that
  82  * the function modified
  83  */
  84 void update_block_border_lighting(Map *map, MapBlock *block,
  85         std::map<v3s16, MapBlock*> &modified_blocks);
  86
  87 /*!
  88  * Copies back nodes from a voxel manipulator
  89  * to the map and updates lighting.
  90  * For server use only.
  91  *
  92  * \param modified_blocks output, contains all map blocks that
  93  * the function modified
  94  */
  95 void blit_back_with_light(ServerMap *map, MMVManip *vm,
  96         std::map<v3s16, MapBlock*> *modified_blocks);
  97
  98 /*!
  99  * Corrects the light in a map block.
 100  * For server use only.
 101  *
 102  * \param block the block to update
 103  */
 104 void repair_block_light(ServerMap *map, MapBlock *block,
 105         std::map<v3s16, MapBlock*> *modified_blocks);
 106
 107 /*!
 108  * This class iterates trough voxels that intersect with
 109  * a line. The collision detection does not see nodeboxes,
 110  * every voxel is a cube and is returned.
 111  * This iterator steps to all nodes exactly once.
 112  */
 113 struct VoxelLineIterator
 114 {
 115 public:
 116         //! Starting position of the line in world coordinates.
 117         v3f m_start_position;
 118         //! Direction and length of the line in world coordinates.
 119         v3f m_line_vector;
 120         /*!
 121          * Each component stores the next smallest positive number, by
 122          * which multiplying the line's vector gives a vector that ends
 123          * on the intersection of two nodes.
 124          */
 125         v3f m_next_intersection_multi { 10000.0f, 10000.0f, 10000.0f };
 126         /*!
 127          * Each component stores the smallest positive number, by which
 128          * m_next_intersection_multi's components can be increased.
 129          */
 130         v3f m_intersection_multi_inc { 10000.0f, 10000.0f, 10000.0f };
 131         /*!
 132          * Direction of the line. Each component can be -1 or 1 (if a
 133          * component of the line's vector is 0, then there will be 1).
 134          */
 135         v3s16 m_step_directions { 1, 1, 1 };
 136         //! Position of the current node.
 137         v3s16 m_current_node_pos;
 138         //! Index of the current node
 139         s16 m_current_index = 0;
 140         //! Position of the start node.
 141         v3s16 m_start_node_pos;
 142         //! Index of the last node
 143         s16 m_last_index;
 144
 145         /*!
 146          * Creates a voxel line iterator with the given line.
 147          * @param start_position starting point of the line
 148          * in voxel coordinates
 149          * @param line_vector    length and direction of the
 150          * line in voxel coordinates. start_position+line_vector
 151          * is the end of the line
 152          */
 153         VoxelLineIterator(const v3f &start_position,const v3f &line_vector);
 154
 155         /*!
 156          * Steps to the next voxel.
 157          * Updates m_current_node_pos and
 158          * m_previous_node_pos.
 159          * Note that it works even if hasNext() is false,
 160          * continuing the line as a ray.
 161          */
 162         void next();
 163
 164         /*!
 165          * Returns true if the next voxel intersects the given line.
 166          */
 167         inline bool hasNext() const
 168         {
 169                 return m_current_index < m_last_index;
 170         }
 171
 172         /*!
 173          * Returns how many times next() must be called until
 174          * voxel==m_current_node_pos.
 175          * If voxel does not intersect with the line,
 176          * the result is undefined.
 177          */
 178         s16 getIndex(v3s16 voxel);
 179 };
 180
 181 } // namespace voxalgo