1. Epic GamesDeveloper
  3. FHeightField

FHeightField

Unreal Engine C++ API Reference > Runtime > Chaos > Chaos

Inheritance Hierarchy

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

  Type Name Description
Public variable FDataType GeomData  

Constructors

  Type Name Description
Public function  

FHeightField ( const FHeightField& Other
)

  
Public function  

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

  
Public function  

FHeightField ( TArrayView< const uint16 > InHeights,
TArrayView< const uint8 > InMaterialIndices,
int32 InNumRows,
int32 InNumCols,
const FVec3& InScale
)

  

Destructors

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

Functions

  Type Name Description
Public function void

EditHeights ( TArrayView< const uint16 > InHeights,
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 FClosestFaceData

FindClosestFace ( const FVec3& Position,
FReal SearchDist
)

  
Public function Const FReal

GetHeight ( int32 InIndex
)

  
Public function Const FReal

GetHeight ( int32 InX,
int32 InY
)

  
Public function Const FReal

GetHeightAt ( const FVec2& InGridLocationLocal
)

  
Public function Const uint8

GetMaterialIndex ( int32 InX,
int32 InY
)

  
Public function Const uint8

GetMaterialIndex ( int32 InIndex
)

  
Public function Const FVec3

GetNormalAt ( const FVec2& InGridLocationLocal
)

  
Public function Const int32  
Public function Const int32  
Public function Const FVec3

GetPointScaled ( int32 InIndex
)

  
Public function Const bool

GJKContactPoint ( const TImplicitObjectScaled< FCapsule >& QueryGeom,
const FRigidTransform3& QueryTM,
const FReal Thickness,
FVec3& ContactLocation,
FVec3& ContactNormal,
FReal& ContactPhi,
int32& ContactFaceIndex
)

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

GJKContactPoint ( const TImplicitObjectScaled< FConvex >& QueryGeom,
const FRigidTransform3& QueryTM,
const FReal Thickness,
FVec3& ContactLocation,
FVec3& ContactNormal,
FReal& ContactPhi,
int32& ContactFaceIndex
)

  
Public function Const bool

GJKContactPoint ( const TImplicitObjectScaled< TSphere< FReal, 3 >>& QueryGeom,
const FRigidTransform3& QueryTM,
const FReal Thickness,
FVec3& ContactLocation,
FVec3& ContactNormal,
FReal& ContactPhi,
int32& ContactFaceIndex
)

  
Public function Const bool

GJKContactPoint ( const TSphere< FReal, 3 >& QueryGeom,
const FRigidTransform3& QueryTM,
const FReal Thickness,
FVec3& ContactLocation,
FVec3& ContactNormal,
FReal& ContactPhi,
int32& ContactFaceIndex
)

  
Public function Const bool

IsHole ( int32 InIndex
)

  
Public function Const bool

IsHole ( int32 InCellX,
int32 InCellY
)

  
Public function Const bool

IsOverlappingAnyCells ( const FAABB3& QueryBounds
)

 Does the mesh-space QueryBounds overlap the bounds of any cells in the heightfield?
Public function Const bool

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

  
Public function Const bool

OverlapGeom ( const TImplicitObjectScaled< FConvex >& QueryGeom,
const FRigidTransform3& QueryTM,
const FReal Thickness,
FMTDInfo* OutMTD
)

  
Public function Const bool

OverlapGeom ( const TImplicitObjectScaled< FCapsule >& QueryGeom,
const FRigidTransform3& QueryTM,
const FReal Thickness,
FMTDInfo* OutMTD
)

  
Public function Const bool

OverlapGeom ( const TImplicitObjectScaled< TSphere< FReal, 3 >>& QueryGeom,
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 TBox< FReal, 3 >& QueryGeom,
const FRigidTransform3& QueryTM,
const FReal Thickness,
FMTDInfo* OutMTD
)

  
Public function Const bool

OverlapGeom ( const TSphere< FReal, 3 >& 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 void

SetScale ( const FVec3& InScale
)

  
Public function Static constexpr EImplicitObjectType  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const bool

SweepGeom ( const TImplicitObjectScaled< TSphere< FReal, 3 >>& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
FReal& OutTime,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal,
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,
FVec3& OutFaceNormal,
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,
FVec3& OutFaceNormal,
const FReal Thickness,
bool bComputeMTD
)

  
Public function Const bool

SweepGeom ( const TSphere< FReal, 3 >& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
FReal& OutTime,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal,
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,
FVec3& OutFaceNormal,
const FReal Thickness,
bool bComputeMTD
)

  
Public function Const bool

SweepGeomCCD ( const TImplicitObjectScaled< TSphere< FReal, 3 >>& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
const FReal IgnorePenetration,
const FReal TargetPenetration,
FReal& OutTOI,
FReal& OutPhi,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal
)

 Sweep used for CCD. Ignores triangles we penetrate by less than IgnorePenetration, and calculate the TOI for a depth of TargetPenetration. If both are zero, this is equivalent to SweepGeom.
Public function Const bool

SweepGeomCCD ( const TImplicitObjectScaled< TBox< FReal, 3 >>& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
const FReal IgnorePenetration,
const FReal TargetPenetration,
FReal& OutTOI,
FReal& OutPhi,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal
)

 Sweep used for CCD. Ignores triangles we penetrate by less than IgnorePenetration, and calculate the TOI for a depth of TargetPenetration. If both are zero, this is equivalent to SweepGeom.
Public function Const bool

SweepGeomCCD ( const FConvex& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
const FReal IgnorePenetration,
const FReal TargetPenetration,
FReal& OutTOI,
FReal& OutPhi,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal
)

 Sweep used for CCD. Ignores triangles we penetrate by less than IgnorePenetration, and calculate the TOI for a depth of TargetPenetration. If both are zero, this is equivalent to SweepGeom.
Public function Const bool

SweepGeomCCD ( const FCapsule& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
const FReal IgnorePenetration,
const FReal TargetPenetration,
FReal& OutTOI,
FReal& OutPhi,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal
)

 Sweep used for CCD. Ignores triangles we penetrate by less than IgnorePenetration, and calculate the TOI for a depth of TargetPenetration. If both are zero, this is equivalent to SweepGeom.
Public function Const bool

SweepGeomCCD ( const TImplicitObjectScaled< FConvex >& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
const FReal IgnorePenetration,
const FReal TargetPenetration,
FReal& OutTOI,
FReal& OutPhi,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal
)

 Sweep used for CCD. Ignores triangles we penetrate by less than IgnorePenetration, and calculate the TOI for a depth of TargetPenetration. If both are zero, this is equivalent to SweepGeom.
Public function Const bool

SweepGeomCCD ( const TSphere< FReal, 3 >& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
const FReal IgnorePenetration,
const FReal TargetPenetration,
FReal& OutTOI,
FReal& OutPhi,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal
)

 Sweep used for CCD. Ignores triangles we penetrate by less than IgnorePenetration, and calculate the TOI for a depth of TargetPenetration. If both are zero, this is equivalent to SweepGeom.
Public function Const bool

SweepGeomCCD ( const TImplicitObjectScaled< FCapsule >& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
const FReal IgnorePenetration,
const FReal TargetPenetration,
FReal& OutTOI,
FReal& OutPhi,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal
)

 Sweep used for CCD. Ignores triangles we penetrate by less than IgnorePenetration, and calculate the TOI for a depth of TargetPenetration. If both are zero, this is equivalent to SweepGeom.
Public function Const bool

SweepGeomCCD ( const TBox< FReal, 3 >& QueryGeom,
const FRigidTransform3& StartTM,
const FVec3& Dir,
const FReal Length,
const FReal IgnorePenetration,
const FReal TargetPenetration,
FReal& OutTOI,
FReal& OutPhi,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex,
FVec3& OutFaceNormal
)

 Sweep used for CCD. Ignores triangles we penetrate by less than IgnorePenetration, and calculate the TOI for a depth of TargetPenetration. If both are zero, this is equivalent to SweepGeom.
Public function Const void

VisitTriangles ( const FAABB3& QueryBounds,
const FRigidTransform3& QueryTransform,
const TriangleVisitor& Visitor
)

 Visit all triangles transformed into the specified space.

Overridden from FImplicitObject

  Type Name Description
Public function Virtual Const const FAABB3  
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  
Public function Virtual Const bool

IsOverlappingBoundsImpl ( const FAABB3& LocalBounds
)

 This should not be public, but it needs to be callable by derived classes on another instance.
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  
Public function Virtual Const void

VisitOverlappingLeafObjectsImpl ( const FAABB3& LocalBounds,
const FRigidTransform3& ObjectTransform,
const int32 RootObjectIndex,
int32& ObjectIndex,
int32& LeafObjectIndex,
const FImplicitHierarchyVisitor& VisitorFunc
)

 This should not be public, but it needs to be callable by derived classes on another instance.

Classes

  Type Name Description
Public struct FClosestFaceData    
Public struct FData    

Typedefs

Name Description
FDataType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page