Navigation
API > API/Plugins > API/Plugins/MeshModelingToolsEditorOnlyExp
Editor tool to paint a vertex attribute as vertex colors
| Name | UMeshVertexAttributePaintToolBase |
| Type | class |
| Header File | /Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsEditorOnlyExp/Public/MeshVertexAttributePaintToolBase.h |
| Include Path | #include "MeshVertexAttributePaintToolBase.h" |
Syntax
UCLASS (MinimalAPI)
class UMeshVertexAttributePaintToolBase : public UMeshSculptToolBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → USingleSelectionTool → UMeshSurfacePointTool → UMeshSculptToolBase → UMeshVertexAttributePaintToolBase
Implements Interfaces
- IClickDragBehaviorTarget
- IModifierToggleBehaviorTarget
- IHoverBehaviorTarget
- IInputBehaviorSource
- IInteractiveToolCameraFocusAPI
Derived Classes
- UDataflowEditorVertexAttributePaintTool
- UMeshAttributePaintToolV2
- UMorphTargetMaskTool
- USkeletalMeshVertexAttributePaintTool
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMeshVertexAttributePaintToolBase() |
MeshVertexAttributePaintToolBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UMeshVertexAttributePaintToolBase() |
MeshVertexAttributePaintToolBase.h |
Structs
| Name | Remarks |
|---|---|
| FMirrorData | This structure holds information for mirroring |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ColorMapDisplayInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| CopyAverageValueInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| EdgesSelectionModeInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| FacesSelectionModeInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| FloodSelectionInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| GreyscaleDisplayInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| GrowSelectionInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| InvertMirrorDirectionInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| MaterialColorDisplayInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| MirrorValuesInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| PaintBrushId | int32 | MeshVertexAttributePaintToolBase.h | |
| PasteAverageValueInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| ShrinkSelectionInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| SmoothBrushId | int32 | MeshVertexAttributePaintToolBase.h | |
| ToggleValuePickerInputChord | FInputChord | MeshVertexAttributePaintToolBase.h | |
| VerticesSelectionModeInputChord | FInputChord | MeshVertexAttributePaintToolBase.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PaintBrushOpProperties | TObjectPtr< UMeshVertexAttributePaintToolPaintBrushOpProps > | MeshVertexAttributePaintToolBase.h | ||
| SmoothBrushOpProperties | TObjectPtr< UMeshVertexAttributePaintToolSmoothBrushOpProps > | MeshVertexAttributePaintToolBase.h | ||
| ToolProperties | TObjectPtr< UMeshVertexAttributePaintToolProperties > | Properties of the tool | MeshVertexAttributePaintToolBase.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MirrorData | FMirrorData | MeshVertexAttributePaintToolBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ApplyValueToSelection
(
EMeshVertexAttributePaintToolEditOperation Operation, |
Selection operations | MeshVertexAttributePaintToolBase.h | |
void ApplyVisibilityFilter
(
const TArray< int32 >& Vertices, |
MeshVertexAttributePaintToolBase.h | ||
void ApplyVisibilityFilter
(
TSet< int32 >& Triangles, |
MeshVertexAttributePaintToolBase.h | ||
void CopyAverageFromSelectionToClipboard() |
MeshVertexAttributePaintToolBase.h | ||
void FloodSelection() |
MeshVertexAttributePaintToolBase.h | ||
float GetBrushAdaptiveSize() |
MeshVertexAttributePaintToolBase.h | ||
float GetBrushFalloff() |
MeshVertexAttributePaintToolBase.h | ||
float GetBrushMaxRadius() |
MeshVertexAttributePaintToolBase.h | ||
float GetBrushMinRadius() |
MeshVertexAttributePaintToolBase.h | ||
EMeshVertexAttributePaintToolEditMode GetEditingMode() |
MeshVertexAttributePaintToolBase.h | ||
const TArray< int32 > & GetSelectedVertices() |
MeshVertexAttributePaintToolBase.h | ||
void GrowSelection() |
MeshVertexAttributePaintToolBase.h | ||
bool HasSelection() |
MeshVertexAttributePaintToolBase.h | ||
bool HaveVisibilityFilter() |
MeshVertexAttributePaintToolBase.h | ||
void InvertSelection() |
MeshVertexAttributePaintToolBase.h | ||
bool IsInBrushMode() |
MeshVertexAttributePaintToolBase.h | ||
bool IsVolumetricBrush() |
MeshVertexAttributePaintToolBase.h | ||
void MirrorValues() |
MeshVertexAttributePaintToolBase.h | ||
void PasteValueToSelectionFromClipboard() |
MeshVertexAttributePaintToolBase.h | ||
void PruneSelection
(
float Threshold |
MeshVertexAttributePaintToolBase.h | ||
void SelectBorder() |
MeshVertexAttributePaintToolBase.h | ||
void SetBrushAdaptiveSize
(
float AdaptiveSize |
MeshVertexAttributePaintToolBase.h | ||
void SetBrushAreaMode
(
EMeshVertexPaintBrushAreaType BrushAreaMode |
MeshVertexAttributePaintToolBase.h | ||
void SetBrushFalloff
(
float NewFalloff |
MeshVertexAttributePaintToolBase.h | ||
void SetBrushMode
(
EMeshVertexAttributePaintToolEditOperation BrushMode |
MeshVertexAttributePaintToolBase.h | ||
void SetBrushRadius
(
float NewRadius |
MeshVertexAttributePaintToolBase.h | ||
void SetColorMode
(
EMeshVertexAttributePaintToolColorMode NewColorMode |
MeshVertexAttributePaintToolBase.h | ||
void SetComponentSelectionMode
(
EComponentSelectionMode NewMode |
MeshVertexAttributePaintToolBase.h | ||
void SetEditingMode
(
EMeshVertexAttributePaintToolEditMode Editmode |
MeshVertexAttributePaintToolBase.h | ||
void ShrinkSelection() |
MeshVertexAttributePaintToolBase.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SetFocusInViewport() |
MeshVertexAttributePaintToolBase.h |
Overridden from UMeshSculptToolBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual double GetCurrentBrushRadius() |
MeshVertexAttributePaintToolBase.h | ||
virtual void SetupBrushEditBehaviorSetup
(
ULocalTwoAxisPropertyEditInputBehavior& OutBehavior |
MeshVertexAttributePaintToolBase.h | ||
virtual void UpdateMaterialMode
(
EMeshEditingMaterialModes MaterialMode |
MeshVertexAttributePaintToolBase.h |
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAccept() |
MeshVertexAttributePaintToolBase.h | ||
virtual void DrawHUD
(
FCanvas* Canvas, |
MeshVertexAttributePaintToolBase.h | ||
virtual bool HasAccept() |
MeshVertexAttributePaintToolBase.h | ||
virtual bool HasCancel() |
MeshVertexAttributePaintToolBase.h | ||
| MeshVertexAttributePaintToolBase.h | |||
virtual void OnTick
(
float DeltaTime |
MeshVertexAttributePaintToolBase.h | ||
virtual void RegisterActions
(
FInteractiveToolActionSet& ActionSet |
MeshVertexAttributePaintToolBase.h | ||
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
MeshVertexAttributePaintToolBase.h | ||
virtual void Setup() |
MeshVertexAttributePaintToolBase.h | ||
virtual void Shutdown
(
EToolShutdownType ShutdownType |
MeshVertexAttributePaintToolBase.h |
Overridden from IInteractiveToolCameraFocusAPI
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBox GetWorldSpaceFocusBox() |
MeshVertexAttributePaintToolBase.h |
Overridden from IHoverBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit BeginHoverSequenceHitTest
(
const FInputDeviceRay& Ray |
MeshVertexAttributePaintToolBase.h | ||
virtual bool OnUpdateHover
(
const FInputDeviceRay& DevicePos |
MeshVertexAttributePaintToolBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ApplyStamp
(
const FSculptBrushStamp& InStamp |
MeshVertexAttributePaintToolBase.h | ||
void BeginChange() |
MeshVertexAttributePaintToolBase.h | ||
void CancelChange() |
MeshVertexAttributePaintToolBase.h | ||
UE::Geometry::FFrame3d ComputeMirroredFrame
(
const UE::Geometry::FFrame3d& InLocalSpaceFrame |
MeshVertexAttributePaintToolBase.h | ||
float ComputeStampFalloffAtVertex
(
const FSculptBrushStamp& Stamp, |
MeshVertexAttributePaintToolBase.h | ||
void EnableBrushMirroring
(
bool bEnable |
MeshVertexAttributePaintToolBase.h | ||
void EnableValuePicker
(
bool bEnable |
MeshVertexAttributePaintToolBase.h | ||
void EndChange() |
MeshVertexAttributePaintToolBase.h | ||
void FullUpdateOctree() |
MeshVertexAttributePaintToolBase.h | ||
float GetAverageWeightValueFromSelection() |
MeshVertexAttributePaintToolBase.h | ||
int32 GetBrushNearestVertex() |
MeshVertexAttributePaintToolBase.h | ||
int32 GetBrushNearestVertexAccurate() |
MeshVertexAttributePaintToolBase.h | ||
float GetCurrentWeightValueUnderBrush() |
MeshVertexAttributePaintToolBase.h | ||
EMeshSelectorTool GetMeshSelectionTool() |
MeshVertexAttributePaintToolBase.h | ||
EAxis::Type GetMirrorAxis() |
MeshVertexAttributePaintToolBase.h | ||
void InitializeMirrorIndicator() |
MeshVertexAttributePaintToolBase.h | ||
bool IsBrushMirroringEnabled() |
MeshVertexAttributePaintToolBase.h | ||
bool IsBrushMirroringInObjectSpace() |
MeshVertexAttributePaintToolBase.h | ||
bool IsMirrorPlaneWidgetVisible() |
MeshVertexAttributePaintToolBase.h | ||
bool IsValuePickerEnabled() |
MeshVertexAttributePaintToolBase.h | ||
void LoadBrushConfig
(
EMeshVertexAttributePaintToolEditOperation BrushMode |
MeshVertexAttributePaintToolBase.h | ||
void OnColorRampChanged
(
TArray< FRichCurve* > Curves |
MeshVertexAttributePaintToolBase.h | ||
void OnMirrorCommand() |
MeshVertexAttributePaintToolBase.h | ||
void OnSelectionModified() |
MeshVertexAttributePaintToolBase.h | ||
void PrecomputeSeamEdges() |
MeshVertexAttributePaintToolBase.h | ||
void RebuildOctree() |
MeshVertexAttributePaintToolBase.h | ||
void SaveBrushConfig
(
EMeshVertexAttributePaintToolEditOperation BrushMode |
MeshVertexAttributePaintToolBase.h | ||
bool SetAttributeToPaint
(
int32 InNewAttributeIndex |
MeshVertexAttributePaintToolBase.h | ||
void SetMeshSelectionTool
(
EMeshSelectorTool SelectorTool |
MeshVertexAttributePaintToolBase.h | ||
void SetMirrorAxis
(
EAxis::Type InAxis |
MeshVertexAttributePaintToolBase.h | ||
void SetMirrorPlaneWidgetVisible
(
bool bVisible |
MeshVertexAttributePaintToolBase.h | ||
bool SyncMeshWithWeightBuffer() |
MeshVertexAttributePaintToolBase.h | ||
bool SyncWeightBufferWithMesh() |
MeshVertexAttributePaintToolBase.h | ||
bool UpdateBrushPosition
(
const FRay& WorldRay |
MeshVertexAttributePaintToolBase.h | ||
void UpdateBrushType
(
EMeshVertexAttributePaintToolEditOperation EditOperation |
MeshVertexAttributePaintToolBase.h | ||
void UpdateMirrorIndicator() |
MeshVertexAttributePaintToolBase.h | ||
void UpdateMirrorPlaneMesh() |
MeshVertexAttributePaintToolBase.h | ||
void UpdateROI
(
const FSculptBrushStamp& CurrentStamp, |
MeshVertexAttributePaintToolBase.h | ||
bool UpdateStampPosition
(
const FRay& WorldRay |
MeshVertexAttributePaintToolBase.h | ||
void UpdateVertexColorOverlay
(
const TSet< int32 >* TrianglesToUpdate |
Update the vertex color of the mesh from the attribute | MeshVertexAttributePaintToolBase.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CommitToolMesh
(
FDynamicMesh3& InToolMesh |
MeshVertexAttributePaintToolBase.h | ||
virtual bool SetupToolMesh
(
FDynamicMesh3& InOutToolMesh, |
MeshVertexAttributePaintToolBase.h | ||
virtual void UpdatePreview
(
const TSet< int32 >* TrianglesToUpdate, |
MeshVertexAttributePaintToolBase.h |
Overridden from UMeshSculptToolBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 FindHitSculptMeshTriangleConst
(
const FRay3d& LocalRay |
MeshVertexAttributePaintToolBase.h | ||
virtual int32 FindHitTargetMeshTriangleConst
(
const FRay3d& LocalRay |
MeshVertexAttributePaintToolBase.h | ||
virtual FDynamicMesh3 * GetBaseMesh () |
MeshVertexAttributePaintToolBase.h | ||
virtual const FDynamicMesh3 * GetBaseMesh () |
MeshVertexAttributePaintToolBase.h | ||
virtual UBaseDynamicMeshComponent * GetSculptMeshComponent() |
UMeshSculptToolBase API. | MeshVertexAttributePaintToolBase.h | |
virtual void InitializeIndicator() |
MeshVertexAttributePaintToolBase.h | ||
virtual void OnBeginStroke
(
const FRay& WorldRay |
MeshVertexAttributePaintToolBase.h | ||
virtual void OnCancelStroke() |
MeshVertexAttributePaintToolBase.h | ||
virtual void OnEndStroke() |
MeshVertexAttributePaintToolBase.h | ||
virtual bool SharesBrushPropertiesChanges() |
MeshVertexAttributePaintToolBase.h | ||
virtual bool ShowWorkPlane() |
MeshVertexAttributePaintToolBase.h | ||
virtual void UpdateHitSculptMeshTriangle
(
int32 TriangleID, |
MeshVertexAttributePaintToolBase.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddReferencedObjects
(
UObject* InThis, |
MeshVertexAttributePaintToolBase.h |