PxActor is the base class for the main simulation objects in the physics SDK. More...

#include <PxActor.h>

Inheritance diagram for physx::PxActor:

Collaboration diagram for physx::PxActor:

Public Member Functions
virtual void	release ()=0
	Deletes the actor.

virtual PxActorType::Enum	getType () const =0
	Retrieves the type of actor.

virtual PxScene *	getScene () const =0
	Retrieves the scene which this actor belongs to.

virtual void	setName (const char *name)=0
	Sets a name string for the object that can be retrieved with getName().

virtual const char *	getName () const =0
	Retrieves the name string set with setName().

virtual PxBounds3	getWorldBounds (float inflation=1.01f) const =0
	Retrieves the axis aligned bounding box enclosing the actor.

virtual void	setActorFlag (PxActorFlag::Enum flag, bool value)=0
	Raises or clears a particular actor flag.

virtual void	setActorFlags (PxActorFlags inFlags)=0
	Sets the actor flags.

virtual PxActorFlags	getActorFlags () const =0
	Reads the PxActor flags.

virtual void	setDominanceGroup (PxDominanceGroup dominanceGroup)=0
	Assigns dynamic actors a dominance group identifier.

virtual PxDominanceGroup	getDominanceGroup () const =0
	Retrieves the value set with setDominanceGroup().

virtual void	setOwnerClient (PxClientID inClient)=0
	Sets the owner client of an actor.

virtual PxClientID	getOwnerClient () const =0
	Returns the owner client that was specified at creation time.

virtual PxAggregate *	getAggregate () const =0
	Retrieves the aggregate the actor might be a part of.

Public Member Functions inherited from physx::PxBase
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.

Public Attributes
void *	userData
	user can assign this to whatever, usually to create a 1:1 relationship with a user object.

Protected Member Functions
PX_INLINE	PxActor (PxType concreteType, PxBaseFlags baseFlags)

PX_INLINE	PxActor (PxBaseFlags baseFlags)

virtual bool	isKindOf (const char *name) const
	Returns whether a given type name matches with the type of this instance.

Protected Member Functions inherited from physx::PxBase
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.

template<class T >
bool	typeMatch () const

Additional Inherited Members
Protected Attributes inherited from physx::PxBase
PxType	mConcreteType

PxBaseFlags	mBaseFlags

PxU32	mBuiltInRefCount

Detailed Description

PxActor is the base class for the main simulation objects in the physics SDK.

The actor is owned by and contained in a PxScene.

Member Function Documentation

◆ getActorFlags()

virtual PxActorFlags physx::PxActor::getActorFlags ( ) const

pure virtual

Reads the PxActor flags.

See the list of flags #PxActorFlag

Returns: The values of the PxActor flags.

See also: PxActorFlag setActorFlag()

◆ getAggregate()

virtual PxAggregate * physx::PxActor::getAggregate ( ) const

pure virtual

Retrieves the aggregate the actor might be a part of.

Returns: The aggregate the actor is a part of, or NULL if the actor does not belong to an aggregate.

See also: PxAggregate

◆ getDominanceGroup()

virtual PxDominanceGroup physx::PxActor::getDominanceGroup ( ) const

pure virtual

Retrieves the value set with setDominanceGroup().

Returns: The dominance group of this actor.

See also: setDominanceGroup() PxDominanceGroup PxScene::setDominanceGroupPair()

◆ getName()

virtual const char * physx::PxActor::getName ( ) const

pure virtual

Retrieves the name string set with setName().

Returns: Name string associated with object.

See also: setName()

Implemented in physx::NpSoftBody.

◆ getOwnerClient()

virtual PxClientID physx::PxActor::getOwnerClient ( ) const

pure virtual

Returns the owner client that was specified at creation time.

This value cannot be changed once the object is placed into the scene.

See also: PxClientID PxScene::createClient()

◆ getScene()

virtual PxScene * physx::PxActor::getScene ( ) const

pure virtual

Retrieves the scene which this actor belongs to.

Returns: Owner Scene. NULL if not part of a scene.

See also: PxScene

◆ getType()

