USphereComponent

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

Windows
MacOS
Linux

Inheritance Hierarchy

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

Protected variable

float

 

SphereRadius

The radius of the sphere

Constructors

Name Description

Public function

USphereComponent

(
    const FObjectInitializer& ObjectInitializer
)

Functions

Name Description

Public function Const

float

 

GetScaledSphereRadius()

Public function Const

float

 

GetShapeScale()

Get the scale used by this shape.

Public function Const

float

 

GetUnscaledSphereRadius()

Public function

void

 

InitSphereRadius

(
    float InSphereRadius
)

Sets the sphere radius without triggering a render or physics update.

Public function

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

Public function Virtual

void

 

UpdateBodySetup()

Update the body setup parameters based on shape information

Overridden from UPrimitiveComponent

Name Description

Public function Virtual Const

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.

Public function Virtual

FPrimitiveSceneProxy *

 

CreateSceneProxy()

Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Public function Virtual Const

FCollisionShape

 

GetCollisionShape

(
    float Inflation
)

Return a CollisionShape that most closely matches this primitive.

Public function Virtual Const

bool

 

IsZeroExtent()

This isn't bound extent, but for shape component to utilize extent is 0.

Overridden from USceneComponent

Name Description

Public function Virtual Const

void

 

CalcBoundingCylinder

(
    float& CylinderRadius,
    float& CylinderHalfHeight
)

Calculate the axis-aligned bounding cylinder of the component (radius in X-Y, half-height along Z axis).

Public function Virtual Const

FBoxSphereBounds

 

CalcBounds

(
    const FTransform& LocalToWorld
)

Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback