initial public release

2022-11-02 22:43:14 +01:00
commit ff02526c05
4222 changed files with 85051 additions and 0 deletions
@@ -0,0 +1,145 @@
+/**
+ * @file
+ *
+ * @author  Mamadou Babaei <mamadou@senseglove.com>
+ *
+ * @section LICENSE
+ *
+ * (The MIT License)
+ *
+ * Copyright (c) 2020 - 2022 SenseGlove
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * @section DESCRIPTION
+ *
+ *
+ */
+
+
+#pragma once
+
+#include "HAL/Platform.h"
+#include "Templates/SharedPointer.h"
+#include "Templates/UniquePtr.h"
+#include "UObject/ObjectMacros.h"
+
+#include "SGBuzzCommand.h"
+
+#include "SGTimedBuzzCommand.generated.h"
+
+class FSGTimedBuzzCommandImpl;
+
+UCLASS(BlueprintType)
+class SENSEGLOVECORE_API USGTimedBuzzCommand : public USGBuzzCommand
+{
+    GENERATED_BODY()
+
+public:
+    static USGTimedBuzzCommand* NewTimedBuzzCommand(
+        UObject* Outer, const FSGTimedBuzzCommandImpl& TimedBuzzCommandImpl);
+
+    static USGTimedBuzzCommand* NewTimedBuzzCommand(
+        UObject* Outer, TSharedRef<FSGTimedBuzzCommandImpl> TimedBuzzCommandImpl);
+
+public:
+    static USGTimedBuzzCommand* NewTimedBuzzCommand(UObject* Outer);
+
+    static USGTimedBuzzCommand* NewTimedBuzzCommand(
+        UObject* Outer,
+        ESGFinger Finger, int32 Magnitude, float DurationSeconds, float StartTimeSeconds = 0.0f);
+
+    static USGTimedBuzzCommand* NewTimedBuzzCommand(
+        UObject* Outer,
+        const USGBuzzCommand* BaseCommand, float DurationSeconds, float StartTimeSeconds = 0.0f);
+
+private:
+    struct FImpl;
+
+    struct FImplDeleter
+    {
+        void operator()(const FImpl* P) const;
+    };
+
+    TUniquePtr<FImpl, FImplDeleter> Pimpl;
+    FImplDeleter PimplDeleter;
+
+public:
+    USGTimedBuzzCommand();
+    USGTimedBuzzCommand(ESGFinger Finger, int32 Magnitude, float DurationSeconds, float StartTimeSeconds = 0.0f);
+    USGTimedBuzzCommand(const USGBuzzCommand* BaseCommand, float DurationSeconds, float StartTimeSeconds = 0.0f);
+
+public:
+    /**
+     * The cast from underlying type constructor.
+     */
+    explicit USGTimedBuzzCommand(const FSGTimedBuzzCommandImpl& TimedBuzzCommandImpl);
+
+protected:
+    /**
+     * The cast from underlying pointer type constructor.
+     */
+    explicit USGTimedBuzzCommand(TSharedRef<FSGTimedBuzzCommandImpl> TimedBuzzCommandImpl);
+
+public:
+    /**
+     * The destructor.
+     */
+    virtual ~USGTimedBuzzCommand() override;
+
+public:
+    /**
+     * The cast to underlying type method.
+     */
+    TSharedRef<FSGTimedBuzzCommandImpl> ToTimedBuzzCommandImpl() const;
+
+protected:
+    /**
+     * Allows the child classes to synchronize the parent's underlying object at any time.
+     */
+    virtual void SyncImplObject() const override;
+
+    /**
+     * Allows the child classes to synchronize the parent's uproperties at any time.
+     */
+    virtual void SyncUProperties() override;
+
+public:
+    USGBuzzCommand* Copy(UObject* Outer) const;
+
+    USGBuzzCommand* Merge(UObject* Outer, const USGBuzzCommand* BuzzCommand) const;
+
+public:
+    USGBuzzCommand* GetBaseCommand(UObject* Outer) const;
+
+    int32 GetMagnitude() const;
+
+    float GetDuration() const;
+
+    float GetElapsedTime() const;
+
+    bool HasTimeElapsed() const;
+
+    float NormalizedTime(bool bClamp01 = true) const;
+
+    void ResetTiming();
+    void UpdateTiming(float DeltaSeconds);
+
+    FString ToString() const;
+};