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

PxBase Class Reference
+ +[Common] +

Base class for objects that can be members of a PxCollection. +More... +

+#include <PxBase.h> +

+

+Inheritance diagram for PxBase:
+
+

Inheritance graph
+ +PxActorPxAggregatePxArticulationPxArticulationJointPxClothFabricPxConstraintPxConvexMeshPxHeightFieldPxJointPxMaterialPxPruningStructurePxShapePxTriangleMeshPxVehicleWheelsPxClothPxParticleBasePxRigidActorPxParticleFluidPxParticleSystemPxRigidBodyPxRigidStaticPxArticulationLinkPxRigidDynamicPxD6JointPxDistanceJointPxFixedJointPxPrismaticJointPxRevoluteJointPxSphericalJointPxBVH33TriangleMeshPxBVH34TriangleMeshPxVehicleDrivePxVehicleNoDrivePxVehicleDrive4WPxVehicleDriveNWPxVehicleDriveTank +
[legend]
+
+Collaboration diagram for PxBase:
+
+

Collaboration graph
+ +PxFlags\< PxBaseFlag::Enum, PxU16 \> +
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

virtual void release ()=0
 Releases the PxBase instance, please check documentation of release in derived class.
virtual const char * getConcreteTypeName () const =0
 Returns string name of dynamic type.
template<class T >
T * is ()
template<class T >
const T * is () const
PX_FORCE_INLINE PxType getConcreteType () const
 Returns concrete type of object.
PX_FORCE_INLINE void setBaseFlag (PxBaseFlag::Enum flag, bool value)
 Set PxBaseFlag.
PX_FORCE_INLINE void setBaseFlags (PxBaseFlags inFlags)
 Set PxBaseFlags.
PX_FORCE_INLINE PxBaseFlags getBaseFlags () const
 Returns PxBaseFlags.
virtual bool isReleasable () const
 Whether the object is subordinate.

Protected Member Functions

PX_INLINE PxBase (PxType concreteType, PxBaseFlags baseFlags)
 Constructor setting concrete type and base flags.
PX_INLINE PxBase (PxBaseFlags baseFlags)
 Deserialization constructor setting base flags.
virtual ~PxBase ()
 Destructor.
virtual bool isKindOf (const char *superClass) const
 Returns whether a given type name matches with the type of this instance.
template<class T >
bool typeMatch () const

Protected Attributes

PxType mConcreteType
PxBaseFlags mBaseFlags

Friends

void getBinaryMetaData_PxBase (PxOutputStream &stream)
+

Detailed Description

+Base class for objects that can be members of a PxCollection. +

+All PxBase sub-classes can be serialized.

+

See also:
PxCollection
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
PX_INLINE PxBase::PxBase (PxType  concreteType,
PxBaseFlags  baseFlags 
) [inline, protected]
+
+
+ +

+Constructor setting concrete type and base flags. +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE PxBase::PxBase (PxBaseFlags  baseFlags  )  [inline, protected]
+
+
+ +

+Deserialization constructor setting base flags. +

+ +

+

+ +

+
+ + + + + + + + +
virtual PxBase::~PxBase (  )  [inline, protected, virtual]
+
+
+ +

+Destructor. +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
PX_FORCE_INLINE PxBaseFlags PxBase::getBaseFlags (  )  const [inline]
+
+
+ +

+Returns PxBaseFlags. +

+

Returns:
PxBaseFlags
+
See also:
PxBaseFlags
+ +
+

+ +

+
+ + + + + + + + +
PX_FORCE_INLINE PxType PxBase::getConcreteType (  )  const [inline]
+
+
+ +

+Returns concrete type of object. +

+

Returns:
PxConcreteType::Enum of serialized object
+
See also:
PxConcreteType
+ +
+

+ +

+
+ + + + + + + + +
virtual const char* PxBase::getConcreteTypeName (  )  const [pure virtual]
+
+
+ +

+Returns string name of dynamic type. +

+

Returns:
Class name of most derived type of this object.
+ +

Implemented in PxAggregate, PxArticulation, PxArticulationJoint, PxArticulationLink, PxConstraint, PxMaterial, PxPruningStructure, PxRigidDynamic, PxRigidStatic, PxShape, PxCloth, PxClothFabric, PxD6Joint, PxDistanceJoint, PxFixedJoint, PxPrismaticJoint, PxRevoluteJoint, PxSphericalJoint, PxConvexMesh, PxHeightField, PxParticleFluid, PxParticleSystem, PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveNW, PxVehicleDriveTank, PxVehicleNoDrive, and PxVehicleWheels.

