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

USphereComponent

A sphere 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

USphereComponent

UDrawSphereComponent

References

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

Syntax

class USphereComponent : public UShapeComponent

Remarks

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

Variables

		Name	Description
	float	SphereRadius	The radius of the sphere

Constructors

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

Functions

	Name	Description
float	GetScaledSphereRadius()
float	GetShapeScale()	Get the scale used by this shape.
float	GetUnscaledSphereRadius()
void	InitSphereRadius ( float InSphereRadius )	Sets the sphere radius without triggering a render or physics update.
void	SetSphereRadius ( float InSphereRadius, bool bUpdateOverlaps )	Change the sphere radius. This is the unscaled radius, 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
bool	AreSymmetricRotations ( const FQuat& A, const FQuat& B, const FVector& Scale3D )	Returns true if the given transforms result in the same bounds, due to rotational symmetry.
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
	void	CalcBoundingCylinder ( float& CylinderRadius, float& CylinderHalfHeight )	Calculate the axis-aligned bounding cylinder of the component (radius in X-Y, half-height along Z axis).
	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