#6092: Extend FX interfaces

codereader · Sep 4, 2022 · 2c5b31d · 2c5b31d
1 parent e6ceda0
commit 2c5b31d
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 0 deletions.
diff --git a/include/ifx.h b/include/ifx.h
@@ -12,7 +12,11 @@ class IFxAction
 
     virtual ~IFxAction() {}
 
+    // Returns the action delay in seconds
+    virtual float getDelay() = 0;
 
+    // True: Don't shake the entity this effect is attached to
+    virtual bool getIgnoreMaster() = 0;
 };
 
 class IFxDeclaration :
@@ -26,6 +30,10 @@ class IFxDeclaration :
 
     // Returns the n-th action (based on the given 0-based index)
     virtual IFxAction::Ptr getAction(std::size_t index) = 0;
+
+    // Returns the name of the joint this FX should bind to
+    // Evaluated to an empty string if "bindTo" is not set
+    virtual std::string getBindTo() = 0;
 };
 
 }
diff --git a/radiantcore/CMakeLists.txt b/radiantcore/CMakeLists.txt
@@ -71,6 +71,7 @@ add_library(radiantcore MODULE
             fonts/GlyphInfo.cpp
             fonts/GlyphSet.cpp
             fx/FxDeclaration.cpp
+            fx/FxAction.cpp
             fx/FxManager.cpp
             grid/GridManager.cpp
             imagefile/BMPLoader.cpp

diff --git a/radiantcore/fx/FxAction.cpp b/radiantcore/fx/FxAction.cpp
@@ -0,0 +1,21 @@
+#include "FxAction.h"
+
+namespace fx
+{
+
+FxAction::FxAction() :
+    _delayInSeconds(0.0),
+    _ignoreMaster(false)
+{}
+
+float FxAction::getDelay()
+{
+    return _delayInSeconds;
+}
+
+bool FxAction::getIgnoreMaster()
+{
+    return _ignoreMaster;
+}
+
+}
diff --git a/radiantcore/fx/FxAction.h b/radiantcore/fx/FxAction.h
@@ -0,0 +1,24 @@
+#pragma once
+
+#include "ifx.h"
+
+namespace fx
+{
+
+class FxAction :
+    public IFxAction
+{
+private:
+    float _delayInSeconds;
+    bool _ignoreMaster;
+
+public:
+    using Ptr = std::shared_ptr<FxAction>;
+
+    FxAction();
+
+    float getDelay() override;
+    bool getIgnoreMaster() override;
+};
+
+}
diff --git a/radiantcore/fx/FxDeclaration.cpp b/radiantcore/fx/FxDeclaration.cpp
@@ -19,8 +19,15 @@ IFxAction::Ptr FxDeclaration::getAction(std::size_t index)
     return _actions.at(index);
 }
 
+std::string FxDeclaration::getBindTo()
+{
+    ensureParsed();
+    return _bindTo;
+}
+
 void FxDeclaration::onBeginParsing()
 {
+    _bindTo.clear();
     _actions.clear();
 }
 

diff --git a/radiantcore/fx/FxDeclaration.h b/radiantcore/fx/FxDeclaration.h
@@ -12,12 +12,14 @@ class FxDeclaration :
 {
 private:
     std::vector<IFxAction::Ptr> _actions;
+    std::string _bindTo;
 
 public:
     FxDeclaration(const std::string& name);
 
     std::size_t getNumActions() override;
     IFxAction::Ptr getAction(std::size_t index) override;
+    std::string getBindTo() override;
 
 protected:
     void onBeginParsing() override;

diff --git a/tools/msvc/DarkRadiantCore.vcxproj b/tools/msvc/DarkRadiantCore.vcxproj
@@ -85,6 +85,7 @@
     <ClCompile Include="..\..\radiantcore\fonts\FontManager.cpp" />
     <ClCompile Include="..\..\radiantcore\fonts\GlyphInfo.cpp" />
     <ClCompile Include="..\..\radiantcore\fonts\GlyphSet.cpp" />
+    <ClCompile Include="..\..\radiantcore\fx\FxAction.cpp" />
     <ClCompile Include="..\..\radiantcore\fx\FxDeclaration.cpp" />
     <ClCompile Include="..\..\radiantcore\fx\FxManager.cpp" />
     <ClCompile Include="..\..\radiantcore\grid\GridManager.cpp" />
@@ -831,6 +832,7 @@
     <ClInclude Include="..\..\radiantcore\fonts\FontManager.h" />
     <ClInclude Include="..\..\radiantcore\fonts\GlyphInfo.h" />
     <ClInclude Include="..\..\radiantcore\fonts\GlyphSet.h" />
+    <ClInclude Include="..\..\radiantcore\fx\FxAction.h" />
     <ClInclude Include="..\..\radiantcore\fx\FxDeclaration.h" />
     <ClInclude Include="..\..\radiantcore\fx\FxManager.h" />
     <ClInclude Include="..\..\radiantcore\grid\GridItem.h" />

diff --git a/tools/msvc/DarkRadiantCore.vcxproj.filters b/tools/msvc/DarkRadiantCore.vcxproj.filters
@@ -1162,6 +1162,9 @@
     <ClCompile Include="..\..\radiantcore\fx\FxDeclaration.cpp">
       <Filter>src\fx</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\radiantcore\fx\FxAction.cpp">
+      <Filter>src\fx</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\..\radiantcore\modulesystem\ModuleLoader.h">
@@ -2388,6 +2391,9 @@
     <ClInclude Include="..\..\radiantcore\fx\FxDeclaration.h">
       <Filter>src\fx</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\radiantcore\fx\FxAction.h">
+      <Filter>src\fx</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <None Include="..\..\install\gl\cubemap_fp.glsl">