UBrushComponent

Inheritance Hierarchy

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

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

BuildSimpleBrushCollision()

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

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) b...

 

HasInvertedPolys()

Return true if the brush appears to have inverted polys

Public function

[ENGINE_API](API\Runtime\Engine\AI\Navigation\ENGINE_API) v...

 

RequestUpdateBrushCollision()

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

Overridden from UPrimitiveComponent

Name Description

Public function Virtual

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

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

uint8

 

GetStaticDepthPriorityGroup()

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

Public function Virtual

void

 

GetUsedMaterials

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

Retrieves the materials used in this component

Overridden from USceneComponent

Name Description

Public function Virtual

FBoxSphereBo ...

 

CalcBounds

(
    const FTransform & LocalToWorld
)

Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Public function Virtual

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

void

 

GetResourceSizeEx

(
    FResourceSizeEx & CumulativeResourc...
)

Get the size of the object/resource for display to artists/LDs in the Editor.

Public function Virtual

bool

 

IsEditorOnly()

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

Public function Virtual

void

 

PostLoad()

WITH_EDITOR.

See Also

References

Module

Engine

Header

Runtime/Engine/Classes/Components/BrushComponent.h