TransformComponent.h

Go to the documentation of this file.

/*
Copyright (c) 2018 DIVIDE-Studio
Copyright (c) 2009 Ionut Cava
 
This file is part of DIVIDE Framework.
 
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.
 
*/
 
#pragma once
#ifndef DVD_TRANSFORM_COMPONENT_H_
#define DVD_TRANSFORM_COMPONENT_H_
 
#include "SGNComponent.h"
#include "Core/Math/Headers/Transform.h"
 
namespace Divide {
namespace Attorney {
    class TransformComponentSGN;
}
 
enum class TransformType : U8 {
    NONE = 0,
    TRANSLATION = toBit(1),
    SCALE = toBit(2),
    ROTATION = toBit(3),
    ALL = TRANSLATION | SCALE | ROTATION,
    COUNT = 4
};
 
BEGIN_COMPONENT_EXT1(Transform, ComponentType::TRANSFORM, ITransform)
    friend class Attorney::TransformComponentSGN;
 
    public:
        enum class ScalingMode : U8 {
            UNIFORM = 0u,
            NON_UNIFORM
            //PROPAGATE_TO_LEAFS_ALL,
            //PROPAGATE_TO_LEAFS_NON_UNIFORM
        };
    public:
     TransformComponent(SceneGraphNode* parentSGN, PlatformContext& context);
 
     void reset();
 
                   void      getWorldMatrix(mat4<F32>& matOut) const;
                   void      getWorldMatrixInterpolated( mat4<F32>& matrixOut) const;
     [[nodiscard]] mat4<F32> getWorldMatrix() const;
     [[nodiscard]] mat4<F32> getWorldMatrixInterpolated() const;
 
     void getLocalRotationMatrix( mat4<F32>& matOut ) const;
     void getLocalRotationMatrixInterpolated( mat4<F32>& matOut ) const;
 
     void getWorldRotationMatrix( mat4<F32>& matOut ) const;
     void getWorldRotationMatrixInterpolated( mat4<F32>& matOut ) const;
 
     void setPosition(const vec3<F32>& position) override;
     void setPosition(F32 x, F32 y, F32 z) override;
     void setPositionX(F32 positionX) override;
     void setPositionY(F32 positionY) override;
     void setPositionZ(F32 positionZ) override;
     void translate(const vec3<F32>& axisFactors) override;
     using ITransform::setPosition;
 
     void setScale(const vec3<F32>& amount) override;
     void setScaleX(F32 amount) override;
     void setScaleY(F32 amount) override;
     void setScaleZ(F32 amount) override;
     void scale(const vec3<F32>& axisFactors) override;
     void scaleX(F32 amount) override;
     void scaleY(F32 amount) override;
     void scaleZ(F32 amount) override;
     using ITransform::setScale;
 
     void setRotation(const vec3<F32>& axis, Angle::DEGREES<F32> degrees) override;
     void setRotation(Angle::DEGREES<F32> pitch, Angle::DEGREES<F32> yaw, Angle::DEGREES<F32> roll) override;
     void setRotation(const Quaternion<F32>& quat) override;
     void setRotationX(Angle::DEGREES<F32> angle) override;
     void setRotationY(Angle::DEGREES<F32> angle) override;
     void setRotationZ(Angle::DEGREES<F32> angle) override;
     using ITransform::setRotation;
 
     void rotate(const vec3<F32>& axis, Angle::DEGREES<F32> degrees) override;
     void rotate(Angle::DEGREES<F32> pitch, Angle::DEGREES<F32> yaw, Angle::DEGREES<F32> roll) override;
     void rotate(const Quaternion<F32>& quat) override;
     void rotateSlerp(const Quaternion<F32>& quat, D64 deltaTime) override;
     void rotateX(Angle::DEGREES<F32> angle) override;
     void rotateY(Angle::DEGREES<F32> angle) override;
     void rotateZ(Angle::DEGREES<F32> angle) override;
     using ITransform::rotate;
 
     [[nodiscard]] const vec3<F32> getLocalDirection(const vec3<F32>& worldForward = WORLD_Z_NEG_AXIS) const;
     [[nodiscard]] const vec3<F32> getWorldDirection(const vec3<F32>& worldForward = WORLD_Z_NEG_AXIS) const;
 
     void setDirection(const vec3<F32>& fwdDirection, const vec3<F32>& upDirection = WORLD_Y_AXIS);
     void setTransform(const TransformValues& values);
 
     [[nodiscard]] bool isUniformScaled() const noexcept;
 
     [[nodiscard]] vec3<F32> getWorldPosition() const;
     [[nodiscard]] vec3<F32> getLocalPosition() const;
     [[nodiscard]] vec3<F32> getWorldPositionInterpolated() const;
     [[nodiscard]] vec3<F32> getLocalPositionInterpolated() const;
 
