diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html | 391 |
1 files changed, 391 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html new file mode 100644 index 00000000..1099cedc --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html @@ -0,0 +1,391 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxMeshScale Class Reference</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 --> +<div class="contents"> +<h1>PxMeshScale Class Reference<br> +<small> +[<a class="el" href="group__geomutils.html">Geomutils</a>]</small> +</h1><!-- doxytag: class="PxMeshScale" -->A class expressing a nonuniform scaling transformation. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxMeshScale_8h-source.html">PxMeshScale.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxMeshScale:</div> +<div class="dynsection"> +<p><center><img src="classPxMeshScale__coll__graph.png" border="0" usemap="#PxMeshScale__coll__map" alt="Collaboration graph"></center> +<map name="PxMeshScale__coll__map"> +<area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="7,16,60,37"><area shape="rect" href="classPxQuat.html" title="This is a quaternion class. For more information on quaternion mathematics consult..." alt="PxQuat" coords="96,16,149,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxMeshScale-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#e61dcd43ff73b52319a187e029906657">PxMeshScale</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor initializes to identity scale. <a href="#e61dcd43ff73b52319a187e029906657"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#073dcde32362dd33ba16db1375d32ded">PxMeshScale</a> (PxReal r)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from scalar. <a href="#073dcde32362dd33ba16db1375d32ded"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#861aff2d78563d1e844d5cb6a34057c6">PxMeshScale</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &s)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor to initialize to arbitrary scale and identity scale rotation. <a href="#861aff2d78563d1e844d5cb6a34057c6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#5187c2f3e63fea4fc8913630429779c3">PxMeshScale</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &s, const <a class="el" href="classPxQuat.html">PxQuat</a> &r)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor to initialize to arbitrary scaling. <a href="#5187c2f3e63fea4fc8913630429779c3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#8f7835837651faf5b74d3ee94b6901d7">isIdentity</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the scaling is an identity transformation. <a href="#8f7835837651faf5b74d3ee94b6901d7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE <a class="el" href="classPxMeshScale.html">PxMeshScale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#b6a550b31ba9d77b00400cbb7126a7b5">getInverse</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the inverse of this scaling transformation. <a href="#b6a550b31ba9d77b00400cbb7126a7b5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE <a class="el" href="classPxMat33.html">PxMat33</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#e2b26c0cb36188e42f532f8c22024a71">toMat33</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts this transformation to a 3x3 matrix representation. <a href="#e2b26c0cb36188e42f532f8c22024a71"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#97297ffe7d5de702b70df7e3c7050274">hasNegativeDeterminant</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if combination of negative scale components will cause the triangle normal to flip. The SDK will flip the normals internally. <a href="#97297ffe7d5de702b70df7e3c7050274"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#9750f18491c9bff546f62b7f999883df">transform</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &v) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#6c8b93430301371e3c5c60fed3e53c3b">isValidForTriangleMesh</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#4101dcecd21337bd95b3ca1fb52d1e1d">isValidForConvexMesh</a> () const </td></tr> + +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#12f2dbcf5214c4c5956dab0e75831449">scale</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A nonuniform scaling. <a href="#12f2dbcf5214c4c5956dab0e75831449"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxQuat.html">PxQuat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMeshScale.html#63902c04c9a3f326b5f969fa931e53fd">rotation</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The orientation of the scaling axes. <a href="#63902c04c9a3f326b5f969fa931e53fd"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A class expressing a nonuniform scaling transformation. +<p> +The scaling is along arbitrary axes that are specified by <a class="el" href="classPxMeshScale.html#63902c04c9a3f326b5f969fa931e53fd" title="The orientation of the scaling axes.">PxMeshScale::rotation</a>.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Negative scale values are supported for <a class="el" href="classPxTriangleMeshGeometry.html" title="Triangle mesh geometry class.">PxTriangleMeshGeometry</a> with absolute values for each component within [PX_MIN_ABS_MESH_SCALE, PX_MAX_ABS_MESH_SCALE] range. Negative scale causes a reflection around the specified axis, in addition PhysX will flip the normals for mesh triangles when scale.x*scale.y*scale.z < 0. <p> +Only positive scale values are supported for <a class="el" href="classPxConvexMeshGeometry.html" title="Convex mesh geometry class.">PxConvexMeshGeometry</a> with values for each component within [PX_MIN_ABS_MESH_SCALE, PX_MAX_ABS_MESH_SCALE] range).</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxConvexMeshGeometry.html" title="Convex mesh geometry class.">PxConvexMeshGeometry</a> <a class="el" href="classPxTriangleMeshGeometry.html" title="Triangle mesh geometry class.">PxTriangleMeshGeometry</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="e61dcd43ff73b52319a187e029906657"></a><!-- doxytag: member="PxMeshScale::PxMeshScale" ref="e61dcd43ff73b52319a187e029906657" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale::PxMeshScale </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor initializes to identity scale. +<p> + +</div> +</div><p> +<a class="anchor" name="073dcde32362dd33ba16db1375d32ded"></a><!-- doxytag: member="PxMeshScale::PxMeshScale" ref="073dcde32362dd33ba16db1375d32ded" args="(PxReal r)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale::PxMeshScale </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>r</em> </td> + <td> ) </td> + <td><code> [inline, explicit]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor from scalar. +<p> + +</div> +</div><p> +<a class="anchor" name="861aff2d78563d1e844d5cb6a34057c6"></a><!-- doxytag: member="PxMeshScale::PxMeshScale" ref="861aff2d78563d1e844d5cb6a34057c6" args="(const PxVec3 &s)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale::PxMeshScale </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>s</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor to initialize to arbitrary scale and identity scale rotation. +<p> + +<p>References <a class="el" href="Px_8h-source.html#l00084">PxIdentity</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5187c2f3e63fea4fc8913630429779c3"></a><!-- doxytag: member="PxMeshScale::PxMeshScale" ref="5187c2f3e63fea4fc8913630429779c3" args="(const PxVec3 &s, const PxQuat &r)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale::PxMeshScale </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>s</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxQuat.html">PxQuat</a> & </td> + <td class="paramname"> <em>r</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor to initialize to arbitrary scaling. +<p> + +<p>References <a class="el" href="PxQuat_8h-source.html#l00132">PxQuat::isUnit()</a>, and <a class="el" href="PxAssert_8h-source.html#l00061">PX_ASSERT</a>.</p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="b6a550b31ba9d77b00400cbb7126a7b5"></a><!-- doxytag: member="PxMeshScale::getInverse" ref="b6a550b31ba9d77b00400cbb7126a7b5" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE <a class="el" href="classPxMeshScale.html">PxMeshScale</a> PxMeshScale::getInverse </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the inverse of this scaling transformation. +<p> + +</div> +</div><p> +<a class="anchor" name="97297ffe7d5de702b70df7e3c7050274"></a><!-- doxytag: member="PxMeshScale::hasNegativeDeterminant" ref="97297ffe7d5de702b70df7e3c7050274" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxMeshScale::hasNegativeDeterminant </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns true if combination of negative scale components will cause the triangle normal to flip. The SDK will flip the normals internally. +<p> + +</div> +</div><p> +<a class="anchor" name="8f7835837651faf5b74d3ee94b6901d7"></a><!-- doxytag: member="PxMeshScale::isIdentity" ref="8f7835837651faf5b74d3ee94b6901d7" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxMeshScale::isIdentity </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns true if the scaling is an identity transformation. +<p> + +</div> +</div><p> +<a class="anchor" name="4101dcecd21337bd95b3ca1fb52d1e1d"></a><!-- doxytag: member="PxMeshScale::isValidForConvexMesh" ref="4101dcecd21337bd95b3ca1fb52d1e1d" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxMeshScale::isValidForConvexMesh </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>References <a class="el" href="PxMeshScale_8h-source.html#l00047">PX_MESH_SCALE_MAX</a>, and <a class="el" href="PxMeshScale_8h-source.html#l00043">PX_MESH_SCALE_MIN</a>.</p> + +<p>Referenced by <a class="el" href="PxConvexMeshGeometry_8h-source.html#l00131">PxConvexMeshGeometry::isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6c8b93430301371e3c5c60fed3e53c3b"></a><!-- doxytag: member="PxMeshScale::isValidForTriangleMesh" ref="6c8b93430301371e3c5c60fed3e53c3b" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxMeshScale::isValidForTriangleMesh </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>References <a class="el" href="PxVec3_8h-source.html#l00367">PxVec3::maxElement()</a>, <a class="el" href="PxVec3_8h-source.html#l00351">PxVec3::minElement()</a>, <a class="el" href="PxMeshScale_8h-source.html#l00047">PX_MESH_SCALE_MAX</a>, and <a class="el" href="PxMeshScale_8h-source.html#l00043">PX_MESH_SCALE_MIN</a>.</p> + +<p>Referenced by <a class="el" href="PxTriangleMeshGeometry_8h-source.html#l00131">PxTriangleMeshGeometry::isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e2b26c0cb36188e42f532f8c22024a71"></a><!-- doxytag: member="PxMeshScale::toMat33" ref="e2b26c0cb36188e42f532f8c22024a71" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE <a class="el" href="classPxMat33.html">PxMat33</a> PxMeshScale::toMat33 </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Converts this transformation to a 3x3 matrix representation. +<p> + +<p>References <a class="el" href="PxMat33_8h-source.html#l00353">PxMat33::column0</a>, <a class="el" href="PxMat33_8h-source.html#l00353">PxMat33::column1</a>, <a class="el" href="PxMat33_8h-source.html#l00353">PxMat33::column2</a>, and <a class="el" href="PxMat33_8h-source.html#l00190">PxMat33::getTranspose()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="9750f18491c9bff546f62b7f999883df"></a><!-- doxytag: member="PxMeshScale::transform" ref="9750f18491c9bff546f62b7f999883df" args="(const PxVec3 &v) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> PxMeshScale::transform </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>v</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="63902c04c9a3f326b5f969fa931e53fd"></a><!-- doxytag: member="PxMeshScale::rotation" ref="63902c04c9a3f326b5f969fa931e53fd" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxQuat.html">PxQuat</a> <a class="el" href="classPxMeshScale.html#63902c04c9a3f326b5f969fa931e53fd">PxMeshScale::rotation</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The orientation of the scaling axes. +<p> + +<p>Referenced by <a class="el" href="PxTriangleMeshGeometry_8h-source.html#l00131">PxTriangleMeshGeometry::isValid()</a>, <a class="el" href="PxConvexMeshGeometry_8h-source.html#l00131">PxConvexMeshGeometry::isValid()</a>, and <a class="el" href="PxMassProperties_8h-source.html#l00083">PxMassProperties::PxMassProperties()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="12f2dbcf5214c4c5956dab0e75831449"></a><!-- doxytag: member="PxMeshScale::scale" ref="12f2dbcf5214c4c5956dab0e75831449" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> <a class="el" href="classPxMeshScale.html#12f2dbcf5214c4c5956dab0e75831449">PxMeshScale::scale</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +A nonuniform scaling. +<p> + +<p>Referenced by <a class="el" href="PxTriangleMeshGeometry_8h-source.html#l00131">PxTriangleMeshGeometry::isValid()</a>, <a class="el" href="PxConvexMeshGeometry_8h-source.html#l00131">PxConvexMeshGeometry::isValid()</a>, and <a class="el" href="PxMassProperties_8h-source.html#l00083">PxMassProperties::PxMassProperties()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxMeshScale_8h-source.html">PxMeshScale.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 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> |