diff options
| author | Bryan Galdrikian <[email protected]> | 2017-02-21 12:07:59 -0800 |
|---|---|---|
| committer | Bryan Galdrikian <[email protected]> | 2017-02-21 12:07:59 -0800 |
| commit | 446ce137c6823ba9eff273bdafdaf266287c7c98 (patch) | |
| tree | d20aab3e2ed08d7b3ca71c2f40db6a93ea00c459 /NvBlast/docs/api_docs/files/pageextphysx.html | |
| download | blast-1.0.0-beta.tar.xz blast-1.0.0-beta.zip | |
first commitv1.0.0-beta
Diffstat (limited to 'NvBlast/docs/api_docs/files/pageextphysx.html')
| -rw-r--r-- | NvBlast/docs/api_docs/files/pageextphysx.html | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/NvBlast/docs/api_docs/files/pageextphysx.html b/NvBlast/docs/api_docs/files/pageextphysx.html new file mode 100644 index 0000000..0d0c366 --- /dev/null +++ b/NvBlast/docs/api_docs/files/pageextphysx.html @@ -0,0 +1,175 @@ +<html> + <head> + <title>NVIDIA(R) Blast(R) SDK 1.0 API Reference: PhysX Extensions</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="blast_logo.png"> + <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">Class List</a> + <a class="qindex" href="functions.html">Class Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1><a class="anchor" name="pageextphysx">PhysX Extensions </a></h1>NvBlastExtPhysX contains extensions for easier use of Blast Toolkit with the PhysX SDK. There are 3 of them:<ul> +<li><b>ExtPxManager</b>: Manager to keep Blast Actors in sync with PhysX actors.</li><li><b>ExtImpactDamageManager</b>: Manager to collect and apply impact damage caused by collision in PhysX Scene.</li><li><b>ExtStressSolver</b>: Stress Solver to propagate stress through support graph and apply it as damage to Blast actors.</li></ul> +<p> +This library also contains an extension for synchronizing Blast state:<ul> +<li><b>ExtSync</b> - Utility for writing Blast state to a buffer, to be read by a client. This may be used for networking, for example.</li></ul> +<p> +<br> + <h2><a class="anchor" name="ExtPxManager"> +ExtPxManager</a></h2> +<b>Physics Manager</b> - is a reference implementation for keeping Blast Actors synced with PhysX actors. It's main job is to listen for TkFamily events and update <em>PxScene</em> (by adding and removing PxActors) accordingly.<p> +In order to use it create ExtPxManager:<p> +<div class="fragment"><pre class="fragment">ExtPxManager* pxManager = ExtPxManager::create(m_physics, m_tkFramework); +</pre></div><p> +For every <em>TkAsset</em> prepare <em>ExtPxAsset</em>. Which contains <em>TkAsset</em> + collection of physics geometry for every chunk. Every chunk can contain any number of subchunks. Where each subchunk is basically PxConvexMeshGeometry with transform. Also every chunk can be marked as static (<em>isStatic</em> flag). If actor contains at least one static chunks in it's support graph it makes an actor kinematic (static), otherwise it's dynamic. Having zero subchunks makes chunk invisible in physics scene, it can be used for example to represent 'earth' as a special invisible static chunk and connect all near earth chunks to it.<p> +To create a <em>ExtPxFamily</em> from an <em>ExtPxAsset:</em> <p> +<div class="fragment"><pre class="fragment">ExtPxFamilyDesc familyDesc; +familyDesc.pxAsset = pxAsset; +familyDesc.group = tkGroup; +familyDesc.actorDesc.initialBondHealths = <span class="keyword">nullptr</span>; +familyDesc.actorDesc.initialSupportChunkHealths = <span class="keyword">nullptr</span>; +familyDesc.actorDesc.uniformInitialBondHealth = BOND_HEALTH_MAX; +familyDesc.actorDesc.uniformInitialLowerSupportChunkHealth = 1.0f; +ExtPxFamily* family = pxManager->createFamily(desc); +</pre></div><p> +You can subscribe to family events in order to sync graphics (or anything else) with physics:<p> +<div class="fragment"><pre class="fragment">family->subscribe(listener); +</pre></div><p> +Listener will be notified with all physics actors added and removed.<p> +And finally spawn the family in some world position (the first actor/actors will be created and event will be fired to the listener):<p> +<div class="fragment"><pre class="fragment">ExtPxSpawnSettings spawnSettings = { + &pxScene, + defaultPxMaterial, + RIGIDBODY_DENSITY +}; + +family->spawn(PxTransform(0, 0, 0), spawnSettings); +</pre></div><p> +You can get families actor's either from listening to events or by calling getActors(). Every <em>ExtPxActor</em> matches 1 <-> 1 with TkActor (which matches <em><a class="el" href="struct_nv_blast_actor.html">NvBlastActor</a></em> accordingly).<p> +<div class="fragment"><pre class="fragment">ExtPxActor* actor = ....; +physx::PxRigidDynamic rigidDynamic = actor->getPxActor(); <span class="comment">// </span> +</pre></div><p> +ExtPxActor remains internally unchanged through it's life time. Use <em>ExtPxActor</em> <em>getChunkIndices()</em> and <em>getPxActor()</em> to update graphics representation. Sample code:<p> +<div class="fragment"><pre class="fragment"> <span class="keyword">const</span> uint32_t* chunkIndices; + <span class="keywordtype">size_t</span> chunkIndexCount; + actor.getChunkIndices(chunkIndices, chunkIndexCount); + <span class="keywordflow">for</span> (uint32_t i = 0; i < chunkIndexCount; i++) + { + uint32_t chunkIndex = chunkIndices[i]; + <span class="keywordflow">for</span> (Renderable* r : m_chunks[chunkIndex].renderables) + { + r->setTransform(actor.getPxActor()->getGlobalPose() * pxAsset.chunks[chunkIndex].convexes[0].transform); + } + } +</pre></div><p> +In order to use joints set joint create function with <em>ExtPxManager::setCreateJointFunction</em>(...). It will be called when new TkJoint's are being created. All the joint updates and remove will be handled by manager internally.<p> +<br> + <h2><a class="anchor" name="ExtImpactDamageManager"> +ExtImpactDamageManager</a></h2> +<b>Impact Damage Manager</b> - is a reference implementation for fast and easy impact damage support. It's built on top of ExtPxManager.<p> +In order to use it create it:<p> +<div class="fragment"><pre class="fragment">ExtImpactDamageManager* impactManager = ExtImpactDamageManager::create(pxManager); +</pre></div><p> +Call it's onContact method on every <em>PxSimulationEventCallback</em> <em>onContact()</em> <p> +<div class="fragment"><pre class="fragment"> <span class="keyword">class </span>EventCallback : <span class="keyword">public</span> PxSimulationEventCallback + { + <span class="keyword">public</span>: + EventCallback(ExtImpactDamageManager* manager) : m_manager(manager) {} + + <span class="keyword">virtual</span> <span class="keywordtype">void</span> onContact(<span class="keyword">const</span> PxContactPairHeader& pairHeader, <span class="keyword">const</span> PxContactPair* pairs, uint32_t nbPairs) + { + m_manager->onContact(pairHeader, pairs, nbPairs); + } + + <span class="keyword">private</span>: + ExtImpactDamageManager* m_manager; + }; +</pre></div><p> +Call <em>applyDamage()</em> when you want the buffered damage to be applied:<p> +<div class="fragment"><pre class="fragment">impactManager->applyDamage(); +</pre></div><p> +Also important to enable contact notification with custom filter shader for PxScene. <em>ImpactDamageManager</em> has a reference filter shader implementation which can be used for that:<p> +<div class="fragment"><pre class="fragment">PxSceneDesc sceneDesc; +sceneDesc.filterShader = ExtImpactDamageManager::FilterShader; +</pre></div><p> +<br> + <h2><a class="anchor" name="ExtStressSolver"> +ExtStressSolver</a></h2> +<b>Stress Solver</b> - is a reference implementation of stress propagation using Blast support graph.<h3><a class="anchor" name="Features"> +Features</a></h3> +<ul> +<li>Supports both static and dynamic actors</li><li>Propagates both linear and angular momentum</li><li>Graph complexity selection (reduces support graph to smaller size trade off speed and quality)</li><li>Apply stress damage on Blast Actor</li><li>Debug Render</li></ul> +<h3><a class="anchor" name="Usage"> +Usage</a></h3> +In order to use it instance stress solver by providing <em>ExtPxFamily:</em> <p> +<div class="fragment"><pre class="fragment">ExtStressSolver* stressSolver = ExtStressSolver::create(family); +</pre></div><p> +And then call update() every frame:<p> +<div class="fragment"><pre class="fragment"><span class="keywordtype">bool</span> doDamage = <span class="keyword">true</span>; <span class="comment">// if you want to actually apply stress and damage actors</span> +stressSolver->update(doDamage); +</pre></div><p> +By default it will apply scene gravity on static actors and centrifugal force on dynamic actors. Also applyImpulse(...) can be called for additional stress to apply:<p> +<div class="fragment"><pre class="fragment">stressSolver->applyImpulse(actor, position, force); +</pre></div><p> +It fully utilizes the fact that it knows initial support graph structure and does maximum of processing in <em>create</em>(...) method calls. After that all actors split calls are synced internally quite fast and only the actual stress propagation takes most of computational time. Computational time is linearly proprtional to <em>bondIterationsPerFrame</em> setting. To fine tune look for balance between <em>bondIterationsPerFrame</em> and <em>graphReductionLevel</em> . The more bond iterations are set the more precise computation will be. The smaller graph allows to make higher fidelity computations witihing the same bond iterations per frame (same time spent), but actual cracks (damaged bonds) will be more sparsed as the result.<p> +<br> + <h2><a class="anchor" name="ExtSync"> +ExtSync</a></h2> +<b>Synchronization Extension (NvBlastExtSync)</b> - is a reference implementation for synchronizing Blast state.<p> +The idea is that you can use it to write synchronization events to the buffer (on server for example) and then apply this buffer on a client. TkFamily ID should be properly set for that.<p> +3 types of events are supported:<p> +<ul> +<li><b>ExtSyncEventType::Fracture</b>: Fracture event. Contains fracture commands information on particular TkFamily. Applied incrementally. Relatively small.</li><li><b>ExtSyncEventType::FamilySync</b>: Family sync event. Contains all necessary information to fully sync TkFamily state.</li><li><b>ExtSyncEventType::Physics</b>: Physics sync event. Contains all necessary information to fully sync ExtPxFamily state.</li></ul> +<p> +In order to use it create ExtSync:<p> +<div class="fragment"><pre class="fragment">ExtSync* sync = ExtSync::create(); +</pre></div><p> +Then let ExtSync insatnce listen to family fracture commands and write them to internal buffer:<p> +<div class="fragment"><pre class="fragment">TkFamily* family = ...; +family->addListener(*sync); + +<span class="comment">// fracture family</span> +<span class="comment">// ....</span> +</pre></div><p> +You can fully record TkFamily state or ExtPxFamily state at any moment by calling:<p> +<div class="fragment"><pre class="fragment">sync->syncFamily(tkFamily); +<span class="comment">// or</span> +sync->syncFamily(pxFamily); +</pre></div><p> +Now you can take sync buffer:<p> +<div class="fragment"><pre class="fragment"><span class="keyword">const</span> ExtSyncEvent*<span class="keyword">const</span>* buffer; +uint32_t size; +sync->acquireSyncBuffer(buffer, size); + +m_savedBuffer.resize(size); +<span class="keywordflow">for</span> (uint32_t i = 0; i < size; ++i) +{ + m_savedBuffer[i] = buffer[i]->clone(); +} + +sync->releaseSyncBuffer(); +</pre></div><p> +On the client you can then apply this buffer:<p> +<div class="fragment"><pre class="fragment">sync->applySyncBuffer(tkFramework, m_savedBuffer.data(), m_savedBuffer.size(), group, pxManager); +</pre></div><p> +ExtPxManager is required only if sync buffer contains ExtSyncEventType::Physics events.<p> +<br> + </div> +<!-- start footer part --> +<div class="footer"> +Copyright © 2015-2017 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> +</div> +</body> +</html> |