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

UBrushComponent

A brush component defines a shape that can be modified within the editor.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UBrushComponent

References

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

Syntax

class UBrushComponent : public UPrimitiveComponent

Remarks

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.

Variables

		Name	Description
	UModel *	Brush
	UBodySetup *...	BrushBodySetup	Description of collision

Constructors

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

Functions

	Name	Description
void	BuildSimpleBrushCollision()	Create the AggGeom collection-of-convex-primitives from the Brush UModel data.
bool	HasInvertedPolys()	Return true if the brush appears to have inverted polys
void	RequestUpdateBrushCollision()	If the transform mirroring no longer reflects the body setup, request its recalculation

Overridden from UPrimitiveComponent

	Name	Description
bool	ComponentIsTouchingSelectionBox ( const FBox& InSelBBox, const FEngineShowFlags& ShowFlags, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComp... )	Determines whether the supplied bounding box intersects with the component.
bool	ComponentIsTouchingSelectionFrustum ( const FConvexVolume& InFrustum, const FEngineShowFlags& ShowFlags, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComp... )	Determines whether the supplied frustum intersects with the component.
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
UBodySetup &...	GetBodySetup()	Return the BodySetup to use for this PrimitiveComponent (single body case)
uint8	GetStaticDepthPriorityGroup()	Determines the DPG the primitive's primary elements are drawn in.
void	GetUsedMaterials ( TArray< UMaterialInterface* > ..., bool bGetDebugMaterials )	Retrieves the materials used in this component

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
	bool	IsEditorOnly()	Returns whether this component is an editor-only object or not
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

		Name	Description
	FVector	PrePivot_DEPRECATED	Local space translation