PhysicsMaterial.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/Color.h>
#include <Jolt/Core/Result.h>
#include <Jolt/ObjectStream/SerializableObject.h>
 
JPH_NAMESPACE_BEGIN
 
class StreamIn;
class StreamOut;

class JPH_EXPORT PhysicsMaterial : public SerializableObject, public RefTarget<PhysicsMaterial>
{
    JPH_DECLARE_SERIALIZABLE_VIRTUAL(JPH_EXPORT, PhysicsMaterial)
 
public:
                                            PhysicsMaterial() = default;
    virtual                                 ~PhysicsMaterial() override = default;

    static RefConst<PhysicsMaterial>        sDefault;
 
    // Properties
    virtual const char *                    GetDebugName() const            { return "Unknown"; }
    virtual Color                           GetDebugColor() const           { return Color::sGrey; }

    virtual void                            SaveBinaryState(StreamOut &inStream) const;
 
    using PhysicsMaterialResult = Result<Ref<PhysicsMaterial>>;

    static PhysicsMaterialResult            sRestoreFromBinaryState(StreamIn &inStream);
 
protected:
                                            PhysicsMaterial(const PhysicsMaterial &) = default;
    PhysicsMaterial &                       operator = (const PhysicsMaterial &) = default;

    virtual void                            RestoreBinaryState(StreamIn &inStream);
};
 
using PhysicsMaterialList = Array<RefConst<PhysicsMaterial>>;
 
JPH_NAMESPACE_END