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] --- .../PhysXAPI/files/group__common.html | 611 +++++++++++++++++++++ 1 file changed, 611 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/group__common.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/group__common.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/group__common.html b/PhysX_3.4/Documentation/PhysXAPI/files/group__common.html new file mode 100644 index 00000000..9a3a279c --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/group__common.html @@ -0,0 +1,611 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: Common + + + + + + + +
+

Common

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes

struct  PxBaseFlag
 Flags for PxBase. More...
class  PxBase
 Base class for objects that can be members of a PxCollection. More...
class  PxCollection
 Collection class for serialization. More...
struct  PxStridedData
struct  PxTypedStridedData< TDataType >
struct  PxBoundedData
struct  PxPadding< TNumBytes >
class  PxFixedSizeLookupTable< NB_ELEMENTS >
class  PxPhysicsInsertionCallback
 Callback interface that permits PxCooking to insert a TriangleMesh, HeightfieldMesh or ConvexMesh directly into PxPhysics without the need to store the cooking results into a stream. More...
struct  PxDebugColor
 Default color values used for debug rendering. More...
struct  PxDebugPoint
 Used to store a single point and colour for debug rendering. More...
struct  PxDebugLine
 Used to store a single line and colour for debug rendering. More...
struct  PxDebugTriangle
 Used to store a single triangle and colour for debug rendering. More...
struct  PxDebugText
 Used to store a text for debug rendering. Doesn't own 'string' array. More...
class  PxRenderBuffer
 Interface for points, lines, triangles, and text buffer. More...
class  PxProcessPxBaseCallback
 Callback class used to process PxBase objects. More...
class  PxSerializationContext
 Binary serialization context class. More...
class  PxDeserializationContext
 Binary deserialization context class. More...
class  PxSerializationRegistry
 Class serving as a registry for XML (RepX) and binary serializable types. More...
class  PxTolerancesScale
 Class to define the scale at which simulation runs. Most simulation tolerances are calculated in terms of the values here. More...
struct  PxConcreteType
 an enumeration of concrete classes inheriting from PxBase More...
struct  PxTypeInfo< T >
 a structure containing per-type information for types inheriting from PxBase More...
class  PxInputStream
 Input stream class for I/O. More...
class  PxInputData
 Input data class for I/O which provides random read access. More...
class  PxOutputStream
 Output stream class for I/O. More...

Defines

#define PX_PHYSX_CORE_API
#define PX_PHYSX_COMMON_API
#define PX_SERIAL_ALIGN   16
 Default serialization alignment.
#define PX_SERIAL_FILE_ALIGN   128
 Serialized input data must be aligned to this value.
#define PX_SERIAL_OBJECT_ID_INVALID   0
 PxSerialObjectId value for objects that do not have an ID.
#define PX_SERIAL_REF_KIND_PTR_TYPE_BIT   (1u<<31)
 Bit to mark pointer type references,.
#define PX_SERIAL_REF_KIND_PXBASE   (0 | PX_SERIAL_REF_KIND_PTR_TYPE_BIT)
 Reference kind value for PxBase objects.
#define PX_SERIAL_REF_KIND_MATERIAL_IDX   (1)
 Reference kind value for material indices.
#define PX_MAKE_FOURCC(a, b, c, d)   ( (a) | ((b)<<8) | ((c)<<16) | ((d)<<24) )
 Used to fix multi-byte characters warning from gcc for situations like: PxU32 foo = 'CCTS';.
#define PX_DEFINE_TYPEINFO(_name, _fastType)

Typedefs

typedef PxU16 PxType
typedef PxFlags
+< PxBaseFlag::Enum, PxU16 > 		PxBaseFlags
typedef PxU32 PxTriangleID
typedef PxU16 PxMaterialTableIndex
typedef PxU16 PxType
typedef PxU64 PxSerialObjectId
 ID type for PxBase objects in a PxCollection.
typedef void(* PxBinaryMetaDataCallback )(PxOutputStream &stream)
 Callback type for exporting binary meta data for a serializable type.

Functions

PX_PHYSX_COMMON_API
+physx::PxCollection
+*PX_CALL_CONV 		PxCreateCollection ()
 Creates a collection object.
PX_FOUNDATION_API PxQuat PxShortestRotation (const PxVec3 &from, const PxVec3 &target)
 finds the shortest rotation between two vectors.
PX_FOUNDATION_API PxVec3 PxDiagonalize (const PxMat33 &m, PxQuat &axes)
PX_INLINE PxTolerancesScale::PxTolerancesScale ()
 constructor sets to default
PX_INLINE bool PxTolerancesScale::isValid () const
 Returns true if the descriptor is valid.
+

Define Documentation

+ +
+
+ + + + + + + + + + + + +
#define PX_DEFINE_TYPEINFO (_name,
_fastType   ) 
+
+
+ +

