Merge branch 'master' of https://github.com/minetest/minetest

[dragonfireclient.git] / src / nodedef.h

diff --git a/src/nodedef.h b/src/nodedef.h
index 66c21cc0711b43d3e4299322e3afb763814668ee..3e77624eb3134b7d25eca4b003d398005786d642 100644 (file)
--- a/src/nodedef.h
+++ b/src/nodedef.h
@@ -44,6 +44,9 @@ class ITextureSource;
 class IShaderSource;
 class IGameDef;
 class NodeResolver;
+#if BUILD_UNITTESTS
+class TestSchematic;
+#endif
 
 enum ContentParamType
 {
@@ -231,6 +234,14 @@ enum AlignStyle : u8 {
        ALIGN_STYLE_USER_DEFINED,
 };
 
+enum AlphaMode : u8 {
+       ALPHAMODE_BLEND,
+       ALPHAMODE_CLIP,
+       ALPHAMODE_OPAQUE,
+       ALPHAMODE_LEGACY_COMPAT, /* means either opaque or clip */
+};
+
+
 /*
        Stand-alone definition of a TileSpec (basically a server-side TileSpec)
 */
@@ -315,9 +326,7 @@ struct ContentFeatures
        // These will be drawn over the base tiles.
        TileDef tiledef_overlay[6];
        TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
-       // If 255, the node is opaque.
-       // Otherwise it uses texture alpha.
-       u8 alpha;
+       AlphaMode alpha;
        // The color of the node.
        video::SColor color;
        std::string palette_name;
@@ -418,29 +427,27 @@ struct ContentFeatures
        void serialize(std::ostream &os, u16 protocol_version) const;
        void deSerialize(std::istream &is);
 
-       /*!
-        * Since vertex alpha is no longer supported, this method
-        * adds opacity directly to the texture pixels.
-        *
-        * \param tiles array of the tile definitions.
-        * \param length length of tiles
-        */
-       void correctAlpha(TileDef *tiles, int length);
-
-#ifndef SERVER
-       /*
-        * Checks if any tile texture has any transparent pixels.
-        * Prints a warning and returns true if that is the case, false otherwise.
-        * This is supposed to be used for use_texture_alpha backwards compatibility.
-        */
-       bool textureAlphaCheck(ITextureSource *tsrc, const TileDef *tiles,
-               int length);
-#endif
-       
-
        /*
                Some handy methods
        */
+       void setDefaultAlphaMode()
+       {
+               switch (drawtype) {
+               case NDT_NORMAL:
+               case NDT_LIQUID:
+               case NDT_FLOWINGLIQUID:
+                       alpha = ALPHAMODE_OPAQUE;
+                       break;
+               case NDT_NODEBOX:
+               case NDT_MESH:
+                       alpha = ALPHAMODE_LEGACY_COMPAT; // this should eventually be OPAQUE
+                       break;
+               default:
+                       alpha = ALPHAMODE_CLIP;
+                       break;
+               }
+       }
+
        bool needsBackfaceCulling() const
        {
                switch (drawtype) {
@@ -474,6 +481,21 @@ struct ContentFeatures
        void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc,
                scene::IMeshManipulator *meshmanip, Client *client, const TextureSettings &tsettings);
 #endif
+
+private:
+#ifndef SERVER
+       /*
+        * Checks if any tile texture has any transparent pixels.
+        * Prints a warning and returns true if that is the case, false otherwise.
+        * This is supposed to be used for use_texture_alpha backwards compatibility.
+        */
+       bool textureAlphaCheck(ITextureSource *tsrc, const TileDef *tiles,
+               int length);
+#endif
+
+       void setAlphaFromLegacy(u8 legacy_alpha);
+
+       u8 getAlphaForLegacy() const;
 };
 
 /*!
@@ -770,10 +792,13 @@ class NodeDefManager {
 
 NodeDefManager *createNodeDefManager();
 
+// NodeResolver: Queue for node names which are then translated
+// to content_t after the NodeDefManager was initialized
 class NodeResolver {
 public:
        NodeResolver();
        virtual ~NodeResolver();
+       // Callback which is run as soon NodeDefManager is ready
        virtual void resolveNodeNames() = 0;
 
        // required because this class is used as mixin for ObjDef
@@ -785,12 +810,31 @@ class NodeResolver {
        bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
                bool all_required = false, content_t c_fallback = CONTENT_IGNORE);
 
-       void nodeResolveInternal();
+       inline bool isResolveDone() const { return m_resolve_done; }
+       void reset(bool resolve_done = false);
 
-       u32 m_nodenames_idx = 0;
-       u32 m_nnlistsizes_idx = 0;
+       // Vector containing all node names in the resolve "queue"
        std::vector<std::string> m_nodenames;
+       // Specifies the "set size" of node names which are to be processed
+       // this is used for getIdsFromNrBacklog
+       // TODO: replace or remove
        std::vector<size_t> m_nnlistsizes;
+
+protected:
+       friend class NodeDefManager; // m_ndef
+
        const NodeDefManager *m_ndef = nullptr;
+       // Index of the next "m_nodenames" entry to resolve
+       u32 m_nodenames_idx = 0;
+
+private:
+#if BUILD_UNITTESTS
+       // Unittest requires access to m_resolve_done
+       friend class TestSchematic;
+#endif
+       void nodeResolveInternal();
+
+       // Index of the next "m_nnlistsizes" entry to process
+       u32 m_nnlistsizes_idx = 0;
        bool m_resolve_done = false;
 };