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 > MeshPaintingToolset > UMeshVertexPaintingTool

Light Theme

Dark Theme

UMeshVertexPaintingTool

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

USingleSelectionTool

UMeshSurfacePointTool

UBaseBrushTool

UMeshVertexPaintingTool

	UMeshColorPaintingTool
	UMeshWeightPaintingTool

References

Module	MeshPaintingToolset
Header	/Engine/Plugins/MeshPainting/Source/MeshPaintingToolset/Public/MeshVertexPaintingTool.h
Include	#include "MeshVertexPaintingTool.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract)
class UMeshVertexPaintingTool :
public UBaseBrushTool,
public IMeshPaintSelectionInterface

Variables

		Name	Description
	bool	bCachedClickRay
	bool	bInDrag
	bool	bResultValid
	bool	bStampPending
	double	InitialMeshArea
	FRay	PendingClickRay
	FVector2D	PendingClickScreenPosition
	FRay	PendingStampRay
	UMeshPaintSelec...	SelectionMechanic

Constructors

	Name	Description
	UMeshVertexPaintingTool()

Functions

	Name	Description
void	ApplyVertexData ( FPerVertexPaintActionArgs& InArgs, int32 VertexIndex, FMeshPaintParameters Parameters )	Per vertex action function used for painting vertex data
void	CacheSelectionData()
double	CalculateTargetEdgeLength ( int TargetTriCount )
void	FinishPainting()
bool	IsPainting()
FSimpleDeleg...	OnPaintingFinished()
bool	Paint ( const TArrayView< TPair< FVector, F... )
bool	Paint ( const FVector& InRayOrigin, const FVector& InRayDirection )
void	SetAdditionalPaintParameters ( FMeshPaintParameters& InPaintParam... )
void	UpdateResult()

Overridden from UBaseBrushTool

		Name	Description
	double	EstimateMaximumTargetDimension()	Subclasses should implement this to give an estimate of target dimension for brush size scaling

Overridden from UMeshSurfacePointTool

	Name	Description
bool	HitTest ( const FRay& Ray, FHitResult& OutHit )
void	OnBeginDrag ( const FRay& Ray )	UMeshSurfacePointTool implementation
void	OnEndDrag ( const FRay& Ray )	This function is called when the user releases the button driving a click-drag-release interaction
void	OnUpdateDrag ( const FRay& Ray )	This function is called each frame that the user is in a click-drag-release interaction

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	Render ( IToolsContextRenderAPI* Render... )	Allow the Tool to do any custom drawing (ie via PDI/RHI)
void	Setup()	Register InputBehaviors, etc
void	Shutdown ( EToolShutdownType ShutdownType )	Called by ToolManager to shut down the Tool

Overridden from IClickDragBehaviorTarget

		Name	Description
	FInputRayHit	CanBeginClickDragSequence ( const FInputDeviceRay& PressPos )	IClickDragBehaviorTarget implementation.

Overridden from IModifierToggleBehaviorTarget

		Name	Description
	void	OnUpdateModifierState ( int ModifierID, bool bIsOn )	Notify target of current modifier state

Overridden from IMeshPaintSelectionInterface

		Name	Description
	bool	AllowsMultiselect()
	bool	IsMeshAdapterSupported ( TSharedPtr< IMeshPaintComponentAdap... )

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

Take our survey

Dismiss