ModuleFieldSampler.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 MODULE_FIELD_SAMPLER_H
#define MODULE_FIELD_SAMPLER_H

#include "Apex.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class FieldSamplerWeightedCollisionFilterCallback
{
public:
    virtual bool fieldSamplerWeightedCollisionFilter(const physx::PxFilterData &objectA,const physx::PxFilterData &objectB,float &multiplierValue) = 0;
};


class ModuleFieldSampler : public Module
{
protected:
    virtual                 ~ModuleFieldSampler() {}

public:

    virtual bool            setFieldSamplerWeightedCollisionFilterCallback(const Scene& apexScene,FieldSamplerWeightedCollisionFilterCallback *callback) = 0;

    
#if PX_PHYSICS_VERSION_MAJOR == 3

    virtual void            enablePhysXMonitor(const Scene& apexScene, bool enable) = 0;
    virtual void            setPhysXMonitorFilterData(const Scene& apexScene, physx::PxFilterData filterData) = 0;
#endif

    virtual uint32_t        createForceSampleBatch(const Scene& apexScene, uint32_t maxCount, const physx::PxFilterData filterData) = 0;

    virtual void            releaseForceSampleBatch(const Scene& apexScene, uint32_t batchId) = 0;

    virtual void            submitForceSampleBatch( const Scene& apexScene, uint32_t batchId,
                                                    PxVec4* forces, const uint32_t forcesStride, 
                                                    const PxVec3* positions, const uint32_t positionsStride, 
                                                    const PxVec3* velocities, const uint32_t velocitiesStride,
                                                    const float* mass, const uint32_t massStride,
                                                    const uint32_t* indices, const uint32_t numIndices) = 0;

};



PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // MODULE_FIELD_SAMPLER_H