GroundEmitterActor.h

/*
 * Copyright (c) 2008-2017, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, 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.
 */


#ifndef GROUND_EMITTER_ACTOR_H
#define GROUND_EMITTER_ACTOR_H

#include "Apex.h"

namespace nvidia
{
namespace apex
{


PX_PUSH_PACK_DEFAULT

class GroundEmitterAsset;
class RenderVolume;

class MaterialLookupCallback
{
public:
    struct MaterialRequest
    {
        PxVec3      samplePosition; 
        uint32_t    outMaterialID; 
    };

    virtual void requestMaterialLookups(uint32_t requestCount, MaterialRequest* reqList) = 0;

    virtual ~MaterialLookupCallback() {}
};

class GroundEmitterActor : public Actor
{
protected:
    virtual ~GroundEmitterActor() {}

public:
    virtual GroundEmitterAsset*     getEmitterAsset() const = 0;

    virtual const PxMat44           getPose() const = 0;
    virtual void                    setPose(const PxMat44& pos) = 0;

    virtual void                    setMaterialLookupCallback(MaterialLookupCallback*) = 0;
    
    virtual MaterialLookupCallback* getMaterialLookupCallback() const = 0;

    virtual void                    setAttachActor(PxActor*) = 0;

    virtual void                    setAttachRelativePosition(const PxVec3& pos) = 0;

    virtual const PxActor*          getAttachActor() const = 0;

    virtual const PxVec3&           getAttachRelativePosition() const = 0;

    /* Override some asset settings at run time */

    virtual void                    setDensity(const float&) = 0;
    
    virtual void                    setRadius(float) = 0;
    
    virtual void                    setMaxRaycastsPerFrame(uint32_t) = 0;
    
    virtual void                    setRaycastHeight(float) = 0;
    
    virtual void                    setSpawnHeight(float) = 0;

    virtual const float &           getDensity() const = 0;
    
    virtual float                   getRadius() const = 0;
    
    virtual uint32_t                getMaxRaycastsPerFrame() const = 0;
    
    virtual float                   getRaycastHeight() const = 0;
    
    virtual float                   getSpawnHeight() const = 0;

    virtual void                    setRaycastCollisionGroups(uint32_t) = 0;

    virtual void                    setRaycastCollisionGroupsMask(physx::PxFilterData*) = 0;


    virtual uint32_t                getRaycastCollisionGroups() const = 0;

    virtual void                    setPreferredRenderVolume(RenderVolume* volume) = 0;
};


PX_POP_PACK

}
} // end namespace nvidia

#endif // GROUND_EMITTER_ACTOR_H