aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxCollection_8h-source.html
blob: 7ebe47fe05dbbe0b735b3ed624b7d4a9199685a7 (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxCollection.h Source File</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<h1>PxCollection.h</h1><a href="PxCollection_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// Redistribution and use in source and binary forms, with or without</span>
<a name="l00003"></a>00003 <span class="comment">// modification, are permitted provided that the following conditions</span>
<a name="l00004"></a>00004 <span class="comment">// are met:</span>
<a name="l00005"></a>00005 <span class="comment">//  * Redistributions of source code must retain the above copyright</span>
<a name="l00006"></a>00006 <span class="comment">//    notice, this list of conditions and the following disclaimer.</span>
<a name="l00007"></a>00007 <span class="comment">//  * Redistributions in binary form must reproduce the above copyright</span>
<a name="l00008"></a>00008 <span class="comment">//    notice, this list of conditions and the following disclaimer in the</span>
<a name="l00009"></a>00009 <span class="comment">//    documentation and/or other materials provided with the distribution.</span>
<a name="l00010"></a>00010 <span class="comment">//  * Neither the name of NVIDIA CORPORATION nor the names of its</span>
<a name="l00011"></a>00011 <span class="comment">//    contributors may be used to endorse or promote products derived</span>
<a name="l00012"></a>00012 <span class="comment">//    from this software without specific prior written permission.</span>
<a name="l00013"></a>00013 <span class="comment">//</span>
<a name="l00014"></a>00014 <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY</span>
<a name="l00015"></a>00015 <span class="comment">// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00016"></a>00016 <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span>
<a name="l00017"></a>00017 <span class="comment">// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR</span>
<a name="l00018"></a>00018 <span class="comment">// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span>
<a name="l00019"></a>00019 <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span>
<a name="l00020"></a>00020 <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<a name="l00021"></a>00021 <span class="comment">// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY</span>
<a name="l00022"></a>00022 <span class="comment">// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<a name="l00023"></a>00023 <span class="comment">// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
<a name="l00024"></a>00024 <span class="comment">// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00025"></a>00025 <span class="comment">//</span>
<a name="l00026"></a>00026 <span class="comment">// Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.</span>
<a name="l00027"></a>00027 <span class="comment">// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.</span>
<a name="l00028"></a>00028 <span class="comment">// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  </span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="preprocessor">#ifndef PX_PHYSICS_PX_COLLECTION</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define PX_PHYSICS_PX_COLLECTION</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="PxSerialFramework_8h.html">PxSerialFramework.h</a>"</span>
<a name="l00035"></a>00035 
<a name="l00040"></a>00040 <span class="preprocessor">#if !PX_DOXYGEN</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="keyword">namespace </span>physx
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <span class="preprocessor">#endif</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span>
<a name="l00045"></a>00045 <span class="keyword">class </span><a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>;
<a name="l00046"></a>00046 
<a name="l00105"></a><a class="code" href="classPxCollection.html">00105</a> <span class="keyword">class </span><a class="code" href="classPxCollection.html" title="Collection class for serialization.">PxCollection</a>
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 <span class="keyword">public</span>: 
<a name="l00108"></a>00108 
<a name="l00122"></a>00122     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                        <span class="keyword">add</span>(<a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>&amp; object, <a class="code" href="group__common.html#gb2ccfb663643cd2d66b59908189d88cd" title="ID type for PxBase objects in a PxCollection.">PxSerialObjectId</a> <span class="keywordtype">id</span> = <a class="code" href="group__common.html#g70054743832670870a1ce9f619907c77" title="PxSerialObjectId value for objects that do not have an ID.">PX_SERIAL_OBJECT_ID_INVALID</a>) = 0;
<a name="l00123"></a>00123 
<a name="l00131"></a>00131     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                        <span class="keyword">remove</span>(<a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>&amp; object) = 0;
<a name="l00132"></a>00132             
<a name="l00139"></a>00139     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                        contains(<a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>&amp; <span class="keywordtype">object</span>) <span class="keyword">const</span> = 0;
<a name="l00140"></a>00140 
<a name="l00151"></a>00151     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                        addId(<a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>&amp; <span class="keywordtype">object</span>, <a class="code" href="group__common.html#gb2ccfb663643cd2d66b59908189d88cd" title="ID type for PxBase objects in a PxCollection.">PxSerialObjectId</a> <span class="keywordtype">id</span>) = 0;
<a name="l00152"></a>00152 
<a name="l00160"></a>00160     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                        removeId(<a class="code" href="group__common.html#gb2ccfb663643cd2d66b59908189d88cd" title="ID type for PxBase objects in a PxCollection.">PxSerialObjectId</a> <span class="keywordtype">id</span>) = 0;
<a name="l00161"></a>00161     
<a name="l00170"></a>00170     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                        <span class="keyword">add</span>(<a class="code" href="classPxCollection.html" title="Collection class for serialization.">PxCollection</a>&amp; collection) = 0;
<a name="l00171"></a>00171 
<a name="l00180"></a>00180     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                        <span class="keyword">remove</span>(<a class="code" href="classPxCollection.html" title="Collection class for serialization.">PxCollection</a>&amp; collection) = 0;
<a name="l00181"></a>00181 
<a name="l00187"></a>00187     <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a>                       getNbObjects() <span class="keyword">const</span> = 0;
<a name="l00188"></a>00188 
<a name="l00195"></a>00195     <span class="keyword">virtual</span> <a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>&amp;                     getObject(<a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a> index) <span class="keyword">const</span> = 0;
<a name="l00196"></a>00196 
<a name="l00205"></a>00205     <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a>                       getObjects(<a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>** userBuffer, <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a> bufferSize, <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a> startIndex=0) <span class="keyword">const</span> = 0;
<a name="l00206"></a>00206 
<a name="l00215"></a>00215     <span class="keyword">virtual</span> <a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>*                     find(<a class="code" href="group__common.html#gb2ccfb663643cd2d66b59908189d88cd" title="ID type for PxBase objects in a PxCollection.">PxSerialObjectId</a> <span class="keywordtype">id</span>) <span class="keyword">const</span> = 0;
<a name="l00216"></a>00216     
<a name="l00222"></a>00222     <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a>                       getNbIds() <span class="keyword">const</span> = 0;
<a name="l00223"></a>00223 
<a name="l00232"></a>00232     <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a>                       getIds(<a class="code" href="group__common.html#gb2ccfb663643cd2d66b59908189d88cd" title="ID type for PxBase objects in a PxCollection.">PxSerialObjectId</a>* userBuffer, <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a> bufferSize, <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a> startIndex=0) <span class="keyword">const</span> = 0;
<a name="l00233"></a>00233 
<a name="l00242"></a>00242     <span class="keyword">virtual</span> <a class="code" href="group__common.html#gb2ccfb663643cd2d66b59908189d88cd" title="ID type for PxBase objects in a PxCollection.">PxSerialObjectId</a>            getId(<span class="keyword">const</span> <a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>&amp; <span class="keywordtype">object</span>) <span class="keyword">const</span> = 0;  
<a name="l00243"></a>00243 
<a name="l00253"></a>00253     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                        release() = 0;
<a name="l00254"></a>00254 
<a name="l00255"></a>00255 <span class="keyword">protected</span>:
<a name="l00256"></a><a class="code" href="classPxCollection.html#3cf81c15b4dcd6e16f56c1d0bc383ba3">00256</a>                                         <a class="code" href="classPxCollection.html#3cf81c15b4dcd6e16f56c1d0bc383ba3">PxCollection</a>()  {}
<a name="l00257"></a><a class="code" href="classPxCollection.html#3d6a12201cf8a03da20c74c1c1cb548c">00257</a>     <span class="keyword">virtual</span>                             <a class="code" href="classPxCollection.html#3d6a12201cf8a03da20c74c1c1cb548c">~PxCollection</a>() {}
<a name="l00258"></a>00258 };
<a name="l00259"></a>00259     
<a name="l00260"></a>00260 <span class="preprocessor">#if !PX_DOXYGEN</span>
<a name="l00261"></a>00261 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span>
<a name="l00262"></a>00262 <span class="preprocessor">#endif</span>
<a name="l00263"></a>00263 <span class="preprocessor"></span>
<a name="l00275"></a>00275 <a class="code" href="group__common.html#g87ae1d60bdf83754e2fe5065aab40ec4">PX_PHYSX_COMMON_API</a> physx::PxCollection* PX_CALL_CONV <a class="code" href="group__common.html#ga3979f24ebe59e173e262c7155b1a489" title="Creates a collection object.">PxCreateCollection</a>();
<a name="l00276"></a>00276 
<a name="l00277"></a>00277 
<a name="l00279"></a>00279 <span class="preprocessor">#endif</span>
</pre></div></div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>