1. Epic GamesDeveloper
  3. USphereComponent

USphereComponent

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

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

References

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

Syntax

UCLASS (ClassGroup="Collision", EditInlineNew,  
       HideCategories=(Object, LOD, Lighting, TextureStreaming),  
       Meta=(DisplayName="Sphere Collision", BlueprintSpawnableComponent), MinimalAPI)  
class USphereComponent : public UShapeComponent

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly export float SphereRadius The radius of the sphere

Constructors

  Type Name Description
Public function  

USphereComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category float  
Public function Const UFunction BlueprintCallable, Category float Get the scale used by this shape.
Public function Const UFunction BlueprintCallable, Category float  
Public function void

InitSphereRadius ( float InSphereRadius
)

 Sets the sphere radius without triggering a render or physics update.
Public function UFunction BlueprintCallable, Category void

SetSphereRadius ( float InSphereRadius,
bool bUpdateOverlaps
)

 Change the sphere radius. This is the unscaled radius, before component scale is applied.

Overridden from UShapeComponent

  Type Name Description
Public function Virtual void Update the body setup parameters based on shape information

Overridden from UPrimitiveComponent

  Type 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 * 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 This isn't bound extent, but for shape component to utilize extent is 0.

Overridden from USceneComponent

  Type 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page