UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
Chaos::TCorePlane< T, d > Class Template Reference

#include <CorePlane.h>

Public Member Functions

 TCorePlane ()=default
 
 TCorePlane (const TVec3< T > &InX, const TVec3< T > &InNormal)
 
template<typename U >
U SignedDistance (const TVec3< U > &x) const
 
FReal PhiWithNormal (const FVec3 &x, FVec3 &Normal) const
 
FVec3 FindClosestPoint (const FVec3 &x, const FReal Thickness=(FReal) 0) const
 
bool Raycast (const FVec3 &StartPoint, const FVec3 &Dir, const FReal Length, const FReal Thickness, FReal &OutTime, FVec3 &OutPosition, FVec3 &OutNormal, int32 &OutFaceIndex) const
 
Pair< FVec3, bool > FindClosestIntersection (const FVec3 &StartPoint, const FVec3 &EndPoint, const FReal Thickness) const
 
const TVec3< T > & X () const
 
const TVec3< T > & Normal () const
 
const TVec3< T > & Normal (const TVec3< T > &) const
 
FORCEINLINE void Serialize (FArchive &Ar)
 
uint32 GetTypeHash () const
 

Static Public Member Functions

static TCorePlane< T > MakeScaledSafe (const TCorePlane< T > &Plane, const TVec3< T > &Scale)
 
template<typename U >
static FORCEINLINE TCorePlane< T > MakeScaledUnsafe (const TCorePlane< U > &Plane, const TVec3< T > &Scale, const TVec3< T > &InvScale)
 
template<typename U >
static FORCEINLINE void MakeScaledUnsafe (const TVec3< U > &PlaneN, const TVec3< U > &PlaneX, const TVec3< T > &Scale, const TVec3< T > &InvScale, TVec3< T > &OutN, TVec3< T > &OutX)
 
template<typename U >
static FORCEINLINE TCorePlane< T > MakeFrom (const TCorePlane< U > &Plane)
 

Constructor & Destructor Documentation

◆ TCorePlane() [1/2]

template<typename T , int d = 3>
Chaos::TCorePlane< T, d >::TCorePlane ( )
default

◆ TCorePlane() [2/2]

template<typename T , int d = 3>
Chaos::TCorePlane< T, d >::TCorePlane ( const TVec3< T > &  InX,
const TVec3< T > &  InNormal 
)
inline

Member Function Documentation

◆ FindClosestIntersection()

template<typename T , int d = 3>
Pair< FVec3, bool > Chaos::TCorePlane< T, d >::FindClosestIntersection ( const FVec3 &  StartPoint,
const FVec3 &  EndPoint,
const FReal  Thickness 
) const
inline

◆ FindClosestPoint()

template<typename T , int d = 3>
FVec3 Chaos::TCorePlane< T, d >::FindClosestPoint ( const FVec3 &  x,
const FReal  Thickness = (FReal)0 
) const
inline

◆ GetTypeHash()

template<typename T , int d = 3>
uint32 Chaos::TCorePlane< T, d >::GetTypeHash ( ) const
inline

◆ MakeFrom()

template<typename T , int d = 3>
template<typename U >
static FORCEINLINE TCorePlane< T > Chaos::TCorePlane< T, d >::MakeFrom ( const TCorePlane< U > &  Plane)
inlinestatic

◆ MakeScaledSafe()

template<typename T , int d = 3>
static TCorePlane< T > Chaos::TCorePlane< T, d >::MakeScaledSafe ( const TCorePlane< T > &  Plane,
const TVec3< T > &  Scale 
)
inlinestatic

◆ MakeScaledUnsafe() [1/2]

template<typename T , int d = 3>
template<typename U >
static FORCEINLINE TCorePlane< T > Chaos::TCorePlane< T, d >::MakeScaledUnsafe ( const TCorePlane< U > &  Plane,
const TVec3< T > &  Scale,
const TVec3< T > &  InvScale 
)
inlinestatic

◆ MakeScaledUnsafe() [2/2]

template<typename T , int d = 3>
template<typename U >
static FORCEINLINE void Chaos::TCorePlane< T, d >::MakeScaledUnsafe ( const TVec3< U > &  PlaneN,
const TVec3< U > &  PlaneX,
const TVec3< T > &  Scale,
const TVec3< T > &  InvScale,
TVec3< T > &  OutN,
TVec3< T > &  OutX 
)
inlinestatic

◆ Normal() [1/2]

template<typename T , int d = 3>
const TVec3< T > & Chaos::TCorePlane< T, d >::Normal ( ) const
inline

◆ Normal() [2/2]

template<typename T , int d = 3>
const TVec3< T > & Chaos::TCorePlane< T, d >::Normal ( const TVec3< T > &  ) const
inline

◆ PhiWithNormal()

template<typename T , int d = 3>
FReal Chaos::TCorePlane< T, d >::PhiWithNormal ( const FVec3 &  x,
FVec3 &  Normal 
) const
inline

Phi is positive on the side of the normal, and negative otherwise.

◆ Raycast()

template<typename T , int d = 3>
bool Chaos::TCorePlane< T, d >::Raycast ( const FVec3 &  StartPoint,
const FVec3 &  Dir,
const FReal  Length,
const FReal  Thickness,
FReal &  OutTime,
FVec3 &  OutPosition,
FVec3 &  OutNormal,
int32 &  OutFaceIndex 
) const
inline

◆ Serialize()

template<typename T , int d = 3>
FORCEINLINE void Chaos::TCorePlane< T, d >::Serialize ( FArchive &  Ar)
inline

◆ SignedDistance()

template<typename T , int d = 3>
template<typename U >
U Chaos::TCorePlane< T, d >::SignedDistance ( const TVec3< U > &  x) const
inline

Phi is positive on the side of the normal, and negative otherwise.

◆ X()

template<typename T , int d = 3>
const TVec3< T > & Chaos::TCorePlane< T, d >::X ( ) const
inline
The documentation for this class was generated from the following file: