// 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) 2008-2023 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  

#ifndef PX_FEM_SOFT_BODY_MATERIAL_H
#define PX_FEM_SOFT_BODY_MATERIAL_H
/** \addtogroup physics
@{
*/

#include "PxFEMMaterial.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

	struct PxFEMSoftBodyMaterialModel
	{
		enum Enum
		{
			eCO_ROTATIONAL,   //!< Default model. Well suited for high stiffness. Does need tetrahedra with good shapes (no extreme slivers) in the rest pose.
			eNEO_HOOKEAN      //!< Well suited for lower stiffness. Robust to any tetrahedron shape.
		};
	};

	class PxScene;
	/**
	\brief Material class to represent a set of softbody FEM material properties.

	@see PxPhysics.createFEMSoftBodyMaterial
	*/
	class PxFEMSoftBodyMaterial : public PxFEMMaterial
	{
	public:

		/**
		\brief Sets material velocity damping term

		\param[in] damping Material velocity damping term. <b>Range:</b> [0, PX_MAX_F32)<br>		

		@see getDamping
		*/
		virtual		void	setDamping(PxReal damping) = 0;

		/**
		\brief Retrieves velocity damping
		\return The velocity damping.

		@see setDamping()
		*/
		virtual		PxReal	getDamping() const = 0;

		/**
		\brief Sets material damping scale. A scale of 1 corresponds to default damping, a value of 0 will only apply damping to certain motions leading to special effects that look similar to water filled softbodies.

		\param[in] scale Damping scale term. <b>Default:</b> 1 <b>Range:</b> [0, 1]

		@see getDampingScale
		*/
		virtual		void	setDampingScale(PxReal scale) = 0;

		/**
		\brief Retrieves material damping scale.
		\return The damping scale term.

		@see setDamping()
		*/
		virtual		PxReal	getDampingScale() const = 0;

		/**
		\brief Sets the material model.

		\param[in] model The material model

		@see getMaterialModel
		*/
		virtual		void	setMaterialModel(PxFEMSoftBodyMaterialModel::Enum model) = 0;
		
		/**
		\brief Retrieves the material model.
		\return The material model.

		@see setMaterialModel()
		*/
		virtual		PxFEMSoftBodyMaterialModel::Enum getMaterialModel() const = 0;

		virtual		const char*		getConcreteTypeName() const { return "PxFEMSoftBodyMaterial"; }

	protected:
		PX_INLINE			PxFEMSoftBodyMaterial(PxType concreteType, PxBaseFlags baseFlags) : PxFEMMaterial(concreteType, baseFlags) {}
		PX_INLINE			PxFEMSoftBodyMaterial(PxBaseFlags baseFlags) : PxFEMMaterial(baseFlags) {}
		virtual				~PxFEMSoftBodyMaterial() {}
		virtual		bool	isKindOf(const char* name) const { return !::strcmp("PxFEMSoftBodyMaterial", name) || PxFEMMaterial::isKindOf(name); }
	};

#if !PX_DOXYGEN
} // namespace physx
#endif

/** @} */
#endif