+Value:

class _name; \
+    template <> struct PxTypeInfo<_name>    {   static const char* name() { return #_name;  }   enum { eFastTypeId = _fastType };   };
+
+
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
#define PX_MAKE_FOURCC (a,
b,
c,
d   )    ( (a) | ((b)<<8) | ((c)<<16) | ((d)<<24) )
+
+
+ +

+Used to fix multi-byte characters warning from gcc for situations like: PxU32 foo = 'CCTS';. +

+ +

+

+ +

+
+ + + + +
#define PX_PHYSX_COMMON_API
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define PX_PHYSX_CORE_API
+
+
+ +

+ +

+

+ +

+
+ + + + +
#define PX_SERIAL_ALIGN   16
+
+
+ +

+Default serialization alignment. +

+ +

+

+ +

+
+ + + + +
#define PX_SERIAL_FILE_ALIGN   128
+
+
+ +

+Serialized input data must be aligned to this value. +

+ +

+

+ +

+
+ + + + +
#define PX_SERIAL_OBJECT_ID_INVALID   0
+
+
+ +

+PxSerialObjectId value for objects that do not have an ID. +

+ +

+

+ +

+
+ + + + +
#define PX_SERIAL_REF_KIND_MATERIAL_IDX   (1)
+
+
+ +

+Reference kind value for material indices. +

+ +

+

+ +

+
+ + + + +
#define PX_SERIAL_REF_KIND_PTR_TYPE_BIT   (1u<<31)
+
+
+ +

+Bit to mark pointer type references,. +

+

See also:
PxDeserializationContext
+ +
+

+ +

+
+ + + + +
#define PX_SERIAL_REF_KIND_PXBASE   (0 | PX_SERIAL_REF_KIND_PTR_TYPE_BIT)
+
+
+ +

+Reference kind value for PxBase objects. +

+ +

Referenced by PxSerializerDefaultAdapter< T >::registerReferences(), and PxDeserializationContext::translatePxBase().

+ +
+

+

Typedef Documentation

+ +
+
+ + + + +
typedef PxFlags<PxBaseFlag::Enum, PxU16> PxBaseFlags
+
+
+ +

+ +

+

+ +

+
+ + + + +
typedef void(* PxBinaryMetaDataCallback)(PxOutputStream &stream)
+
+
+ +

+Callback type for exporting binary meta data for a serializable type. +

+

See also:
PxSerializationRegistry::registerBinaryMetaDataCallback
+
Parameters:
+ + +
stream Stream to store binary meta data.
+
+ +
+

+ +

+
+ + + + +
typedef PxU16 PxMaterialTableIndex
+
+
+ +

+ +

+

+ +

+
+ + + + +
typedef PxU64 PxSerialObjectId
+
+
+ +

+ID type for PxBase objects in a PxCollection. +

+ +

+

+ +

+
+ + + + +
typedef PxU32 PxTriangleID
+
+
+ +

+ +

+

+ +

+
+ + + + +
typedef PxU16 PxType
+
+
+ +

+ +

+

+ +

+
+ + + + +
typedef PxU16 PxType
+
+
+ +

+ +

+

+

Function Documentation

+ +
+
+ + + + + + + + +
PX_INLINE bool PxTolerancesScale::isValid (  )  const [inherited]
+
+
+ +

+Returns true if the descriptor is valid. +

+

Returns:
true if the current settings are valid (returns always true).
+ +

References PxTolerancesScale::length, and PxTolerancesScale::mass.

+ +
+

+ +

+
+ + + + + + + + +
PX_PHYSX_COMMON_API physx::PxCollection* PX_CALL_CONV PxCreateCollection (  ) 
+
+
+ +

+Creates a collection object. +

+Objects can only be serialized or deserialized through a collection. For serialization, users must add objects to the collection and serialize the collection as a whole. For deserialization, the system gives back a collection of deserialized objects to users.

+

Returns:
The new collection object.
+
See also:
PxCollection, PxCollection::release()
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
PX_FOUNDATION_API PxVec3 PxDiagonalize (const PxMat33 &  m,
PxQuat &  axes 
)
+
+
+ +

+ +

Referenced by PxMassProperties::getMassSpaceInertia().

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
PX_FOUNDATION_API PxQuat PxShortestRotation (const PxVec3 &  from,
const PxVec3 &  target 
)
+
+
+ +

+finds the shortest rotation between two vectors. +

+

Parameters:
+ + + +
[in] from the vector to start from
[in] target the vector to rotate to
+
+
Returns:
a rotation about an axis normal to the two vectors which takes one to the other via the shortest path
+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE PxTolerancesScale::PxTolerancesScale (  )  [inherited]
+
+
+ +

+constructor sets to default +

+ +

+

+

+ +

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