aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Source/SceneQuery/src/SqIncrementalAABBTree.h
blob: a631fa808a3329c6c26af60fcd57caad7bac57a7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
//
// 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-2018 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 SQ_INCREMENTAL_AABB_TREE_H
#define SQ_INCREMENTAL_AABB_TREE_H

#include "foundation/PxBounds3.h"
#include "PsUserAllocated.h"
#include "PsVecMath.h"
#include "SqPruner.h"
#include "SqAABBTreeBuild.h"
#include "PsPool.h"

namespace physx
{
	using namespace shdfnd::aos;

	namespace Sq
	{
		class AABBTree;

		#define NB_OBJECTS_PER_NODE	4

		///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		// tree indices, can change in runtime
		struct AABBTreeIndices
		{
			PX_FORCE_INLINE AABBTreeIndices(PoolIndex index) :
				nbIndices(1)
			{
				indices[0] = index;
				for(PxU32 i = 1; i < NB_OBJECTS_PER_NODE; i++)
				{
					indices[i] = 0;
				}
			}

			PxU32			nbIndices;
			PoolIndex		indices[NB_OBJECTS_PER_NODE];
		};

		///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		// tree node, has parent information
		class IncrementalAABBTreeNode : public Ps::UserAllocated
		{
		public:
			PX_FORCE_INLINE								IncrementalAABBTreeNode():
				mParent(NULL)
			{
				mChilds[0] = NULL;
				mChilds[1] = NULL;
			}
			PX_FORCE_INLINE								IncrementalAABBTreeNode(AABBTreeIndices* indices):
				mParent(NULL)
			{
				mIndices = indices;
				mChilds[1] = NULL;
			}
			PX_FORCE_INLINE								~IncrementalAABBTreeNode() {}

			PX_FORCE_INLINE	PxU32						isLeaf()								const { return PxU32(mChilds[1]==0); }

			PX_FORCE_INLINE	const PxU32*				getPrimitives(const PxU32* )			const { return &mIndices->indices[0]; }
			PX_FORCE_INLINE	PxU32*						getPrimitives(PxU32* )					{ return &mIndices->indices[0]; }
			PX_FORCE_INLINE	PxU32						getNbPrimitives()						const { return mIndices->nbIndices; }

			PX_FORCE_INLINE	const IncrementalAABBTreeNode*	getPos(const IncrementalAABBTreeNode* )	const { return mChilds[0]; }
			PX_FORCE_INLINE	const IncrementalAABBTreeNode*	getNeg(const IncrementalAABBTreeNode* )	const { return mChilds[1]; }

			PX_FORCE_INLINE	IncrementalAABBTreeNode*		getPos(IncrementalAABBTreeNode* ) { return mChilds[0]; }
			PX_FORCE_INLINE	IncrementalAABBTreeNode*		getNeg(IncrementalAABBTreeNode* ) { return mChilds[1]; }

			PX_FORCE_INLINE	void						getAABBCenterExtentsV(physx::shdfnd::aos::Vec3V* center, physx::shdfnd::aos::Vec3V* extents) const
			{
				const float half = 0.5f;
				const FloatV halfV = FLoad(half);

				*extents = Vec3V_From_Vec4V((V4Scale(V4Sub(mBVMax, mBVMin), halfV)));
				*center = Vec3V_From_Vec4V((V4Scale(V4Add(mBVMax, mBVMin), halfV)));
			}

			PX_FORCE_INLINE	void						getAABBCenterExtentsV2(physx::shdfnd::aos::Vec3V* center, physx::shdfnd::aos::Vec3V* extents) const
			{
				*extents = Vec3V_From_Vec4V((V4Sub(mBVMax, mBVMin)));
				*center = Vec3V_From_Vec4V((V4Add(mBVMax, mBVMin)));
			}

