PathConstraintPath.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/Core/Reference.h>
#include <Jolt/Core/Result.h>
#include <Jolt/ObjectStream/SerializableObject.h>
 
JPH_NAMESPACE_BEGIN
 
class StreamIn;
class StreamOut;
#ifdef JPH_DEBUG_RENDERER
class DebugRenderer;
#endif // JPH_DEBUG_RENDERER
 
class JPH_EXPORT PathConstraintPath : public SerializableObject, public RefTarget<PathConstraintPath>
{
public:
    JPH_DECLARE_SERIALIZABLE_ABSTRACT(JPH_EXPORT, PathConstraintPath)
 
    using PathResult = Result<Ref<PathConstraintPath>>;
 
    virtual             ~PathConstraintPath() override = default;
 
    virtual float       GetPathMaxFraction() const = 0;
 
    virtual float       GetClosestPoint(Vec3Arg inPosition) const = 0;
 
    virtual void        GetPointOnPath(float inFraction, Vec3 &outPathPosition, Vec3 &outPathTangent, Vec3 &outPathNormal, Vec3 &outPathBinormal) const = 0;
 
    void                SetIsLooping(bool inIsLooping)                      { mIsLooping = inIsLooping; }
    bool                IsLooping() const                                   { return mIsLooping; }
 
#ifdef JPH_DEBUG_RENDERER
    void                DrawPath(DebugRenderer *inRenderer, RMat44Arg inBaseTransform) const;
#endif // JPH_DEBUG_RENDERER
 
    virtual void        SaveBinaryState(StreamOut &inStream) const;
 
    static PathResult   sRestoreFromBinaryState(StreamIn &inStream);
 
protected:
    virtual void        RestoreBinaryState(StreamIn &inStream);
 
private:
    bool                mIsLooping = false;
};
 
JPH_NAMESPACE_END