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

UShapeComponent

ShapeComponent is a PrimitiveComponent that is represented by a simple geometrical shape (sphere, capsule, box, etc).

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UShapeComponent

UBoxComponent

UCapsuleComponent

USphereComponent

UDrawSphereComponent

References

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

Syntax

class UShapeComponent : public UPrimitiveComponent

Remarks

ShapeComponent is a PrimitiveComponent that is represented by a simple geometrical shape (sphere, capsule, box, etc).

Variables

	Name	Description
TSubclassOf< cl...	AreaClass	Navigation area type (empty = default obstacle)
uint8: 1	bDrawOnlyIfSelected	Only show this component if the actor is selected
uint8: 1	bDynamicObstacle	If set, shape will be exported for navigation as dynamic modifier instead of using regular collision data
uint8: 1	bShouldCollideWhenPlacing	If true it allows Collision when placing even if collision is not enabled
uint8: 1	bUseArchetypeBodySetup	If the body setup can be shared (i.e. there have been no alterations compared to the CDO)
UBodySetup *...	ShapeBodySetup	Description of collision
FColor	ShapeColor	Color used to draw the shape.

Constructors

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

Functions

	Name	Description
void	AddShapeToGeomArray()
void	AddShapeToGeomArray()
void	AddShapeToGeomArray()
void	AddShapeToGeomArray()
void	CreateShapeBodySetupIfNeeded()
bool	PrepareSharedBodySetup()	Checks if a shared body setup is available (and if we're eligible for it).
void	SetShapeToNewGeom ( const FPhysicsShapeHandle& Shape )
void	SetShapeToNewGeom ( const FPhysicsShapeHandle& Shape )
void	SetShapeToNewGeom ( const FPhysicsShapeHandle& Shape )
void	SetShapeToNewGeom ( const FPhysicsShapeHandle& Shape )
void	UpdateBodySetup()	Update the body setup parameters based on shape information

Overridden from UPrimitiveComponent

	Name	Description
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
bool	DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExpo... )	Collects custom navigable geometry of component.
UBodySetup &...	GetBodySetup()	Return the BodySetup to use for this PrimitiveComponent (single body case)
bool	IgnoreBoundsForEditorFocus()	Whether or not the bounds of this component should be considered when focusing the editor camera to an actor with this component in it.

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
	bool	ShouldCollideWhenPlacing()	If true, bounds should be used when placing component/actor in level. Does not affect spawning.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Overridden from INavRelevantInterface

		Name	Description
	void	GetNavigationData ( FNavigationRelevantData& Data )	Prepare navigation modifiers
	bool	IsNavigationRelevant()	Are modifiers active?

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss