Alignment macros

PX_ALIGN_PREFIX and PX_ALIGN_SUFFIX can be used for type alignment instead of aligning individual variables as follows: PX_ALIGN_PREFIX(16) struct A { ... } PX_ALIGN_SUFFIX(16); This declaration style is parsed correctly by Visual Assist.

Referenced by PxFixedSizeLookupTable< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES >::addPair(), physx::PxTask::addReference(), PxContactStreamIterator::advanceToIndex(), PxDefaultAllocator::allocate(), PxBounds3::contains(), PxBounds3::fattenFast(), PxBounds3::fattenSafe(), physx::PxTask::finishBefore(), PxGeometryHolder::get(), PxHitBuffer< PxSweepHit >::getAnyHit(), PxBatchQueryResult< HitType >::getAnyHit(), PxMat44::getBasis(), PxBounds3::getCenter(), PxBounds3::getDimensions(), PxContactStreamIterator::getExtendedContact(), PxBounds3::getExtents(), PxTransform::getInverse(), PxMassProperties::getMassSpaceInertia(), PxSimulationStatistics::getNbBroadPhaseAdds(), PxSimulationStatistics::getNbBroadPhaseRemoves(), PxSimulationStatistics::getRbPairStats(), PxHitBuffer< PxSweepHit >::getTouch(), PxFixedSizeLookupTable< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES >::getYVal(), PxBounds3::include(), PxBounds3::intersects(), PxBounds3::intersects1D(), PxBounds3::isEmpty(), PxBounds3::isInside(), PxContactStreamIterator::nextContact(), PxContactPairExtraDataIterator::nextItemSet(), PxContactStreamIterator::nextPatch(), PxVec3::normalizeFast(), PxStrideIterator< const PxVec3 >::operator!=(), PxTransform::operator*(), PxMassProperties::operator*(), PxStrideIterator< const PxVec3 >::operator-(), PxStrideIterator< const PxVec3 >::operator<(), PxStrideIterator< const PxVec3 >::operator<=(), PxStrideIterator< const PxVec3 >::operator==(), PxStrideIterator< const PxVec3 >::operator>(), PxStrideIterator< const PxVec3 >::operator>=(), PxVec4::operator[](), PxVec3::operator[](), PxVec2::operator[](), PxExtendedVec3::operator[](), PxClamp(), PxCreateRepXObject(), PxMassProperties::PxMassProperties(), PxMeshScale::PxMeshScale(), PxQuat::PxQuat(), PxStrideIterator< const PxVec3 >::PxStrideIterator(), PxTransform::PxTransform(), PxSerializerDefaultAdapter< T >::registerReferences(), physx::PxTask::release(), physx::PxTask::removeReference(), PxTransform::rotate(), PxMassProperties::rotateInertia(), PxTransform::rotateInv(), PxBounds3::scaleFast(), PxMassProperties::scaleInertia(), PxBounds3::scaleSafe(), physx::PxLightCpuTask::setContinuation(), physx::PxTask::startAfter(), PxMassProperties::sum(), PxTransform::transform(), PxBounds3::transformFast(), PxTransform::transformInv(), PxBounds3::transformSafe(), PxMassProperties::translate(), and PxMassProperties::translateInertia().

Referenced by PxSimulationStatistics::getRbPairStats(), PxGetGaussMapVertexLimitForPlatform(), and PxGeometryHolder::storeAny().

General defines

Deprecated macro

• To deprecate a function: Place PX_DEPRECATED at the start of the function header (leftmost word).
• To deprecate a 'typedef', a 'struct' or a 'class': Place PX_DEPRECATED directly after the keywords ('typdef', 'struct', 'class').

Use these macro definitions to create warnings for deprecated functions #define PX_DEPRECATED __declspec(deprecated) // Microsoft #define PX_DEPRECATED __attribute__((deprecated())) // GCC

Assert macro

Value:

PX_INLINE PxFlags<enumtype, storagetype> operator|(enumtype a, enumtype b)                                         \
    {                                                                                                                  \
        PxFlags<enumtype, storagetype> r(a);                                                                           \
        r |= b;                                                                                                        \
        return r;                                                                                                      \
    }                                                                                                                  \
    PX_INLINE PxFlags<enumtype, storagetype> operator&(enumtype a, enumtype b)                                         \
    {                                                                                                                  \
        PxFlags<enumtype, storagetype> r(a);                                                                           \
        r &= b;                                                                                                        \
        return r;                                                                                                      \
    }                                                                                                                  \
    PX_INLINE PxFlags<enumtype, storagetype> operator~(enumtype a)                                                     \
    {                                                                                                                  \
        return ~PxFlags<enumtype, storagetype>(a);                                                                     \
    }

Value:

typedef PxFlags<x::Enum, y> x##s;                                                                                  \
    PX_FLAGS_OPERATORS(x::Enum, y)

Force inline macro

The constant PX_FOUNDATION_VERSION is used when creating certain PhysX module objects. This is to ensure that the application is using the same header version as the library was built with.

family shortcuts

Inline macro

C++ standard library defines

Referenced by PxBounds3::empty(), PxHeightFieldDesc::isValid(), PxBounds3::isValid(), PxBounds3::setEmpty(), and PxBounds3::setMaximal().

Referenced by PxContactStreamIterator::getMaxImpulse().

Referenced by PxVehicleCopyDynamicsMap::PxVehicleCopyDynamicsMap().

Noalias macro

Value:

\
protected:                                                                                                             \
    Class(const Class&);                                                                                               \
    Class& operator=(const Class&);

Noinline macro

Referenced by PxVec3::normalizeFast(), and PxVec3::normalizeSafe().

The constant PX_PHYSICS_VERSION is used when creating certain PhysX module objects. This is to ensure that the application is using the same header version as the library was built with.

Define API function declaration

PX_FOUNDATION_DLL=1 - used by the DLL library (PhysXCommon) to export the API PX_FOUNDATION_DLL=0 - for windows configurations where the PX_FOUNDATION_API is linked through standard static linking no definition - this will allow DLLs and libraries to use the exported API from PhysXCommon Calling convention Pack macros - disabled on SPU because they are not supported

Restrict macro

DLL export macros

Compiler defines, see http://sourceforge.net/p/predef/wiki/Compilers/ Operating system defines, see http://sourceforge.net/p/predef/wiki/OperatingSystems/ Architecture defines, see http://sourceforge.net/p/predef/wiki/Architectures/ SIMD defines define anything not defined on this platform to 0

files to always include

enum for empty constructor tag

Enumerator:

PxEmpty

enum for identity constructor flag for quaternions, transforms, and matrices

Enumerator:

PxIdentity

enum for zero constructor tag for vectors and matrices

Enumerator:

PxZero

Construct from center, extent, and (not necessarily orthogonal) basis.

References PxMat33::column0, PxMat33::column1, PxMat33::column2, PxAbs(), PxBounds3::PxBounds3(), PxVec3::x, PxVec3::y, and PxVec3::z.

Referenced by PxBounds3::poseExtent(), and PxBounds3::transformFast().

returns the AABB containing v0 and v1.

Parameters:

	v0	first point included in the AABB.
	v1	second point included in the AABB.

References PxVec3::maximum(), PxVec3::minimum(), and PxBounds3::PxBounds3().

returns the AABB from center and extents vectors.

Parameters:

	center	Center vector
	extent	Extents vector

References PxBounds3::PxBounds3().

Referenced by PxBounds3::scaleFast().

References PxFlags< enumtype, storagetype >::mBits.

indicates if these bounds contain v.

Parameters:

v

Point to test against bounds.

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, PX_ASSERT, PxVec3::x, PxVec3::y, and PxVec3::z.

Return empty bounds.

References PX_MAX_BOUNDS_EXTENTS, and PxBounds3::PxBounds3().

fattens the AABB in all 3 dimensions by the given distance.

Calling this method for empty bounds leads to undefined behavior. Use fattenSafe() instead.

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, PX_ASSERT, PxVec3::x, PxVec3::y, and PxVec3::z.

Referenced by PxBounds3::fattenSafe().

fattens the AABB in all 3 dimensions by the given distance.

This version is safe to call for empty bounds.

References PxBounds3::fattenFast(), PxBounds3::isEmpty(), PxBounds3::isValid(), and PX_ASSERT.

get component of the box's center along a given axis

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, and PX_ASSERT.

returns the center of this axis aligned box.

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, and PX_ASSERT.

Referenced by PxBounds3::scaleFast(), and PxBounds3::transformFast().

returns the dimensions (width/height/depth) of this axis aligned box.

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, and PX_ASSERT.

Referenced by PxBounds3::getExtents().