virtual PxActorType::Enum physx::PxActor::getType ( ) const

pure virtual

Retrieves the type of actor.

Returns: The actor type of the actor.

See also: PxActorType

Implemented in physx::NpSoftBody.

◆ getWorldBounds()

virtual PxBounds3 physx::PxActor::getWorldBounds ( float inflation = 1.01f ) const

pure virtual

Retrieves the axis aligned bounding box enclosing the actor.

Note: It is not allowed to use this method while the simulation is running (except during PxScene::collide(), in PxContactModifyCallback or in contact report callbacks).

Parameters

[in] inflation Scale factor for computed world bounds. Box extents are multiplied by this value.

Returns: The actor's bounding box.

See also: PxBounds3

Implemented in physx::NpSoftBody, and physx::PxSoftBody.

◆ isKindOf()

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

inlineprotectedvirtual

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

Reimplemented from physx::PxBase.

Reimplemented in physx::PxArticulationLink, physx::PxRigidActor, physx::PxRigidBody, physx::PxRigidDynamic, physx::PxRigidStatic, physx::PxParticleSystem, physx::PxPBDParticleSystem, and physx::PxSoftBody.

◆ release()

virtual void physx::PxActor::release ( )

pure virtual

Deletes the actor.

Do not keep a reference to the deleted instance.

If the actor belongs to a #PxAggregate object, it is automatically removed from the aggregate.

See also: PxBase.release(), PxAggregate

Implements physx::PxBase.

Implemented in physx::NpSoftBody, physx::PxArticulationLink, physx::PxRigidActor, and physx::PxSoftBody.

◆ setActorFlag()

virtual void physx::PxActor::setActorFlag	(	PxActorFlag::Enum	flag,
		bool	value
	)

pure virtual

Raises or clears a particular actor flag.

See the list of flags #PxActorFlag

Sleeping: Does NOT wake the actor up automatically.

Parameters

[in]	flag	The PxActor flag to raise(set) or clear. See #PxActorFlag.
[in]	value	The boolean value to assign to the flag.

See also: PxActorFlag getActorFlags()

◆ setActorFlags()

virtual void physx::PxActor::setActorFlags ( PxActorFlags inFlags )

pure virtual

Sets the actor flags.

See the list of flags #PxActorFlag

See also: PxActorFlag setActorFlag()

◆ setDominanceGroup()

virtual void physx::PxActor::setDominanceGroup ( PxDominanceGroup dominanceGroup )

pure virtual

Assigns dynamic actors a dominance group identifier.

PxDominanceGroup is a 5 bit group identifier (legal range from 0 to 31).

The PxScene::setDominanceGroupPair() lets you set certain behaviors for pairs of dominance groups. By default every dynamic actor is created in group 0.

Default: 0

Sleeping: Changing the dominance group does NOT wake the actor up automatically.

Parameters

[in] dominanceGroup The dominance group identifier. Range: [0..31]

See also: getDominanceGroup() PxDominanceGroup PxScene::setDominanceGroupPair()

◆ setName()

virtual void physx::PxActor::setName ( const char * name )

pure virtual

Sets a name string for the object that can be retrieved with getName().

This is for debugging and is not used by the SDK. The string is not copied by the SDK, only the pointer is stored.

Parameters

[in] name String to set the objects name to.

Default: NULL

See also: getName()

Implemented in physx::NpSoftBody.

◆ setOwnerClient()

virtual void physx::PxActor::setOwnerClient ( PxClientID inClient )

pure virtual

Sets the owner client of an actor.

This cannot be done once the actor has been placed into a scene.

Default: PX_DEFAULT_CLIENT

See also: PxClientID PxScene::createClient()

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

RavEngine/deps/physx/physx/include/PxActor.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getActorFlags()

◆ getAggregate()

◆ getDominanceGroup()

◆ getName()

◆ getOwnerClient()

◆ getScene()

◆ getType()

◆ getWorldBounds()

◆ isKindOf()

◆ release()

◆ setActorFlag()

◆ setActorFlags()

◆ setDominanceGroup()

◆ setName()

◆ setOwnerClient()