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/classPxMaterial.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/classPxMaterial.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxMaterial.html | 685 |
1 files changed, 685 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxMaterial.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxMaterial.html new file mode 100644 index 00000000..bd33b88a --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxMaterial.html @@ -0,0 +1,685 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxMaterial 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>PxMaterial Class Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxMaterial" --><!-- doxytag: inherits="PxBase" -->Material class to represent a set of surface properties. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxMaterial_8h-source.html">PxMaterial.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxMaterial:</div> +<div class="dynsection"> +<p><center><img src="classPxMaterial__inherit__graph.png" border="0" usemap="#PxMaterial__inherit__map" alt="Inheritance graph"></center> +<map name="PxMaterial__inherit__map"> +<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="15,16,71,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxMaterial:</div> +<div class="dynsection"> +<p><center><img src="classPxMaterial__coll__graph.png" border="0" usemap="#PxMaterial__coll__map" alt="Collaboration graph"></center> +<map name="PxMaterial__coll__map"> +<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,106,153,128"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="7,16,244,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxMaterial-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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#c0635989d3c9a12d55d25fe468e91256">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrements the reference count of a material and releases it if the new reference count is zero. <a href="#c0635989d3c9a12d55d25fe468e91256"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#459b91a5b16327891dc7b9364c854888">getReferenceCount</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the reference count of the material. <a href="#459b91a5b16327891dc7b9364c854888"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#2d19a3388f5c3f023540661baa587de5">acquireReference</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquires a counted reference to a material. <a href="#2d19a3388f5c3f023540661baa587de5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#971a4c6a385310c28aaeaa1f5ead78e9">setDynamicFriction</a> (PxReal coef)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the coefficient of dynamic friction. <a href="#971a4c6a385310c28aaeaa1f5ead78e9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#fc25f357ba1de24c8b98b22f94153d3d">getDynamicFriction</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the DynamicFriction value. <a href="#fc25f357ba1de24c8b98b22f94153d3d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#0384706084d22fe2ec745bc81d54ef14">setStaticFriction</a> (PxReal coef)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the coefficient of static friction. <a href="#0384706084d22fe2ec745bc81d54ef14"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#b80c2e686ea428c58dbd020e067eaa70">getStaticFriction</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the coefficient of static friction. <a href="#b80c2e686ea428c58dbd020e067eaa70"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#9038f690c180b962a7543734f44ec0f1">setRestitution</a> (PxReal rest)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the coefficient of restitution. <a href="#9038f690c180b962a7543734f44ec0f1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#06db9f154df542598da209a31fdc123f">getRestitution</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the coefficient of restitution. <a href="#06db9f154df542598da209a31fdc123f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#3dbcd175e805766442291c1285eafe8c">setFlag</a> (<a class="el" href="structPxMaterialFlag.html#0cbfebf648d620e4619a5a81b49cc298">PxMaterialFlag::Enum</a> flag, bool)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Raises or clears a particular material flag. <a href="#3dbcd175e805766442291c1285eafe8c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#452856bae712ad60a281ec45a4bd69a9">setFlags</a> (<a class="el" href="classPxFlags.html">PxMaterialFlags</a> inFlags)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">sets all the material flags. <a href="#452856bae712ad60a281ec45a4bd69a9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxMaterialFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#f8fca7a3079e8da26c8275a9fe3ce635">getFlags</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the flags. See <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a>. <a href="#f8fca7a3079e8da26c8275a9fe3ce635"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#15c32fcd28a63a02caad0247dd2e9835">setFrictionCombineMode</a> (<a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> combMode)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the friction combine mode. <a href="#15c32fcd28a63a02caad0247dd2e9835"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#0d97b1335e367b8f27f32f6c3766f5a8">getFrictionCombineMode</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the friction combine mode. <a href="#0d97b1335e367b8f27f32f6c3766f5a8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#8f9930b0e18a932e428a061891e4683f">setRestitutionCombineMode</a> (<a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> combMode)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the restitution combine mode. <a href="#8f9930b0e18a932e428a061891e4683f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#a4f567c979252e84dc88cbd626dc8812">getRestitutionCombineMode</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the restitution combine mode. <a href="#a4f567c979252e84dc88cbd626dc8812"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#1a6bbe6443abf57f9b81104cae070e4c">getConcreteTypeName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#1a6bbe6443abf57f9b81104cae070e4c"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#462f7d7aa49aec69871bbf066632a5d4">userData</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">user can assign this to whatever, usually to create a 1:1 relationship with a user object. <a href="#462f7d7aa49aec69871bbf066632a5d4"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#9f402b870b0729455ba8199b46a0fccd">PxMaterial</a> (<a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#f307774d0f072ac743621419a5d7c1a7">PxMaterial</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#f304d5eda8ffb0d1afeada9a98186c0a">~PxMaterial</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#51a36ceb87a3713a997e498b012e9ebd">isKindOf</a> (const char *name) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#51a36ceb87a3713a997e498b012e9ebd"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Material class to represent a set of surface properties. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#35c1965ae47b24e119c6a2d8ce25477e" title="Creates a new material with default properties.">PxPhysics.createMaterial</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="9f402b870b0729455ba8199b46a0fccd"></a><!-- doxytag: member="PxMaterial::PxMaterial" ref="9f402b870b0729455ba8199b46a0fccd" args="(PxType concreteType, PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxMaterial::PxMaterial </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> </td> + <td class="paramname"> <em>concreteType</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td> + <td class="paramname"> <em>baseFlags</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="f307774d0f072ac743621419a5d7c1a7"></a><!-- doxytag: member="PxMaterial::PxMaterial" ref="f307774d0f072ac743621419a5d7c1a7" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxMaterial::PxMaterial </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td> + <td class="paramname"> <em>baseFlags</em> </td> + <td> ) </td> + <td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="f304d5eda8ffb0d1afeada9a98186c0a"></a><!-- doxytag: member="PxMaterial::~PxMaterial" ref="f304d5eda8ffb0d1afeada9a98186c0a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxMaterial::~PxMaterial </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="2d19a3388f5c3f023540661baa587de5"></a><!-- doxytag: member="PxMaterial::acquireReference" ref="2d19a3388f5c3f023540661baa587de5" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxMaterial::acquireReference </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Acquires a counted reference to a material. +<p> +This method increases the reference count of the material by 1. Decrement the reference count by calling <a class="el" href="classPxMaterial.html#c0635989d3c9a12d55d25fe468e91256" title="Decrements the reference count of a material and releases it if the new reference...">release()</a> +</div> +</div><p> +<a class="anchor" name="1a6bbe6443abf57f9b81104cae070e4c"></a><!-- doxytag: member="PxMaterial::getConcreteTypeName" ref="1a6bbe6443abf57f9b81104cae070e4c" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const char* PxMaterial::getConcreteTypeName </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns string name of dynamic type. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Class name of most derived type of this object. </dd></dl> + +<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="fc25f357ba1de24c8b98b22f94153d3d"></a><!-- doxytag: member="PxMaterial::getDynamicFriction" ref="fc25f357ba1de24c8b98b22f94153d3d" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxMaterial::getDynamicFriction </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the DynamicFriction value. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The coefficient of dynamic friction.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#971a4c6a385310c28aaeaa1f5ead78e9" title="Sets the coefficient of dynamic friction.">setDynamicFriction</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f8fca7a3079e8da26c8275a9fe3ce635"></a><!-- doxytag: member="PxMaterial::getFlags" ref="f8fca7a3079e8da26c8275a9fe3ce635" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFlags.html">PxMaterialFlags</a> PxMaterial::getFlags </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the flags. See <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a>. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The material flags.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a> <a class="el" href="classPxMaterial.html#452856bae712ad60a281ec45a4bd69a9" title="sets all the material flags.">setFlags()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0d97b1335e367b8f27f32f6c3766f5a8"></a><!-- doxytag: member="PxMaterial::getFrictionCombineMode" ref="0d97b1335e367b8f27f32f6c3766f5a8" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> PxMaterial::getFrictionCombineMode </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the friction combine mode. +<p> +See <a class="el" href="classPxMaterial.html#15c32fcd28a63a02caad0247dd2e9835" title="Sets the friction combine mode.">setFrictionCombineMode</a>.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The friction combine mode for this material.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> <a class="el" href="classPxMaterial.html#15c32fcd28a63a02caad0247dd2e9835" title="Sets the friction combine mode.">setFrictionCombineMode()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="459b91a5b16327891dc7b9364c854888"></a><!-- doxytag: member="PxMaterial::getReferenceCount" ref="459b91a5b16327891dc7b9364c854888" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxMaterial::getReferenceCount </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the reference count of the material. +<p> +At creation, the reference count of the material is 1. Every shape referencing this material increments the count by 1. When the reference count reaches 0, and only then, the material gets destroyed automatically.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the current reference count. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="06db9f154df542598da209a31fdc123f"></a><!-- doxytag: member="PxMaterial::getRestitution" ref="06db9f154df542598da209a31fdc123f" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxMaterial::getRestitution </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the coefficient of restitution. +<p> +See <a class="el" href="classPxMaterial.html#9038f690c180b962a7543734f44ec0f1" title="Sets the coefficient of restitution.">setRestitution</a>.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The coefficient of restitution.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#9038f690c180b962a7543734f44ec0f1" title="Sets the coefficient of restitution.">setRestitution()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a4f567c979252e84dc88cbd626dc8812"></a><!-- doxytag: member="PxMaterial::getRestitutionCombineMode" ref="a4f567c979252e84dc88cbd626dc8812" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> PxMaterial::getRestitutionCombineMode </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the restitution combine mode. +<p> +See <a class="el" href="classPxMaterial.html#8f9930b0e18a932e428a061891e4683f" title="Sets the restitution combine mode.">setRestitutionCombineMode</a>.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The coefficient of restitution combine mode for this material.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> <a class="el" href="classPxMaterial.html#8f9930b0e18a932e428a061891e4683f" title="Sets the restitution combine mode.">setRestitutionCombineMode</a> <a class="el" href="classPxMaterial.html#06db9f154df542598da209a31fdc123f" title="Retrieves the coefficient of restitution.">getRestitution()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b80c2e686ea428c58dbd020e067eaa70"></a><!-- doxytag: member="PxMaterial::getStaticFriction" ref="b80c2e686ea428c58dbd020e067eaa70" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxMaterial::getStaticFriction </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the coefficient of static friction. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The coefficient of static friction.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#0384706084d22fe2ec745bc81d54ef14" title="Sets the coefficient of static friction.">setStaticFriction</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="51a36ceb87a3713a997e498b012e9ebd"></a><!-- doxytag: member="PxMaterial::isKindOf" ref="51a36ceb87a3713a997e498b012e9ebd" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxMaterial::isKindOf </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>superClass</em> </td> + <td> ) </td> + <td> const<code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns whether a given type name matches with the type of this instance. +<p> + +<p>Reimplemented from <a class="el" href="classPxBase.html#ae9d444c7cfd1715a101350a1b1226ef">PxBase</a>.</p> + +<p>References <a class="el" href="PxBase_8h-source.html#l00178">PxBase::isKindOf()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c0635989d3c9a12d55d25fe468e91256"></a><!-- doxytag: member="PxMaterial::release" ref="c0635989d3c9a12d55d25fe468e91256" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxMaterial::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Decrements the reference count of a material and releases it if the new reference count is zero. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#35c1965ae47b24e119c6a2d8ce25477e" title="Creates a new material with default properties.">PxPhysics.createMaterial()</a> </dd></dl> + +<p>Implements <a class="el" href="classPxBase.html#fe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p> + +</div> +</div><p> +<a class="anchor" name="971a4c6a385310c28aaeaa1f5ead78e9"></a><!-- doxytag: member="PxMaterial::setDynamicFriction" ref="971a4c6a385310c28aaeaa1f5ead78e9" args="(PxReal coef)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxMaterial::setDynamicFriction </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>coef</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the coefficient of dynamic friction. +<p> +The coefficient of dynamic friction should be in [0, PX_MAX_F32). If set to greater than staticFriction, the effective value of staticFriction will be increased to match.<p> +<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>coef</em> </td><td>Coefficient of dynamic friction. <b>Range:</b> [0, PX_MAX_F32)</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#fc25f357ba1de24c8b98b22f94153d3d" title="Retrieves the DynamicFriction value.">getDynamicFriction()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3dbcd175e805766442291c1285eafe8c"></a><!-- doxytag: member="PxMaterial::setFlag" ref="3dbcd175e805766442291c1285eafe8c" args="(PxMaterialFlag::Enum flag, bool)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxMaterial::setFlag </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxMaterialFlag.html#0cbfebf648d620e4619a5a81b49cc298">PxMaterialFlag::Enum</a> </td> + <td class="paramname"> <em>flag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Raises or clears a particular material flag. +<p> +See the list of flags <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a><p> +<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>flag</em> </td><td>The <a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> flag to raise(set) or clear.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#f8fca7a3079e8da26c8275a9fe3ce635" title="Retrieves the flags. See PxMaterialFlag.">getFlags()</a> <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="452856bae712ad60a281ec45a4bd69a9"></a><!-- doxytag: member="PxMaterial::setFlags" ref="452856bae712ad60a281ec45a4bd69a9" args="(PxMaterialFlags inFlags)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxMaterial::setFlags </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxMaterialFlags</a> </td> + <td class="paramname"> <em>inFlags</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +sets all the material flags. +<p> +See the list of flags <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a><p> +<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected. +</div> +</div><p> +<a class="anchor" name="15c32fcd28a63a02caad0247dd2e9835"></a><!-- doxytag: member="PxMaterial::setFrictionCombineMode" ref="15c32fcd28a63a02caad0247dd2e9835" args="(PxCombineMode::Enum combMode)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxMaterial::setFrictionCombineMode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> </td> + <td class="paramname"> <em>combMode</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the friction combine mode. +<p> +See the enum <a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> .<p> +<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>combMode</em> </td><td>Friction combine mode to set for this material. See <a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a>.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> <a class="el" href="classPxMaterial.html#0d97b1335e367b8f27f32f6c3766f5a8" title="Retrieves the friction combine mode.">getFrictionCombineMode</a> <a class="el" href="classPxMaterial.html#0384706084d22fe2ec745bc81d54ef14" title="Sets the coefficient of static friction.">setStaticFriction()</a> <a class="el" href="classPxMaterial.html#971a4c6a385310c28aaeaa1f5ead78e9" title="Sets the coefficient of dynamic friction.">setDynamicFriction()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9038f690c180b962a7543734f44ec0f1"></a><!-- doxytag: member="PxMaterial::setRestitution" ref="9038f690c180b962a7543734f44ec0f1" args="(PxReal rest)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxMaterial::setRestitution </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>rest</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the coefficient of restitution. +<p> +A coefficient of 0 makes the object bounce as little as possible, higher values up to 1.0 result in more bounce.<p> +<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rest</em> </td><td>Coefficient of restitution. <b>Range:</b> [0,1]</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#06db9f154df542598da209a31fdc123f" title="Retrieves the coefficient of restitution.">getRestitution()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8f9930b0e18a932e428a061891e4683f"></a><!-- doxytag: member="PxMaterial::setRestitutionCombineMode" ref="8f9930b0e18a932e428a061891e4683f" args="(PxCombineMode::Enum combMode)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxMaterial::setRestitutionCombineMode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> </td> + <td class="paramname"> <em>combMode</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the restitution combine mode. +<p> +See the enum <a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> .<p> +<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>combMode</em> </td><td>Restitution combine mode for this material. See <a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a>.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> <a class="el" href="classPxMaterial.html#a4f567c979252e84dc88cbd626dc8812" title="Retrieves the restitution combine mode.">getRestitutionCombineMode()</a> <a class="el" href="classPxMaterial.html#9038f690c180b962a7543734f44ec0f1" title="Sets the coefficient of restitution.">setRestitution()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0384706084d22fe2ec745bc81d54ef14"></a><!-- doxytag: member="PxMaterial::setStaticFriction" ref="0384706084d22fe2ec745bc81d54ef14" args="(PxReal coef)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxMaterial::setStaticFriction </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>coef</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the coefficient of static friction. +<p> +The coefficient of static friction should be in the range [0, PX_MAX_F32)<p> +<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>coef</em> </td><td>Coefficient of static friction. <b>Range:</b> [0, PX_MAX_F32)</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#b80c2e686ea428c58dbd020e067eaa70" title="Retrieves the coefficient of static friction.">getStaticFriction()</a> </dd></dl> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="462f7d7aa49aec69871bbf066632a5d4"></a><!-- doxytag: member="PxMaterial::userData" ref="462f7d7aa49aec69871bbf066632a5d4" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* <a class="el" href="classPxMaterial.html#462f7d7aa49aec69871bbf066632a5d4">PxMaterial::userData</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +user can assign this to whatever, usually to create a 1:1 relationship with a user object. +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxMaterial_8h-source.html">PxMaterial.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> |