Chaos::FPBDCollisionConstraintHandle Class Reference

A handle to a contact constraint. More...

#include <PBDCollisionConstraintHandle.h>

Inheritance diagram for Chaos::FPBDCollisionConstraintHandle:

Public Types
using	Base = TIntrusiveConstraintHandle< FPBDCollisionConstraint >
using	FImplicitPair = TPair< const FImplicitObject *, const FImplicitObject * >
using	FGeometryPair = TPair< const TGeometryParticleHandle< FReal, 3 > *, const TGeometryParticleHandle< FReal, 3 > * >
using	FHandleKey = TPair< FImplicitPair, FGeometryPair >
Public Types inherited from Chaos::TIntrusiveConstraintHandle< FPBDCollisionConstraint >
using	FConstraint = FPBDCollisionConstraint
Public Types inherited from Chaos::FConstraintHandle
using	FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >

Public Member Functions
	FPBDCollisionConstraintHandle ()
const FPBDCollisionConstraint &	GetContact () const
FPBDCollisionConstraint &	GetContact ()
const FPBDCollisionConstraint &	GetPointContact () const
FPBDCollisionConstraint &	GetPointContact ()
const FPBDCollisionConstraint &	GetSweptPointContact () const
FPBDCollisionConstraint &	GetSweptPointContact ()
bool	GetCCDEnabled () const
virtual void	SetEnabled (bool InEnabled) override final
virtual bool	IsEnabled () const override final
virtual bool	IsProbe () const override final
FVec3	GetAccumulatedImpulse () const
virtual FParticlePair	GetConstrainedParticles () const override final
const FPBDCollisionConstraints *	ConcreteContainer () const
FPBDCollisionConstraints *	ConcreteContainer ()
Public Member Functions inherited from Chaos::TIntrusiveConstraintHandle< FPBDCollisionConstraint >
	TIntrusiveConstraintHandle ()
void	SetContainer (FPBDConstraintContainer *InContainer)
FConstraint *	GetConstraint ()
const FConstraint *	GetConstraint () const
Public Member Functions inherited from Chaos::FIntrusiveConstraintHandle
	FIntrusiveConstraintHandle ()
void	SetContainer (FPBDConstraintContainer *InContainer)
Public Member Functions inherited from Chaos::FConstraintHandle
	FConstraintHandle ()
	FConstraintHandle (FPBDConstraintContainer *InContainer)
virtual	~FConstraintHandle ()
virtual bool	IsValid () const
FPBDConstraintContainer *	GetContainer ()
const FPBDConstraintContainer *	GetContainer () const
bool	IsInConstraintGraph () const
Private::FPBDIslandConstraint *	GetConstraintGraphEdge () const
void	SetConstraintGraphEdge (Private::FPBDIslandConstraint *InEdge)
virtual bool	SupportsSleeping () const
virtual bool	SupportsPartialIslandSleeping () const
virtual bool	IsSleeping () const
virtual void	SetIsSleeping (const bool bInIsSleeping)
virtual FVec3f	GetNetLinearImpulse () const
virtual bool	WasAwakened () const
virtual void	SetWasAwakened (const bool bInWasAwakened)
int32	GetContainerId () const
template<typename T >
T *	As ()
template<typename T >
const T *	As () const
template<typename T >
T *	AsUnsafe ()
template<typename T >
const T *	AsUnsafe () const
const FConstraintHandleTypeID &	GetType () const
	UE_DEPRECATED (5.3, "Use GetConstraintGraphEdge") int32 GetConstraintGraphIndex() const
	UE_DEPRECATED (5.3, "Not supported") void SetConstraintGraphIndex(const int32 InIndex) const

Static Public Member Functions
static CHAOS_API const FConstraintHandleTypeID &	StaticType ()
Static Public Member Functions inherited from Chaos::FIntrusiveConstraintHandle
static const FConstraintHandleTypeID &	StaticType ()
Static Public Member Functions inherited from Chaos::FConstraintHandle
static const FConstraintHandleTypeID &	StaticType ()
static const FConstraintHandleTypeID &	InvalidType ()

