FHeightField

Windows
MacOS
Linux

Inheritance Hierarchy

FImplicitObject

FHeightField

References

Module

Chaos

Header

/Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/HeightField.h

Include

#include "Chaos/HeightField.h"

Syntax

class FHeightField : public Chaos::FImplicitObject

Variables

Name Description

Public variable

FDataType

 

GeomData

Constructors

Name Description

Public function

FHeightField

(
    const FHeightField& Other
)

Public function

FHeightField

(
    TArray< FReal >&& Height,
    TArray< uint8 >&& InMaterialIndice...,
    int32 InNumRows,
    int32 InNumCols,
    const FVec3& InScale
)

Public function

FHeightField

(
    TArrayView< const uint16 > InHeight...,
    TArrayView< uint8 > InMaterialIndic...,
    int32 InNumRows,
    int32 InNumCols,
    const FVec3& InScale
)

Destructors

Name Description

Public function Virtual

~FHeightField()

Not required as long as FImplicitObject also has deleted move constructor (adding this causes an error on Linux build) FHeightField(FHeightField&& Other) = default;

Functions

Name Description

Public function

void

 

EditHeights

(
    TArrayView< const uint16 > InHeight...,
    int32 InBeginRow,
    int32 InBeginCol,
    int32 InNumRows,
    int32 InNumCols
)

Support for editing a subsection of the heightfield

Public function

void

 

EditHeights

(
    TArrayView< FReal > InHeights,
    int32 InBeginRow,
    int32 InBeginCol,
    int32 InNumRows,
    int32 InNumCols
)

Support for editing a subsection of the heightfield

Public function Const

FClosestFace...

 

FindClosestFace

(
    const FVec3& Position,
    FReal SearchDist
)

Public function Const

FReal

 

GetHeight

(
    int32 InX,
    int32 InY
)

Public function Const

FReal

 

GetHeight

(
    int32 InIndex
)

Public function Const

FReal

 

GetHeightAt

(
    const FVec2& InGridLocationLocal
)

Public function Const

uint8

 

GetMaterialIndex

(
    int32 InIndex
)

Public function Const

uint8

 

GetMaterialIndex

(
    int32 InX,
    int32 InY
)

Public function Const

FVec3

 

GetNormalAt

(
    const FVec2& InGridLocationLocal
)

Public function Const

int32

 

GetNumCols()

Public function Const

int32

 

GetNumRows()

Public function Const

bool

 

GJKContactPoint

(
    const TImplicitObjectScaled< FConve...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FVec3& ContactLocation,
    FVec3& ContactNormal,
    FReal& ContactPhi
)

Public function Const

bool

 

GJKContactPoint

(
    const TImplicitObjectScaled< FCapsu...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FVec3& ContactLocation,
    FVec3& ContactNormal,
    FReal& ContactPhi
)

Public function Const

bool

 

GJKContactPoint

(
    const TImplicitObjectScaled< TSpher...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FVec3& ContactLocation,
    FVec3& ContactNormal,
    FReal& ContactPhi
)

Public function Const

bool

 

GJKContactPoint

(
    const FConvex& QueryGeom,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FVec3& ContactLocation,
    FVec3& ContactNormal,
    FReal& ContactPhi
)

Public function Const

bool

 

GJKContactPoint

(
    const FCapsule& QueryGeom,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FVec3& ContactLocation,
    FVec3& ContactNormal,
    FReal& ContactPhi
)

Public function Const

bool

 

GJKContactPoint

(
    const TSphere< FReal, 3 >& QueryGe...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FVec3& ContactLocation,
    FVec3& ContactNormal,
    FReal& ContactPhi
)

Public function Const

bool

 

GJKContactPoint

(
    const TBox< FReal, 3 >& QueryGeom,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FVec3& ContactLocation,
    FVec3& ContactNormal,
    FReal& ContactPhi
)

Public function Const

bool

 

GJKContactPoint

(
    const TImplicitObjectScaled< TBox< ...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FVec3& ContactLocation,
    FVec3& ContactNormal,
    FReal& ContactPhi
)

Public function Const

bool

 

IsHole

(
    int32 InIndex
)

Public function Const

bool

 

IsHole

(
    int32 InCellX,
    int32 InCellY
)

Public function Const

bool

 

OverlapGeom

(
    const TImplicitObjectScaled< FConve...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FMTDInfo* OutMTD
)

Public function Const

bool

 

OverlapGeom

(
    const TImplicitObjectScaled< FCapsu...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FMTDInfo* OutMTD
)

Public function Const

bool

 

OverlapGeom

(
    const TImplicitObjectScaled< TBox< ...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FMTDInfo* OutMTD
)

Public function Const

bool

 

OverlapGeom

(
    const TImplicitObjectScaled< TSpher...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FMTDInfo* OutMTD
)

Public function Const

bool

 

OverlapGeom

(
    const FConvex& QueryGeom,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FMTDInfo* OutMTD
)

Public function Const

bool

 

OverlapGeom

(
    const FCapsule& QueryGeom,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FMTDInfo* OutMTD
)

Public function Const

bool

 

OverlapGeom

(
    const TBox< FReal, 3 >& QueryGeom,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FMTDInfo* OutMTD
)

Public function Const

bool

 

OverlapGeom