			PX_FORCE_INLINE	void						getAABBMinMaxV(physx::shdfnd::aos::Vec4V* minV, physx::shdfnd::aos::Vec4V* maxV) const
			{
				*minV = mBVMin;
				*maxV = mBVMax;
			}

			Vec4V						mBVMin;		// Global bounding-volume min enclosing all the node-related primitives
			Vec4V						mBVMax;		// Global bounding-volume max enclosing all the node-related primitives			
			IncrementalAABBTreeNode*	mParent;	// node parent
			union
			{
				IncrementalAABBTreeNode*	mChilds[2];		// childs of node if not a leaf
				AABBTreeIndices*			mIndices;		// if leaf, indices information 
			};			
		};

		struct IncrementalAABBTreeNodePair
		{
			IncrementalAABBTreeNode	mNode0;
			IncrementalAABBTreeNode	mNode1;
		};

		typedef Ps::Array<IncrementalAABBTreeNode*>	NodeList;

		///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		// incremental AABB tree, all changes are immediatelly reflected to the tree
		class IncrementalAABBTree : public Ps::UserAllocated
		{
		public:
			IncrementalAABBTree();
			~IncrementalAABBTree();

			// Build the tree for the first time 
			bool						build(AABBTreeBuildParams& params, Ps::Array<IncrementalAABBTreeNode*>& mapping);

			// insert a new index into the tree
			IncrementalAABBTreeNode*	insert(const PoolIndex index,  const PxBounds3* bounds, NodeList& changedLeaf);

			// update the object in the tree - full update insert/remove
			IncrementalAABBTreeNode*	update(IncrementalAABBTreeNode* node, const PoolIndex index, const PxBounds3* bounds, NodeList& changedLeaf);
			// update the object in the tree, faster method, that may unballance the tree
			IncrementalAABBTreeNode*	updateFast(IncrementalAABBTreeNode* node, const PoolIndex index, const PxBounds3* bounds, NodeList& changedLeaf);

			// remove object from the tree
			IncrementalAABBTreeNode*	remove(IncrementalAABBTreeNode* node, const PoolIndex index, const PxBounds3* bounds);

			// fixup the tree indices, if we swapped the objects in the pruning pool
			void						fixupTreeIndices(IncrementalAABBTreeNode* node, const PoolIndex index, const PoolIndex newIndex);

			// origin shift
			void						shiftOrigin(const PxVec3& shift);
			
			// get the tree root node
			const IncrementalAABBTreeNode*	getNodes() const { return mRoot; }

			// define this function so we can share the scene query code with regular AABBTree
			const PxU32*				getIndices() const { return NULL; }

			// paranoia checks
			void						hierarchyCheck(PoolIndex maxIndex, const PxBounds3* bounds);
			void						hierarchyCheck(const PxBounds3* bounds);
			void						checkTreeLeaf(IncrementalAABBTreeNode* leaf, PoolIndex h);
			PxU32						getTreeLeafDepth(IncrementalAABBTreeNode* leaf);

			void						release();
			
		private:

			// clone the tree from the generic AABB tree that was built
			void						clone(Ps::Array<IncrementalAABBTreeNode*>& mapping, const PxU32* indices, IncrementalAABBTreeNode** treeNodes);

			// split leaf node, the newly added object does not fit in
			IncrementalAABBTreeNode*	splitLeafNode(IncrementalAABBTreeNode* node,  const PoolIndex index,  const Vec4V& minV,  const Vec4V& maxV, const PxBounds3* bounds);

			void						rotateTree(IncrementalAABBTreeNode* node, NodeList& changedLeaf, PxU32 largesRotateNode, const PxBounds3* bounds, bool rotateAgain);

			void						releaseNode(IncrementalAABBTreeNode* node);
		private:
			Ps::Pool<AABBTreeIndices>				mIndicesPool;
			Ps::Pool<IncrementalAABBTreeNodePair>	mNodesPool;
			IncrementalAABBTreeNode*			mRoot;

			NodeAllocator						mNodeAllocator;
		};
	}
}

#endif