Inheritance diagram for physx::NpArticulationSensor:

Collaboration diagram for physx::NpArticulationSensor:

Public Member Functions
	NpArticulationSensor (PxBaseFlags baseFlags)

void	preExportDataReset ()

virtual void	exportExtraData (PxSerializationContext &)

void	importExtraData (PxDeserializationContext &)

void	resolveReferences (PxDeserializationContext &)

virtual void	requiresObjects (PxProcessPxBaseCallback &)

virtual bool	isSubordinate () const

	NpArticulationSensor (PxArticulationLink *link, const PxTransform &relativePose)

virtual void	release ()
	Releases the sensor.

virtual PxSpatialForce	getForces () const
	Returns the spatial force in the local frame of the sensor.

virtual PxTransform	getRelativePose () const
	Returns the relative pose between this sensor and the body frame of the link that the sensor is attached to.

virtual void	setRelativePose (const PxTransform &)
	Sets the relative pose between this sensor and the body frame of the link that the sensor is attached to.

virtual PxArticulationLink *	getLink () const
	Returns the link that this sensor is attached to.

virtual PxU32	getIndex () const
	Returns the index of this sensor inside the articulation.

virtual PxArticulationReducedCoordinate *	getArticulation () const
	Returns the articulation that this sensor is part of.

virtual PxArticulationSensorFlags	getFlags () const
	Returns the sensor's flags.

virtual void	setFlag (PxArticulationSensorFlag::Enum flag, bool enabled)
	Sets a flag of the sensor.

PX_FORCE_INLINE Sc::ArticulationSensorCore &	getSensorCore ()

PX_FORCE_INLINE const Sc::ArticulationSensorCore &	getSensorCore () const

PX_FORCE_INLINE ArticulationSensorHandle	getHandle ()

PX_FORCE_INLINE void	setHandle (ArticulationSensorHandle handle)

Public Member Functions inherited from physx::PxArticulationSensor
virtual const char *	getConcreteTypeName () const
	Returns the string name of the dynamic type.

Public Member Functions inherited from physx::PxBase
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 Member Functions inherited from physx::NpBase
	NpBase (const PxEMPTY)

	NpBase (NpType::Enum type)

PX_INLINE bool	isAPIWriteForbidden () const

PX_INLINE bool	isAPIWriteForbiddenExceptSplitSim () const

PX_FORCE_INLINE NpType::Enum	getNpType () const

PX_FORCE_INLINE void	setNpScene (NpScene *scene)

PX_FORCE_INLINE NpScene *	getNpScene () const

PX_FORCE_INLINE PxU32	getBaseIndex () const

PX_FORCE_INLINE void	setBaseIndex (PxU32 index)

Public Member Functions inherited from physx::PxUserAllocated
PX_INLINE void *	operator new (size_t, void *address)

PX_INLINE void	operator delete (void , void )

template<typename Alloc >
PX_INLINE void *	operator new (size_t size, Alloc alloc, const char *fileName, int line)

template<typename Alloc >
PX_INLINE void *	operator new (size_t size, size_t, Alloc alloc, const char *fileName, int line)

template<typename Alloc >
PX_INLINE void *	operator new[] (size_t size, Alloc alloc, const char *fileName, int line)

template<typename Alloc >
PX_INLINE void *	operator new[] (size_t size, size_t, Alloc alloc, const char *fileName, int line)

template<typename Alloc >
PX_INLINE void	operator delete (void ptr, Alloc alloc, const char fileName, int line)

template<typename Alloc >
PX_INLINE void	operator delete[] (void ptr, Alloc alloc, const char fileName, int line)

PX_INLINE void	operator delete (void *ptr)

PX_INLINE void	operator delete[] (void *ptr)

Static Public Member Functions
static NpArticulationSensor *	createObject (PxU8 *&address, PxDeserializationContext &context)

static void	getBinaryMetaData (PxOutputStream &stream)

Static Public Member Functions inherited from physx::NpBase
static void	getBinaryMetaData (PxOutputStream &stream)

Additional Inherited Members
Public Attributes inherited from physx::PxArticulationSensor
void *	userData
	user can assign this to whatever, usually to create a 1:1 relationship with a user object.

