ClothingAsset.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_ASSET_H
#define CLOTHING_ASSET_H

#include "Asset.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class ClothingActor;
class ClothingPreview;

#define CLOTHING_AUTHORING_TYPE_NAME "ClothingAsset"


struct ClothSolverMode
{
    enum Enum
    {
        v3,
    };
};


struct ClothingMeshSkinningMap
{
    PxVec3 positionBary;

    uint32_t vertexIndex0;

    PxVec3 normalBary;

    uint32_t vertexIndex1;

    PxVec3 tangentBary;

    uint32_t vertexIndex2;
};

class ClothingAsset : public Asset
{
protected:
    // do not manually delete this object
    virtual ~ClothingAsset() {}
public:
    virtual uint32_t getNumActors() const = 0;

    virtual ClothingActor* getActor(uint32_t index) = 0;

    virtual PxBounds3 getBoundingBox() const = 0;

    virtual uint32_t getNumGraphicalLodLevels() const = 0;

    virtual uint32_t getGraphicalLodValue(uint32_t lodLevel) const = 0;

    virtual float getBiggestMaxDistance() const = 0;

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

    virtual bool remapBoneIndex(const char* name, uint32_t newIndex) = 0;

    virtual uint32_t getNumBones() const = 0;

    virtual uint32_t getNumUsedBones() const = 0;

    virtual const char* getBoneName(uint32_t internalIndex) const = 0;

    virtual bool getBoneBasePose(uint32_t internalIndex, PxMat44& result) const = 0;

    virtual void getBoneMapping(uint32_t* internal2externalMap) const = 0;

    virtual const RenderMeshAsset*  getRenderMeshAsset(uint32_t lodLevel) const = 0;

    virtual uint32_t prepareMorphTargetMapping(const PxVec3* originalPositions, uint32_t numPositions, float epsilon) = 0;
    
    virtual uint32_t getMeshSkinningMapSize(uint32_t lod) = 0;

    virtual void getMeshSkinningMap(uint32_t lod, ClothingMeshSkinningMap* map) = 0;

    virtual bool releaseGraphicalData() = 0;
};

PX_POP_PACK

} // namespace nvidia
} // namespace nvidia

#endif // CLOTHING_ASSET_H