Merge branch 'luaaddvfxoffset' into 'master'

addVfx ability to provide additional local offset

See merge request OpenMW/openmw!4591

Author: Capostrophic

CMakeLists.txt

@@ -82,7 +82,7 @@ message(STATUS "Configuring OpenMW...")
 set(OPENMW_VERSION_MAJOR 0)
 set(OPENMW_VERSION_MINOR 52)
 set(OPENMW_VERSION_RELEASE 0)
-set(OPENMW_LUA_API_REVISION 133)
+set(OPENMW_LUA_API_REVISION 134)
 set(OPENMW_POSTPROCESSING_API_REVISION 5)
 
 set(OPENMW_VERSION_COMMITHASH "")

apps/openmw/mwlua/animationbindings.cpp

@@ -1,6 +1,7 @@
 #include "animationbindings.hpp"
 
 #include <components/lua/luastate.hpp>
+#include <components/lua/utilpackage.hpp>
 #include <components/misc/finitevalues.hpp>
 
 #include "../mwbase/environment.hpp"
@@ -243,15 +244,26 @@ namespace MWLua
         api["addVfx"] = [context](const SelfObject& object, std::string_view model, sol::optional<sol::table> options) {
             if (options)
             {
+                sol::object transformObject = options->get<sol::object>("transform");
+                std::optional<osg::Matrix> transform;
+                if (transformObject.is<LuaUtil::TransformM>())
+                    transform = LuaUtil::cast<LuaUtil::TransformM>(transformObject).mM;
+                else if (transformObject.is<LuaUtil::TransformQ>())
+                    transform = osg::Matrix(LuaUtil::cast<LuaUtil::TransformQ>(transformObject).mQ);
+                if (transform.has_value() && !transform->valid())
+                    throw std::runtime_error("Transform provided for 'addVfx' is invalid");
+
                 context.mLuaManager->addAction(
                     [object = Object(object), model = std::string(model),
                         effectId = options->get_or<std::string>("vfxId", ""), loop = options->get_or("loop", false),
                         boneName = options->get_or<std::string>("boneName", ""),
                         particleTexture = options->get_or<std::string>("particleTextureOverride", ""),
-                        useAmbientLight = options->get_or("useAmbientLight", true)] {
+                        useAmbientLight = options->get_or("useAmbientLight", true),
+                        autoTransform = options->get_or("autoTransform", true), transform] {
                         MWRender::Animation* anim = getMutableAnimationOrThrow(object);
 
-                        anim->addEffect(model, effectId, loop, boneName, particleTexture, useAmbientLight);
+                        anim->addEffect(model, effectId, loop, boneName, particleTexture, useAmbientLight,
+                            autoTransform, transform);
                     },
                     "addVfxAction");
             }

apps/openmw/mwrender/animation.cpp

@@ -7,6 +7,7 @@
 #include <osg/BlendFunc>
 #include <osg/LightModel>
 #include <osg/Material>
+#include <osg/Matrix>
 #include <osg/MatrixTransform>
 #include <osg/Switch>
 
@@ -1704,7 +1705,7 @@ namespace MWRender
     }
 
     void Animation::addEffect(std::string_view model, std::string_view effectId, bool loop, std::string_view bonename,
-        std::string_view texture, bool useAmbientLight)
+        std::string_view texture, bool useAmbientLight, bool autoTransform, const std::optional<osg::Matrix>& transform)
     {
         if (!mObjectRoot.get())
             return;
@@ -1737,21 +1738,35 @@ namespace MWRender
         }
 
         osg::ref_ptr<SceneUtil::PositionAttitudeTransform> trans = new SceneUtil::PositionAttitudeTransform;
