ClothingActor.h

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.



#ifndef CLOTHING_ACTOR_H
#define CLOTHING_ACTOR_H

#include "Actor.h"
#include "Renderable.h"
#include "ClothingAsset.h"

namespace NvParameterized
{
class Interface;
}

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class ClothingVelocityCallback;
class ClothingPlane;
class ClothingConvex;
class ClothingSphere;
class ClothingCapsule;
class ClothingTriangleMesh;
class ClothingRenderProxy;


struct ClothingTeleportMode
{
    enum Enum
    {
        Continuous,

        Teleport,

        TeleportAndReset,
    };
};



class ClothingActor : public Actor, public Renderable
{
protected:
    virtual ~ClothingActor() {}
public:

    virtual ::NvParameterized::Interface* getActorDesc() = 0;

    virtual void updateState(const PxMat44& globalPose, const PxMat44* newBoneMatrices, uint32_t boneMatricesByteStride, uint32_t numBoneMatrices, ClothingTeleportMode::Enum teleportMode) = 0;

    virtual void updateMaxDistanceScale(float scale, bool multipliable) = 0;

    virtual const PxMat44& getGlobalPose() const = 0;

    virtual void setWind(float windAdaption, const PxVec3& windVelocity) = 0;

    virtual void setMaxDistanceBlendTime(float blendTime) = 0;

    virtual float getMaxDistanceBlendTime() const = 0;

    virtual void setVisible(bool enable) = 0;

    virtual bool isVisible() const = 0;

    virtual void setFrozen(bool enable) = 0;

    virtual bool isFrozen() const = 0;

    virtual ClothSolverMode::Enum getClothSolverMode() const = 0;

    virtual void setGraphicalLOD(uint32_t lod) = 0;

    virtual uint32_t getGraphicalLod() = 0;

    virtual bool rayCast(const PxVec3& worldOrigin, const PxVec3& worldDirection, float& time, PxVec3& normal, uint32_t& vertexIndex) = 0;

    virtual void attachVertexToGlobalPosition(uint32_t vertexIndex, const PxVec3& globalPosition) = 0;

    virtual void freeVertex(uint32_t vertexIndex) = 0;

    virtual uint32_t getClothingMaterial() const = 0;

    virtual void setClothingMaterial(uint32_t index) = 0;

    virtual void setOverrideMaterial(uint32_t submeshIndex, const char* overrideMaterialName) = 0;

    virtual void setVelocityCallback(ClothingVelocityCallback* callback) = 0;

    virtual void getPhysicalMeshPositions(void* buffer, uint32_t byteStride) = 0;

    virtual void getPhysicalMeshNormals(void* buffer, uint32_t byteStride) = 0;

    virtual float getMaximumSimulationBudget() const = 0;

    virtual uint32_t getNumSimulationVertices() const = 0;

    
    virtual const PxVec3* getSimulationPositions() = 0;

    virtual const PxVec3* getSimulationNormals() = 0;

    virtual bool getSimulationVelocities(PxVec3* velocities) = 0;

    virtual uint32_t getNumGraphicalVerticesActive(uint32_t submeshIndex) const = 0;

    virtual PxMat44 getRenderGlobalPose() const = 0;

    virtual const PxMat44* getCurrentBoneSkinningMatrices() const = 0;


    virtual bool isHalfPrecisionAllowed() const = 0;

    virtual void setHalfPrecision(bool isAllowed) = 0;


    virtual ClothingPlane* createCollisionPlane(const PxPlane& plane) = 0;

    virtual ClothingConvex* createCollisionConvex(ClothingPlane** planes, uint32_t numPlanes) = 0;

    virtual ClothingSphere* createCollisionSphere(const PxVec3& position, float radius) = 0;

    virtual ClothingCapsule* createCollisionCapsule(ClothingSphere& sphere1, ClothingSphere& sphere2) = 0;

    virtual ClothingTriangleMesh* createCollisionTriangleMesh() = 0;

    virtual ClothingRenderProxy* acquireRenderProxy() = 0;

#if APEX_UE4

    virtual void simulate(PxF32 dt) = 0;
#endif
};

PX_POP_PACK

}
} // namespace nvidia

#endif // CLOTHING_ACTOR_H