Additional Inherited Members
Protected Attributes inherited from Chaos::FConstraintHandle
FPBDConstraintContainer *	ConstraintContainer
Private::FPBDIslandConstraint *	GraphEdge

Detailed Description

A handle to a contact constraint.

Note

This is an intrusive handle, so you can use a contact pointer as a handle.

Member Typedef Documentation

Base

using Chaos::FPBDCollisionConstraintHandle::Base = TIntrusiveConstraintHandle<FPBDCollisionConstraint>

FGeometryPair

using Chaos::FPBDCollisionConstraintHandle::FGeometryPair = TPair<const TGeometryParticleHandle<FReal, 3>*, const TGeometryParticleHandle<FReal, 3>*>

FHandleKey

using Chaos::FPBDCollisionConstraintHandle::FHandleKey = TPair<FImplicitPair, FGeometryPair>

FImplicitPair

using Chaos::FPBDCollisionConstraintHandle::FImplicitPair = TPair<const FImplicitObject*, const FImplicitObject*>

Constructor & Destructor Documentation

FPBDCollisionConstraintHandle()

Chaos::FPBDCollisionConstraintHandle::FPBDCollisionConstraintHandle ( )

inline

Member Function Documentation

ConcreteContainer() [1/2]

FPBDCollisionConstraints * Chaos::FPBDCollisionConstraintHandle::ConcreteContainer ( )

inline

ConcreteContainer() [2/2]

const FPBDCollisionConstraints * Chaos::FPBDCollisionConstraintHandle::ConcreteContainer ( ) const

inline

GetAccumulatedImpulse()

FVec3 Chaos::FPBDCollisionConstraintHandle::GetAccumulatedImpulse ( ) const

inline

GetCCDEnabled()

bool Chaos::FPBDCollisionConstraintHandle::GetCCDEnabled ( ) const

inline

GetConstrainedParticles()

FParticlePair Chaos::FPBDCollisionConstraintHandle::GetConstrainedParticles ( ) const

inlinefinaloverridevirtual

Implements Chaos::FConstraintHandle.

GetContact() [1/2]

FPBDCollisionConstraint & Chaos::FPBDCollisionConstraintHandle::GetContact ( )

inline

GetContact() [2/2]

const FPBDCollisionConstraint & Chaos::FPBDCollisionConstraintHandle::GetContact ( ) const

inline

GetPointContact() [1/2]

FPBDCollisionConstraint & Chaos::FPBDCollisionConstraintHandle::GetPointContact ( )

inline

GetPointContact() [2/2]

const FPBDCollisionConstraint & Chaos::FPBDCollisionConstraintHandle::GetPointContact ( ) const

inline

GetSweptPointContact() [1/2]

FPBDCollisionConstraint & Chaos::FPBDCollisionConstraintHandle::GetSweptPointContact ( )

inline

GetSweptPointContact() [2/2]

const FPBDCollisionConstraint & Chaos::FPBDCollisionConstraintHandle::GetSweptPointContact ( ) const

inline

IsEnabled()

bool Chaos::FPBDCollisionConstraintHandle::IsEnabled ( ) const

inlinefinaloverridevirtual

Implements Chaos::FConstraintHandle.

IsProbe()

bool Chaos::FPBDCollisionConstraintHandle::IsProbe ( ) const

inlinefinaloverridevirtual

Reimplemented from Chaos::FConstraintHandle.

SetEnabled()

void Chaos::FPBDCollisionConstraintHandle::SetEnabled ( bool  InEnabled )

inlinefinaloverridevirtual

Implements Chaos::FConstraintHandle.

StaticType()

const FConstraintHandleTypeID & Chaos::FPBDCollisionConstraintHandle::StaticType ( )

static

---

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

• Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Collision/PBDCollisionConstraintHandle.h
• Engine/Source/Runtime/Experimental/Chaos/Private/Chaos/Collision/PBDCollisionConstraintHandle.cpp
• Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDCollisionConstraints.h