UBrushBuilder

Base class of UnrealEd brush builders.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/BrushBuilder.h

Include

#include "Engine/BrushBuilder.h"

Syntax

class UBrushBuilder : public UObject

Remarks

Base class of UnrealEd brush builders.

Tips for writing brush builders:

  • Always validate the user-specified and call BadParameters function if anything is wrong, instead of actually building geometry. If you build an invalid brush due to bad user parameters, you'll cause an extraordinary amount of pain for the poor user.

  • When generating polygons with more than 3 vertices, BE SURE all the polygon's vertices are coplanar! Out-of-plane polygons will cause geometry to be corrupted.

Variables

Name Description

Public variable

FString

 

BitmapFilename

Protected variable

FName

 

Layer

Protected variable

uint32: 1

 

MergeCoplanars

Public variable

uint32: 1

 

NotifyBadParams

If false, disabled the bad param notifications

Protected variable

TArray< struct ...

 

Polys

Public variable

FString

 

ToolTip

Localized FString that will be displayed as the name of this brush builder in the editor

Protected variable

TArray< FVector...

 

Vertices

Constructors

Name Description

Public function

UBrushBuilder

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

bool

 

BadParameters

(
    const FText& msg
)

Public function Virtual

void

 

BeginBrush

(
    bool InMergeCoplanars,
    FName InLayer
)

@ todo document all below

Public function Virtual

bool

 

Build

(
    UWorld* InWorld,
    ABrush* InBrush
)

Builds the brush shape for the specified ABrush or the builder brush if Brush is nullptr.

Public function Virtual

bool

 

EndBrush

(
    UWorld* InWorld,
    ABrush* InBrush
)

Public function Virtual Const

int32

 

GetPolyCount()

Public function Virtual Const

FVector

 

GetVertex

(
    int32 i
)

Public function Virtual Const

int32

 

GetVertexCount()

Public function Virtual

void

 

Poly3i

(
    int32 Direction,
    int32 i,
    int32 j,
    int32 k,
    FName ItemName,
    bool bIsTwoSidedNonSolid
)

Public function Virtual

void

 

Poly4i

(
    int32 Direction,
    int32 i,
    int32 j,
    int32 k,
    int32 l,
    FName ItemName,
    bool bIsTwoSidedNonSolid
)

Public function Virtual

void

 

PolyBegin

(
    int32 Direction,
    FName ItemName
)

Public function Virtual

void

 

PolyEnd()

Public function Virtual

void

 

Polyi

(
    int32 i
)

Public function Virtual

int32

 

Vertex3f

(
    float X,
    float Y,
    float Z
)

Public function Virtual

int32

 

Vertexv

(
    FVector v
)