PhysX SDK 3.2 API Reference: Class List

PhysX SDK 3.2 API

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
physx::PxDefaultFileInputDataDefault implementation of a file read stream
physx::PxDefaultFileOutputStreamDefault implementation of a file write stream
physx::PxDefaultMemoryInputDataDefault implementation of a memory read stream
physx::PxDefaultMemoryOutputStreamDefault implementation of a memory write stream
Px1DConstraintA constraint
Px1DConstraintFlagConstraint row flags
PxActiveTransformData struct for use with Active Transform Notification. Used with PxScene::getActiveTransforms()
PxActorPxActor is the base class for the main simulation objects in the physics SDK
PxActorClientBehaviorBitMulticlient behavior bit flags for actors
PxActorFlagFlags which control the behavior of an actor
PxActorTypeIdentifies each type of actor
PxActorTypeSelectionFlagIdentifies each type of actor for retrieving actors from a scene
PxAggregateClass to aggregate actors into a single broad phase entry
PxAllocationListenerAbstract listener class that listens to allocation and deallocation events from the foundation memory system
PxAllocatorCallbackAbstract base class for an application defined memory allocator that can be used by the Px library
PxArticulationTree structure of bodies connected by joints that is treated as a unit by the dynamics solver
PxArticulationJointJoint between two links in an articulation
PxArticulationLinkComponent of an articulation that represents a rigid body
PxBatchQueryBatched queries object. This is used to perform several queries at the same time
PxBatchQueryDescDescriptor class for PxBatchQuery
PxBatchQueryStatus
PxBinaryConverterBinary converter for serialized streams
PxBitAndDataT< storageType, bitMask >
PxBoundedData
PxBounds3Class representing 3D range or axis aligned bounding box
PxBoxControllerBox character controller
PxBoxControllerDescDescriptor for a box character controller
PxBoxGeometryClass representing the geometry of a box
PxBoxObstacleA box obstacle
PxBroadcastingAllocatorAbstract base class for an application defined memory allocator that allows an external listener to audit the memory allocations
PxCapsuleClimbingMode
PxCapsuleControllerA capsule character controller
PxCapsuleControllerDescA descriptor for a capsule character controller
PxCapsuleGeometryClass representing the geometry of a capsule
PxCapsuleObstacleA capsule obstacle
PxCCTHitDescribes a generic CCT hit
PxCCTInteractionModeHow a CCT interacts with other CCTs
PxCCTNonWalkableModeHow a CCT interacts with non-walkable parts
PxClientBehaviorBitMulticlient behavior bit flags for clients
PxClothSet of connected particles tailored towards simulating character cloth. A cloth object consists of the following components:
PxClothCollisionDataCollision data used for cloth-sphere and cloth-capsule collision
PxClothCollisionPlanePlane representation used for cloth-convex collision
PxClothCollisionSphereSphere representation used for cloth-capsule collision
PxClothFabricA cloth fabric is a structure that contains all the internal solver constraints of a clothing mesh
PxClothFabricPhaseTypeDescribe type of phase in cloth fabric
PxClothFlagFlag for behaviors of the cloth solver
PxClothMeshDescDescriptor class for a cloth mesh
PxClothMeshEdgeFlagFlags which describe how cooking should treat a cloth mesh edge
PxClothMeshVertFlagFlags which describe how cooking should treat a cloth mesh vertex
PxClothParticlePer particle data for cloth
PxClothParticleMotionConstraintConstraints for cloth particle motion
PxClothParticleSeparationConstraintSeparation constraints for cloth particle movement
PxClothPhaseSolverConfigSolver configuration parameters for a cloth fabric phase type
PxCollectionCollection class for serialization
PxCombineModeEnumeration that determines the way in which two material properties will be combined to yield a friction or restitution coefficient for a collision
PxConcreteTypeEnumeration of concrete classes inheriting from PxSerializable
PxConstraintPlugin class for implementing constraints
PxConstraintConnectorThis class connects a custom constraint to the SDK
PxConstraintDominanceExpresses the dominance relationship of a constraint. For the time being only three settings are permitted:
PxConstraintExtIDsUnique identifiers for extensions classes which implement a constraint based on PxConstraint
PxConstraintFlagConstraint flags
PxConstraintInfoDescriptor for a broken constraint
PxConstraintShaderTableTable of function pointers for a constraint
PxConstraintVisualizationFlagFlags for determining which components of the constraint should be visualized
PxConstraintVisualizer
PxContactModifyCallbackAn interface class that the user can implement in order to modify contact constraints
PxContactModifyPairAn array of instances of this class is passed to PxContactModifyCallback::onContactModify()
PxContactPairContact report pair information
PxContactPairFlagCollection of flags providing information on contact report pairs
PxContactPairHeaderAn Instance of this class is passed to PxSimulationEventCallback.onContact()
PxContactPairHeaderFlagCollection of flags providing information on contact report pairs
PxContactPairPointA contact point as used by contact notification
PxContactPointA contact point as used by contact modification
PxContactPointAuxPer-ontact point solver inputs as used by contact modification
PxContactSetAn array of contact points, as passed to contact modification
PxControllerBase class for character controllers
PxControllerBehaviorCallbackUser behavior callback
PxControllerBehaviorFlagController behavior
PxControllerDebugRenderFlagsDebug-rendering flags
PxControllerDescDescriptor class for a character controller
PxControllerFiltersFiltering data for "move" call
PxControllerFlagWhich sides a character is colliding with
PxControllerManagerManages an array of character controllers
PxControllerObstacleHitDescribes a hit between a CCT and a user-defined obstacle. Passed to onObstacleHit()
PxControllerShapeHitDescribes a hit between a CCT and a shape. Passed to onShapeHit()
PxControllerShapeTypeThe type of controller, eg box, sphere or capsule
PxControllersHitDescribes a hit between a CCT and another CCT. Passed to onControllerHit()
PxControllerStateDescribes a controller's internal state
PxControllerStatsDescribes a controller's internal statistics
PxConverterReportMode
PxConvexFlagFlags which describe the format and behavior of a convex mesh
PxConvexMeshA convex mesh
PxConvexMeshDescDescriptor class for PxConvexMesh
PxConvexMeshGeometryConvex mesh geometry class
PxCooking
PxCookingParamsStructure describing parameters affecting mesh cooking
PxCookingValue
PxD6AxisUsed to specify one of the degrees of freedom of a D6 joint
PxD6DriveUsed to specify which axes of a D6 joint are driven
PxD6JointA D6 joint is a general constraint between two actors
PxD6JointDriveParameters for configuring the drive model of a PxD6Joint
PxD6JointDriveFlagFlags for configuring the drive model of a PxD6Joint
PxD6MotionUsed to specify the range of motions allowed for a degree of freedom in a D6 joint
PxDataAccessFlag
PxDebugColorDefault color values used for debug rendering
PxDebugLineUsed to store a single line and colour for debug rendering
PxDebugPointUsed to store a single point and colour for debug rendering
PxDebugTextUsed to store a text for debug rendering. Doesn't own 'string' array
PxDebugTriangleUsed to store a single triangle and colour for debug rendering
PxDefaultAllocatorDefault implementation of the allocator interface required by the SDK
PxDefaultCpuDispatcherA default implementation for a CPU task dispatcher
PxDefaultErrorCallbackDefault implementation of the error callback
PxDistanceJoint
PxDistanceJointFlagFlags for configuring the drive of a PxDistanceJoint
PxErrorCallbackUser defined interface class. Used by the library to emit debug information
PxErrorCodeError codes
PxExtendedVec3
PxField
PxFieldDescriptorA field descriptor
PxFilterDataPxFilterData is user-definable data which gets passed into the collision filtering shader and/or callback
PxFilterFlagCollection of flags describing the filter actions to take for a collision pair
PxFilterObjectFlags
PxFilterObjectTypeIdentifies each type of filter object
PxFilterOpCollision filtering operations
PxFindOverlapTriangleMeshUtil
PxFixedJointA fixed joint permits no relative movement between two bodies. ie the bodies are glued together
PxFixedSizeLookupTable< NUM_ELEMENTS >
PxFlags< enumtype, storagetype >Container for bitfield flag variables associated with a specific enum type
PxForceModeParameter to addForce() and addTorque() calls, determines the exact operation that is carried out
PxFoundationFoundation SDK singleton class
PxGeometryA geometry object
PxGeometryHolderGeometry holder class
PxGeometryQueryCollection of geometry object queries (sweeps, raycasts, overlaps, ...)
PxGeometryTypeA geometry type
PxGroupsMask64-bit mask used for collision filtering
PxHeightFieldA height field class
PxHeightFieldDescDescriptor class for PxHeightField
PxHeightFieldFlagEnum with flag values to be used in PxHeightFieldDesc.flags
PxHeightFieldFormatDescribes the format of height field samples
PxHeightFieldGeometryHeight field geometry class
PxHeightFieldMaterialSpecial material index values for height field samples
PxHeightFieldSampleHeightfield sample format
PxHeightFieldTessFlagDetermines the tessellation of height field cells
PxHullPolygonPolygon data
PxInputDataInput data class for I/O which provides random read access
PxInputStreamInput stream class for I/O
PxJointBase interface providing common functionality for PhysX joints
PxJointActorIndexEnumeration for specifying one or other of the actors referenced by a joint
PxJointLimitDescribes a one-sided limit
PxJointLimitConeDescribes an elliptical conical joint limit. Note that very small or highly elliptical limit cones may result in jitter
PxJointLimitPairDescribes a two-sided limit
PxJointLimitParametersDescribes the parameters for a joint limit
PxJointTypeEnumeration of PhysX' built-in joint types
PxLockedDataParent class for bulk data that is shared between the SDK and the application
PxMat333x3 matrix class
PxMat444x4 matrix class
PxMaterial
PxMaterialFlagFlags which control the behavior of a material
PxMeshFlagEnum with flag values to be used in PxSimpleTriangleMesh::flags
PxMeshGeometryFlagSome flags to control the simulated behavior of the mesh geometry
PxMeshQuery
PxMeshScaleA class expressing a nonuniform scaling transformation
PxNameManager
PxObservableObservable interface for classes which can send out state change notifications
PxObservableTypeIdentifier for the different observable object types
PxObserverObserver interface to get notification on object state changes
PxObstacleBase class for obstacles
PxObstacleContextContext class for obstacles
PxOutputStreamOutput stream class for I/O
PxOverlapQueryResultStruct for the result of a batched overlap query
PxPackValidation
PxPadding< TNumBytes >
PxPairFlagCollection of flags describing the actions to take for a collision pair
PxParticleBaseThe particle base class represents the shared module for particle based simulation. This class can't be instantiated
PxParticleBaseFlagParticleBase flags
PxParticleCreationDataDescriptor-like user-side class describing buffers for particle creation
PxParticleExt
PxParticleExt::PxParticleExt::IndexPoolClass to manage particle indices. Extension particle index management can be useful if no application side particle index allocation functionality is available. An PxParticleExt::IndexPool instance is meant to be used for one PxParticleSystem/PxParticleFluid instance. The instance can be created with PxParticleExt::createIndexPool()
PxParticleExt::PxParticleExt::ParticleBounds
PxParticleFlag
PxParticleFluidThe particle fluid class represents the main module for particle based fluid simulation. SPH (Smoothed Particle Hydrodynamics) is used to animate the particles. This class inherits the properties of the PxParticleBase class and adds particle-particle interactions
PxParticleFluidReadDataData layout descriptor for reading fluid particle data from the SDK
PxParticleReadDataData layout descriptor for reading particle data from the SDK
PxParticleReadDataFlag
PxParticleSystemThe particle system class represents the main module for particle based simulation
PxPhysicsAbstract singleton factory class used for instancing objects in the Physics SDK
PxPlaneRepresentation of a plane
PxPlaneGeometryClass describing a plane geometry
PxPlatform
PxPrismaticJointA prismatic joint permits relative translational movement between two bodies along an axis, but no relative rotational movement
PxPrismaticJointFlagFlags specific to the prismatic joint
PxPruningStructurePruning structure used to accelerate scene queries (raycast, sweep tests, etc)
PxPtrArray< TDataType >
PxPtrManager
PxPvdUpdateType
PxQuatThis is a quaternion class. For more information on quaternion mathematics consult a mathematics source on complex numbers
PxRaycastHitRaycast hit information
PxRaycastQueryResultStruct for the result of a batched raycast query
PxRefResolverClass used to "resolve pointers" during deserialization
PxRenderBufferInterface for points, lines, triangles, and text buffer
PxRevoluteJointA joint which behaves in a similar way to a hinge or axle
PxRevoluteJointFlagFlags specific to the Revolute Joint
PxRigidActorPxRigidActor represents a base class shared between dynamic and static rigid bodies in the physics SDK
PxRigidBodyPxRigidBody is a base class shared between dynamic rigid body objects
PxRigidBodyExtUtility functions for use with PxRigidBody and subclasses
PxRigidDynamicPxRigidDynamic represents a dynamic rigid simulation object in the physics SDK
PxRigidDynamicFlagCollection of flags describing the behavior of a dynamic rigid body
PxRigidStaticPxRigidStatic represents a static rigid body simulation object in the physics SDK
PxSceneA scene is a collection of bodies, particle systems and constraints which can interact
PxSceneDescDescriptor class for scenes. See PxScene
PxSceneFlagFlags for configuring properties of the scene
PxSceneLimitsClass used to retrieve limits(e.g. maximum number of bodies) for a scene. The limits are used as a hint to the size of the scene, not as a hard limit (i.e. it will be possible to create more objects than specified in the scene limits)
PxSceneQueryCacheHit cache for scene queries
PxSceneQueryFilterCallbackScene query filtering callbacks
PxSceneQueryFilterDataScene query filtering data
PxSceneQueryFilterFlagFiltering flags for scene queries
PxSceneQueryFlagScene query specification
PxSceneQueryHitScene query hit information
PxSceneQueryHitTypeClassification of scene query hits
PxSceneQueryImpactHitScene query hit information for queries with impacts
PxSceneQueryReportResultSpecifies the behaviour after a query result
PxSerialFlag
PxSerializableBase class for serializable objects
PxSerialObjectAndRef
PxSerialOrderObjects are written in a fixed order within a serialized file
PxShapeAbstract class for collision shapes
PxShapeExtUtility functions for use with PxShape
PxShapeFlagFlags which affect the behavior of PxShapes
PxSimpleTriangleMeshA structure describing a triangle mesh
PxSimulationEventCallbackAn interface class that the user can implement in order to receive simulation events
PxSimulationFilterCallbackFilter callback to specify handling of collision pairs
PxSimulationStatisticsClass used to retrieve statistics for a simulation step
PxSphereGeometryA class representing the geometry of a sphere
PxSphericalJointA joint which behaves in a similar way to a ball and socket
PxSphericalJointFlagFlags specific to the spherical joint
PxStridedData
PxStrideIterator< T >
PxStrideIterator< T >::PxStrideIterator::StripConst< X >
PxStrideIterator< T >::PxStrideIterator::StripConst< const X >
PxStringTableTable to manage strings. Strings allocated through this object are expected to be owned by this object
PxStringTableExtFactory class for creating PxStringTable with a specific allocator
PxStripConst< T >
PxStripConst< const T >
PxSweepCache
PxSweepHitThis structure captures results for a single sweep query
PxSweepQueryResultStruct for the result of a batched sweep query
pxtask::AllocIdID of the Feature which owns/allocated memory from the heap
pxtask::AllocIdStatsStatistics collected per AllocationId by HeapManager
pxtask::AllocInfoClass to track allocation statistics, see PxgMirrored
pxtask::BaseTaskBase class of all task types
pxtask::CpuDispatcherA CpuDispatcher is responsible for scheduling the execution of tasks passed to it by the SDK
pxtask::CudaBufferFlagsHint flag to tell how the buffer will be used
pxtask::CudaBufferMemorySpaceMemory type managed by a heap
pxtask::CudaBufferTypeBuffer type: made of hint flags and the memory space (Device Memory, Pinned Host Memory, ...)
pxtask::CudaContextManagerManages memory, thread locks, and task scheduling for a CUDA context
pxtask::CudaContextManagerDescDescriptor used to create a CudaContextManager
pxtask::CudaInteropModePossible graphic/CUDA interoperability modes for context
pxtask::CudaMemoryManagerAllocator class for different kinds of CUDA related memory
pxtask::CudaMemoryManagerStatsMemory statistics struct returned by CudaMemMgr::getStats()
pxtask::GpuCopyDescInput descriptor for the GpuDispatcher's built-in copy kernel
pxtask::GpuCopyDescQueueContainer class for queueing GpuCopyDesc instances in pinned (non-pageable) CPU memory
pxtask::GpuDispatcherA GpuTask dispatcher
pxtask::GpuTaskTask implementation for launching CUDA work
pxtask::GpuTaskHintDefine the 'flavor' of a GpuTask
pxtask::LightCpuTaskA BaseTask implementation with immediate execution and simple dependencies
pxtask::NvCudaBufferBuffer which keeps informations about allocated piece of memory
pxtask::ScopedCudaLockConvenience class for holding CUDA lock within a scope
pxtask::SpuDispatcherA SpuDispatcher
pxtask::SpuTaskA task to be executed on one or more SPUs
pxtask::TaskA BaseTask implementation with deferred execution and full dependencies
pxtask::TaskManagerThe TaskManager interface
pxtask::TaskTypeIdentifies the type of each heavyweight Task object
PxTolerancesScaleClass to define the scale at which simulation runs. Most simulation tolerances are calculated in terms of the values here
PxTransformClass representing a rigid euclidean transform as a quaternion and a vector
PxTriangleTriangle class
PxTriangleMeshA triangle mesh, also called a 'polygon soup'
PxTriangleMeshDescDescriptor class for PxTriangleMesh
PxTriangleMeshGeometryTriangle mesh geometry class
PxTriggerPairDescriptor for a trigger pair
PxTriggerPairFlagCollection of flags providing information on trigger report pairs
PxTypedStridedData< TDataType >
PxTypeInfo< T >Structure containing per-type information for types inheriting from PxSerializable
PxUserControllerHitReportUser callback class for character controller events
PxUserReferencesContainer for user-defined names/references
PxVec22 Element vector class
PxVec33 Element vector class
PxVec44 Element vector class
PxVehicleAckermannGeometryData
PxVehicleAutoBoxData
PxVehicleChassisData
PxVehicleClutchData
PxVehicleDifferential4WData
PxVehicleDrivableSurfaceToTireFrictionPairsFriction for each combination of driving surface type and tire type
PxVehicleDrivableSurfaceTypeDriving surface type
PxVehicleDriveA complete vehicle with instance dynamics data and configuration data for wheels and engine,clutch,gears,autobox
PxVehicleDrive4WData structure with instanced dynamics data and configuration data of a vehicle with up to 4 driven wheels
PxVehicleDrive4WRawInputDataUsed to produce smooth vehicle driving control values from analog inputs
PxVehicleDriveDynDataData structure with instanced dynamics data for vehicle with engine, clutch, gears, autobox
PxVehicleDriveSimDataData structure describing non-wheel configuration data of a vehicle that has engine, gears, clutch, and auto-box
PxVehicleDriveSimData4WData structure describing configuration data of a vehicle with up to 4 driven wheels,
PxVehicleDriveTankData structure with instanced dynamics data and configuration data of a tank
PxVehicleDriveTankRawInputDataUsed to produce smooth analog tank control values from analog inputs
PxVehicleEngineData
PxVehicleGearsData
PxVehicleKeySmoothingDataUsed to produce smooth vehicle driving control values from key inputs
PxVehiclePadSmoothingDataUsed to produce smooth analog vehicle control values from analog inputs
PxVehicleSuspensionData
PxVehicleTireData
PxVehicleTireForceCalculatorStructure containing shader data for each tire of a vehicle and a shader function that computes individual tire forces
PxVehicleTireLoadFilterDataTire load can be strongly dependent on the timestep so it is a good idea to filter it to give less jerky handling behavior. The filtered tire load is used as an input to the tire model
PxVehicleWheelData
PxVehicleWheelsData structure with instanced dynamics data and configuration data of a vehicle with just wheels
PxVehicleWheelsDynDataData structure with instanced dynamics data for wheels
PxVehicleWheelsSimDataData structure describing configuration data of a vehicle with up to 20 wheels,
PxVisualDebuggerClass to communicate with the PhysX Visual Debugger
PxVisualDebuggerConnectionFlag
PxVisualDebuggerExt
PxVisualDebuggerFlagsPVD Flags
PxVisualizationParameterDebug visualization parameters


Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com