1. Epic GamesDeveloper
  3. FConvex

FConvex

Note: While Convex technically supports a margin, the margin is typically a property of the instance wrapper (ImplicitScaled, ImplicitTransformed, or ImplicitInstanced).

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

Inheritance Hierarchy

References

   
Module Chaos
Header /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Convex.h
Include #include "Chaos/Convex.h"

Syntax

class FConvex : public Chaos::FImplicitObject

Remarks

Note: While Convex technically supports a margin, the margin is typically a property of the instance wrapper (ImplicitScaled, ImplicitTransformed, or ImplicitInstanced). Usually the margin on the convex itself is zero.

Constructors

  Type Name Description
Public function  

FConvex ()

  
Public function  

FConvex ( FConvex&& Other
)

  
Public function  

FConvex ( TArray< FPlaneType >&& InPlanes,
TArray< FVec3Type >&& InVertices
)

 NOTE: This constructor will result in approximate COM and volume calculations, since it does not have face indices for surface particles.
Public function  

FConvex ( TArray< FPlaneType >&& InPlanes,
TArray< TArray< int32 > >&& InFaceIndices,
TArray< FVec3Type >&& InVertices
)

  
Public function  

FConvex ( const TArray< FVec3Type >& InVertices,
const FReal InMargin,
FConvexBuilder::EBuildMethod BuildMethod
)

  
Public function  

FConvex ( TArray< FPlaneType >&& InPlanes,
TArray< TArray< int32 > >&& InFaceIndices,
TArray< FVec3Type >&& InVertices,
const FVec3Type& InMin,
const FVec3Type& InMax,
const FRealType InVolume,
const FVec3Type InInertiaTensor,
const FRotation3& InRotationMatrix,
const bool bRegularDatas
)

  

Functions

  Type Name Description
Public function Const TUniquePtr< FConvex >  
Public function Const int32

FindVertexPlanes ( int32 VertexIndex,
int32* OutVertexPlanes,
int32 MaxVertexPlanes
)

 Get an array of all the plane indices that belong to a vertex (up to MaxVertexPlanes).
Public function Const FVec3  
Public function Const const FVec3  
Public function Const FVec3

GetClosestEdge ( int32 PlaneIndexHint,
const FVec3& Position,
FVec3& OutEdgePos0,
FVec3& OutEdgePos1
)

 Get the nearest point on an edge and the edge vertices Used for manifold generation
Public function Const FVec3

GetClosestEdgePosition ( int32 PlaneIndex,
const FVec3& Position
)

 Get the nearest point on an edge of the specified face.
Public function Const bool

GetClosestEdgeVertices ( int32 PlaneIndex,
const FVec3& Position,
int32& OutVertexIndex0,
int32& OutVertexIndex1
)

  
Public function Const int32

GetEdgePlane ( int32 EdgeIndex,
int32 EdgePlaneIndex
)

 Get the plane index of one of the two planes using an edge.
Public function Const int32

GetEdgeVertex ( int32 EdgeIndex,
int32 EdgeVertexIndex
)

 Get the vertex index of one of the two vertices in an edge.
Public function Const const TArray< FPlaneType > &  
Public function Const const FMatrix33

GetInertiaTensor ( const FReal Mass
)

  
Public function Const FConvex::FAABB3Type  
Public function Const FVec3

GetMarginAdjustedVertex ( const int32 VertexIndex,
const FReal InMargin,
FReal* OutSupportDelta
)

  
Public function Const FVec3

GetMarginAdjustedVertexScaled ( int32 VertexIndex,
FReal InMargin,
const FVec3& Scale,
FReal* OutSupportDelta
)

  
Public function Const int32

GetMostOpposingPlane ( const FVec3& Normal
)

 Get the index of the plane that most opposes the normal.
Public function Const int32

GetMostOpposingPlaneScaled ( const FVec3& Normal,
const FVec3& Scale
)

 Get the index of the plane that most opposes the normal.
Public function Const const TPlaneConcrete< FReal, 3 >

GetPlane ( int32 FaceIndex
)

 Get the plane at the specified index (e.g., indices from FindVertexPlanes)
Public function Const void

GetPlaneNX ( const int32 FaceIndex,
FVec3& OutN,
FVec3& OutX
)

  
Public function Const const FPlaneType &

GetPlaneRaw ( int32 FaceIndex
)

  
Public function Const int32

GetPlaneVertex ( int32 PlaneIndex,
int32 PlaneVertexIndex
)

 Get the vertex index of one of the vertices making up the corners of the specified face.
