UBrushComponent

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

Windows
MacOS
Linux

Inheritance Hierarchy

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

Public variable

UModel *

 

Brush

Public variable

UBodySetup *...

 

BrushBodySetup

Description of collision

Constructors

Name Description

Public function

UBrushComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

BuildSimpleBrushCollision()

Create the AggGeom collection-of-convex-primitives from the Brush UModel data.

Public function Const

bool

 

HasInvertedPolys()

Return true if the brush appears to have inverted polys

Public function

void

 

RequestUpdateBrushCollision()

If the transform mirroring no longer reflects the body setup, request its recalculation

Overridden from UPrimitiveComponent

Name Description

Public function Virtual Const

bool

 

ComponentIsTouchingSelectionBox

(
    const FBox& InSelBBox,
    const FEngineShowFlags& ShowFlags,
    const bool bConsiderOnlyBSP,
    const bool bMustEncompassEntireComp...
)

Determines whether the supplied bounding box intersects with the component.

Public function Virtual Const

bool

 

ComponentIsTouchingSelectionFrustum

(
    const FConvexVolume& InFrustum,
    const FEngineShowFlags& ShowFlags,
    const bool bConsiderOnlyBSP,
    const bool bMustEncompassEntireComp...
)

Determines whether the supplied frustum intersects with the component.

Public function Virtual

FPrimitiveSc...

 

CreateSceneProxy()

Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Public function Virtual

UBodySetup &...

 

GetBodySetup()

Return the BodySetup to use for this PrimitiveComponent (single body case)

Public function Virtual Const

uint8

 

GetStaticDepthPriorityGroup()

Determines the DPG the primitive's primary elements are drawn in.

Public function Virtual Const

void

 

GetUsedMaterials

(
    TArray< UMaterialInterface* > ...,
    bool bGetDebugMaterials
)

Retrieves the materials used in this component

Overridden from USceneComponent

Name Description

Public function Virtual Const

FBoxSphereBo...

 

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

 

ShouldCollideWhenPlacing()

If true, bounds should be used when placing component/actor in level. Does not affect spawning.

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

IsEditorOnly()

Returns whether this component is an editor-only object or not

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

Name Description

Public variable

FVector

 

PrePivot_DEPRECATED

Local space translation

See Also

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback