From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../Documentation/PhysXGuide/Manual/Index.html | 797 +++++++++++++++++++++ 1 file changed, 797 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXGuide/Manual/Index.html (limited to 'PhysX_3.4/Documentation/PhysXGuide/Manual/Index.html') diff --git a/PhysX_3.4/Documentation/PhysXGuide/Manual/Index.html b/PhysX_3.4/Documentation/PhysXGuide/Manual/Index.html new file mode 100644 index 00000000..9d81ed92 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXGuide/Manual/Index.html @@ -0,0 +1,797 @@ + + + + + + + + User's Guide — NVIDIA PhysX SDK 3.4.0 Documentation + + + + + + + + + + + + + + + + +

+

+

+

+ +

+

User's Guide¶

+

../_images/PhysXlogo1.png

+

Built October 24, 2016

+

Contents:

+

+

Welcome to PhysX
- About this User Guide
- Physics vs. PhysX
- World and Objects
+
Snippets
- What are PhysX Snippets?
- HelloWorld: PhysX Basics
- Using PhysX Visual Debugger with SnippetHelloWorld
+
Building with PhysX
- Build Settings
- Build Configurations
- Header Files
- Libraries
- Redistribution
+
The PhysX API
- Introduction
- Memory Management
- Error Reporting
- Math Classes
- Connecting PhysX Objects with User Application Objects
- Type Casting
- Reference Counting
- Using Different Units
- Assertions
- Determinism
+
Startup and Shutdown
- Introduction
- Foundation and Physics
- Cooking
- Extensions
- Optional SDK Components
- Delay-Loading DLLs
  +
- Shutting Down
+
Threading
- Introduction
- Data Access from Multiple Threads
  - Scene Locking
  - Locking Semantics
  - Locking Best Practices
  +
- Asynchronous Simulation
  +
- Multithreaded Simulation
  - TaskManager
  - CpuDispatcher
  - CpuDispatcher Implementation Guidelines
  - BaseTask
  - Task
  - LightCpuTask
  +
+
Geometry
- Introduction
- Geometry Types
  - Spheres
  - Capsules
  - Boxes
  - Planes
  - Convex Meshes
  - Convex Mesh cooking
  - Triangle Meshes
  - Height Fields
  +
- Mesh Scaling
- PxGeometryHolder
- Vertex and Face Data
  - Convex Meshes
  - Triangle Meshes
  - Height Fields
  - Heightfield Modification
  +
+
Rigid Body Overview
- Introduction
- Rigid Body Object Model
- The Simulation Loop
+
Rigid Body Collision
- Introduction
- Shapes
- Simulation Shapes and Scene Query Shapes
- Kinematic Triangle Meshes (Planes, Heighfields)
- Broad-phase Algorithms
- Regions of Interest
- Broad-phase Callback
- Collision Filtering
- Aggregates
- Creating an Aggregate
- Populating an Aggregate
- Releasing an Aggregate
- Amortizing Insertion
- Trigger Shapes
- Interactions
+
Rigid Body Dynamics
- Velocity
- Mass Properties
- Applying Forces and Torques
- Gravity
- Friction and Restitution
- Sleeping
  - Sleep state change events
  +
- Kinematic Actors
- Active Transforms
- Active Actors
- Dominance
- Solver Iterations
- Immediate Mode
- Enhanced Determinism
- Axis locking
+
Simulation
- Callback Sequence
- Simulation memory
  - Scene Limits
  - 16K Data Blocks
  - Scratch Buffer
  - In-place Serialization
  - PVD Integration
  +
- Completion Tasks
- Synchronizing with Other Threads
- Substepping
- Split sim
- Split fetchResults
+
Advanced Collision Detection
- Tuning Shape Collision Behavior
- Contact Modification
- Contact reporting
  - Contact Reports and CCD
  +
- Extracting Contact information
  - Extra Contact Data
  +
- Continuous Collision Detection
  - Contact Notification and Modification
  - Triggers
  - Tuning CCD
  - Performance Implications
  - Limitations
  +
- Raycast CCD
- Speculative CCD
- Persistent Contact Manifold (PCM)
+
Joints
- Joint Basics
  - Visualization
  - Force Reporting
  - Breakage
  - Projection
  - Limits
  - Actuation
  - Mass Scaling
  +
- Fixed Joint
- Spherical Joint
- Revolute Joint
- Prismatic Joint
- Distance Joint
- D6 Joint
  +
- Custom Constraints
  +
+
Articulations
- Creating an Articulation
- Articulation Joints
- Driving an Articulation
- Articulation Projection
- Articulations and Sleeping
+
Scene Origin
- Shifting The Scene Origin
+
GPU Rigid Bodies
- Introduction
- Using GPU Rigid Bodies
- What is GPU accelerated?
- Tuning
- Performance Considerations
+
Geometry Queries
- Introduction
- Raycasts
  +
- Overlaps
- Penetration Depth
- Sweeps
  - Initial Overlaps
  - Precise Sweeps
  - Sweeps against Height Fields
  - Pitfalls
  +
- Additional PxGeometryQuery functions
- PxMeshQuery
  - Mesh Overlaps
  - Sweeps against Triangles
  +
+
Spatial Queries
- PxSpatialIndex
+
Scene Queries
- Introduction
- Basic queries
  - Raycasts
  - Sweeps
  - Overlaps
  +
