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

Light Theme

Dark Theme

UBoxComponent

A box generally used for simple collision. Bounds are rendered as lines in the editor.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UShapeComponent

UBoxComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/BoxComponent.h
Include	#include "Components/BoxComponent.h"

Syntax

class UBoxComponent : public UShapeComponent

Remarks

A box generally used for simple collision. Bounds are rendered as lines in the editor.

Variables

		Name	Description
	FVector	BoxExtent	The extents (radii dimensions) of the box
	float	LineThickness	Used to control the line thickness when rendering

Constructors

	Name	Description
	UBoxComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FVector	GetScaledBoxExtent()
FVector	GetUnscaledBoxExtent()
void	InitBoxExtent ( const FVector& InBoxExtent )	Sets the box extents without triggering a render or physics update.
void	SetBoxExtent ( FVector InBoxExtent, bool bUpdateOverlaps )	Change the box extent size. This is the unscaled size, before component scale is applied.

Overridden from UShapeComponent

		Name	Description
	void	UpdateBodySetup()	Update the body setup parameters based on shape information

Overridden from UPrimitiveComponent

	Name	Description
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
FCollisionSh...	GetCollisionShape ( float Inflation )	Return a CollisionShape that most closely matches this primitive.
bool	IsZeroExtent()	This isn't bound extent, but for shape component to utilize extent is 0.

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

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

Take our survey

Dismiss