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).

API > API/Runtime > API/Runtime/Chaos

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.

   
Name FConvex
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Convex.h
Include Path #include "Chaos/Convex.h"

Syntax

class FConvex : public Chaos::FImplicitObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FConvex ( const FConvex& Other
)

 IMPORTANT to keep this copy constructor private to avoid unintented expensive copies. Chaos/Convex.h  

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. Chaos/Convex.h  

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

   Chaos/Convex.h  

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

   Chaos/Convex.h  

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
)

   Chaos/Convex.h  

FConvex ( FConvex&& Other
)

   Chaos/Convex.h  

FConvex ()

   Chaos/Convex.h  

Typedefs

Name Type Remarks Include Path
FAABB3Type TAABB< FRealType, 3 >   Chaos/Convex.h
FPlaneType TPlaneConcrete< FRealType, 3 >   Chaos/Convex.h
FRealType TType   Chaos/Convex.h
FVec3Type TVec3< FRealType >   Chaos/Convex.h
TType FRealSingle   Chaos/Convex.h

Constants

Name Type Remarks Include Path
D unsigned   Chaos/Convex.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CenterOfMass FVec3Type   Chaos/Convex.h  
LocalBoundingBox FAABB3Type   Chaos/Convex.h  
Planes TArray< FPlaneType >   Chaos/Convex.h  
RotationOfMass FRotation3   Chaos/Convex.h  
StructureData FConvexStructureData   Chaos/Convex.h  
UnitMassInertiaTensor FVec3   Chaos/Convex.h  
Vertices TArray< FVec3Type >   Chaos/Convex.h  
Volume FRealType   Chaos/Convex.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TUniquePtr< FConvex > CopyAsConvex()

   Chaos/Convex.h  

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

 Get an array of all the plane indices that belong to a vertex (up to MaxVertexPlanes). Chaos/Convex.h  

FVec3 GetCenter()

   Chaos/Convex.h  

const FVec3 GetCenterOfMass()

   Chaos/Convex.h  

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

 Get the nearest point on an edge and the edge vertices Used for manifold generation Chaos/Convex.h  

FVec3 GetClosestEdgePosition ( int32 PlaneIndex,
const FVec3& Position
) const

 Get the nearest point on an edge of the specified face. Chaos/Convex.h  

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

   Chaos/Convex.h  

int32 GetEdgePlane ( int32 EdgeIndex,
int32 EdgePlaneIndex
) const

 Get the plane index of one of the two planes using an edge. Chaos/Convex.h  

int32 GetEdgeVertex ( int32 EdgeIndex,
int32 EdgeVertexIndex
) const

 Get the vertex index of one of the two vertices in an edge. Chaos/Convex.h  

const TArray< FPlaneType > & GetFaces()

   Chaos/Convex.h  

void GetHalfEdges ( int32 EdgeIndex,
int32& OutHalfEdge0,
int32& OutHalfEdge1
) const

 Get the half edges associated with an edge. Chaos/Convex.h  

const FMatrix33 GetInertiaTensor ( const FReal Mass
) const

   Chaos/Convex.h  

FConvex::FAABB3Type GetLocalBoundingBox()

   Chaos/Convex.h  

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

   Chaos/Convex.h  

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

   Chaos/Convex.h  

int32 GetMostOpposingPlane ( const FVec3& Normal
) const

 Get the index of the plane that most opposes the normal. Chaos/Convex.h  

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

 Get the index of the plane that most opposes the normal. Chaos/Convex.h  

const TPlaneConcrete< FReal, 3 > GetPlane ( int32 FaceIndex
) const

 Get the plane at the specified index (e.g., indices from FindVertexPlanes) Chaos/Convex.h  

int32 GetPlaneHalfEdge ( int32 PlaneIndex,
int32 PlaneEdgeIndex
) const

 Get the half edge index for a given plane. Chaos/Convex.h  

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

   Chaos/Convex.h  

const FPlaneType & GetPlaneRaw ( int32 FaceIndex
) const

   Chaos/Convex.h  

int32 GetPlaneVertex ( int32 PlaneIndex,
int32 PlaneVertexIndex
) const

 Get the vertex index of one of the vertices making up the corners of the specified face. Chaos/Convex.h  

FRotation3 GetRotationOfMass()

   Chaos/Convex.h  

const FConvexStructureData & GetStructureData()

 The convex structure data (mainly exposed for testing) Chaos/Convex.h  

const FVec3Type & GetVertex ( int32 VertexIndex
) const

 Get the vertex at the specified index (e.g., indices from GetPlaneVertexs) Chaos/Convex.h  

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

   Chaos/Convex.h  

