1. Epic GamesDeveloper
  3. UBoxComponent

UBoxComponent

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly export FVector BoxExtent The extents (radii dimensions) of the box
Protected variable FEngineShowFlags ShowFlags List of all show flags this box component visualizer should respect.

Constructors

  Type Name Description
Public function  

UBoxComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category FVector  
Public function Const FEngineShowFlags  
Public function Const UFunction BlueprintCallable, Category FVector  
Public function void

InitBoxExtent ( const FVector& InBoxExtent
)

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

SetBoxExtent ( FVector InBoxExtent,
bool bUpdateOverlaps
)

 Change the box extent size. This is the unscaled size, before component scale is applied.
Public function void

SetShowFlags ( const FEngineShowFlags& InShowFlags
)

  

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