1. Epic GamesDeveloper
  3. UShapeComponent

UShapeComponent

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

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract,  
       HideCategories=(Object, LOD, Lighting, TextureStreaming, Activation, "Components|Activation"),  
       EditInlineNew, Meta=(BlueprintSpawnableComponent), ShowCategories=(Mobility), MinimalAPI)  
class UShapeComponent : public UPrimitiveComponent

Remarks

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

Variables

  Type Name Description
Public variable UProperty TSubclassOf< class UNavAreaBase > AreaClass Navigation area type (empty / none has no effect on underlying area type).
Protected variable UProperty Category, EditAnywhere, Meta TSubclassOf< class UNavAreaBase > AreaClassOverride Navigation area type override, null / none = no change to nav mesh.
Public variable UProperty uint8: 1 bDrawOnlyIfSelected Only show this component if the actor is selected
Public variable UProperty Category, EditAnywhere uint8: 1 bDynamicObstacle If set, shape will be exported for navigation as dynamic modifier instead of using regular collision data
Public variable UProperty uint8: 1 bShouldCollideWhenPlacing If true it allows Collision when placing even if collision is not enabled
Protected variable uint8: 1 bUseArchetypeBodySetup If the body setup can be shared (i.e. there have been no alterations compared to the CDO)
Protected variable UProperty Category, EditAnywhere, Meta uint8: 1 bUseSystemDefaultObstacleAreaClass Uses FNavigationSystem::GetDefaultObstacleArea() by default instead of AreaClassOverride, bDynamicObstacle must be true to use this.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly float LineThickness Used to control the line thickness when rendering
Public variable UProperty Transient duplicatetransient TObjectPtr< class UBodySetup > ShapeBodySetup Description of collision
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly FColor ShapeColor Color used to draw the shape.

Constructors

  Type Name Description
Public function  

UShapeComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function Const TSubclassOf< class UNavAreaBase >  
Protected function bool Checks if a shared body setup is available (and if we're eligible for it).
Public function void

SetAreaClassOverride ( TSubclassOf< class UNavAreaBase > InAreaClassOverride
)

  
Public function UFunction BlueprintCallable, Category void

SetLineThickness ( float Thickness
)

 Set the LineThickness.
Protected function ENGINE_API void  
Protected function void  
Protected function ENGINE_API void  
Protected function ENGINE_API void  
Public function void  
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 UBodySetup * Return the BodySetup to use for this PrimitiveComponent (single body case)
Public function Virtual Const bool 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

  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.
Public function Virtual Const bool If true, bounds should be used when placing component/actor in level. Does not affect spawning.

Overridden from UActorComponent

  Type Name Description
Public function Virtual Const bool Override to specify that a component is relevant to the navigation system

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from INavRelevantInterface

  Type Name Description
Public function Virtual Const bool Collects custom navigable geometry of component.
Public function Virtual Const void Prepares navigation modifiers

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page