ClothingPhysicalMesh.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_PHYSICAL_MESH_H
#define CLOTHING_PHYSICAL_MESH_H

#include "ApexInterface.h"
#include "IProgressListener.h"

namespace nvidia
{
namespace apex
{


struct ClothingConstrainCoefficients
{
    float maxDistance; 
    float collisionSphereRadius; 
    float collisionSphereDistance; 
};


PX_PUSH_PACK_DEFAULT

struct ClothingPhysicalMeshStats
{
    uint32_t    totalBytes;
    uint32_t    numVertices;
    uint32_t    numIndices;
};


class ClothingPhysicalMesh : public ApexInterface
{
public:
    virtual uint32_t getNumVertices() const = 0;

    virtual uint32_t getNumSimulatedVertices() const = 0;

    virtual uint32_t getNumMaxDistance0Vertices() const = 0;

    virtual uint32_t getNumIndices() const = 0;

    virtual uint32_t getNumSimulatedIndices() const = 0;

    virtual void getIndices(void* indexDestination, uint32_t byteStride, uint32_t numIndices) const = 0;

    virtual bool isTetrahedralMesh() const = 0;

    virtual void simplify(uint32_t subdivisions, int32_t maxSteps, float maxError, IProgressListener* progress) = 0;

    virtual void setGeometry(bool tetraMesh, uint32_t numVertices, uint32_t vertexByteStride, const void* vertices, const uint32_t* driveChannels, 
                            uint32_t numIndices, uint32_t indexByteStride, const void* indices) = 0;

    // direct access to specific buffers
    virtual bool getIndices(uint32_t* indices, uint32_t byteStride) const = 0;

    virtual bool getVertices(PxVec3* vertices, uint32_t byteStride) const = 0;

    virtual bool getNormals(PxVec3* normals, uint32_t byteStride) const = 0;

    virtual uint32_t getNumBonesPerVertex() const = 0;

    virtual bool getBoneIndices(uint16_t* boneIndices, uint32_t byteStride) const = 0;

    virtual bool getBoneWeights(float* boneWeights, uint32_t byteStride) const = 0;

    virtual void allocateMasterFlagsBuffer() = 0;

    virtual uint32_t* getMasterFlagsBuffer() = 0;

    virtual void allocateConstrainCoefficientBuffer() = 0;

    virtual ClothingConstrainCoefficients* getConstrainCoefficientBuffer() const = 0;

    virtual bool getConstrainCoefficients(ClothingConstrainCoefficients* coeffs, uint32_t byteStride) const = 0;

    virtual void getStats(ClothingPhysicalMeshStats& stats) const = 0;

};

PX_POP_PACK

}
} // namespace nvidia

#endif // CLOTHING_PHYSICAL_MESH_H