Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > PhysicsEngine > FKSphylElem

Light Theme

Dark Theme

FKSphylElem

Capsule shape used for collision. Z axis is capsule axis.

Windows

MacOS

Linux

Inheritance Hierarchy

FKShapeElem

FKSphylElem

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/PhysicsEngine/SphylElem.h
Include	#include "PhysicsEngine/SphylElem.h"

Syntax

struct FKSphylElem : public FKShapeElem

Remarks

Capsule shape used for collision. Z axis is capsule axis.

Variables

	Name	Description
FVector	Center	Position of the capsule's origin
float	Length	This is of line-segment ie. add Radius to both ends to find total length.
float	Radius	Radius of the capsule
FRotator	Rotation	Rotation of the capsule

Constructors

	Name	Description
	FKSphylElem()
	FKSphylElem ( float InRadius, float InLength )

Functions

	Name	Description
FBox	CalcAABB ( const FTransform& BoneTM, float Scale )
void	DrawElemSolid ( FPrimitiveDrawInterface* PDI, const FTransform& ElemTM, const FVector& Scale3D, const FMaterialRenderProxy* Ma... )
void	DrawElemWire ( FPrimitiveDrawInterface* PDI, const FTransform& ElemTM, const FVector& Scale3D, const FColor Color )
void	FixupDeprecated ( FArchive& Ar )
float	GetClosestPointAndNormal ( const FVector& WorldPosition, const FTransform& BodyToWorldTM, FVector& ClosestWorldPosition, FVector& Normal )	Finds the closest point on the shape given a world position.
void	GetElemSolid ( const FTransform& ElemTM, const FVector& Scale3D, const FMaterialRenderProxy* Ma..., int32 ViewIndex, FMeshElementCollector& Collector )
FKSphylElem	GetFinalScaled ( const FVector& Scale3D, const FTransform& RelativeTM )
float	GetScaledCylinderLength ( const FVector& Scale3D )	Returns the scaled length of the cylinder part of the Sphyl
float	GetScaledHalfLength ( const FVector& Scale3D )	Returns half of the total scaled length of the Sphyl, which includes the scaled top and bottom caps
float	GetScaledRadius ( const FVector& Scale3D )	Returns the scaled radius for this Sphyl, which is determined by the Max scale on X/Y and clamped by half the total length
float	GetShortestDistanceToPoint ( const FVector& WorldPosition, const FTransform& BodyToWorldTM )	Finds the shortest distance between the element and a world position.
FTransform	GetTransform()	Utility function that builds an FTransform from the current data.
float	GetVolume ( const FVector& Scale )
void	ScaleElem ( FVector DeltaSize, float MinSize )
void	SetTransform ( const FTransform& InTransform )

Constants

Name	Description
StaticShapeType

Deprecated Variables

		Name	Description
	FQuat	Orientation_DEPRECATED
	FMatrix	TM_DEPRECATED

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

Take our survey

Dismiss