+ +
+

+ +

+
+
+template<class T >
+ + + + + + + + +
const T* PxBase::is (  )  const [inline]
+
+
+ +

+ +

+

+ +

+
+
+template<class T >
+ + + + + + + + +
T* PxBase::is (  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
virtual bool PxBase::isKindOf (const char *  superClass  )  const [inline, protected, virtual]
+
+
+ +

+Returns whether a given type name matches with the type of this instance. +

+ +

Reimplemented in PxActor, PxAggregate, PxArticulation, PxArticulationJoint, PxArticulationLink, PxConstraint, PxMaterial, PxPruningStructure, PxRigidActor, PxRigidBody, PxRigidDynamic, PxRigidStatic, PxShape, PxCloth, PxClothFabric, PxD6Joint, PxDistanceJoint, PxFixedJoint, PxJoint, PxPrismaticJoint, PxRevoluteJoint, PxSphericalJoint, PxConvexMesh, PxHeightField, PxTriangleMesh, PxBVH33TriangleMesh, PxBVH34TriangleMesh, PxParticleBase, PxParticleFluid, PxParticleSystem, PxVehicleDrive, PxVehicleDrive4W, PxVehicleDriveNW, PxVehicleDriveTank, PxVehicleNoDrive, and PxVehicleWheels.

+ +

Referenced by PxVehicleWheels::isKindOf(), PxVehicleNoDrive::isKindOf(), PxVehicleDriveTank::isKindOf(), PxVehicleDriveNW::isKindOf(), PxVehicleDrive4W::isKindOf(), PxVehicleDrive::isKindOf(), PxTriangleMesh::isKindOf(), PxShape::isKindOf(), PxPruningStructure::isKindOf(), PxMaterial::isKindOf(), PxJoint::isKindOf(), PxHeightField::isKindOf(), PxConvexMesh::isKindOf(), PxConstraint::isKindOf(), PxClothFabric::isKindOf(), PxArticulationJoint::isKindOf(), PxArticulation::isKindOf(), PxAggregate::isKindOf(), and PxActor::isKindOf().

+ +
+

+ +

+
+ + + + + + + + +
virtual bool PxBase::isReleasable (  )  const [inline, virtual]
+
+
+ +

+Whether the object is subordinate. +

+A class is subordinate, if it can only be instantiated in the context of another class.

+

Returns:
Whether the class is subordinate
+
See also:
PxSerialization::isSerializable
+ +

References PxBaseFlag::eIS_RELEASABLE.

+ +
+

+ +

+
+ + + + + + + + +
virtual void PxBase::release (  )  [pure virtual]
+
+
+ +

+Releases the PxBase instance, please check documentation of release in derived class. +

+ +

Implemented in PxActor, PxAggregate, PxArticulation, PxArticulationLink, PxConstraint, PxMaterial, PxPruningStructure, PxRigidActor, PxShape, PxCloth, PxClothFabric, PxJoint, PxConvexMesh, PxHeightField, PxTriangleMesh, and PxVehicleWheels.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
PX_FORCE_INLINE void PxBase::setBaseFlag (PxBaseFlag::Enum  flag,
bool  value 
) [inline]
+
+
+ +

+Set PxBaseFlag. +

+

Parameters:
+ + + +
[in] flag The flag to be set
[in] value The flags new value
+
+ +
+

+ +

+
+ + + + + + + + + +
PX_FORCE_INLINE void PxBase::setBaseFlags (PxBaseFlags  inFlags  )  [inline]
+
+
+ +

+Set PxBaseFlags. +

+

Parameters:
+ + +
[in] inFlags The flags to be set
+
+
See also:
PxBaseFlags
+ +
+

+ +

+
+
+template<class T >
+ + + + + + + + +
bool PxBase::typeMatch (  )  const [inline, protected]
+
+
+ +

+ +

References PxConcreteType::eUNDEFINED.

+ +
+

+

Friends And Related Function Documentation

+ +
+
+ + + + + + + + + +
void getBinaryMetaData_PxBase (PxOutputStream &  stream  )  [friend]
+
+
+ +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxBaseFlags PxBase::mBaseFlags [protected]
+
+
+ +

+ +

+

+ +

+
+ + + + +
PxType PxBase::mConcreteType [protected]
+
+
+ +

+ +

+

+

The documentation for this class was generated from the following file: +
+ +

+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