physx::PxBase Class Reference

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

#include <PxBase.h>

Inheritance diagram for physx::PxBase:

Collaboration diagram for physx::PxBase:

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
PxU32	mBuiltInRefCount

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

Member Function Documentation

getBaseFlags()

PX_FORCE_INLINE PxBaseFlags physx::PxBase::getBaseFlags ( ) const

inline

Returns PxBaseFlags.

Returns

PxBaseFlags

See also

PxBaseFlags

getConcreteType()

PX_FORCE_INLINE PxType physx::PxBase::getConcreteType ( ) const

inline

Returns concrete type of object.

Returns

PxConcreteType::Enum of serialized object

See also

PxConcreteType

getConcreteTypeName()

virtual const char * physx::PxBase::getConcreteTypeName ( ) const

pure virtual

Returns string name of dynamic type.

Returns

Class name of most derived type of this object.

Implemented in physx::PxContactJoint, physx::PxD6Joint, physx::PxDistanceJoint, physx::PxFixedJoint, physx::PxGearJoint, physx::PxPrismaticJoint, physx::PxRackAndPinionJoint, physx::PxRevoluteJoint, physx::PxSphericalJoint, physx::PxBVH, physx::PxConvexMesh, physx::PxHeightField, physx::PxAggregate, physx::PxArticulationJointReducedCoordinate, physx::PxArticulationLink, physx::PxArticulationSensor, physx::PxArticulationAttachment, physx::PxArticulationTendonJoint, physx::PxArticulationSpatialTendon, physx::PxArticulationFixedTendon, physx::PxFEMClothMaterial, physx::PxFEMSoftBodyMaterial, physx::PxFLIPMaterial, physx::PxMPMMaterial, physx::PxPBDMaterial, physx::PxCustomMaterial, physx::PxPruningStructure, physx::PxRigidDynamic, physx::PxRigidStatic, physx::PxShape, physx::PxVehicleDrive, physx::PxVehicleDrive4W, physx::PxVehicleDriveNW, physx::PxVehicleDriveTank, physx::PxVehicleNoDrive, physx::PxVehicleWheels, physx::Gu::SoftBodyAuxData, physx::Gu::TetrahedronMesh, physx::Gu::SoftBodyMesh, physx::Gu::BV4TriangleMesh, physx::Gu::RTreeTriangleMesh, physx::NpArticulationReducedCoordinate, physx::PxConstraint, physx::PxMaterial, physx::PxPBDParticleSystem, and physx::PxSoftBody.

isKindOf()

virtual bool physx::PxBase::isKindOf ( const char *  superClass ) const

inlineprotectedvirtual

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

Reimplemented in physx::PxRefCounted, physx::PxContactJoint, physx::PxD6Joint, physx::PxDistanceJoint, physx::PxFixedJoint, physx::PxGearJoint, physx::PxJoint, physx::PxPrismaticJoint, physx::PxRackAndPinionJoint, physx::PxRevoluteJoint, physx::PxSphericalJoint, physx::PxBVH, physx::PxConvexMesh, physx::PxHeightField, physx::PxSoftBodyAuxData, physx::PxTetrahedronMesh, physx::PxSoftBodyMesh, physx::PxTriangleMesh, physx::PxBVH33TriangleMesh, physx::PxBVH34TriangleMesh, physx::PxActor, physx::PxAggregate, physx::PxArticulationJointReducedCoordinate, physx::PxArticulationLink, physx::PxBaseMaterial, physx::PxFEMClothMaterial, physx::PxFEMMaterial, physx::PxFEMSoftBodyMaterial, physx::PxFLIPMaterial, physx::PxMaterial, physx::PxMPMMaterial, physx::PxParticleMaterial, physx::PxPBDMaterial, physx::PxCustomMaterial, physx::PxPruningStructure, physx::PxRigidActor, physx::PxRigidBody, physx::PxRigidDynamic, physx::PxRigidStatic, physx::PxShape, physx::PxVehicleDrive, physx::PxVehicleDrive4W, physx::PxVehicleDriveNW, physx::PxVehicleDriveTank, physx::PxVehicleNoDrive, physx::PxVehicleWheels, physx::NpArticulationReducedCoordinate, physx::PxConstraint, physx::PxParticleSystem, physx::PxPBDParticleSystem, and physx::PxSoftBody.

isReleasable()

virtual bool physx::PxBase::isReleasable ( ) const

inlinevirtual

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

release()

virtual void physx::PxBase::release ( )

pure virtual

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

Implemented in physx::PxVehicleWheels, physx::Gu::ConvexMesh, physx::Gu::BVH, physx::Gu::HeightField, physx::Gu::SoftBodyAuxData, physx::Gu::TetrahedronMesh, physx::Gu::SoftBodyMesh, physx::Gu::TriangleMesh, physx::NpArticulationJointReducedCoordinate, physx::NpArticulationReducedCoordinate, physx::NpArticulationSensor, physx::NpArticulationAttachment, physx::NpArticulationSpatialTendon, physx::NpArticulationTendonJoint, physx::NpArticulationFixedTendon, physx::NpFEMSoftBodyMaterial, physx::Sq::PruningStructure, physx::NpSoftBody, physx::NpAggregate, physx::NpConstraint, physx::NpMaterial, physx::NpPBDMaterial, physx::NpShape, physx::PxRefCounted, physx::PxJoint, physx::PxConvexMesh, physx::PxHeightField, physx::PxSoftBodyAuxData, physx::PxTetrahedronMesh, physx::PxSoftBodyMesh, physx::PxTriangleMesh, physx::PxActor, physx::PxAggregate, physx::PxArticulationLink, physx::PxArticulationSensor, physx::PxArticulationReducedCoordinate, physx::PxArticulationAttachment, physx::PxArticulationTendonJoint, physx::PxArticulationTendon, physx::PxConstraint, physx::PxParticleBuffer, physx::PxPruningStructure, physx::PxRigidActor, physx::PxShape, and physx::PxSoftBody.

setBaseFlag()

PX_FORCE_INLINE void physx::PxBase::setBaseFlag ( PxBaseFlag::Enum  flag, bool  value  )

inline

Set PxBaseFlag

Parameters

[in]	flag	The flag to be set
[in]	value	The flags new value

setBaseFlags()

PX_FORCE_INLINE void physx::PxBase::setBaseFlags ( PxBaseFlags  inFlags )

inline

Set PxBaseFlags

Parameters

[in]

inFlags

The flags to be set

See also

PxBaseFlags

---

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

• RavEngine/deps/physx/physx/include/common/PxBase.h