- Touching and blocking hits
- Query modes
  - Closest hit
  - Any hit
  - Multiple hits
  - Multiple hits with blocking hit
  +
- Filtering
  +
- User defined hit callbacks for unbounded results
- Batched queries
- Volume Caching
  - Filling the Cache
  - Querying the Cache
  +
- Single Object Caching
- PxPruningStructureType
  +
- PxPruningStructure
  - Merge process
  +
+
Vehicles
- Introduction
- Algorithm
- First Code
  +
- Snippets
  +
- Advanced Concepts
  - Vehicle Creation
  - Filtering
  - Tire Friction on Drivable Surfaces
  - Vehicle Controls
  - Vehicle Update
  +
- More Advanced Concepts
  - Vehicle Telemetry
  - Vehicle Update Multi-Threaded
  - Tire Shaders
  - Vehicle Types
  - SI Units
  - Level of Detail
  - Wheel Contact Beyond Raycasts
  +
- Tuning Guide
  +
- Troubleshooting
  +
- References
  - Anti-roll Bar
  - Tire Modeling
  - Engine Torque Curves
  - Differentials
  - Clutch
  - Ackermann Steer Correction
  - Tanks
  - General
  +
+
Character Controllers
- Introduction
- Kinematic Character Controller
- Creating a character controller
- Overlap Recovery Module
- Character Volume
- Volume Update
- Moving a Character Controller
- Graphics Update
- Auto Stepping
- Climbing Mode
- Up Vector
- Walkable Parts & Invisible Walls
- Obstacle Objects
- Hit Callback
- Behavior Callback
- Character Interactions: CCT-vs-dynamic actors
- Character Interactions: CCT-vs-CCT
- Hidden Kinematic Actors
- Time Stepping
- Invalidating Internal Geometry Caches
- Runtime Tessellation
- Troubleshooting
  - Character goes through walls in rare cases
  - Tessellation performance issue
  - The capsule controller manages to climb over obstacles higher than the step offset value
  +
+
Particles (deprecated)
- Introduction
- Creating Particle Systems
- Particle Management
  +
- Parameter Guide
  +
- Collision Handling
  +
- Best Practices / Troubleshooting
  - Particle Grid and Spatial Data Structure Overflow
  +
- GPU/CUDA Acceleration
- Sample Discussion
- References
+
Cloth
- Introduction
- Simulation Algorithm
  +
- Best Practices / Troubleshooting
  - Performance Tips
  - Using GPU Cloth
  - Fast-Moving Characters
  - Avoiding Stretching
  - Avoiding Jitter
  - PVD Support
  +
- Snippet Discussion
  +
- References
+
Debug Visualization
- Introduction
- Usage
+
PhysX Visual Debugger (PVD)
- PVD
- Basic Setup (SDK Side)
  - Network Setup
  - File Setup
  +
- Advanced Setup
  +
+
Simulation Statistics
- Interface
- Usage
+
Serialization
- Introduction
- First Code
- In-depth Discussion
  +
- Common Use Cases
- Snippet Discussion
  - SnippetSerialization
  - SnippetConvert
  - SnippetLoadCollection
  +
- Best practices / Troubleshooting
- PVD
+
Extending Serialization
- Introduction
- Overview
- Binary Serialization of Custom Classes
- RepX Serialization of Custom Classes
  - PhysX API Metadata System
  +
+
Best Practices Guide
- Introduction
- Debugging
  +
- Performance Issues
  +
- Character Controller Systems using Scene Queries and Penetration Depth Computation
- Quantizing HeightField Samples
- Reducing memory usage
  +
- Behavior issues
  +
- GPU Rigid Bodies
- Determinism
+
Migrating From PhysX SDK 2.x to 3.x
- Removed Features
  - Compartments
  - Deformables
  - NxUtilLib
  - Anisotropic Friction
  +
- Basics
  - SDK Header
  - SDK Redistribution
  - API Conventions
  - Callback Classes
  - Memory Management
  - Debug Rendering
  - Error Reporting
  - Type Casting
  - Multithreading
  - Startup and Shutdown
  - Extensions
  - Heightfields
  - Cooking
  - Serialization
  +
- API Design Changes
  - Changed Actor Hierarchy
  - Actor Creation
  +
- Material Indexes
- Continuous Collision Detection
- Pose Description
- Shape Description
  - Skin Width
  +
- Joints
- Time Stepping
  - Simulation Parameters
  +
- Collision Filtering
- Scene Queries
  - Raycasts
  - Overlaps
  - Sweep Tests
  +
+
Migrating From PhysX SDK 3.2 to 3.3
- Math Classes
- Scene Query API
- SPU batch queries
- Core PhysX
- PhysX Extensions
- PhysX Character Controller
- PhysX Vehicles
- CCD
- PhysX Visual Debugger
- PhysX Cloth
- RepX Serialization
- Binary Serialization
- PhysX TaskManager
+
Migrating From PhysX SDK 3.3 to 3.4
- Deprecated APIs
  +
- Core PhysX
- Contact Generation
- PhysX Cooking
- Reference Counting
- PhysX Visual Debugger
- Scene queries
- PxExtensions
+

+

+

+ + +

+

+

+

+

+

Previous topic

+

NVIDIA® PhysX® SDK 3.4.0 Documentation

+

Next topic

+

Welcome to PhysX

+ + +

+

+

+

+ + + + \ No newline at end of file -- cgit v1.2.3