RenderVolume.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 RENDER_VOLUME_H
#define RENDER_VOLUME_H

#include "Apex.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class IofxAsset;
class IofxActor;

class RenderVolume : public ApexInterface
{
public:
    virtual physx::PxBounds3    getBounds() const = 0;

    virtual bool                getAffectsAllIofx() const = 0;

    virtual bool                addIofxAsset(IofxAsset& iofx) = 0;

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

    virtual void                setOwnershipBounds(const PxBounds3& b) = 0;

    virtual PxBounds3           getOwnershipBounds() const = 0;

    virtual IofxActor* const*   lockIofxActorList(uint32_t& count) = 0;
    
    virtual void                unlockIofxActorList() = 0;

    virtual IofxAsset* const*   getIofxAssetList(uint32_t& count) const = 0;

    virtual PxVec3              getPosition() const = 0; 
    virtual uint32_t            getPriority() const = 0; 

    virtual bool                affectsIofxAsset(const IofxAsset& iofx) const = 0;

protected:
    virtual ~RenderVolume() {}
};

PX_POP_PACK

}
} // namespace nvidia

#endif // RENDER_VOLUME_H