GroundEmitterActor.h

Go to the documentation of this file.

//
// 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 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