const TArray< FVec3Type > & GetVertices()

   Chaos/Convex.h  

const FReal GetVolume()

   Chaos/Convex.h  

FReal GetWindingOrder()

 Returns a winding order multiplier used in the manifold clipping and required when we have negative scales (See ImplicitObjectScaled) Chaos/Convex.h  

bool HasStructureData()

 Whether the structure data has been created for this convex (will eventually always be true) Chaos/Convex.h  

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
) const

   Chaos/Convex.h  

void MovePlanesAndRebuild ( FRealType InDelta
)

   Chaos/Convex.h  

int32 NumEdges()

   Chaos/Convex.h  

int32 NumPlanes()

   Chaos/Convex.h  

int32 NumPlaneVertices ( int32 PlaneIndex
) const

 The number of vertices that make up the corners of the specified face. Chaos/Convex.h  

int32 NumVertices()

   Chaos/Convex.h  

Chaos::FConvex * RawCopyAsConvex()

   Chaos/Convex.h  

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

   Chaos/Convex.h  

void SerializeImp ( FArchive& Ar
)

   Chaos/Convex.h  

void SimplifyGeometry()

   Chaos/Convex.h  

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

 Return support point on the shape Chaos/Convex.h  

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

 Return support point on the core shape (the convex shape with all planes moved inwards by margin). Chaos/Convex.h  

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

 SupportCore with non-uniform scale support. Chaos/Convex.h  

VectorRegister4Float SupportCoreSimd ( const VectorRegister4Float& Direction,
const FReal InMargin
) const

 Return support point on the core shape (the convex shape with all planes moved inwards by margin). Chaos/Convex.h  

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

   Chaos/Convex.h  

FString ToStringFull()

 Print all the datas. Chaos/Convex.h  

FString ToStringSummary()

 A one-line summary of the convex. Chaos/Convex.h  

Overridden from FImplicitObject

Name Remarks Include Path Unreal Specifiers

virtual const FAABB3 BoundingBox()

   Chaos/Convex.h  

virtual Chaos::FImplicitObjectPtr CopyGeometry()

   Chaos/Convex.h  

virtual Chaos::FImplicitObjectPtr CopyGeometryWithScale ( const FVec3& Scale
) const

   Chaos/Convex.h  

virtual Chaos::FImplicitObjectPtr DeepCopyGeometry()

   Chaos/Convex.h  

virtual Chaos::FImplicitObjectPtr DeepCopyGeometryWithScale ( const FVec3& Scale
) const

   Chaos/Convex.h  

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

 Finds the first intersecting face at given position Chaos/Convex.h  

virtual Pair< FVec3, bool > FindClosestIntersectionImp ( const FVec3& StartPoint,
const FVec3& EndPoint,
const FReal Thickness
) const

   Chaos/Convex.h  

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

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

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

 Returns the most opposing face. Chaos/Convex.h  

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

   Chaos/Convex.h  

virtual FReal GetMargin()

   Chaos/Convex.h  

virtual FReal GetRadius()

   Chaos/Convex.h  

virtual uint32 GetTypeHash()

   Chaos/Convex.h  

virtual FName GetTypeName ()

   Chaos/Convex.h  

virtual bool IsPerformanceWarning()

   Chaos/Convex.h  

virtual bool IsValidGeometry()

   Chaos/Convex.h  

virtual FString PerformanceWarningAndSimplifaction()

   Chaos/Convex.h  

virtual FReal PhiWithNormal ( const FVec3& X,
FVec3& Normal
) const

 Return the distance to the surface. Chaos/Convex.h  

virtual FReal PhiWithNormalScaled ( const FVec3& Pos,
const FVec3& Scale,
FVec3& Normal
) const

 Find the closest point on the surface, and return the separating distance and axis. Chaos/Convex.h  

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

 Calls [GJKRaycast()](API\Runtime\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. Chaos/Convex.h  

virtual void Serialize ( FChaosArchive& Ar
)

   Chaos/Convex.h  

virtual void Serialize ( FArchive& Ar
)

   Chaos/Convex.h  

virtual FString ToString()

   Chaos/Convex.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FName GetTypeName ( const EImplicitObjectType InType
)

   Chaos/Convex.h  

static EImplicitObjectType StaticType()

   Chaos/Convex.h  

Operators

Name Remarks Include Path Unreal Specifiers

FConvex & operator= ( const FConvex& Other
)

   Chaos/Convex.h  

FConvex & operator= ( FConvex&& Other
)

   Chaos/Convex.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page