     [[nodiscard]] vec3<F32> getFwdVector() const;
     [[nodiscard]] vec3<F32> getUpVector() const;
     [[nodiscard]] vec3<F32> getRightVector() const;
 
     [[nodiscard]] vec3<F32> getWorldScale() const;
     [[nodiscard]] vec3<F32> getLocalScale() const;
     [[nodiscard]] vec3<F32> getWorldScaleInterpolated() const;
     [[nodiscard]] vec3<F32> getLocalScaleInterpolated() const;
 
     [[nodiscard]] Quaternion<F32> getWorldOrientation() const;
     [[nodiscard]] Quaternion<F32> getLocalOrientation() const;
     [[nodiscard]] Quaternion<F32> getWorldOrientationInterpolated() const;
     [[nodiscard]] Quaternion<F32> getLocalOrientationInterpolated() const;
 
     void getWorldTransforms(vec3<F32>& positionOut, vec3<F32>& scaleOut, Quaternion<F32>& rotationOut);
     void getWorldTransformsInterpolated(vec3<F32>& positionOut, vec3<F32>& scaleOut, Quaternion<F32>& rotationOut);
 
     void setTransforms(const mat4<F32>& transform);
 
     [[nodiscard]] TransformValues getLocalValues() const;
 
     void pushTransforms();
     bool popTransforms();
 
     void resetCache();
     void setOffset(bool state, const mat4<F32>& offset = mat4<F32>()) noexcept;
 
     [[nodiscard]] bool saveCache(ByteBuffer& outputBuffer) const override;
     [[nodiscard]] bool loadCache(ByteBuffer& inputBuffer) override;
 
     PROPERTY_R_IW(TransformValues, cachedDerivedTransform);
 
     PROPERTY_RW(bool, editorLockPosition, false);
     PROPERTY_RW(bool, editorLockRotation, false);
     PROPERTY_RW(bool, editorLockScale, false);
     PROPERTY_RW(ScalingMode, scalingMode, ScalingMode::UNIFORM);
 
     PROPERTY_R_IW(mat4<F32>, localMatrix, MAT4_IDENTITY);
     PROPERTY_R_IW(mat4<F32>, localMatrixInterpolated, MAT4_IDENTITY);
 
  protected:
     friend class TransformSystem;
     template<typename T, typename U>
     friend class ECSSystem;
 
 
     void setTransformDirty(TransformType type) noexcept;
     void setTransformDirty(U32 typeMask) noexcept;
 
     void updateCachedValues();
 
     void onParentTransformDirty(U32 transformMask) noexcept;
     void onParentUsageChanged(NodeUsageContext context) noexcept;
 
     void onParentChanged(const SceneGraphNode* oldParent, const SceneGraphNode* newParent);
 
     // Local transform interface access (all are in local space)
     void getScale(vec3<F32>& scaleOut) const override;
     void getPosition(vec3<F32>& posOut) const override;
     void getOrientation(Quaternion<F32>& quatOut) const override;
 
     //Derived = World
     [[nodiscard]] Quaternion<F32> getDerivedOrientation() const;
     [[nodiscard]] vec3<F32>       getDerivedPosition()    const;
     [[nodiscard]] vec3<F32>       getDerivedScale()       const;
 
     //Called only when then transform changed in the main update loop!
     void updateLocalMatrix( D64 interpolationFactor );
  private:
     void updateLocalMatrixLocked();
     void updateLocalMatrixInterpolated( D64 interpolationFactor );
 
  private:
    std::pair<bool, mat4<F32>> _transformOffset;
 
    using TransformStack = std::stack<TransformValues>;
 
    std::atomic_uint _transformUpdatedMask{};
    TransformValues  _prevTransformValues;
    TransformValues  _transformValuesInterpolated;
    TransformStack   _transformStack{};
    Transform        _transformInterface;
 
    NodeUsageContext _parentUsageContext;
 
    bool _cacheDirty = true;
    bool _uniformScaled = true;
 
    mutable SharedMutex _localMatrixLock{};
    mutable SharedMutex _lock{};
 
 
END_COMPONENT(Transform);
 
namespace Attorney {
    class TransformComponentSGN {
        static void onParentTransformDirty(TransformComponent& comp, const U32 transformMask) noexcept {
            comp.onParentTransformDirty(transformMask);
        }
 
        static void onParentUsageChanged(TransformComponent& comp, const NodeUsageContext context) noexcept {
            comp.onParentUsageChanged(context);
        }
        
        static void onParentChanged(TransformComponent& comp, const SceneGraphNode* oldParent, const SceneGraphNode* newParent) noexcept {
            comp.onParentChanged(oldParent, newParent);
        }
        friend class Divide::SceneGraphNode;
    };
 
} //namespace Attorney
 
} //namespace Divide
 
#endif //DVD_TRANSFORM_COMPONENT_H_