Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

2.4 KB
Raw Blame
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// SPDX-FileCopyrightText: Copyright (c) 2008-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

#ifndef PX_SPARSE_GRID_PARAMS_H
#define PX_SPARSE_GRID_PARAMS_H

#include "foundation/PxSimpleTypes.h"
#include "foundation/PxMath.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

	/**
	\brief Parameters to define the sparse grid settings like grid spacing, maximal number of subgrids etc.
	*/
	struct PxSparseGridParams
	{
		/**
		\brief Default constructor.
		*/
		PX_INLINE PxSparseGridParams()
		{
			maxNumSubgrids = 512;
			subgridSizeX = 32;
			subgridSizeY = 32;
			subgridSizeZ = 32;
			gridSpacing = 0.2f;
			haloSize = 1;
		}

		/**
		\brief Copy constructor.
		*/
		PX_CUDA_CALLABLE PX_INLINE PxSparseGridParams(const PxSparseGridParams& params)
		{
			maxNumSubgrids = params.maxNumSubgrids;
			subgridSizeX = params.subgridSizeX;
			subgridSizeY = params.subgridSizeY;
			subgridSizeZ = params.subgridSizeZ;
			gridSpacing = params.gridSpacing;
			haloSize = params.haloSize;
		}

		PX_CUDA_CALLABLE PX_INLINE PxU32 getNumCellsPerSubgrid() const
		{
			return subgridSizeX * subgridSizeY * subgridSizeZ;
		}

		PX_CUDA_CALLABLE PX_INLINE PxReal getSqrt3dx() const
		{
			return PxSqrt(3.0f) * gridSpacing;
		}


		/**
		\brief (re)sets the structure to the default.
		*/
		PX_INLINE void setToDefault()
		{
			*this = PxSparseGridParams();
		}

		/**
		\brief Assignment operator
		*/
		PX_INLINE void operator = (const PxSparseGridParams& params)
		{
			maxNumSubgrids = params.maxNumSubgrids;
			subgridSizeX = params.subgridSizeX;
			subgridSizeY = params.subgridSizeY;
			subgridSizeZ = params.subgridSizeZ;
			gridSpacing = params.gridSpacing;
			haloSize = params.haloSize;
		}

		PxU32	maxNumSubgrids;			//!< Maximum number of subgrids
		PxReal	gridSpacing;			//!< Grid spacing for the grid
		PxU16	subgridSizeX;			//!< Subgrid resolution in x dimension (must be an even number)
		PxU16	subgridSizeY;			//!< Subgrid resolution in y dimension (must be an even number)
		PxU16	subgridSizeZ;			//!< Subgrid resolution in z dimension (must be an even number)
		PxU16	haloSize;				//!< Number of halo cell layers around every subgrid cell. Only 0 and 1 are valid values
	};


#if !PX_DOXYGEN
} // namespace physx
#endif

#endif