Version 1.3.0 update!

Author: rlguy

.gitignore

@@ -1,3 +1,6 @@
 src/engine/kernels/kernels.cpp
 src/engine/versionutils.cpp
-src/addon/__init__.py
+src/addon/__init__.py
+src/addon/utils/installation_utils.py
+CMakeLists.txt
+build

README.md

@@ -30,7 +30,7 @@ See any of our [market place product pages](https://github.com/rlguy/Blender-FLI
 - CPU 64-bit Intel® or AMD® or Apple Silicon multi-core processor
 - 8 GB RAM minimum, 16 GB of RAM or more is highly recommended
 
-***Blender Support on MacOS:** Due to a MacOS specific [Blender bug](https://developer.blender.org/T68243) in versions 2.80, 2.81, and 2.82, these Blender versions cannot be supported. Blender 2.79 or 2.83+ or 2.9+ or 3.0+ are required for MacOS.
+**Blender Support on MacOS:** Due to a MacOS specific [Blender bug](https://developer.blender.org/T68243) in versions 2.80, 2.81, and 2.82, these Blender versions cannot be supported. Blender 2.79 or 2.83+ or 2.9+ or 3.0+ are required for MacOS.
 
 ## Release Notes
 
@@ -100,7 +100,9 @@ Once successfully built, the FLIP Fluids addon will be located in the ```build/b
 ## Links
 
 - [Blender Market Page](https://www.blendermarket.com/products/flipfluids)
+- [Gumroad Page](https://flipfluids.gumroad.com/l/flipfluids)
+- [FlippedNormals Page](https://flippednormals.com/downloads/the-flip-fluids-addon-for-blender/ref/FLIPFluids/)
 - [Documentation and Wiki](https://github.com/rlguy/Blender-FLIP-Fluids/wiki)
 - [Bug/Issue Tracker](https://github.com/rlguy/Blender-FLIP-Fluids/issues)
 - [FLIP Fluids Homepage](http://flipfluids.com)
-- [Twitter](https://twitter.com/flipfluids) | [Instagram](https://www.instagram.com/flip.fluids/) | [Facebook](https://www.facebook.com/FLIPFluids/) | [YouTube](https://www.youtube.com/flipfluids)
+- [Twitter](https://twitter.com/flipfluids) | [Instagram](https://www.instagram.com/flip.fluids/) | [Facebook](https://www.facebook.com/FLIPFluids/) | [FLIP Fluids YouTube](https://www.youtube.com/flipfluids) | [BlenderPhysics YouTube](https://www.youtube.com/blenderphysicsvideos)

__init__.py

@@ -59,6 +59,14 @@ def draw(self, context):
                 "wm.url_open", 
                 text="Purchase the FLIP Fluids addon on the Blender Market", 
             ).url = "https://blendermarket.com/products/flipfluids"
+        column.operator(
+                "wm.url_open", 
+                text="Purchase the FLIP Fluids addon on Gumroad", 
+            ).url = "https://flipfluids.gumroad.com/l/flipfluids"
+        column.operator(
+                "wm.url_open", 
+                text="Purchase the FLIP Fluids addon on FlippedNormals", 
+            ).url = "https://flippednormals.com/downloads/the-flip-fluids-addon-for-blender/ref/FLIPFluids/"
 
 
 def register():

build.py

@@ -23,7 +23,7 @@
 import os, shutil, subprocess, platform, argparse
 
 
-def cmake_make(cmakelists_dir, cmake_path, make_path, build_debug=True, make_build=True, darwin_arch=""):
+def cmake_make(cmakelists_dir, cmake_path, make_path, build_debug=True, make_build=True, darwin_arch="", library_suffix=""):
     if build_debug:
         build_debug_flag = "-DBUILD_DEBUG=ON"
     else:
@@ -39,6 +39,9 @@ def cmake_make(cmakelists_dir, cmake_path, make_path, build_debug=True, make_bui
     elif system == "Linux":
         cmake_command = [cmake_path, cmakelists_dir, build_debug_flag]
 
+    if library_suffix:
+        cmake_command.append("-DLIBRARY_SUFFIX=" + library_suffix)
+
     subprocess.check_call(cmake_command)
 
     if make_build:
@@ -76,6 +79,7 @@ def main():
     parser = argparse.ArgumentParser(description="FLIP Fluids Addon build and compile script")
     parser.add_argument("-build-directory", help="Path to destination build directory")
     parser.add_argument("-darwin-arch", help="Target architecture to set for CMAKE_OSX_ARCHITECTURES")
+    parser.add_argument("-library-suffix", help="Specify suffix to add to the generated library name")
     parser.add_argument("-cmake-path", help="Specify path to CMake binary (www.cmake.org)")
     parser.add_argument("-make-path", help="Specify path to GNU Make binary (www.gnu.org/software/make)")
     parser.add_argument('--clean', action="store_true", help="Clear generated files in the build directory before building")
@@ -91,6 +95,10 @@ def main():
     if args.darwin_arch:
         darwin_arch = args.darwin_arch
 
+    library_suffix = ""
+    if args.library_suffix:
+        library_suffix = args.library_suffix
+
     cmake_path = "cmake"
     if args.cmake_path:
         cmake_path = process_path(args.cmake_path)
@@ -127,8 +135,8 @@ def main():
         if args.clean:
             clean_build_directory(build_dir)
 
-        cmake_make(root_dir, cmake_path, make_path, build_debug=True, make_build=not args.no_compile, darwin_arch=darwin_arch)
-        cmake_make(root_dir, cmake_path, make_path, build_debug=False, make_build=not args.no_compile, darwin_arch=darwin_arch)
+        cmake_make(root_dir, cmake_path, make_path, build_debug=True, make_build=not args.no_compile, darwin_arch=darwin_arch, library_suffix=library_suffix)
+        cmake_make(root_dir, cmake_path, make_path, build_debug=False, make_build=not args.no_compile, darwin_arch=darwin_arch, library_suffix=library_suffix)
 
         lib_dir = os.path.join(build_dir, "bl_flip_fluids", "flip_fluids_addon", "pyfluid", "lib")
         if os.path.isdir(lib_dir):

cmake/CMakeLists.txt

@@ -40,6 +40,7 @@ option(DISTRIBUTE_SOURCE "Include source code in addon" ON)
 option(WITH_OPENCL "Compile project with OpenCL features" OFF)
 option(WITH_ENGINE_TEST "Compile engine test executable" OFF)
 option(WITH_PYFLUID_MODULE "Compile pyfluid Python module" OFF)
+SET(LIBRARY_SUFFIX "" CACHE STRING "Optional suffix to add to the end of the library name")
 
 if(APPLE)
     set(MACOSX_DEPLOYMENT_TARGET 10.10)
@@ -48,11 +49,21 @@ endif()
 project(bl_flip_fluids)
 set(CMAKE_BUILD_TYPE Release)
 
+set(FLUIDENGINE_VERSION_TYPE_IS_STABLE_BUILD TRUE)
 set(FLUIDENGINE_VERSION_MAJOR 1)
-set(FLUIDENGINE_VERSION_MINOR 2)
+set(FLUIDENGINE_VERSION_MINOR 3)
 set(FLUIDENGINE_VERSION_REVISION 0)
-set(FLUIDENGINE_VERSION_LABEL "1.2.0 GitHub Release 26-NOV-2021")
+set(FLUIDENGINE_VERSION_DATE "12-MAR-2022")
 
+if(FLUIDENGINE_VERSION_TYPE_IS_STABLE_BUILD)
+    set(FLUIDENGINE_VERSION_TYPE_LABEL "GitHub Release")
+    set(FLUIDENGINE_VERSION_TYPE_IS_STABLE_BUILD_PYTHON "True")
+else()
+    set(FLUIDENGINE_VERSION_TYPE_LABEL "Experimental GitHub Release")
+    set(FLUIDENGINE_VERSION_TYPE_IS_STABLE_BUILD_PYTHON "False")
+endif()
+
+set(FLUIDENGINE_VERSION_LABEL "${FLUIDENGINE_VERSION_MAJOR}.${FLUIDENGINE_VERSION_MINOR}.${FLUIDENGINE_VERSION_REVISION} ${FLUIDENGINE_VERSION_TYPE_LABEL} ${FLUIDENGINE_VERSION_DATE}")
 if(BUILD_DEBUG)
     set(FLUIDENGINE_VERSION_LABEL "${FLUIDENGINE_VERSION_LABEL} (DEBUG BUILD)") 
 endif()
@@ -120,6 +131,10 @@ configure_file(
   "${PROJECT_SOURCE_DIR}/src/addon/__init__.py.in"
   "${PROJECT_SOURCE_DIR}/src/addon/__init__.py"
 )
+configure_file(
+  "${PROJECT_SOURCE_DIR}/src/addon/utils/installation_utils.py.in"
+  "${PROJECT_SOURCE_DIR}/src/addon/utils/installation_utils.py"
+)
 
 # Generate kernels.cpp
 file(READ "src/engine/kernels/trilinearinterpolate.cl" TRILINEAR_INTERPOLATE_KERNEL_STRING)
@@ -160,16 +175,16 @@ endif()
 set(BLENDER_ADDON_DIR "${CMAKE_BINARY_DIR}/bl_flip_fluids/flip_fluids_addon")
 set_output_directories("${BLENDER_ADDON_DIR}/pyfluid/lib")
 if(BUILD_DEBUG)
-    add_library(blpyfluiddebug SHARED $<TARGET_OBJECTS:objects>)
+    add_library("blpyfluiddebug${LIBRARY_SUFFIX}" SHARED $<TARGET_OBJECTS:objects>)
 else()
-    add_library(blpyfluidrelease SHARED $<TARGET_OBJECTS:objects>)
+    add_library("blpyfluidrelease${LIBRARY_SUFFIX}" SHARED $<TARGET_OBJECTS:objects>)
 endif()
 
 if(WITH_OPENCL) 
     if(BUILD_DEBUG)
-        target_link_libraries(blpyfluiddebug "${OpenCL_LIBRARY}")
+        target_link_libraries("blpyfluiddebug${LIBRARY_SUFFIX}" "${OpenCL_LIBRARY}")
     else()
-        target_link_libraries(blpyfluidrelease "${OpenCL_LIBRARY}")
+        target_link_libraries("blpyfluidrelease${LIBRARY_SUFFIX}" "${OpenCL_LIBRARY}")
     endif()
 endif()
 

src/addon/__init__.py.in

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 bl_info = {
-    "name" : "FLIP Fluids",
+    "name" : "FLIP Fluids GitHub Release @FLUIDENGINE_VERSION_MAJOR@.@FLUIDENGINE_VERSION_MINOR@.@FLUIDENGINE_VERSION_REVISION@",
     "description": "A FLIP Fluid Simulation Tool for Blender (v@FLUIDENGINE_VERSION_LABEL@)",
     "author" : "Ryan Guy, Dennis Fassbaender",
     "version" : (@FLUIDENGINE_VERSION_MAJOR@, @FLUIDENGINE_VERSION_MINOR@, @FLUIDENGINE_VERSION_REVISION@),

src/addon/bake.py

@@ -809,6 +809,15 @@ def __initialize_fluid_simulation_settings(fluidsim, data):
         fluidsim.enable_whitewater_motion_blur = \
             __get_parameter_data(whitewater.generate_whitewater_motion_blur_data, frameno)
 
+        fluidsim.enable_whitewater_velocity_attribute = \
+            __get_parameter_data(whitewater.enable_velocity_vector_attribute, frameno)
+
+        fluidsim.enable_whitewater_id_attribute = \
+            __get_parameter_data(whitewater.enable_id_attribute, frameno)
+
+        fluidsim.enable_whitewater_lifetime_attribute = \
+            __get_parameter_data(whitewater.enable_lifetime_attribute, frameno)
+
         is_generating_whitewater = __get_parameter_data(whitewater.enable_whitewater_emission, frameno)
         fluidsim.enable_diffuse_particle_emission = is_generating_whitewater
 
@@ -1012,6 +1021,8 @@ def __initialize_fluid_simulation_settings(fluidsim, data):
         __get_parameter_data(surface.enable_velocity_vector_attribute, frameno)
     fluidsim.enable_surface_speed_attribute = \
         __get_parameter_data(surface.enable_speed_attribute, frameno)
+    fluidsim.enable_surface_vorticity_attribute = \
+        __get_parameter_data(surface.enable_vorticity_vector_attribute, frameno)
     fluidsim.enable_surface_age_attribute = \
         __get_parameter_data(surface.enable_age_attribute, frameno)
     fluidsim.enable_surface_color_attribute = \
@@ -1904,6 +1915,13 @@ def __write_surface_data(cache_directory, fluidsim, frameno):
         with open(velocity_filepath, 'wb') as f:
             f.write(filedata)
 
+    if fluidsim.enable_surface_vorticity_attribute:
+        vorticity_filename = "vorticity" + fstring + ".bobj"
+        vorticity_filepath = os.path.join(cache_directory, "bakefiles", vorticity_filename)
+        filedata = fluidsim.get_surface_vorticity_attribute_data()
+        with open(vorticity_filepath, 'wb') as f:
+            f.write(filedata)
+
     if fluidsim.enable_surface_speed_attribute:
         speed_filename = "speed" + fstring + ".data"
         speed_filepath = os.path.join(cache_directory, "bakefiles", speed_filename)
@@ -1991,6 +2009,81 @@ def __write_whitewater_data(cache_directory, fluidsim, frameno):
         with open(dust_blur_filepath, 'wb') as f:
             f.write(filedata)
 
+    if fluidsim.enable_whitewater_velocity_attribute:
+        foam_velocity_filename = "velocityfoam" + fstring + ".wwp"
+        foam_velocity_filepath = os.path.join(cache_directory, "bakefiles", foam_velocity_filename)
+        filedata = fluidsim.get_whitewater_foam_velocity_attribute_data()
+        with open(foam_velocity_filepath, 'wb') as f:
+            f.write(filedata)
+
+        bubble_velocity_filename = "velocitybubble" + fstring + ".wwp"
+        bubble_velocity_filepath = os.path.join(cache_directory, "bakefiles", bubble_velocity_filename)
+        filedata = fluidsim.get_whitewater_bubble_velocity_attribute_data()
+        with open(bubble_velocity_filepath, 'wb') as f:
+            f.write(filedata)
+
+        spray_velocity_filename = "velocityspray" + fstring + ".wwp"
+        spray_velocity_filepath = os.path.join(cache_directory, "bakefiles", spray_velocity_filename)
+        filedata = fluidsim.get_whitewater_spray_velocity_attribute_data()
+        with open(spray_velocity_filepath, 'wb') as f:
+            f.write(filedata)
+
+        dust_velocity_filename = "velocitydust" + fstring + ".wwp"
+        dust_velocity_filepath = os.path.join(cache_directory, "bakefiles", dust_velocity_filename)
+        filedata = fluidsim.get_whitewater_dust_velocity_attribute_data()
+        with open(dust_velocity_filepath, 'wb') as f:
+            f.write(filedata)
+
+    if fluidsim.enable_whitewater_id_attribute:
+        foam_id_filename = "idfoam" + fstring + ".wwi"
+        foam_id_filepath = os.path.join(cache_directory, "bakefiles", foam_id_filename)
+        filedata = fluidsim.get_whitewater_foam_id_attribute_data()
+        with open(foam_id_filepath, 'wb') as f:
+            f.write(filedata)
+
+        bubble_id_filename = "idbubble" + fstring + ".wwi"
+        bubble_id_filepath = os.path.join(cache_directory, "bakefiles", bubble_id_filename)
+        filedata = fluidsim.get_whitewater_bubble_id_attribute_data()
+        with open(bubble_id_filepath, 'wb') as f:
+            f.write(filedata)
+
+        spray_id_filename = "idspray" + fstring + ".wwi"
+        spray_id_filepath = os.path.join(cache_directory, "bakefiles", spray_id_filename)
+        filedata = fluidsim.get_whitewater_spray_id_attribute_data()
+        with open(spray_id_filepath, 'wb') as f:
+            f.write(filedata)
+
+        dust_id_filename = "iddust" + fstring + ".wwi"
+        dust_id_filepath = os.path.join(cache_directory, "bakefiles", dust_id_filename)
+        filedata = fluidsim.get_whitewater_dust_id_attribute_data()
+        with open(dust_id_filepath, 'wb') as f:
+            f.write(filedata)
+
+    if fluidsim.enable_whitewater_lifetime_attribute:
+        foam_lifetime_filename = "lifetimefoam" + fstring + ".wwf"
+        foam_lifetime_filepath = os.path.join(cache_directory, "bakefiles", foam_lifetime_filename)
+        filedata = fluidsim.get_whitewater_foam_lifetime_attribute_data()
+        with open(foam_lifetime_filepath, 'wb') as f:
+            f.write(filedata)
+
+        bubble_lifetime_filename = "lifetimebubble" + fstring + ".wwf"
+        bubble_lifetime_filepath = os.path.join(cache_directory, "bakefiles", bubble_lifetime_filename)
+        filedata = fluidsim.get_whitewater_bubble_lifetime_attribute_data()
+        with open(bubble_lifetime_filepath, 'wb') as f:
+            f.write(filedata)
+
+        spray_lifetime_filename = "lifetimespray" + fstring + ".wwf"
+        spray_lifetime_filepath = os.path.join(cache_directory, "bakefiles", spray_lifetime_filename)
+        filedata = fluidsim.get_whitewater_spray_lifetime_attribute_data()
+        with open(spray_lifetime_filepath, 'wb') as f:
+            f.write(filedata)
+
+        dust_lifetime_filename = "lifetimedust" + fstring + ".wwf"
+        dust_lifetime_filepath = os.path.join(cache_directory, "bakefiles", dust_lifetime_filename)
+        filedata = fluidsim.get_whitewater_dust_lifetime_attribute_data()
+        with open(dust_lifetime_filepath, 'wb') as f:
+            f.write(filedata)
+
 
 def __write_fluid_particle_data(cache_directory, fluidsim, frameno):
     fstring = __frame_number_to_string(frameno)
@@ -2064,6 +2157,7 @@ def __get_frame_stats_dict(cstats):
     stats["surfaceblur"] = __get_mesh_stats_dict(cstats.surfaceblur)
     stats["surfacevelocity"] = __get_mesh_stats_dict(cstats.surfacevelocity)
     stats["surfacespeed"] = __get_mesh_stats_dict(cstats.surfacespeed)
+    stats["surfacevorticity"] = __get_mesh_stats_dict(cstats.surfacevorticity)
     stats["surfaceage"] = __get_mesh_stats_dict(cstats.surfaceage)
     stats["surfacecolor"] = __get_mesh_stats_dict(cstats.surfacecolor)
     stats["surfacesourceid"] = __get_mesh_stats_dict(cstats.surfacesourceid)
@@ -2075,6 +2169,18 @@ def __get_frame_stats_dict(cstats):
     stats["bubbleblur"] = __get_mesh_stats_dict(cstats.bubbleblur)
     stats["sprayblur"] = __get_mesh_stats_dict(cstats.sprayblur)
     stats["dustblur"] = __get_mesh_stats_dict(cstats.dustblur)
+    stats["foamvelocity"] = __get_mesh_stats_dict(cstats.foamvelocity)
+    stats["bubblevelocity"] = __get_mesh_stats_dict(cstats.bubblevelocity)
+    stats["sprayvelocity"] = __get_mesh_stats_dict(cstats.sprayvelocity)
+    stats["dustvelocity"] = __get_mesh_stats_dict(cstats.dustvelocity)
+    stats["foamid"] = __get_mesh_stats_dict(cstats.foamid)
+    stats["bubbleid"] = __get_mesh_stats_dict(cstats.bubbleid)
+    stats["sprayid"] = __get_mesh_stats_dict(cstats.sprayid)
+    stats["dustid"] = __get_mesh_stats_dict(cstats.dustid)
+    stats["foamlifetime"] = __get_mesh_stats_dict(cstats.foamlifetime)
+    stats["bubblelifetime"] = __get_mesh_stats_dict(cstats.bubblelifetime)
+    stats["spraylifetime"] = __get_mesh_stats_dict(cstats.spraylifetime)
+    stats["dustlifetime"] = __get_mesh_stats_dict(cstats.dustlifetime)
     stats["particles"] = __get_mesh_stats_dict(cstats.particles)
     stats["obstacle"] = __get_mesh_stats_dict(cstats.obstacle)
     stats["timing"] = __get_timing_stats_dict(cstats.timing)
@@ -2397,7 +2503,9 @@ def set_console_output(boolval):
 
 
 def __get_addon_version():
-    module = sys.modules["flip_fluids_addon"]
+    module_dir = os.path.dirname(os.path.realpath(__file__))
+    module_name = os.path.basename(os.path.normpath(module_dir))
+    module = sys.modules[module_name]
     addon_major, addon_minor, addon_revision = module.bl_info.get('version', (-1, -1, -1))
     return str(addon_major) + "." + str(addon_minor) + "." + str(addon_revision)
 

src/addon/filesystem/filesystem_protection_layer.py

@@ -33,6 +33,8 @@
     ".sqlite3",
     ".state",
     ".txt",
+    ".wwi",
+    ".wwf",
     ".wwp"
     ]
 
@@ -117,11 +119,33 @@ def delete_files_in_directory(base_directory, extensions, remove_directory=False
         if pathlib.Path(f).suffix in extensions:
             valid_filepaths.append(os.path.join(base_directory, f))
 
+    remove_error_count = 0
+    first_error = None
     for f in valid_filepaths:
-        os.remove(f)
+        try:
+            os.remove(f)
+        except OSError as e:
+            remove_error_count += 1
+            if first_error is None:
+                first_error = str(e)
 
     if remove_directory and not os.listdir(base_directory):
-        os.rmdir(base_directory)
+        try:
+            os.rmdir(base_directory)
+        except OSError as e:
+            remove_error_count += 1
+            if first_error is None:
+                first_error = str(e)
+
+    if remove_error_count > 0:
+        errmsg = "Error encountered attempting to remove " + str(remove_error_count) + " file(s). Reason: <" + first_error + ">. "
+        errmsg += "Try closing all applications accessing the cache directory, restarting Blender/System, or deleting cache directory manually."
+        bpy.ops.flip_fluid_operators.display_error(
+                'INVOKE_DEFAULT',
+                error_message="Error Removing Files",
+                error_description=errmsg,
+                popup_width=700
+                )
 
 
 def delete_file(filepath, error_ok=False):
@@ -138,15 +162,21 @@ def delete_file(filepath, error_ok=False):
         if error_ok:
             pass
         else:
-            raise e
+            errmsg = "Error encountered attempting to remove file. Reason: <" + str(e) + ">."
+            bpy.ops.flip_fluid_operators.display_error(
+                    'INVOKE_DEFAULT',
+                    error_message="Error Removing Files",
+                    error_description=errmsg,
+                    popup_width=700
+                    )
 
 
 def clear_cache_directory(cache_directory, clear_export=False, clear_logs=False, remove_directory=False):
     stats_filepath = os.path.join(cache_directory, "flipstats.data")
     delete_file(stats_filepath)
 
     bakefiles_dir = os.path.join(cache_directory, "bakefiles")
-    extensions = [".bbox", ".bobj", ".data", ".wwp", ".fpd", ".ffd"]
+    extensions = [".bbox", ".bobj", ".data", ".wwp", ".wwf", ".wwi", ".fpd", ".ffd"]
     delete_files_in_directory(bakefiles_dir, extensions, remove_directory=True)
 
     temp_dir = os.path.join(cache_directory, "temp")