Public function Const FRotation3  
Public function Const const FConvexStructureData & The convex structure data (mainly exposed for testing)
Public function Static const FName

GetTypeName ( const EImplicitObjectType InType
)

  
Public function Const const FVec3Type &

GetVertex ( int32 VertexIndex
)

 Get the vertex at the specified index (e.g., indices from GetPlaneVertexs)
Public function Const int32

GetVertexPlanes3 ( int32 VertexIndex,
int32& PlaneIndex0,
int32& PlaneIndex1,
int32& PlaneIndex2
)

  
Public function Const const TArray< FVec3Type > &  
Public function Const const FReal  
Public function Const FReal Returns a winding order multiplier used in the manifold clipping and required when we have negative scales (See ImplicitObjectScaled)
Public function Const bool Whether the structure data has been created for this convex (will eventually always be true)
Public function Const bool

IntersectPlanes3 ( const FVec3& X1,
const FVec3& N1,
const FVec3& X2,
const FVec3& N2,
const FVec3& X3,
const FVec3& N3,
FVec3& OutX,
const FReal EpsilonSq
)

  
Public function void  
Public function Const int32  
Public function Const int32  
Public function Const int32

NumPlaneVertices ( int32 PlaneIndex
)

 The number of vertices that make up the corners of the specified face.
Public function Const int32  
Public function Const Chaos::FConvex *  
Public function Const bool

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

  
Public function void  
Public function void  
Public function Static EImplicitObjectType  
Public function Const FVec3

Support ( const FVec3& Direction,
const FReal Thickness,
int32& VertexIndex
)

 Return support point on the shape
Public function Const FVec3

SupportCore ( const FVec3& Direction,
const FReal InMargin,
FReal* OutSupportDelta,
int32& VertexIndex
)

 Return support point on the core shape (the convex shape with all planes moved inwards by margin).
Public function Const FVec3

SupportCoreScaled ( const FVec3& Direction,
FReal InMargin,
const FVec3& Scale,
FReal* OutSupportDelta,
int32& VertexIndex
)

 SupportCore with non-uniform scale support.
Public function Const VectorRegister4Float

SupportCoreSimd ( const VectorRegister4Float& Direction,
const FReal InMargin
)

 Return support point on the core shape (the convex shape with all planes moved inwards by margin).
Public function Const FVec3

SupportScaled ( const FVec3& Direction,
const FReal Thickness,
const FVec3& Scale,
int32& VertexIndex
)

  
Public function Const FString Print all the datas.
Public function Const FString A one-line summary of the convex.

Overridden from FImplicitObject

  Type Name Description
Public function Virtual Const const FAABB3  
Public function Virtual Const Chaos::FImplicitObjectPtr  
Public function Virtual Const Chaos::FImplicitObjectPtr

CopyGeometryWithScale ( const FVec3& Scale
)

  
Public function Virtual Const Chaos::FImplicitObjectPtr  
Public function Virtual Const Chaos::FImplicitObjectPtr

DeepCopyGeometryWithScale ( const FVec3& Scale
)

  
Public function Virtual Const int32

FindClosestFaceAndVertices ( const FVec3& Position,
TArray< FVec3 >& FaceVertices,
FReal SearchDist
)

 Finds the first intersecting face at given position
Public function Virtual Const Pair< FVec3, bool >

FindClosestIntersectionImp ( const FVec3& StartPoint,
const FVec3& EndPoint,
const FReal Thickness
)

  
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 int32

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

  
Public function Virtual Const FReal  
Public function Virtual Const FReal  
Public function Virtual Const uint32  
Public function Virtual Const FName  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual FString  
Public function Virtual Const FReal

PhiWithNormal ( const FVec3& X,
FVec3& Normal
)

 Return the distance to the surface.
Public function Virtual Const FReal

PhiWithNormalScaled ( const FVec3& Pos,
const FVec3& Scale,
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
)

 Calls [GJKRaycast()](API\Runtime\Chaos\Chaos\Chaos__GJKRaycast)_, which may return true_ but 0 for OutTime_, which means the bodies are touching, but not by enough to determine OutPosition_ and `OutNormal_ should be.
Public function Virtual void  
Public function Virtual void  
Public function Virtual Const FString  

Operators

  Type Name Description
Public function FConvex &

operator= ( FConvex&& Other
)

  
Public function FConvex &

operator= ( const FConvex& Other
)

  

Typedefs

Name Description
FAABB3Type  
FPlaneType  
FRealType  
FVec3Type  
TType  

Constants

Name Description
D  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page