NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBase Class Reference

NVIDIA PhysX SDK 3.4 API

PxBase Class Reference
[Common]

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

#include <PxBase.h>

Inheritance diagram for PxBase:
Collaboration diagram for PxBase:

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

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

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

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]


Friends And Related Function Documentation

void getBinaryMetaData_PxBase ( PxOutputStream stream  )  [friend]


Member Data Documentation


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



Copyright © 2008-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com