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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBase.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>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<h1>PxBase.h</h1><a href="PxBase_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_BASE</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define PX_PHYSICS_PX_BASE</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="PxSerialFramework_8h.html">PxSerialFramework.h</a>"</span>
<a name="l00039"></a>00039 <span class="preprocessor">#include "<a class="code" href="PxCollection_8h.html">PxCollection.h</a>"</span>
<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="PxTypeInfo_8h.html">common/PxTypeInfo.h</a>"</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="PxFlags_8h.html">foundation/PxFlags.h</a>"</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include <string.h></span> <span class="comment">// For strcmp</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="preprocessor">#if !PX_DOXYGEN</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="keyword">namespace </span>physx
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047 <span class="preprocessor">#endif</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span>
<a name="l00049"></a><a class="code" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">00049</a> <span class="keyword">typedef</span> <a class="code" href="namespacephysx.html#9caf1cbcda071b6d2a9c069faa99da23">PxU16</a> <a class="code" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a>;
<a name="l00050"></a>00050
<a name="l00054"></a><a class="code" href="structPxBaseFlag.html">00054</a> <span class="keyword">struct </span><a class="code" href="structPxBaseFlag.html" title="Flags for PxBase.">PxBaseFlag</a>
<a name="l00055"></a>00055 {
<a name="l00056"></a><a class="code" href="structPxBaseFlag.html#c258de0c7adaa37f81b6ab1b0c86a6ee">00056</a> <span class="keyword">enum</span> <a class="code" href="structPxBaseFlag.html#c258de0c7adaa37f81b6ab1b0c86a6ee">Enum</a>
<a name="l00057"></a>00057 {
<a name="l00058"></a><a class="code" href="structPxBaseFlag.html#c258de0c7adaa37f81b6ab1b0c86a6ee2ac901fc5a0e816d32620ec5f4c113ef">00058</a> eOWNS_MEMORY = (1<<0),
<a name="l00059"></a><a class="code" href="structPxBaseFlag.html#c258de0c7adaa37f81b6ab1b0c86a6eec34c2f2192b5e878b7765f7c36de35d2">00059</a> eIS_RELEASABLE = (1<<1)
<a name="l00060"></a>00060 };
<a name="l00061"></a>00061 };
<a name="l00062"></a>00062
<a name="l00063"></a><a class="code" href="group__common.html#g1e3721588799f5fbb18d76e4aab7d018">00063</a> <span class="keyword">typedef</span> <a class="code" href="classPxFlags.html">PxFlags<PxBaseFlag::Enum, PxU16></a> <a class="code" href="classPxFlags.html">PxBaseFlags</a>;
<a name="l00064"></a>00064 <a class="code" href="group__foundation.html#g092f922a63fdc7a95ae4f4e24b3768c1">PX_FLAGS_OPERATORS</a>(<a class="code" href="structPxBaseFlag.html#c258de0c7adaa37f81b6ab1b0c86a6ee">PxBaseFlag::Enum</a>, <a class="code" href="namespacephysx.html#9caf1cbcda071b6d2a9c069faa99da23">PxU16</a>)
<a name="l00065"></a>00065
<a name="l00066"></a>00066
<a name="l00073"></a><a class="code" href="classPxBase.html">00073</a> class <a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>
<a name="l00074"></a>00074 {
<a name="l00075"></a>00075 <span class="comment">//= ATTENTION! =====================================================================================</span>
<a name="l00076"></a>00076 <span class="comment">// Changing the data layout of this class breaks the binary serialization format. See comments for </span>
<a name="l00077"></a>00077 <span class="comment">// PX_BINARY_SERIAL_VERSION. If a modification is required, please adjust the getBinaryMetaData </span>
<a name="l00078"></a>00078 <span class="comment">// function. If the modification is made on a custom branch, please change PX_BINARY_SERIAL_VERSION</span>
<a name="l00079"></a>00079 <span class="comment">// accordingly.</span>
<a name="l00080"></a>00080 <span class="comment">//==================================================================================================</span>
<a name="l00081"></a>00081 <span class="keyword">public</span>:
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <span class="keywordtype">void</span> release() = 0;
<a name="l00086"></a>00086
<a name="l00091"></a>00091 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* getConcreteTypeName() <span class="keyword">const</span> = 0;
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="comment">/* brief Implements dynamic cast functionality. </span>
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment"> Example use:</span>
<a name="l00096"></a>00096 <span class="comment"> </span>
<a name="l00097"></a>00097 <span class="comment"> if(actor->is<PxRigidDynamic>()) {...}</span>
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> \return A pointer to the specified type if object matches, otherwise NULL</span>
<a name="l00100"></a>00100 <span class="comment"> */</span>
<a name="l00101"></a><a class="code" href="classPxBase.html#8f36dbc1f322a7c76384ece24157a3d5">00101</a> <span class="keyword">template</span><<span class="keyword">class</span> T> T* <a class="code" href="classPxBase.html#8f36dbc1f322a7c76384ece24157a3d5">is</a>() { <span class="keywordflow">return</span> typeMatch<T>() ? static_cast<T*>(<span class="keyword">this</span>) : NULL; }
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">/* brief Implements dynamic cast functionality for const objects. </span>
<a name="l00104"></a>00104 <span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment"> Example use:</span>
<a name="l00106"></a>00106 <span class="comment"> </span>
<a name="l00107"></a>00107 <span class="comment"> if(actor->is<PxRigidDynamic>()) {...}</span>
<a name="l00108"></a>00108 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment"> \return A pointer to the specified type if object matches, otherwise NULL</span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a><a class="code" href="classPxBase.html#61051867b30a0247cf01eb45dd608bf3">00111</a> <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">const</span> T* <a class="code" href="classPxBase.html#61051867b30a0247cf01eb45dd608bf3">is</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> typeMatch<T>() ? static_cast<const T*>(<span class="keyword">this</span>) : NULL; }
<a name="l00112"></a>00112
<a name="l00119"></a><a class="code" href="classPxBase.html#4bea698ef56feb6ea7297bfbb21cbd14">00119</a> <a class="code" href="group__foundation.html#g6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="code" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> <a class="code" href="classPxBase.html#4bea698ef56feb6ea7297bfbb21cbd14" title="Returns concrete type of object.">getConcreteType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mConcreteType; }
<a name="l00120"></a>00120
<a name="l00127"></a><a class="code" href="classPxBase.html#1dd20bb574075df904e1878f2e771ef9">00127</a> <a class="code" href="group__foundation.html#g6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <span class="keywordtype">void</span> <a class="code" href="classPxBase.html#1dd20bb574075df904e1878f2e771ef9" title="Set PxBaseFlag.">setBaseFlag</a>(<a class="code" href="structPxBaseFlag.html#c258de0c7adaa37f81b6ab1b0c86a6ee">PxBaseFlag::Enum</a> flag, <span class="keywordtype">bool</span> value) { mBaseFlags = value ? mBaseFlags|flag : mBaseFlags&~flag; }
<a name="l00128"></a>00128
<a name="l00136"></a><a class="code" href="classPxBase.html#fb391b692c561df0a54c413785e4ebd0">00136</a> <a class="code" href="group__foundation.html#g6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <span class="keywordtype">void</span> <a class="code" href="classPxBase.html#fb391b692c561df0a54c413785e4ebd0" title="Set PxBaseFlags.">setBaseFlags</a>(<a class="code" href="classPxFlags.html">PxBaseFlags</a> inFlags ) { mBaseFlags = inFlags; }
<a name="l00137"></a>00137
<a name="l00145"></a><a class="code" href="classPxBase.html#042c1c7315883506ae893dd8cdce4b02">00145</a> <a class="code" href="group__foundation.html#g6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="code" href="classPxFlags.html">PxBaseFlags</a> <a class="code" href="classPxBase.html#042c1c7315883506ae893dd8cdce4b02" title="Returns PxBaseFlags.">getBaseFlags</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mBaseFlags; }
<a name="l00146"></a>00146
<a name="l00156"></a><a class="code" href="classPxBase.html#25118c0c901d602e74a0ee17679499e9">00156</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPxBase.html#25118c0c901d602e74a0ee17679499e9" title="Whether the object is subordinate.">isReleasable</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mBaseFlags & <a class="code" href="structPxBaseFlag.html#c258de0c7adaa37f81b6ab1b0c86a6eec34c2f2192b5e878b7765f7c36de35d2">PxBaseFlag::eIS_RELEASABLE</a>; }
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">protected</span>:
<a name="l00162"></a><a class="code" href="classPxBase.html#263f1ef821c74058ce9335e06cb842a4">00162</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxBase(<a class="code" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="code" href="classPxFlags.html">PxBaseFlags</a> baseFlags)
<a name="l00163"></a>00163 : mConcreteType(concreteType), mBaseFlags(baseFlags) {}
<a name="l00164"></a>00164
<a name="l00168"></a><a class="code" href="classPxBase.html#58b979202e7382701f74977fe3dd5c6f">00168</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="classPxBase.html#58b979202e7382701f74977fe3dd5c6f" title="Deserialization constructor setting base flags.">PxBase</a>(<a class="code" href="classPxFlags.html">PxBaseFlags</a> baseFlags) : mBaseFlags(baseFlags) {}
<a name="l00169"></a>00169
<a name="l00173"></a><a class="code" href="classPxBase.html#dfbf62dc32775b068db1c74c7fd3d982">00173</a> <span class="keyword">virtual</span> <a class="code" href="classPxBase.html#dfbf62dc32775b068db1c74c7fd3d982" title="Destructor.">~PxBase</a>() {}
<a name="l00174"></a>00174
<a name="l00178"></a><a class="code" href="classPxBase.html#ae9d444c7cfd1715a101350a1b1226ef">00178</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPxBase.html#ae9d444c7cfd1715a101350a1b1226ef" title="Returns whether a given type name matches with the type of this instance.">isKindOf</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* superClass)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !::strcmp(superClass, <span class="stringliteral">"PxBase"</span>); }
<a name="l00179"></a>00179
<a name="l00180"></a><a class="code" href="classPxBase.html#f3428f7a99124c0425e8299c9c447f5e">00180</a> <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keywordtype">bool</span> typeMatch()<span class="keyword"> const</span>
<a name="l00181"></a>00181 <span class="keyword"> </span>{
<a name="l00182"></a>00182 <span class="keywordflow">return</span> <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a>(<a class="code" href="structPxTypeInfo.html" title="a structure containing per-type information for types inheriting from PxBase">PxTypeInfo<T>::eFastTypeId</a>)!=<a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a>(<a class="code" href="structPxConcreteType.html#d762aca1d4c8fffae41267fae4f1b8e8e532e94bf1c5c2deac15d6ecc9e96ac6">PxConcreteType::eUNDEFINED</a>) ?
<a name="l00183"></a>00183 <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a>(getConcreteType()) == <a class="code" href="namespacephysx.html#9b7fbd746d18bf5b6545713a8d818f41">PxU32</a>(<a class="code" href="structPxTypeInfo.html" title="a structure containing per-type information for types inheriting from PxBase">PxTypeInfo<T>::eFastTypeId</a>) : isKindOf(<a class="code" href="structPxTypeInfo.html" title="a structure containing per-type information for types inheriting from PxBase">PxTypeInfo<T>::name</a>());
<a name="l00184"></a>00184 }
<a name="l00185"></a>00185
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keyword">private</span>:
<a name="l00188"></a>00188 <span class="keyword">friend</span> <span class="keywordtype">void</span> getBinaryMetaData_PxBase(<a class="code" href="classPxOutputStream.html" title="Output stream class for I/O.">PxOutputStream</a>& stream);
<a name="l00189"></a>00189
<a name="l00190"></a>00190 <span class="keyword">protected</span>:
<a name="l00191"></a><a class="code" href="classPxBase.html#1abe9d19726e1f8f8e56abeb2269b5d4">00191</a> <a class="code" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> mConcreteType; <span class="comment">// concrete type identifier - see PxConcreteType.</span>
<a name="l00192"></a><a class="code" href="classPxBase.html#ff7105f65905ecb9f6f7993ba28b712d">00192</a> <a class="code" href="classPxFlags.html">PxBaseFlags</a> mBaseFlags; <span class="comment">// internal flags</span>
<a name="l00193"></a>00193
<a name="l00194"></a>00194 };
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="preprocessor">#if !PX_DOXYGEN</span>
<a name="l00197"></a>00197 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span>
<a name="l00198"></a>00198 <span class="preprocessor">#endif</span>
<a name="l00199"></a>00199 <span class="preprocessor"></span>
<a name="l00201"></a>00201 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 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>
|