-        if (!mPtr.getClass().isNpc())
+
+        osg::Matrix finalTransform;
+
+        if (!mPtr.getClass().isNpc() && autoTransform)
         {
             osg::Vec3f bounds(MWBase::Environment::get().getWorld()->getHalfExtents(mPtr) * 2.f);
             float scale = std::max({ bounds.x(), bounds.y(), bounds.z() / 2.f }) / 64.f;
             if (scale > 1.f)
-                trans->setScale(osg::Vec3f(scale, scale, scale));
+                finalTransform = osg::Matrix::scale(scale, scale, scale);
             float offset = 0.f;
             if (bounds.z() < 128.f)
                 offset = bounds.z() - 128.f;
             else if (bounds.z() < bounds.x() + bounds.y())
                 offset = 128.f - bounds.z();
             if (MWBase::Environment::get().getWorld()->isFlying(mPtr))
                 offset /= 20.f;
-            trans->setPosition(osg::Vec3f(0.f, 0.f, offset * scale));
+
+            finalTransform.setTrans(osg::Vec3f(0.f, 0.f, offset * scale));
+        }
+
+        if (transform)
+        {
+            finalTransform *= (*transform);
         }
+
+        trans->setScale(finalTransform.getScale());
+        trans->setAttitude(finalTransform.getRotate());
+        trans->setPosition(finalTransform.getTrans());
+
         parentNode->addChild(trans);
 
         osg::ref_ptr<osg::Node> node

apps/openmw/mwrender/animation.hpp

@@ -18,6 +18,7 @@
 #include <components/vfs/pathutil.hpp>
 
 #include <map>
+#include <optional>
 #include <span>
 #include <string>
 #include <unordered_map>
@@ -347,12 +348,14 @@ namespace MWRender
          *              you need to remove it manually using removeEffect when the effect should end.
          * @param bonename Bone to attach to, or empty string to use the scene node instead
          * @param texture override the texture specified in the model's materials - if empty, do not override
-         * @param useAmbientLight attach white ambient light to the root VFX node of the scenegraph (Morrowind
-         * default)
+         * @param useAmbientLight attach white ambient light to the root VFX node of the scenegraph (Morrowind default)
+         * @param autoTransform auto-calculate vfx transform
+         * @param transform apply a relative transform
          * @note Will not add an effect twice.
          */
         void addEffect(std::string_view model, std::string_view effectId, bool loop = false,
-            std::string_view bonename = {}, std::string_view texture = {}, bool useAmbientLight = true);
+            std::string_view bonename = {}, std::string_view texture = {}, bool useAmbientLight = true,
+            bool autoTransform = true, const std::optional<osg::Matrix>& transform = std::nullopt);
 
         void removeEffect(std::string_view effectId);
         void removeEffects();

files/lua_api/openmw/animation.lua

@@ -230,6 +230,8 @@
 --   * `particleTextureOverride` - name of the particle texture to use. (default: "")
 --   * `vfxId` - a string ID that can be used to remove the effect later, using #removeVfx, and to avoid duplicate effects. The default value of "" can have duplicates. To avoid interaction with the engine, use unique identifiers unrelated to magic effect IDs. The engine uses this identifier to add and remove magic effects based on what effects are active on the actor. If this is set equal to the @{openmw.core#MagicEffectId} identifier of the magic effect being added, for example core.magic.EFFECT_TYPE.FireDamage, then the engine will remove it once the fire damage effect on the actor reaches 0. (Default: "").
 --   * `useAmbientLight` - boolean, vfx get a white ambient light attached in Morrowind. If false don't attach this. (default: true)
+--   * `autoTransform` - boolean, if true, the engine will auto-calculate the transform. (default: true)
+--   * `transform` - relative transform (openmw.util#Transform) applied to the vfx. If autoTransform is true this will be applied on top of it.
 --
 -- @usage local mgef = core.magic.effects.records[myEffectName]
 -- anim.addVfx(self, 'VFX_Hands', {boneName = 'Bip01 L Hand', particleTextureOverride = mgef.particle, loop = mgef.continuousVfx, vfxId = mgef.id..'_myuniquenamehere'})
@@ -244,6 +246,7 @@
 --     vfxId = mgef.id,
 --     particleTextureOverride = mgef.particle,
 --     loop = false,
+--     transform = util.transform.move(100, 0, 0)
 --   }
 -- })
 --