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...

Macros
#define	PX_PHYSX_CORE_API
#define	PX_PHYSX_GPU_API
#define	PX_PHYSX_COMMON_API
#define	PX_SERIAL_ALIGN   16
	Default serialization alignment. More...
#define	PX_SERIAL_FILE_ALIGN   128
	Serialized input data must be aligned to this value. More...
#define	PX_SERIAL_OBJECT_ID_INVALID   0
	PxSerialObjectId value for objects that do not have an ID. More...
#define	PX_SERIAL_REF_KIND_PTR_TYPE_BIT   (1u<<31)
	Bit to mark pointer type references,. More...
#define	PX_SERIAL_REF_KIND_PXBASE   (0 | PX_SERIAL_REF_KIND_PTR_TYPE_BIT)
	Reference kind value for PxBase objects. More...
#define	PX_SERIAL_REF_KIND_MATERIAL_IDX   (1)
	Reference kind value for material indices. More...
#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';. More...
#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. More...
typedef void(*	PxBinaryMetaDataCallback) (PxOutputStream &stream)
	Callback type for exporting binary meta data for a serializable type. More...

Functions
PX_PHYSX_COMMON_API physx::PxCollection *PX_CALL_CONV	PxCreateCollection ()
	Creates a collection object. More...
PX_FOUNDATION_API PxQuat	PxShortestRotation (const PxVec3 &from, const PxVec3 &target)
	finds the shortest rotation between two vectors. More...
PX_FOUNDATION_API PxVec3	PxDiagonalize (const PxMat33 &m, PxQuat &axes)
PX_FOUNDATION_API PxTransform	PxTransformFromSegment (const PxVec3 &p0, const PxVec3 &p1, PxReal *halfHeight=NULL)
	creates a transform from the endpoints of a segment, suitable for an actor transform for a PxCapsuleGeometry More...
PX_FOUNDATION_API PxTransform	PxTransformFromPlaneEquation (const PxPlane &plane)
	creates a transform from a plane equation, suitable for an actor transform for a PxPlaneGeometry More...
PX_INLINE PxPlane	PxPlaneEquationFromTransform (const PxTransform &transform)
	creates a plane equation from a transform, such as the actor transform for a PxPlaneGeometry More...
PX_INLINE	PxTolerancesScale::PxTolerancesScale ()
	constructor sets to default More...
PX_INLINE bool	PxTolerancesScale::isValid () const
	Returns true if the descriptor is valid. More...

Detailed Description

Macro Definition Documentation

PX_DEFINE_TYPEINFO

#define PX_DEFINE_TYPEINFO	(		_name,
			_fastType
	)

Value:

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

PX_MAKE_FOURCC

#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';.

PX_PHYSX_COMMON_API

#define PX_PHYSX_COMMON_API

PX_PHYSX_CORE_API

#define PX_PHYSX_CORE_API

PX_PHYSX_GPU_API

#define PX_PHYSX_GPU_API

PX_SERIAL_ALIGN

#define PX_SERIAL_ALIGN   16

Default serialization alignment.

PX_SERIAL_FILE_ALIGN

#define PX_SERIAL_FILE_ALIGN   128

Serialized input data must be aligned to this value.

PX_SERIAL_OBJECT_ID_INVALID

#define PX_SERIAL_OBJECT_ID_INVALID   0

PxSerialObjectId value for objects that do not have an ID.

PX_SERIAL_REF_KIND_MATERIAL_IDX

#define PX_SERIAL_REF_KIND_MATERIAL_IDX   (1)

Reference kind value for material indices.

PX_SERIAL_REF_KIND_PTR_TYPE_BIT

#define PX_SERIAL_REF_KIND_PTR_TYPE_BIT   (1u<<31)

Bit to mark pointer type references,.

See also

PxDeserializationContext

PX_SERIAL_REF_KIND_PXBASE

#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

PxBaseFlags

typedef PxFlags<PxBaseFlag::Enum, PxU16> PxBaseFlags

PxBinaryMetaDataCallback

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.

PxMaterialTableIndex

typedef PxU16 PxMaterialTableIndex

PxSerialObjectId

typedef PxU64 PxSerialObjectId

ID type for PxBase objects in a PxCollection.

PxTriangleID

typedef PxU32 PxTriangleID

PxType [1/2]

typedef PxU16 PxType

PxType [2/2]

typedef PxU16 PxType

Function Documentation

isValid()

PX_INLINE bool PxTolerancesScale::isValid

(

)

const

Returns true if the descriptor is valid.

Returns

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

References PxTolerancesScale::length.

PxCreateCollection()

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()

PxDiagonalize()

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

Referenced by PxMassProperties::getMassSpaceInertia().

PxPlaneEquationFromTransform()

PX_INLINE PxPlane PxPlaneEquationFromTransform

(

const PxTransform &

transform

)

creates a plane equation from a transform, such as the actor transform for a PxPlaneGeometry

Parameters

[in]

transform

the transform

Returns

the plane

References PxTransform::transform().

PxShortestRotation()

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

PxTolerancesScale()

PX_INLINE PxTolerancesScale::PxTolerancesScale

(

)

constructor sets to default

PxTransformFromPlaneEquation()

PX_FOUNDATION_API PxTransform PxTransformFromPlaneEquation

(

const PxPlane &

plane

)

creates a transform from a plane equation, suitable for an actor transform for a PxPlaneGeometry

Parameters

[in]

plane

the desired plane equation

Returns

a PxTransform which will transform the plane PxPlane(1,0,0,0) to the specified plane

PxTransformFromSegment()

PX_FOUNDATION_API PxTransform PxTransformFromSegment	(	const PxVec3 &	p0,
		const PxVec3 &	p1,
		PxReal *	halfHeight = NULL
	)

creates a transform from the endpoints of a segment, suitable for an actor transform for a PxCapsuleGeometry

Parameters

[in]	p0	one end of major axis of the capsule
[in]	p1	the other end of the axis of the capsule
[out]	halfHeight	the halfHeight of the capsule. This parameter is optional.

Returns

A PxTransform which will transform the vector (1,0,0) to the capsule axis shrunk by the halfHeight