FCollisionShape

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

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

Public variable

union FCollisio...

 

@2172

Union that supports up to 3 floats

Public variable

FCollisionShape...

 

Box

Public variable

FCollisionShape...

 

Capsule

Public variable

float

 

HalfExtentX

Public variable

float

 

HalfExtentY

Public variable

float

 

HalfExtentZ

Public variable

float

 

HalfHeight

Public variable

float

 

Radius

Public variable

ECollisionShape...

 

ShapeType

Public variable

FCollisionShape...

 

Sphere

Constructors

Name Description

Public function

FCollisionShape()

Functions

Name Description

Public function Const

FVector

 

GetBox()

Utility function to get Box Extention

Public function Const

float

 

GetCapsuleAxisHalfLength()

Get distance from center of capsule to center of sphere ends

Public function Const

const float

 

GetCapsuleHalfHeight()

Utility function to get Capsule Half Height

Public function Const

const float

 

GetCapsuleRadius()

Utility function to get Capsule Radius

Public function Const

FVector

 

GetExtent()

Utility function to return Extent of the shape

Public function Const

const float

 

GetSphereRadius()

Utility function to get Sphere Radius

Public function Const

bool

 

IsBox()

Is the shape currently a box?

Public function Const

bool

 

IsCapsule()

Is the shape currently a capsule?

Public function Const

bool

 

IsLine()

Is the shape currently a Line (Default)?

Public function Const

bool

 

IsNearlyZero()

Return true if nearly zero. If so, it will back out and use line trace instead

Public function Const

bool

 

IsSphere()

Is the shape currently a sphere?

Public function Static

FCollisionSh...

 

MakeBox

(
    const FVector& BoxHalfExtent
)

Static utility function to make a box

Public function Static

FCollisionSh...

 

MakeCapsule

(
    const FVector& Extent
)

Static utility function to make a capsule

Public function Static

FCollisionSh...

 

MakeCapsule

(
    const float CapsuleRadius,
    const float CapsuleHalfHeight
)

Static utility function to make a capsule

Public function Static

FCollisionSh...

 

MakeSphere

(
    const float SphereRadius
)

Static utility function to make a sphere

Public function Static

constexpr fl...

 

MinBoxExtent()

Public function Static

constexpr fl...

 

MinCapsuleAxisHalfHeight()

Public function Static

constexpr fl...

 

MinCapsuleRadius()

Public function Static

constexpr fl...

 

MinSphereRadius()

Public function

void

 

SetBox

(
    const FVector& HalfExtent
)

Utility function to Set Box and dimension

Public function

void

 

SetCapsule

(
    const FVector& Extent
)

Utility function to set Capsule from Extent data

Public function

void

 

SetCapsule

(
    const float Radius,
    const float HalfHeight
)

Utility function to set Capsule with Radius and Half Height

Public function

void

 

SetSphere

(
    const float Radius
)

Utility function to set Sphere with Radius

Constants

Name

Description

LineShape

Used by engine in multiple places.

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