Class Brush

CSG brush object

Inheritance

Brush

Namespace: CSG

Assembly: FlaxEngine.dll

File: Engine/CSG/Brush.h

Syntax

public class Brush

Methods

CanUseCSG()

Returns true if brush affects world

Declaration

public virtual bool CanUseCSG() const

Returns

bool True if use CSG brush during level geometry building

GetBrushID()

Gets the CSG brush object ID.

Declaration

public virtual Guid GetBrushID() const = 0

Returns

Guid The unique ID.

GetBrushMode()

Gets CSG brush mode

Declaration

public virtual Mode GetBrushMode() const = 0

Returns

Mode Mode

GetBrushScene()

Gets the scene.

Declaration

public virtual Scene* GetBrushScene() const = 0

Returns

Scene Scene

GetSurfaces(Array<Surface, HeapAllocation>& surfaces)

Gets brush surfaces

Declaration

public virtual void GetSurfaces(Array<Surface, HeapAllocation>& surfaces) = 0

Parameters

Array<Surface, HeapAllocation> surfaces Result list of surfaces

GetSurfacesCount()

Gets brush surfaces amount

Declaration

public virtual int32 GetSurfacesCount() = 0

Returns

int32 The mount of the brush surfaces.

OnBrushModified()

Called when brush data gets modified (will request rebuilding in Editor).

Declaration

public virtual void OnBrushModified()