#include <PBDRigidSpringConstraints.h>

Inheritance diagram for Chaos::FPBDRigidSpringConstraintHandle:

Public Types
using	Base = TIndexedContainerConstraintHandle< FPBDRigidSpringConstraints >

using	FConstraintContainer = FPBDRigidSpringConstraints

using	FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >

Public Types inherited from Chaos::TIndexedContainerConstraintHandle< FPBDRigidSpringConstraints >
using	Base = FIndexedConstraintHandle

using	FGeometryParticleHandle = typename Base::FGeometryParticleHandle

using	FConstraintContainer = FPBDRigidSpringConstraints

Public Types inherited from Chaos::FIndexedConstraintHandle
using	FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >

Public Types inherited from Chaos::FConstraintHandle
using	FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >

Public Member Functions
	FPBDRigidSpringConstraintHandle ()

	FPBDRigidSpringConstraintHandle (FConstraintContainer *InConstraintContainer, int32 InConstraintIndex)

CHAOS_API const TVector< FVec3, 2 > &	GetConstraintPositions () const

CHAOS_API void	SetConstraintPositions (const TVector< FVec3, 2 > &ConstraintPositions)

virtual CHAOS_API FParticlePair	GetConstrainedParticles () const override final

CHAOS_API FReal	GetRestLength () const

CHAOS_API void	SetRestLength (const FReal SpringLength)

Public Member Functions inherited from Chaos::TIndexedContainerConstraintHandle< FPBDRigidSpringConstraints >
	TIndexedContainerConstraintHandle ()

	TIndexedContainerConstraintHandle (FConstraintContainer *InConstraintContainer, int32 InConstraintIndex)

virtual void	SetEnabled (bool bInEnabled) override

virtual bool	IsEnabled () const override

void	RemoveConstraint ()

Public Member Functions inherited from Chaos::FIndexedConstraintHandle
	FIndexedConstraintHandle ()

	FIndexedConstraintHandle (FPBDConstraintContainer *InContainer, int32 InConstraintIndex)

virtual	~FIndexedConstraintHandle ()

virtual bool	IsValid () const override

int32	GetConstraintIndex () const

void	SetConstraintIndex (const int32 InConstraintIndex)

Public Member Functions inherited from Chaos::FConstraintHandle
	FConstraintHandle ()

	FConstraintHandle (FPBDConstraintContainer *InContainer)

virtual	~FConstraintHandle ()

FPBDConstraintContainer *	GetContainer ()

const FPBDConstraintContainer *	GetContainer () const

bool	IsInConstraintGraph () const

Private::FPBDIslandConstraint *	GetConstraintGraphEdge () const

void	SetConstraintGraphEdge (Private::FPBDIslandConstraint *InEdge)

virtual bool	IsProbe () const

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 const FConstraintHandleTypeID &	StaticType ()

Static Public Member Functions inherited from Chaos::FIndexedConstraintHandle
static const FConstraintHandleTypeID &	StaticType ()

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

static const FConstraintHandleTypeID &	InvalidType ()

Additional Inherited Members
Protected Member Functions inherited from Chaos::TIndexedContainerConstraintHandle< FPBDRigidSpringConstraints >
FConstraintContainer *	ConcreteContainer ()

const FConstraintContainer *	ConcreteContainer () const

Protected Attributes inherited from Chaos::TIndexedContainerConstraintHandle< FPBDRigidSpringConstraints >
int32	ConstraintIndex

Protected Attributes inherited from Chaos::FIndexedConstraintHandle
int32	ConstraintIndex

Protected Attributes inherited from Chaos::FConstraintHandle
FPBDConstraintContainer *	ConstraintContainer

Private::FPBDIslandConstraint *	GraphEdge

Member Typedef Documentation

◆ Base

using Chaos::FPBDRigidSpringConstraintHandle::Base = TIndexedContainerConstraintHandle<FPBDRigidSpringConstraints>

◆ FConstraintContainer

using Chaos::FPBDRigidSpringConstraintHandle::FConstraintContainer = FPBDRigidSpringConstraints

◆ FGeometryParticleHandle

using Chaos::FPBDRigidSpringConstraintHandle::FGeometryParticleHandle = TGeometryParticleHandle<FReal, 3>

Constructor & Destructor Documentation

◆ FPBDRigidSpringConstraintHandle() [1/2]

Chaos::FPBDRigidSpringConstraintHandle::FPBDRigidSpringConstraintHandle ( )

inline

◆ FPBDRigidSpringConstraintHandle() [2/2]

Chaos::FPBDRigidSpringConstraintHandle::FPBDRigidSpringConstraintHandle	(	FConstraintContainer *	InConstraintContainer,
		int32	InConstraintIndex
	)

inline

Member Function Documentation

◆ GetConstrainedParticles()

FParticlePair Chaos::FPBDRigidSpringConstraintHandle::GetConstrainedParticles ( ) const

finaloverridevirtual

Implements Chaos::FConstraintHandle.

◆ GetConstraintPositions()

const TVector< FVec3, 2 > & Chaos::FPBDRigidSpringConstraintHandle::GetConstraintPositions ( ) const

◆ GetRestLength()

FReal Chaos::FPBDRigidSpringConstraintHandle::GetRestLength ( ) const

◆ SetConstraintPositions()

void Chaos::FPBDRigidSpringConstraintHandle::SetConstraintPositions ( const TVector< FVec3, 2 > & ConstraintPositions )

◆ SetRestLength()

void Chaos::FPBDRigidSpringConstraintHandle::SetRestLength ( const FReal SpringLength )

◆ StaticType()

static const FConstraintHandleTypeID & Chaos::FPBDRigidSpringConstraintHandle::StaticType ( )

inlinestatic

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

Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDRigidSpringConstraints.h
Engine/Source/Runtime/Experimental/Chaos/Private/Chaos/PBDRigidSpringConstraints.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members