returns the extents, which are half of the width/height/depth.

References PxBounds3::getDimensions(), PxBounds3::isValid(), and PX_ASSERT.

Referenced by PxBounds3::scaleFast().

get component of the box's extents along a given axis

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, and PX_ASSERT.

Referenced by PxBounds3::transformFast().

expands the volume to include b.

Parameters:

b

Bounds to perform union with.

References PxBounds3::isValid(), PxVec3::maximum(), PxBounds3::maximum, PxVec3::minimum(), PxBounds3::minimum, and PX_ASSERT.

expands the volume to include v

Parameters:

v

Point to expand to.

References PxBounds3::isValid(), PxVec3::maximum(), PxBounds3::maximum, PxVec3::minimum(), PxBounds3::minimum, and PX_ASSERT.

indicates whether the intersection of this and b is empty or not.

Parameters:

b

Bounds to test for intersection.

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, PX_ASSERT, PxVec3::x, PxVec3::y, and PxVec3::z.

computes the 1D-intersection between two AABBs, on a given axis.

Parameters:

	a	the other AABB
	axis	the axis (0, 1, 2)

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, and PX_ASSERT.

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, PX_ASSERT, and PxVec3::x.

Referenced by PxBounds3::fattenSafe(), PxBounds3::scaleSafe(), and PxBounds3::transformSafe().

checks that the AABB values are not NaN

References PxVec3::isFinite(), PxBounds3::maximum, and PxBounds3::minimum.

Referenced by PxBounds3::isValid().

checks a box is inside another box.

Parameters:

box

the other AABB

References PxBounds3::isValid(), PxBounds3::maximum, PxBounds3::minimum, PX_ASSERT, PxVec3::x, PxVec3::y, and PxVec3::z.

References PxFlags< enumtype, storagetype >::mBits.

checks that the AABB values describe a valid configuration.

References PxBounds3::isFinite(), PxBounds3::maximum, PxBounds3::minimum, PX_MAX_BOUNDS_EXTENTS, PxVec3::x, PxVec3::y, and PxVec3::z.

Referenced by PxBounds3::contains(), PxBounds3::fattenFast(), PxBounds3::fattenSafe(), PxBounds3::getCenter(), PxBounds3::getDimensions(), PxBounds3::getExtents(), PxBounds3::include(), PxBounds3::intersects(), PxBounds3::intersects1D(), PxBounds3::isEmpty(), PxBounds3::isInside(), PxSceneDesc::isValid(), PxBounds3::scaleFast(), PxBounds3::scaleSafe(), PxBounds3::transformFast(), and PxBounds3::transformSafe().

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxVec4::w, PxVec4::x, PxVec4::y, and PxVec4::z.

References PxVec3::x, PxVec3::y, and PxVec3::z.

References PxVec2::x, and PxVec2::y.

Addition operator.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

Construct from pose and extent.

References PxBounds3::basisExtent(), PxTransform::p, and PxTransform::q.

Referenced by PxContactSet::getInternalFaceIndex0(), PxHitBuffer< PxSweepHit >::processTouches(), PxMat33::PxMat33(), PxMat44::PxMat44(), PxQuat::PxQuat(), PxTransform::PxTransform(), PxVec2::PxVec2(), PxVec3::PxVec3(), and PxVec4::PxVec4().

abs returns the absolute value of its argument.

abs returns the absolute value of its argument.

abs returns the absolute value of its argument.

Referenced by PxVec3::abs(), PxBounds3::basisExtent(), PxPlane::contains(), PxVec4::isNormalized(), PxVec3::isNormalized(), PxVec2::isNormalized(), PxQuat::isSane(), PxQuat::isUnit(), PxEquals(), PxQuat::PxQuat(), and PxQuat::toRadiansAndUnitAxis().

Arccosine. Returns angle between 0 and PI in radians Unit: Radians.

References PxClamp().

Arccosine. Returns angle between 0 and PI in radians Unit: Radians.

References PxClamp().

Referenced by PxQuat::getAngle().

Arcsine. Returns angle between -PI/2 and PI/2 in radians Unit: Radians.

References PxClamp().

Arcsine. Returns angle between -PI/2 and PI/2 in radians Unit: Radians.

References PxClamp().

ArcTangent. Returns angle between -PI/2 and PI/2 in radians Unit: Radians.

ArcTangent. Returns angle between -PI/2 and PI/2 in radians Unit: Radians.

