NvBlastExtAuthoringFractureTool.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and related documentation and
// any modifications thereto. Any use, reproduction, disclosure, or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA Corporation is strictly prohibited.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016-2020 NVIDIA Corporation. All rights reserved.


#ifndef NVBLASTAUTHORINGFRACTURETOOL_H
#define NVBLASTAUTHORINGFRACTURETOOL_H

#include "NvBlastExtAuthoringTypes.h"

namespace Nv
{
namespace Blast
{

class SpatialAccelerator;
class Triangulator;
class Mesh;
class CutoutSet;

/*
    Chunk data, chunk with chunkId == 0 is always source mesh.
*/
struct ChunkInfo
{
    enum ChunkFlags
    {
        NO_FLAGS            = 0,
        APPROXIMATE_BONDING = 1 // Created by island splitting or chunk merge, etc. and should check for inexact bonds
    };

    Mesh* meshData;
    int32_t parent;
    int32_t chunkId;
    uint32_t flags;
    bool isLeaf;
    bool isChanged;
};

class RandomGeneratorBase
{
  public:
    // Generates uniformly distributed value in [0, 1] range.
    virtual float getRandomValue() = 0;
    // Seeds random value generator
    virtual void seed(int32_t seed) = 0;
    virtual ~RandomGeneratorBase(){};
};

/*
    Noise fracturing configuration for chunks's faces
*/
struct NoiseConfiguration
{
    float amplitude = 0.f;

    float frequency = 1.f;

    uint32_t octaveNumber = 1;

    NvcVec3 samplingInterval = { 1, 1, 1 };
};

/*
    Slicing fracturing configuration
*/
struct SlicingConfiguration
{
    int32_t x_slices = 1, y_slices = 1, z_slices = 1;

    float offset_variations = 0.f;

    float angle_variations = 0.f;

    /*
        Noise parameters for faces between sliced chunks
    */
    NoiseConfiguration noise;
};

struct CutoutConfiguration
{
    CutoutSet* cutoutSet = nullptr;

    NvcTransform transform = {{0, 0, 0, 1}, {0, 0, 0}};

    NvcVec2 scale = { -1, -1 };

    float aperture = 0.f;

    bool isRelativeTransform = true;

    bool useSmoothing = false;

    NoiseConfiguration noise;
};

class VoronoiSitesGenerator
{
  public:
    virtual ~VoronoiSitesGenerator() {}

    virtual void release() = 0;

    virtual void setBaseMesh(const Mesh* mesh) = 0;

    virtual uint32_t getVoronoiSites(const NvcVec3*& sites) = 0;

    virtual void addSite(const NvcVec3& site) = 0;
    virtual void uniformlyGenerateSitesInMesh(uint32_t numberOfSites) = 0;

    virtual void clusteredSitesGeneration(uint32_t numberOfClusters, uint32_t sitesPerCluster, float clusterRadius) = 0;

    virtual void radialPattern(const NvcVec3& center, const NvcVec3& normal, float radius, int32_t angularSteps,
                               int32_t radialSteps, float angleOffset = 0.0f, float variability = 0.0f) = 0;

    virtual void generateInSphere(const uint32_t count, const float radius, const NvcVec3& center) = 0;

    virtual void setStencil(const Mesh* stencil) = 0;

    virtual void clearStencil() = 0;

    virtual void deleteInSphere(const float radius, const NvcVec3& center, const float eraserProbability = 1) = 0;
};

class FractureTool
{

  public:
    virtual ~FractureTool() {}

    virtual void release() = 0;

    virtual void reset() = 0;


    virtual void setSourceMesh(const Mesh* mesh) = 0;

    virtual int32_t setChunkMesh(const Mesh* mesh, int32_t parentId) = 0;

    virtual void setInteriorMaterialId(int32_t materialId) = 0;

    virtual int32_t getInteriorMaterialId() const = 0;

    virtual void replaceMaterialId(int32_t oldMaterialId, int32_t newMaterialId) = 0;

    virtual Mesh* createChunkMesh(int32_t chunkId) = 0;

    virtual void getTransformation(NvcVec3& offset, float& scale) = 0;


    virtual int32_t
    voronoiFracturing(uint32_t chunkId, uint32_t cellCount, const NvcVec3* cellPoints, bool replaceChunk) = 0;

    virtual int32_t voronoiFracturing(uint32_t chunkId, uint32_t cellCount, const NvcVec3* cellPoints,
                                      const NvcVec3& scale, const NvcQuat& rotation, bool replaceChunk) = 0;


    virtual int32_t
    slicing(uint32_t chunkId, const SlicingConfiguration& conf, bool replaceChunk, RandomGeneratorBase* rnd) = 0;

    virtual int32_t cut(uint32_t chunkId, const NvcVec3& normal, const NvcVec3& position,
                        const NoiseConfiguration& noise, bool replaceChunk, RandomGeneratorBase* rnd) = 0;

    virtual int32_t cutout(uint32_t chunkId, CutoutConfiguration conf, bool replaceChunk, RandomGeneratorBase* rnd) = 0;


    virtual void finalizeFracturing() = 0;

    virtual uint32_t getChunkCount() const = 0;

    virtual const ChunkInfo& getChunkInfo(int32_t chunkIndex) = 0;

    virtual float getMeshOverlap(const Mesh& meshA, const Mesh& meshB) = 0;

    virtual uint32_t getBaseMesh(int32_t chunkIndex, Triangle*& output) = 0;

    virtual uint32_t updateBaseMesh(int32_t chunkIndex, Triangle* output) = 0;

    virtual int32_t getChunkIndex(int32_t chunkId) = 0;

    virtual int32_t getChunkId(int32_t chunkIndex) = 0;

    virtual int32_t getChunkDepth(int32_t chunkId) = 0;

    virtual uint32_t getChunksIdAtDepth(uint32_t depth, int32_t*& chunkIds) = 0;

    virtual uint32_t
    getBufferedBaseMeshes(Vertex*& vertexBuffer, uint32_t*& indexBuffer, uint32_t*& indexBufferOffsets) = 0;

    virtual void setRemoveIslands(bool isRemoveIslands) = 0;

    virtual int32_t islandDetectionAndRemoving(int32_t chunkId, bool createAtNewDepth = false) = 0;

    virtual bool isMeshContainOpenEdges(const Mesh* input) = 0;

    virtual bool deleteChunkSubhierarchy(int32_t chunkId, bool deleteRoot = false) = 0;

    virtual void uniteChunks(uint32_t threshold, uint32_t targetClusterSize,
                             const uint32_t* chunksToMerge, uint32_t mergeChunkCount,
                             const NvcVec2i* adjChunks, uint32_t adjChunksSize,
                             bool removeOriginalChunks = false) = 0;

    virtual bool setApproximateBonding(uint32_t chunkIndex, bool useApproximateBonding) = 0;

    virtual void fitUvToRect(float side, uint32_t chunkId) = 0;

    virtual void fitAllUvToRect(float side) = 0;
};

}  // namespace Blast
}  // namespace Nv

#endif  // ifndef NVBLASTAUTHORINGFRACTURETOOL_H