PathConstraintPathHermite.h

Go to the documentation of this file.

// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <Jolt/Physics/Constraints/PathConstraintPath.h>
 
JPH_NAMESPACE_BEGIN

class JPH_EXPORT PathConstraintPathHermite final : public PathConstraintPath
{
    JPH_DECLARE_SERIALIZABLE_VIRTUAL(JPH_EXPORT, PathConstraintPathHermite)
 
public:
    // See PathConstraintPath::GetPathMaxFraction
    virtual float       GetPathMaxFraction() const override                                 { return float(IsLooping()? mPoints.size() : mPoints.size() - 1); }
 
    // See PathConstraintPath::GetClosestPoint
    virtual float       GetClosestPoint(Vec3Arg inPosition, float inFractionHint) const override;
 
    // See PathConstraintPath::GetPointOnPath
    virtual void        GetPointOnPath(float inFraction, Vec3 &outPathPosition, Vec3 &outPathTangent, Vec3 &outPathNormal, Vec3 &outPathBinormal) const override;

    void                AddPoint(Vec3Arg inPosition, Vec3Arg inTangent, Vec3Arg inNormal)   { mPoints.push_back({ inPosition, inTangent, inNormal}); }
 
    // See: PathConstraintPath::SaveBinaryState
    virtual void        SaveBinaryState(StreamOut &inStream) const override;
 
    struct Point
    {
        JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, Point)
 
        Vec3            mPosition;                                                          
        Vec3            mTangent;                                                           
        Vec3            mNormal;                                                            
    };
 
protected:
    // See: PathConstraintPath::RestoreBinaryState
    virtual void        RestoreBinaryState(StreamIn &inStream) override;
 
private:
    inline void         GetIndexAndT(float inFraction, int &outIndex, float &outT) const;
 
    using Points = Array<Point>;
 
    Points              mPoints;                                                            
};
 
JPH_NAMESPACE_END