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 > PhysicsCore > FCollisionShape

Light Theme

Dark Theme

FCollisionShape

Collision Shapes that supports Sphere, Capsule, Box, or Line

Choose your operating system:

Windows

macOS

Linux

References

Module	PhysicsCore
Header	/Engine/Source/Runtime/PhysicsCore/Public/CollisionShape.h
Include	#include "CollisionShape.h"

Syntax

struct FCollisionShape

Remarks

Collision Shapes that supports Sphere, Capsule, Box, or Line

Variables

	Name	Description
union FCollisio...	@2462	Union that supports up to 3 floats
FCollisionShape...	Box
FCollisionShape...	Capsule
float	HalfExtentX
float	HalfExtentY
float	HalfExtentZ
float	HalfHeight
float	Radius
ECollisionShape...	ShapeType
FCollisionShape...	Sphere

Constructors

	Name	Description
	FCollisionShape()

Functions

	Name	Description
FVector	GetBox()	Utility function to get Box Extention
float	GetCapsuleAxisHalfLength()	Get distance from center of capsule to center of sphere ends
const float	GetCapsuleHalfHeight()	Utility function to get Capsule Half Height
const float	GetCapsuleRadius()	Utility function to get Capsule Radius
FVector	GetExtent()	Utility function to return Extent of the shape
const float	GetSphereRadius()	Utility function to get Sphere Radius
bool	IsBox()	Is the shape currently a box?
bool	IsCapsule()	Is the shape currently a capsule?
bool	IsLine()	Is the shape currently a Line (Default)?
bool	IsNearlyZero()	Return true if nearly zero. If so, it will back out and use line trace instead
bool	IsSphere()	Is the shape currently a sphere?
FCollisionSh...	MakeBox ( const FVector& BoxHalfExtent )	Static utility function to make a box
FCollisionSh...	MakeCapsule ( const FVector& Extent )	Static utility function to make a capsule
FCollisionSh...	MakeCapsule ( const float CapsuleRadius, const float CapsuleHalfHeight )	Static utility function to make a capsule
FCollisionSh...	MakeSphere ( const float SphereRadius )	Static utility function to make a sphere
constexpr fl...	MinBoxExtent()
constexpr fl...	MinCapsuleAxisHalfHeight()
constexpr fl...	MinCapsuleRadius()
constexpr fl...	MinSphereRadius()
void	SetBox ( const FVector3f& HalfExtent )	Utility function to Set Box and dimension
void	SetCapsule ( const FVector3f& Extent )	Utility function to set Capsule from Extent data
void	SetCapsule ( const float Radius, const float HalfHeight )	Utility function to set Capsule with Radius and Half Height
void	SetSphere ( const float Radius )	Utility function to set Sphere with Radius

Constants

Name	Description
LineShape	Used by engine in multiple places.