Protected Member Functions inherited from physx::PxArticulationSensor
PX_INLINE	PxArticulationSensor (PxType concreteType, PxBaseFlags baseFlags)

PX_INLINE	PxArticulationSensor (PxBaseFlags baseFlags)

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.

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 inherited from physx::PxBase
PxType	mConcreteType

PxBaseFlags	mBaseFlags

PxU32	mBuiltInRefCount

Protected Attributes inherited from physx::NpBase
PxU32	mFreeSlot

Member Function Documentation

◆ getArticulation()

PxArticulationReducedCoordinate * physx::NpArticulationSensor::getArticulation ( ) const

virtual

Returns the articulation that this sensor is part of.

Returns: A pointer to the articulation.

Implements physx::PxArticulationSensor.

◆ getFlags()

PxArticulationSensorFlags physx::NpArticulationSensor::getFlags ( ) const

virtual

Returns the sensor's flags.

Returns: The current set of flags of the sensor.

See also: PxArticulationSensorFlag

Implements physx::PxArticulationSensor.

◆ getForces()

PxSpatialForce physx::NpArticulationSensor::getForces ( ) const

virtual

Returns the spatial force in the local frame of the sensor.

Returns: The spatial force.

Note: This call is not allowed while the simulation is running except in a split simulation during PxScene::collide() and up to PxScene::advance(), and in PxContactModifyCallback or in contact report callbacks.

See also: setRelativePose, getRelativePose

Implements physx::PxArticulationSensor.

◆ getIndex()

PxU32 physx::NpArticulationSensor::getIndex ( ) const

virtual

Returns the index of this sensor inside the articulation.

The return value is only valid for sensors attached to articulations that are in a scene.

Returns: The low-level index, or 0xFFFFFFFF if the articulation is not in a scene.

Implements physx::PxArticulationSensor.

◆ getLink()

PxArticulationLink * physx::NpArticulationSensor::getLink ( ) const

virtual

Returns the link that this sensor is attached to.

Returns: A pointer to the link.

Implements physx::PxArticulationSensor.

◆ getRelativePose()

PxTransform physx::NpArticulationSensor::getRelativePose ( ) const

virtual

Returns the relative pose between this sensor and the body frame of the link that the sensor is attached to.

The link body frame is at the center of mass and aligned with the principal axes of inertia, see PxRigidBody::getCMassLocalPose.

Returns: The transform link body frame -> sensor frame.

See also: setRelativePose

Implements physx::PxArticulationSensor.

◆ release()

void physx::NpArticulationSensor::release ( )

virtual

Releases the sensor.

Note: Releasing a sensor is not allowed while the articulation is in a scene. In order to release a sensor, remove and then re-add the articulation to the scene.

Implements physx::PxArticulationSensor.

◆ setFlag()

void physx::NpArticulationSensor::setFlag	(	PxArticulationSensorFlag::Enum	flag,
		bool	enabled
	)

virtual

Sets a flag of the sensor.

Parameters

[in]	flag	The flag to set.
[in]	enabled	The value to set the flag to.

Note: Setting the sensor flags is not allowed while the articulation is in a scene. In order to set the flags, remove and then re-add the articulation to the scene.

See also: PxArticulationSensorFlag

Implements physx::PxArticulationSensor.

◆ setRelativePose()

void physx::NpArticulationSensor::setRelativePose ( const PxTransform & pose )

virtual

Sets the relative pose between this sensor and the body frame of the link that the sensor is attached to.

The link body frame is at the center of mass and aligned with the principal axes of inertia, see PxRigidBody::getCMassLocalPose.

Parameters

[in] pose The transform link body frame -> sensor frame.

Note: Setting the sensor relative pose is not allowed while the articulation is in a scene. In order to set the pose, remove and then re-add the articulation to the scene.

See also: getRelativePose

Implements physx::PxArticulationSensor.

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

RavEngine/deps/physx/physx/source/physx/src/NpArticulationSensor.h
RavEngine/deps/physx/physx/source/physx/src/NpArticulationSensor.cpp
RavEngine/deps/physx/physx/source/physx/src/NpMetaData.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getArticulation()

◆ getFlags()

◆ getForces()

◆ getIndex()

◆ getLink()

◆ getRelativePose()

◆ release()

◆ setFlag()

◆ setRelativePose()