UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
UE::Geometry::FCapsuleGenerator Class Reference

#include <CapsuleGenerator.h>

+ Inheritance diagram for UE::Geometry::FCapsuleGenerator:

Public Member Functions

FMeshShapeGenerator & Generate () override
 
- Public Member Functions inherited from UE::Geometry::FMeshShapeGenerator
virtual ~FMeshShapeGenerator ()
 
bool HasAttributes () const
 
void ResetAttributes (bool bResetPolygonIDs=false)
 
void Reset ()
 
void SetBufferSizes (int NumVertices, int NumTriangles, int NumUVs, int NumNormals)
 
void ExtendBufferSizes (int AddVertices, int AddTriangles, int AddUVs, int AddNormals)
 
void SetVertex (int Index, const FVector3d &Position)
 
int AppendVertex (const FVector3d &Position)
 
void SetUV (int Index, const FVector2f &UV, int ParentVertex)
 
int AppendUV (const FVector2f &UV, int ParentVertex)
 
void SetNormal (int Index, const FVector3f &Normal, int ParentVertex)
 
int AppendNormal (const FVector3f &Normal, int ParentVertex)
 
void SetTriangle (int Index, const FIndex3i &Tri)
 
void SetTriangle (int Index, int A, int B, int C)
 
void SetTriangle (int Index, int A, int B, int C, bool bClockwiseOverride)
 
int AppendTriangle (int A, int B, int C)
 
void SetTriangleUVs (int Index, const FIndex3i &Tri)
 
void SetTriangleUVs (int Index, int A, int B, int C)
 
void SetTriangleUVs (int Index, int A, int B, int C, bool bClockwiseOverride)
 
void SetTriangleNormals (int Index, const FIndex3i &Tri)
 
void SetTriangleNormals (int Index, int A, int B, int C)
 
void SetTriangleNormals (int Index, int A, int B, int C, bool bClockwiseOverride)
 
void SetTrianglePolygon (int Index, int PolygonID)
 
void SetTriangleWithMatchedUVNormal (int Index, int A, int B, int C)
 

Public Attributes

double Radius = 1.0
 
double SegmentLength = 1.0
 
int NumHemisphereArcSteps = 5
 
int NumCircleSteps = 3
 
int NumSegmentSteps = 0
 
bool bPolygroupPerQuad = false
 
- Public Attributes inherited from UE::Geometry::FMeshShapeGenerator
TArray< FVector3d > Vertices
 
TArray< FVector2f > UVs
 
TArray< int > UVParentVertex
 
TArray< FVector3f > Normals
 
TArray< int > NormalParentVertex
 
TArray< FIndex3i > Triangles
 
TArray< FIndex3i > TriangleUVs
 
TArray< FIndex3i > TriangleNormals
 
TArray< int > TrianglePolygonIDs
 
bool bReverseOrientation = false
 

Additional Inherited Members

- Static Public Member Functions inherited from UE::Geometry::FMeshShapeGenerator
static FVector3d BilinearInterp (const FVector3d &v00, const FVector3d &v10, const FVector3d &v11, const FVector3d &v01, double tx, double ty)
 
static FVector2d BilinearInterp (const FVector2d &v00, const FVector2d &v10, const FVector2d &v11, const FVector2d &v01, double tx, double ty)
 
static FVector2f BilinearInterp (const FVector2f &v00, const FVector2f &v10, const FVector2f &v11, const FVector2f &v01, float tx, float ty)
 
static FVector3i LinearInterp (const FVector3i &a, const FVector3i &b, double t)
 

Detailed Description

Generate a Capsule mesh, with UVs wrapped cylindrically. This is basically a "stretched" standard sphere triangulation, where we have a set of quad strips "around" the sphere with a disc-shaped cap at each pole. For the Capsule we duplicate the equatorial ring, creating two separate hemispherical caps which are joined with a single quad strip.

The Capsule line segment is oriented along +Z, with the start point at (0,0,0) and the end point at (0,0,SegmentLength). So the lower hemispherical cap is below the origin, ie the bottom pole is at (0,0,-Radius) and the top pole is at (0,0,SegmentLength+Radius).

Member Function Documentation

◆ Generate()

FMeshShapeGenerator & UE::Geometry::FCapsuleGenerator::Generate ( )
inlineoverridevirtual

Generate the mesh

Implements UE::Geometry::FMeshShapeGenerator.

Member Data Documentation

◆ bPolygroupPerQuad

bool UE::Geometry::FCapsuleGenerator::bPolygroupPerQuad = false

If true, each quad gets a separate polygroup, otherwise the entire mesh is a single polygroup

◆ NumCircleSteps

int UE::Geometry::FCapsuleGenerator::NumCircleSteps = 3

Number of vertices along each circle

◆ NumHemisphereArcSteps

int UE::Geometry::FCapsuleGenerator::NumHemisphereArcSteps = 5

Number of vertices along the 90-degree arc from the pole to edge of spherical cap.

◆ NumSegmentSteps

int UE::Geometry::FCapsuleGenerator::NumSegmentSteps = 0

Number of subdivisions lengthwise along the cylindrical section

◆ Radius

double UE::Geometry::FCapsuleGenerator::Radius = 1.0

Radius of capsule

◆ SegmentLength

double UE::Geometry::FCapsuleGenerator::SegmentLength = 1.0

Length of capsule line segment, so total height is SegmentLength + 2*Radius

The documentation for this class was generated from the following file: