//
// 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 TURBULENCE_RENDERABLE_H
#define TURBULENCE_RENDERABLE_H

#include "foundation/Px.h"
#include "ApexInterface.h"
#include "Renderable.h"
#include "TurbulenceRenderCallback.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

/**
 \brief Render surface field type
 */
struct TurbulenceFieldType
{
	/**
	 \brief Enum of render surface field types
	 */
	enum Enum
	{
		VELOCITY = 0,
		DENSITY,
		FLAME,

		MAX_COUNT
	};
};

/**
 \brief TurbulenceRenderData stores render data for one Turbulence Renderable.
 */
struct TurbulenceRenderData
{
	///UserRenderSurfaceDesc array for all field types
	UserRenderSurfaceDesc	fieldSurfaceDescs[TurbulenceFieldType::MAX_COUNT];
	
	///UserRenderSurface array for all field types
	UserRenderSurface*		fieldSurfaces[TurbulenceFieldType::MAX_COUNT];
};

/**
 \brief The Turbulence renderable represents a unit of rendering.
 
 It contains complete information to render one Turbulence Actor.
*/
class TurbulenceRenderable : public ApexInterface
{
public:
	///Return render data.
	virtual const TurbulenceRenderData*	getRenderData() const = 0;

	///Return AABB of this renderable.
	virtual const physx::PxBounds3&		getBounds() const = 0;

protected:
	virtual	~TurbulenceRenderable() {}

};

PX_POP_PACK

}
} // end namespace nvidia

#endif // TURBULENCE_RENDERABLE_H