UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Friends | List of all members
Chaos::FKinematicTarget Class Reference

#include <KinematicTargets.h>

Public Member Functions

 FKinematicTarget ()
 
bool IsSet () const
 
EKinematicTargetMode GetMode () const
 
FRigidTransform3 GetTarget () const
 
FVec3 GetTargetPosition () const
 
FRotation3 GetTargetRotation () const
 
FRigidTransform3 GetTransform () const
 
FVec3 GetPosition () const
 
FRotation3f GetRotation () const
 
void Clear ()
 
void SetTargetMode (const FVec3 &X, const FRotation3f &R)
 
void SetTargetMode (const FRigidTransform3 &InTarget)
 
void SetVelocityMode ()
 
void SetMode (EKinematicTargetMode InMode)
 
bool IsEqual (const FKinematicTarget &other) const
 
template<typename TOther >
bool IsEqual (const TOther &other) const
 
bool operator== (const FKinematicTarget &other) const
 
template<typename TOther >
void CopyFrom (const TOther &Other)
 

Static Public Member Functions

static FKinematicTarget MakePositionTarget (const FRigidTransform3 &InTransform)
 
static FKinematicTarget MakePositionTarget (const FVec3 &InPosition, const FRotation3f &InRotation)
 
static FKinematicTarget ZeroValue ()
 

Friends

FChaosArchive & operator<< (FChaosArchive &Ar, FKinematicTarget &KinematicTarget)
 

Detailed Description

Data used to integrate kinematic bodies

Constructor & Destructor Documentation

◆ FKinematicTarget()

Chaos::FKinematicTarget::FKinematicTarget ( )
inline

Member Function Documentation

◆ Clear()

void Chaos::FKinematicTarget::Clear ( )
inline

Clear the kinematic target

◆ CopyFrom()

template<typename TOther >
void Chaos::FKinematicTarget::CopyFrom ( const TOther &  Other)
inline

◆ GetMode()

EKinematicTargetMode Chaos::FKinematicTarget::GetMode ( ) const
inline

Get the kinematic target mode

◆ GetPosition()

FVec3 Chaos::FKinematicTarget::GetPosition ( ) const
inline

Get the target position (asserts if not in Position mode)

◆ GetRotation()

FRotation3f Chaos::FKinematicTarget::GetRotation ( ) const
inline

Get the target rotation (asserts if not in Position mode)

◆ GetTarget()

FRigidTransform3 Chaos::FKinematicTarget::GetTarget ( ) const
inline

Get the target transform (asserts if not in Position mode)

◆ GetTargetPosition()

FVec3 Chaos::FKinematicTarget::GetTargetPosition ( ) const
inline

Get the target position (asserts if not in Position mode)

◆ GetTargetRotation()

FRotation3 Chaos::FKinematicTarget::GetTargetRotation ( ) const
inline

Get the target rotation (asserts if not in Position mode)

◆ GetTransform()

FRigidTransform3 Chaos::FKinematicTarget::GetTransform ( ) const
inline

Get the target transform (asserts if not in Position mode)

◆ IsEqual() [1/2]

bool Chaos::FKinematicTarget::IsEqual ( const FKinematicTarget &  other) const
inline

◆ IsEqual() [2/2]

template<typename TOther >
bool Chaos::FKinematicTarget::IsEqual ( const TOther &  other) const
inline

◆ IsSet()

bool Chaos::FKinematicTarget::IsSet ( ) const
inline

Whether this kinematic target has been set (either velocity or position mode)

◆ MakePositionTarget() [1/2]

static FKinematicTarget Chaos::FKinematicTarget::MakePositionTarget ( const FRigidTransform3 &  InTransform)
inlinestatic

◆ MakePositionTarget() [2/2]

static FKinematicTarget Chaos::FKinematicTarget::MakePositionTarget ( const FVec3 &  InPosition,
const FRotation3f &  InRotation 
)
inlinestatic

◆ operator==()

bool Chaos::FKinematicTarget::operator== ( const FKinematicTarget &  other) const
inline

◆ SetMode()

void Chaos::FKinematicTarget::SetMode ( EKinematicTargetMode  InMode)
inline

◆ SetTargetMode() [1/2]

void Chaos::FKinematicTarget::SetTargetMode ( const FRigidTransform3 &  InTarget)
inline

Use transform target mode and set the transform target

◆ SetTargetMode() [2/2]

void Chaos::FKinematicTarget::SetTargetMode ( const FVec3 &  X,
const FRotation3f &  R 
)
inline

Use transform target mode and set the transform target

◆ SetVelocityMode()

void Chaos::FKinematicTarget::SetVelocityMode ( )
inline

Use velocity target mode

◆ ZeroValue()

static FKinematicTarget Chaos::FKinematicTarget::ZeroValue ( )
inlinestatic

Friends And Related Symbol Documentation

◆ operator<<

FChaosArchive & operator<< ( FChaosArchive &  Ar,
FKinematicTarget &  KinematicTarget 
)
friend
The documentation for this class was generated from the following file: