Skeleton.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;

class JPH_EXPORT Skeleton : public RefTarget<Skeleton>
{
    JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, Skeleton)
 
public:
    using SkeletonResult = Result<Ref<Skeleton>>;

    class Joint
    {
        JPH_DECLARE_SERIALIZABLE_NON_VIRTUAL(JPH_EXPORT, Joint)
 
    public:
                            Joint() = default;
                            Joint(const string_view &inName, const string_view &inParentName, int inParentJointIndex) : mName(inName), mParentName(inParentName), mParentJointIndex(inParentJointIndex) { }
 
        String              mName;                                                                      
        String              mParentName;                                                                
        int                 mParentJointIndex = -1;                                                     
    };
 
    using JointVector = Array<Joint>;

    const JointVector &     GetJoints() const                                                           { return mJoints; }
    JointVector &           GetJoints()                                                                 { return mJoints; }
    int                     GetJointCount() const                                                       { return (int)mJoints.size(); }
    const Joint &           GetJoint(int inJoint) const                                                 { return mJoints[inJoint]; }
    Joint &                 GetJoint(int inJoint)                                                       { return mJoints[inJoint]; }
    uint                    AddJoint(const string_view &inName, const string_view &inParentName = string_view()) { mJoints.emplace_back(inName, inParentName, -1); return (uint)mJoints.size() - 1; }
    uint                    AddJoint(const string_view &inName, int inParentIndex)                      { mJoints.emplace_back(inName, inParentIndex >= 0? mJoints[inParentIndex].mName : String(), inParentIndex); return (uint)mJoints.size() - 1; }

    int                     GetJointIndex(const string_view &inName) const;

    void                    CalculateParentJointIndices();

    bool                    AreJointsCorrectlyOrdered() const;

    void                    SaveBinaryState(StreamOut &inStream) const;

    static SkeletonResult   sRestoreFromBinaryState(StreamIn &inStream);
 
private:
    JointVector             mJoints;
};
 
JPH_NAMESPACE_END