Arctangent of (x/y) with correct sign. Returns angle between -PI and PI in radians Unit: Radians.

Arctangent of (x/y) with correct sign. Returns angle between -PI and PI in radians Unit: Radians.

Referenced by PxQuat::toRadiansAndUnitAxis().

Construct from two bounding points.

Clamps v to the range [hi,lo].

References PX_ASSERT, PxMax(), and PxMin().

Referenced by PxAcos(), and PxAsin().

Cosine of an angle (Unit: Radians).

Cosine of an angle (Unit: Radians).

Referenced by PxQuat::PxQuat().

Creates an instance of the foundation class.

The foundation class is needed to initialize higher level SDKs. There may be only one instance per process. Calling this method after an instance has been created already will result in an error message and NULL will be returned.

Parameters:

	version	Version number we are expecting (should be PX_FOUNDATION_VERSION)
	allocator	User supplied interface for allocating memory(see PxAllocatorCallback)
	errorCallback	User supplied interface for reporting errors and displaying messages(see PxErrorCallback)

Returns:

Foundation instance on success, NULL if operation failed

See also:

PxFoundation

References PxAbs().

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

References PxFlags< enumtype, storagetype >::mBits.

Retrieves the Foundation SDK after it has been created.

Note:

The behavior of this method is undefined if the foundation instance has not been created already.

See also:

PxCreateFoundation()

Get the callback that will be used for all profiling.

returns true if the passed number is a finite floating point number as opposed to INF, NAN, etc.

returns true if the passed number is a finite floating point number as opposed to INF, NAN, etc.

Referenced by PxVec4::isFinite(), PxVec3::isFinite(), PxVec2::isFinite(), PxQuat::isFinite(), PxExtendedVec3::isFinite(), PxSphereGeometry::isValid(), PxJointLimitCone::isValid(), PxJointAngularLimitPair::isValid(), PxJointLinearLimitPair::isValid(), PxJointLinearLimit::isValid(), PxJointLimitParameters::isValid(), PxHeightFieldGeometry::isValid(), PxD6JointDrive::isValid(), PxCapsuleGeometry::isValid(), PxMassProperties::operator*(), PxMassProperties::PxMassProperties(), PxMassProperties::sum(), and PxMassProperties::translateInertia().

Stride iterator factory function which infers the iterator type.

Stride iterator factory function which infers the iterator type.

overload for float to use fsel on xbox

The return value is the greater of the two specified values.

Referenced by PxVec3::maxElement(), PxVec2::maxElement(), PxVec4::maximum(), PxVec3::maximum(), PxVec2::maximum(), and PxClamp().

Copies the bytes of one memory block to another. The memory blocks must not overlap.

Note:

Use PxMemMove if memory blocks overlap.

Parameters:

	dest	Pointer to block of memory to copy to.
	src	Pointer to block of memory to copy from.
	count	Number of bytes to copy.

Returns:

Pointer to destination memory block

Referenced by PxContactPair::bufferContacts(), PxFixedSizeLookupTable< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES >::operator=(), and PxFixedSizeLookupTable< eMAX_NB_ENGINE_TORQUE_CURVE_ENTRIES >::PxFixedSizeLookupTable().

Copies the bytes of one memory block to another. The memory blocks can overlap.

Note:

Use PxMemCopy if memory blocks do not overlap.

Parameters:

	dest	Pointer to block of memory to copy to.
	src	Pointer to block of memory to copy from.
	count	Number of bytes to copy.

Returns:

Pointer to destination memory block

Sets the bytes of the provided buffer to the specified value.

Parameters:

	dest	Pointer to block of memory to set to the specified value.
	c	Value to set the bytes of the block of memory to.
	count	Number of bytes to set to the specified value.

Returns:

Pointer to memory block (same as input)

Referenced by PxVehicleDifferentialNWData::PxVehicleDifferentialNWData().

Sets the bytes of the provided buffer to zero.

Parameters:

	dest	Pointer to block of memory to set zero.
	count	Number of bytes to set to zero.

Returns:

Pointer to memory block (same as input)

Referenced by PxWheelQueryResult::PxWheelQueryResult().

overload for float to use fsel on xbox

The return value is the lesser of the two specified values.

