EmitterGeoms.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 EMITTER_GEOMS_H
#define EMITTER_GEOMS_H

#include "Apex.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

struct EmitterType
{
    enum Enum
    {
        ET_RATE = 0,            
        ET_DENSITY_ONCE,        
        ET_DENSITY_BRUSH,       
        ET_FILL,                
        ET_UNDEFINED,
    };
};

class EmitterGeomBox;
class EmitterGeomSphere;
class EmitterGeomSphereShell;
class EmitterGeomCylinder;
class EmitterGeomExplicit;

class EmitterGeom
{
public:
    virtual void                            setEmitterType(EmitterType::Enum) = 0;
    
    virtual EmitterType::Enum               getEmitterType() const = 0;

    virtual const EmitterGeomBox*           isBoxGeom() const
    {
        return NULL;
    }
    
    virtual const EmitterGeomSphere*        isSphereGeom() const
    {
        return NULL;
    }
    
    virtual const EmitterGeomSphereShell*   isSphereShellGeom() const
    {
        return NULL;
    }
    
    virtual const EmitterGeomCylinder*      isCylinderGeom() const
    {
        return NULL;
    }
    
    virtual const EmitterGeomExplicit*      isExplicitGeom() const
    {
        return NULL;
    }
};

class EmitterGeomSphereShell : public EmitterGeom
{
public:
    
    virtual void    setRadius(float radius) = 0;
    
    virtual float   getRadius() const = 0;

    virtual void    setShellThickness(float thickness) = 0;
    
    virtual float   getShellThickness() const = 0;
};

class EmitterGeomSphere : public EmitterGeom
{
public:

    virtual void    setRadius(float radius) = 0;
    
    virtual float   getRadius() const = 0;
};

class EmitterGeomCylinder : public EmitterGeom
{
public:

    virtual void    setRadius(float radius) = 0;
    
    virtual float   getRadius() const = 0;

    virtual void    setHeight(float height) = 0;
    
    virtual float   getHeight() const = 0;
};

class EmitterGeomBox : public EmitterGeom
{
public:

    virtual void    setExtents(const PxVec3& extents) = 0;
    
    virtual PxVec3  getExtents() const = 0;
};

class EmitterGeomExplicit : public EmitterGeom
{
public:
    
    struct PointParams
    {
        PxVec3 position; 
        bool doDetectOverlaps; 
    };

    struct SphereParams
    {
        PxVec3 center; 
        float radius; 
        bool doDetectOverlaps; 
    };

    struct EllipsoidParams
    {
        PxVec3 center; 
        float radius; 
        PxVec3 normal; 
        float polarRadius; 
        bool doDetectOverlaps; 
    };

    virtual void    resetParticleList() = 0;

    virtual void    addParticleList(uint32_t count,
                                    const PointParams* params,
                                    const PxVec3* velocities = 0) = 0;

    virtual void    addParticleList(uint32_t count,
                                    const PxVec3* positions,
                                    const PxVec3* velocities = 0) = 0;

    struct PointListData
    {
        const void* positionStart;          
        uint32_t    positionStrideBytes;    
        const void* velocityStart;          
        uint32_t    velocityStrideBytes;    
        const void* userDataStart;          
        uint32_t    userDataStrideBytes;    
    };
    
    virtual void    addParticleList(uint32_t count, const PointListData& data) = 0;

    virtual void    addSphereList(uint32_t count,
                                  const SphereParams* params,
                                  const PxVec3* velocities = 0) = 0;

    virtual void    addEllipsoidList(uint32_t count,
                                     const EllipsoidParams*  params,
                                     const PxVec3* velocities = 0) = 0;

    virtual void    getParticleList(const PointParams* &params,
                                    uint32_t& numPoints,
                                    const PxVec3* &velocities,
                                    uint32_t& numVelocities) const = 0;

    virtual void    getSphereList(const SphereParams* &params,
                                  uint32_t& numSpheres,
                                  const PxVec3* &velocities,
                                  uint32_t& numVelocities) const = 0;

    virtual void    getEllipsoidList(const EllipsoidParams* &params,
                                     uint32_t& numEllipsoids,
                                     const PxVec3* &velocities,
                                     uint32_t& numVelocities) const = 0;

    virtual uint32_t    getParticleCount() const = 0;

    virtual PxVec3      getParticlePos(uint32_t index) const = 0;

    virtual uint32_t    getSphereCount() const = 0;

    virtual PxVec3      getSphereCenter(uint32_t index) const = 0;

    virtual float       getSphereRadius(uint32_t index) const = 0;

    virtual uint32_t    getEllipsoidCount() const = 0;

    virtual PxVec3      getEllipsoidCenter(uint32_t index) const = 0;

    virtual float       getEllipsoidRadius(uint32_t index) const = 0;

    virtual PxVec3      getEllipsoidNormal(uint32_t index) const = 0;

    virtual float       getEllipsoidPolarRadius(uint32_t index) const = 0;

    virtual float       getDistance() const = 0;
};


PX_POP_PACK

}
} // end namespace nvidia

#endif // EMITTER_GEOMS_H