PxBase Class Reference

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

#include <PxBase.h>

Inheritance diagram for PxBase:

Collaboration diagram for PxBase:

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

Protected Member Functions
PX_INLINE	PxBase (PxType concreteType, PxBaseFlags baseFlags)
	Constructor setting concrete type and base flags. More...
PX_INLINE	PxBase (PxBaseFlags baseFlags)
	Deserialization constructor setting base flags. More...
virtual	~PxBase ()
	Destructor. More...
virtual bool	isKindOf (const char *superClass) const
	Returns whether a given type name matches with the type of this instance. More...
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

PxBase() [1/2]

PX_INLINE PxBase::PxBase ( PxType  concreteType, PxBaseFlags  baseFlags  )

inlineprotected

Constructor setting concrete type and base flags.

PxBase() [2/2]

PX_INLINE PxBase::PxBase ( PxBaseFlags  baseFlags )

inlineprotected

Deserialization constructor setting base flags.

~PxBase()

virtual PxBase::~PxBase ( )

inlineprotectedvirtual

Destructor.

Member Function Documentation

getBaseFlags()

PX_FORCE_INLINE PxBaseFlags PxBase::getBaseFlags ( ) const

inline

Returns PxBaseFlags.

Returns

PxBaseFlags

See also

PxBaseFlags

getConcreteType()

PX_FORCE_INLINE PxType PxBase::getConcreteType ( ) const

inline

Returns concrete type of object.

Returns

PxConcreteType::Enum of serialized object

See also

PxConcreteType

getConcreteTypeName()

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 PxVehicleWheels, PxShape, PxArticulationJoint, PxVehicleDrive, PxD6Joint, PxRigidDynamic, PxMaterial, PxRevoluteJoint, PxVehicleDrive4W, PxVehicleDriveTank, PxConstraint, PxHeightField, PxDistanceJoint, PxVehicleDriveNW, PxPrismaticJoint, PxVehicleNoDrive, PxAggregate, PxSphericalJoint, PxConvexMesh, PxContactJoint, PxFixedJoint, PxArticulationLink, PxBVHStructure, PxPruningStructure, PxArticulationJointReducedCoordinate, and PxRigidStatic.

is() [1/2]

template<class T >

T* PxBase::is ( )

inline

is() [2/2]

template<class T >

const T* PxBase::is ( ) const

inline

isKindOf()

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

inlineprotectedvirtual

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

Reimplemented in PxVehicleWheels, PxRigidBody, PxShape, PxArticulationJoint, PxVehicleDrive, PxD6Joint, PxRigidDynamic, PxJoint, PxRevoluteJoint, PxActor, PxMaterial, PxBVH34TriangleMesh, PxBVH33TriangleMesh, PxTriangleMesh, PxConstraint, PxVehicleDriveTank, PxVehicleDrive4W, PxDistanceJoint, PxHeightField, PxRigidActor, PxPrismaticJoint, PxVehicleDriveNW, PxSphericalJoint, PxAggregate, PxVehicleNoDrive, PxConvexMesh, PxArticulationJointBase, PxContactJoint, PxFixedJoint, PxArticulationLink, PxBVHStructure, PxPruningStructure, PxArticulationJointReducedCoordinate, and PxRigidStatic.

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

isReleasable()

virtual bool 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

References PxBaseFlag::eIS_RELEASABLE.

release()

virtual void PxBase::release ( )

pure virtual

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

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

setBaseFlag()

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

setBaseFlags()

PX_FORCE_INLINE void PxBase::setBaseFlags ( PxBaseFlags  inFlags )

inline

Set PxBaseFlags.

Parameters

[in]

inFlags

The flags to be set

See also

PxBaseFlags

typeMatch()

template<class T >

bool PxBase::typeMatch ( ) const

inlineprotected

References PxConcreteType::eUNDEFINED.

Friends And Related Function Documentation

getBinaryMetaData_PxBase

void getBinaryMetaData_PxBase ( PxOutputStream &  stream )

friend

Member Data Documentation

mBaseFlags

PxBaseFlags PxBase::mBaseFlags

protected

mConcreteType

PxType PxBase::mConcreteType

protected

---

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

• PxBase.h