(
    const TSphere< FReal, 3 >& QueryGe...,
    const FRigidTransform3& QueryTM,
    const FReal Thickness,
    FMTDInfo* OutMTD
)

Public function

void

 

SetScale

(
    const FVec3& InScale
)

Public function Static

constexpr EI...

 

StaticType()

Public function Const

bool

 

SweepGeom

(
    const TImplicitObjectScaled< TSpher...,
    const FRigidTransform3& StartTM,
    const FVec3& Dir,
    const FReal Length,
    FReal& OutTime,
    FVec3& OutPosition,
    FVec3& OutNormal,
    int32& OutFaceIndex,
    const FReal Thickness,
    bool bComputeMTD
)

Public function Const

bool

 

SweepGeom

(
    const TImplicitObjectScaled< TBox< ...,
    const FRigidTransform3& StartTM,
    const FVec3& Dir,
    const FReal Length,
    FReal& OutTime,
    FVec3& OutPosition,
    FVec3& OutNormal,
    int32& OutFaceIndex,
    const FReal Thickness,
    bool bComputeMTD
)

Public function Const

bool

 

SweepGeom

(
    const FConvex& QueryGeom,
    const FRigidTransform3& StartTM,
    const FVec3& Dir,
    const FReal Length,
    FReal& OutTime,
    FVec3& OutPosition,
    FVec3& OutNormal,
    int32& OutFaceIndex,
    const FReal Thickness,
    bool bComputeMTD
)

Public function Const

bool

 

SweepGeom

(
    const TImplicitObjectScaled< FConve...,
    const FRigidTransform3& StartTM,
    const FVec3& Dir,
    const FReal Length,
    FReal& OutTime,
    FVec3& OutPosition,
    FVec3& OutNormal,
    int32& OutFaceIndex,
    const FReal Thickness,
    bool bComputeMTD
)

Public function Const

bool

 

SweepGeom

(
    const TBox< FReal, 3 >& QueryGeom,
    const FRigidTransform3& StartTM,
    const FVec3& Dir,
    const FReal Length,
    FReal& OutTime,
    FVec3& OutPosition,
    FVec3& OutNormal,
    int32& OutFaceIndex,
    const FReal Thickness,
    bool bComputeMTD
)

Public function Const

bool

 

SweepGeom

(
    const TSphere< FReal, 3 >& QueryGe...,
    const FRigidTransform3& StartTM,
    const FVec3& Dir,
    const FReal Length,
    FReal& OutTime,
    FVec3& OutPosition,
    FVec3& OutNormal,
    int32& OutFaceIndex,
    const FReal Thickness,
    bool bComputeMTD
)

Public function Const

bool

 

SweepGeom

(
    const TImplicitObjectScaled< FCapsu...,
    const FRigidTransform3& StartTM,
    const FVec3& Dir,
    const FReal Length,
    FReal& OutTime,
    FVec3& OutPosition,
    FVec3& OutNormal,
    int32& OutFaceIndex,
    const FReal Thickness,
    bool bComputeMTD
)

Public function Const

bool

 

SweepGeom

(
    const FCapsule& QueryGeom,
    const FRigidTransform3& StartTM,
    const FVec3& Dir,
    const FReal Length,
    FReal& OutTime,
    FVec3& OutPosition,
    FVec3& OutNormal,
    int32& OutFaceIndex,
    const FReal Thickness,
    bool bComputeMTD
)

Public function Const

void

 

VisitTriangles

(
    const FAABB3& InQueryBounds,
    const TFunction< void...
)

Overridden from FImplicitObject

Name Description

Public function Virtual Const

const FAABB3

 

BoundingBox()

Public function Virtual Const

FVec3

 

FindGeometryOpposingNormal

(
    const FVec3& DenormDir,
    int32 FaceIndex,
    const FVec3& OriginalNormal
)

Given a normal and a face index, compute the most opposing normal associated with the underlying geometry features.

Public function Virtual Const

int32

 

FindMostOpposingFace

(
    const FVec3& Position,
    const FVec3& UnitDir,
    int32 HintFaceIndex,
    FReal SearchDist
)

Returns the most opposing face.

Public function Virtual Const

uint16

 

GetMaterialIndex

(
    uint32 HintIndex
)

Public function Virtual Const

uint32

 

GetTypeHash()

Public function Virtual Const

bool

 

Overlap

(
    const FVec3& Point,
    const FReal Thickness
)

This gives derived types a way to do an overlap check without calling PhiWithNormal todo: this api is confusing.

Public function Virtual Const

FReal

 

PhiWithNormal

(
    const FVec3& x,
    FVec3& Normal
)

Find the closest point on the surface, and return the separating distance and axis.

Public function Virtual Const

bool

 

Raycast

(
    const FVec3& StartPoint,
    const FVec3& Dir,
    const FReal Length,
    const FReal Thickness,
    FReal& OutTime,
    FVec3& OutPosition,
    FVec3& OutNormal,
    int32& OutFaceIndex
)

This gives derived types a way to avoid calling PhiWithNormal todo: this api is confusing.

Public function Virtual

void

 

Serialize

(
    FChaosArchive& Ar
)

Classes

Name

Description

Public struct

FClosestFaceData

Public struct

FData

Typedefs

Name

Description

FDataType
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss