1. Epic GamesDeveloper
  3. UCapsuleComponent

UCapsuleComponent

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

API > API/Runtime > API/Runtime/Engine

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

   
Name UCapsuleComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Components/CapsuleComponent.h
Include Path #include "Components/CapsuleComponent.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UCapsuleComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/CapsuleComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Returns the capsule half-height scaled by the component scale. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"
Returns the capsule half-height minus radius (to exclude the hemisphere), scaled by the component scale. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

float GetScaledCapsuleRadius()

 Returns the capsule radius scaled by the component scale. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

void GetScaledCapsuleSize ( float& OutRadius,
float& OutHalfHeight
) const

 Returns the capsule radius and half-height scaled by the component scale. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

void GetScaledCapsuleSize_WithoutHemisphere ( float& OutRadius,
float& OutHalfHeightWithoutHemisphere
) const

 Returns the capsule radius and half-height scaled by the component scale. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

float GetShapeScale ()

 Get the scale used by this shape. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

float GetUnscaledCapsuleHalfHeight()

 Returns the capsule half-height, ignoring component scaling. This includes the hemisphere end cap. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"
Returns the capsule half-height minus radius (to exclude the hemisphere), ignoring component scaling. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

float GetUnscaledCapsuleRadius()

 Returns the capsule radius, ignoring component scaling. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

void GetUnscaledCapsuleSize ( float& OutRadius,
float& OutHalfHeight
) const

 Returns the capsule radius and half-height scaled by the component scale. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

void GetUnscaledCapsuleSize_WithoutHemisphere ( float& OutRadius,
float& OutHalfHeightWithoutHemisphere
) const

 Returns the capsule radius and half-height, ignoring component scaling. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

void InitCapsuleSize ( float InRadius,
float InHalfHeight
)

 Sets the capsule size without triggering a render or physics update. This is the preferred method when initializing a component in a class constructor. Components/CapsuleComponent.h  

void SetCapsuleHalfHeight ( float HalfHeight,
bool bUpdateOverlaps
)

 Set the capsule half-height. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

void SetCapsuleRadius ( float Radius,
bool bUpdateOverlaps
)

 Set the capsule radius. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

void SetCapsuleSize ( float InRadius,
float InHalfHeight,
bool bUpdateOverlaps
)

 Change the capsule size. This is the unscaled size, before component scale is applied. Components/CapsuleComponent.h
  • BlueprintCallable
  • Category="Components|Capsule"

Overridden from UShapeComponent

Name Remarks Include Path Unreal Specifiers

virtual void UpdateBodySetup()

 Update the body setup parameters based on shape information Components/CapsuleComponent.h  

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual bool AreSymmetricRotations ( const FQuat& A,
const FQuat& B,
const FVector& Scale3D
) const

 Returns true if the given transforms result in the same bounds, due to rotational symmetry. Components/CapsuleComponent.h  

virtual FPrimitiveSceneProxy * CreateSceneProxy()

 Creates a proxy to represent the primitive to the scene manager in the rendering thread. Components/CapsuleComponent.h  

virtual FCollisionShape GetCollisionShape ( float Inflation
) const

 Return a CollisionShape that most closely matches this primitive. Components/CapsuleComponent.h  

virtual bool IsZeroExtent ()

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

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual void CalcBoundingCylinder ( float& CylinderRadius,
float& CylinderHalfHeight
) const

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

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/CapsuleComponent.h  

virtual void PostLoad()

   Components/CapsuleComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/CapsuleComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
CapsuleHeight_DEPRECATED float   Components/CapsuleComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page