Navigation
API > API/Runtime > API/Runtime/Engine
A brush component defines a shape that can be modified within the editor. They are used both as part of BSP building, and for volumes.
| Name | UBrushComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/BrushComponent.h |
| Include Path | #include "Components/BrushComponent.h" |
Syntax
UCLASS (EditInlineNew, MinimalAPI,
HideCategories=(Physics, Lighting, LOD, Rendering, TextureStreaming, Transform, Activation, "Components|Activation"),
ShowCategories=(Mobility, "Rendering|Material"))
class UBrushComponent : public UPrimitiveComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UBrushComponent
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UBrushComponent
(
const FObjectInitializer& ObjectInitializer |
Components/BrushComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Brush | TObjectPtr< class UModel > | Components/BrushComponent.h | ||
| BrushBodySetup | TObjectPtr< class UBodySetup > | Description of collision | Components/BrushComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BuildSimpleBrushCollision() |
Create the AggGeom collection-of-convex-primitives from the Brush UModel data. | Components/BrushComponent.h | |
void ConditionalRebuildAlteredBSP() |
Components/BrushComponent.h | ||
bool HasInvertedPolys() |
Return true if the brush appears to have inverted polys | Components/BrushComponent.h | |
void RequestUpdateBrushCollision() |
If the transform mirroring no longer reflects the body setup, request its recalculation | Components/BrushComponent.h |
Overridden from UPrimitiveComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ComponentIsTouchingSelectionBox
(
const FBox& InSelBBox, |
Determines whether the supplied bounding box intersects with the component. | Components/BrushComponent.h | |
virtual bool ComponentIsTouchingSelectionFrustum
(
const FConvexVolume& InFrustum, |
Determines whether the supplied frustum intersects with the component. | Components/BrushComponent.h | |
virtual FPrimitiveSceneProxy * CreateSceneProxy() |
Creates a proxy to represent the primitive to the scene manager in the rendering thread. | Components/BrushComponent.h | |
virtual UBodySetup * GetBodySetup() |
Return the BodySetup to use for this PrimitiveComponent (single body case) | Components/BrushComponent.h | |
| Determines the DPG the primitive's primary elements are drawn in. | Components/BrushComponent.h | ||
virtual void GetUsedMaterials
(
TArray< UMaterialInterface* >& OutMaterials, |
Retrieves the materials used in this component | Components/BrushComponent.h | |
virtual bool IsShown
(
const FEngineShowFlags& ShowFlags |
Would this primitive be shown with these rendering flags. | Components/BrushComponent.h |
Overridden from USceneComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBoxSphereBounds CalcBounds
(
const FTransform& LocalToWorld |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. | Components/BrushComponent.h | |
virtual bool ShouldCollideWhenPlacing() |
If true, bounds should be used when placing component/actor in level. Does not affect spawning. | Components/BrushComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsEditorOnly() |
Returns whether this component is an editor-only object or not | Components/BrushComponent.h | |
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Components/BrushComponent.h | ||
virtual void PostLoad() |
Components/BrushComponent.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PrePivot_DEPRECATED | FVector | Local space translation | Components/BrushComponent.h |