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

/*!
\file
\brief classes ModuleCachedData, ApexSDKCachedData
*/

#include "ApexSDK.h"

namespace NvParameterized
{
class Interface;
};

namespace nvidia
{
namespace apex
{


/**
\brief Cached data is stored per-module.
*/
class ModuleCachedData
{
public:
	/**
	 * \brief Retreives the cached data for the asset, if it exists.
	 *
	 * Otherwise returns NULL.
	 */
	virtual ::NvParameterized::Interface*	getCachedDataForAssetAtScale(Asset& asset, const PxVec3& scale) = 0;

	/**	
	 *	\brief Serializes the cooked data for a single asset into a stream.
	 */
	virtual PxFileBuf& serializeSingleAsset(Asset& asset, PxFileBuf& stream) = 0;

	/**	
	 *	\brief Deserializes the cooked data for a single asset from a stream.
	 */
	virtual PxFileBuf& deserializeSingleAsset(Asset& asset, PxFileBuf& stream) = 0;
};

/**
\brief A method for storing actor data in a scene
*/
class ApexSDKCachedData
{
public:
	/**
	 * \brief Retreives the scene cached data for the actor, if it exists.
	 *
	 * Otherwise returns NULL.
	 */
	virtual ModuleCachedData*	getCacheForModule(AuthObjTypeID moduleID) = 0;

	/**
	 * \brief Save cache configuration to a stream
	 */
	virtual PxFileBuf&  		serialize(PxFileBuf&) const = 0;

	/**
	 * \brief Load cache configuration from a stream
	 */
	virtual PxFileBuf&  		deserialize(PxFileBuf&) = 0;

	/**
	 * \brief Clear data
	 */
	virtual void				clear(bool force = true) = 0;

protected:
	ApexSDKCachedData() {}
	virtual						~ApexSDKCachedData() {}
};

}
} // end namespace nvidia::apex


#endif // APEX_SDKCACHED_DATA_H