Referenced by PxVec3::minElement(), PxVec2::minElement(), PxVec4::minimum(), PxVec3::minimum(), PxVec2::minimum(), PxClamp(), PxJointAngularLimitPair::PxJointAngularLimitPair(), PxJointLimitCone::PxJointLimitCone(), and PxJointLinearLimitPair::PxJointLinearLimitPair().

Creates from orientation matrix.

Parameters:

[in]

m

Rotation matrix to extract quaternion from.

References PxMat33::column0, PxMat33::column1, PxMat33::column2, PxQuat::PxQuat(), PxSqrt(), PxVec3::x, PxVec3::y, and PxVec3::z.

reciprocal square root.

reciprocal square root.

Referenced by PxVec4::getNormalized(), PxVec3::getNormalized(), PxVec2::getNormalized(), and PxQuat::toRadiansAndUnitAxis().

Set the callback that will be used for all profiling.

Sine of an angle ( Unit: Radians ).

trigonometry -- all angles are in radians.

Sine of an angle ( Unit: Radians )

Referenced by PxQuat::PxQuat().

Square root.

Square root.

Referenced by PxVec4::magnitude(), PxVec3::magnitude(), PxVec2::magnitude(), PxQuat::magnitude(), PxExtendedVec3::magnitude(), and PxQuat::PxQuat().

Tangent of an angle. Unit: Radians.

Tangent of an angle. Unit: Radians.

References PxMat44::column0, PxMat44::column1, PxMat44::column2, PxMat44::column3, PxTransform::p, PxTransform::q, PxVec4::x, PxVec4::y, and PxVec4::z.

scales the AABB.

Calling this method for empty bounds leads to undefined behavior. Use scaleSafe() instead.

Parameters:

scale

Factor to scale AABB by.

References PxBounds3::centerExtents(), PxBounds3::getCenter(), PxBounds3::getExtents(), PxBounds3::isValid(), and PX_ASSERT.

Referenced by PxBounds3::scaleSafe().

scales the AABB.

This version is safe to call for empty bounds.

Parameters:

scale

Factor to scale AABB by.

References PxBounds3::isEmpty(), PxBounds3::isValid(), PX_ASSERT, and PxBounds3::scaleFast().

References PxFlags< enumtype, storagetype >::mBits.

Sets empty to true.

References PxBounds3::maximum, PxBounds3::minimum, and PX_MAX_BOUNDS_EXTENTS.

Sets the bounds to maximum size [-PX_MAX_BOUNDS_EXTENTS, PX_MAX_BOUNDS_EXTENTS].

References PxBounds3::maximum, PxBounds3::minimum, and PX_MAX_BOUNDS_EXTENTS.

gets the transformed bounds of the passed AABB (resulting in a bigger AABB).

Calling this method for empty bounds leads to undefined behavior. Use transformSafe() instead.

Parameters:

[in]	transform	Transform to apply, can contain scaling as well
[in]	bounds	The bounds to transform.

References PxBounds3::basisExtent(), PxBounds3::getCenter(), PxBounds3::getExtents(), PxBounds3::isValid(), PX_ASSERT, PxTransform::q, and PxTransform::transform().

gets the transformed bounds of the passed AABB (resulting in a bigger AABB).

Calling this method for empty bounds leads to undefined behavior. Use transformSafe() instead.

Parameters:

[in]	matrix	Transform to apply, can contain scaling as well
[in]	bounds	The bounds to transform.

References PxBounds3::basisExtent(), PxBounds3::getCenter(), PxBounds3::getExtents(), PxBounds3::isValid(), and PX_ASSERT.

Referenced by PxBounds3::transformSafe().

gets the transformed bounds of the passed AABB (resulting in a bigger AABB).

This version is safe to call for empty bounds.

Parameters:

[in]	transform	Transform to apply, can contain scaling as well
[in]	bounds	The bounds to transform.

References PxBounds3::isEmpty(), PxBounds3::isValid(), PX_ASSERT, and PxBounds3::transformFast().

gets the transformed bounds of the passed AABB (resulting in a bigger AABB).

This version is safe to call for empty bounds.

Parameters:

[in]	matrix	Transform to apply, can contain scaling as well
[in]	bounds	The bounds to transform.

References PxBounds3::isEmpty(), PxBounds3::isValid(), PX_ASSERT, and PxBounds3::transformFast().

Referenced by PxJointLimitCone::isValid(), PxMassProperties::PxMassProperties(), and PxQuat::toRadiansAndUnitAxis().