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

> Unreal Engine API Reference > Plugins > MeshModelingToolsEditorOnly > UBspConversionTool

Light Theme

Dark Theme

UBspConversionTool

Converts BSP brushes to static meshes.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

UBspConversionTool

References

Module	MeshModelingToolsEditorOnly
Header	/Engine/Plugins/Experimental/MeshModelingToolset/Source/MeshModelingToolsEditorOnly/Public/BspConversionTool.h
Include	#include "BspConversionTool.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UBspConversionTool : public UInteractiveTool

Remarks

Converts BSP brushes to static meshes.

Known limitations:

Preview does not respond to property changes in the brush detail panel while the tool is running. User would need to create some event that does change the preview (such as tool property change, or selection change).
BSP brushes with non-manifold geometry (specifically, the stair brushes) cannot be used with the "Convert, then combine" path because boolean operations do not allow them. The user gets properly notified of this if it comes up.

Variables

		Name	Description
	IToolsContextAs...	AssetAPI
	bool	bCanAccept
	TArray< ABrush ...	BrushesToConvert
	TArray< ABrush ...	BrushesToDelete
	ABrush *	BrushForPivot
	TMap< ABrush &#...	CachedBrushes
	EBspConversionT...	PendingAction
	UPreviewMesh &#...	PreviewMesh
	UBspConversionT...	Settings
	UWorld *	TargetWorld
	UBspConversionT...	ToolActions

Constructors

	Name	Description
	UBspConversionTool()

Functions

	Name	Description
void	ApplyAction ( EBspConversionToolAction ActionType )
bool	AtLeastOneValidConversionTarget()	Returns true if there is at least one valid conversion actor selected (an explicitly selected brush, or a volume if those are included).
bool	CombineThenConvert ( FText* ErrorMessage )	The easy conversion path, where we just use the existing bsp conversion function to convert everything that was selected.
bool	CompareAndUpdateConversionTargets()	Updates the targets that the conversion functions operate on (BrushesToConvert, BrushForPivot), based on level composition, current selection, and settings.
bool	ComputeAndUpdatePreviewMesh ( FText* ErrorMessage )	Performs conversion of BrushesToConvert and stores the result in the preview mesh.
bool	ConvertThenCombine ( FText* ErrorMessage )	The more complicated conversion path, where we convert brushes individually and use static mesh boolean operations to combine them.
bool	IsValidConversionTarget ( const ABrush* Brush )	Determines whether the passed in pointer is a valid convertible brush.
void	OnEditorActorMoved ( AActor* InActor )	Actor movements include any transform changes, and change both the preview and the cached brushes.
void	OnEditorLevelActorListChanged()	Changes to the actor list may change the order of brush composition, or add or remove implicitly included subtractive brushes.
void	OnEditorSelectionChanged ( UObject* NewSelection )	This is the primary event we'll be responding to.
void	RequestAction ( EBspConversionToolAction ActionType )
void	SetAssetAPI ( IToolsContextAssetAPI* InAsset... )
void	SetWorld ( UWorld* World )

Overridden from UInteractiveTool

	Name	Description
bool	CanAccept()
bool	HasAccept()
bool	HasCancel()
void	OnPropertyModified ( UObject* PropertySet, FProperty* Property )	Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes
void	OnTick ( float DeltaTime )	Action support/system
void	RegisterActions ( FInteractiveToolActionSet& ActionS... )	Override this function to register the set of Actions this Tool supports, using FInteractiveToolActionSet::RegisterAction.
void	Render ( IToolsContextRenderAPI* Render... )	Allow the Tool to do any custom drawing (ie via PDI/RHI)
void	Setup()	Called by ToolManager to initialize the Tool after ToolBuilder::BuildTool() has been called
void	Shutdown ( EToolShutdownType ShutdownType )	Called by ToolManager to shut down the Tool

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss