1. Epic GamesDeveloper
  3. UMeshVertexSculptTool

UMeshVertexSculptTool

Mesh Vertex Sculpt Tool Class

API > API/Plugins > API/Plugins/MeshModelingToolsExp

Inheritance Hierarchy

References

   
Module MeshModelingToolsExp
Header /Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsExp/Public/MeshVertexSculptTool.h
Include #include "MeshVertexSculptTool.h"

Syntax

UCLASS&40;&41;  
class UMeshVertexSculptTool : public UMeshSculptToolBase

Remarks

Mesh Vertex Sculpt Tool Class

Variables

  Type Name Description
Protected variable TSet< int32 > AccumulatedTriangleROI  
Protected variable TUniquePtr< UE::Geometry::FPolygroupSet > ActiveGroupSet  
Protected variable FMeshVertexChangeBuilder * ActiveVertexChange  
Public variable UProperty TObjectPtr< UVertexBrushAlphaProperties > AlphaProperties  
Protected variable bool bApplySymmetry  
Protected variable FDynamicMesh3 BaseMesh  
Protected variable TArray< int32 > BaseMeshIndexBuffer  
Protected variable TFunction< bool(int32, const FVector3d &, double MaxDist, FVector3d &, FVector3d &)> BaseMeshQueryFunc  
Protected variable UE::Geometry::FDynamicMeshOctree3 BaseMeshSpatial  
Protected variable bool bCachedFreezeTarget  
Protected variable bool bHaveBrushAlpha  
Protected variable bool bMeshSymmetryIsValid  
Public variable UProperty TObjectPtr< UTexture2D > BrushAlpha  
Protected variable UE::Geometry::FImageDimensions BrushAlphaDimensions  
Protected variable UE::Geometry::TImageBuilder< FVector4f > BrushAlphaValues  
Protected variable bool bStampUpdatePending  
Protected variable bool bTargetDirty Whether normal needs recompute.
Protected variable bool bUndoUpdatePending  
Protected variable UProperty TObjectPtr< UDynamicMeshComponent > DynamicMeshComponent  
Protected variable int32 InitialStrokeTriangleID  
Protected variable TArray< int > NormalsBuffer  
Protected variable TArray< std::atomic< bool > > NormalsFlags  
Protected variable UE::Geometry::FUniqueIndexSet NormalsROIBuilder  
Protected variable UE::Geometry::FDynamicMeshOctree3 Octree  
Protected variable TArray< uint32 > OctreeUpdateTempBuffer  
Protected variable TArray< bool > OctreeUpdateTempFlagBuffer  
Public variable OnInteractiveToolDetailsPanelRequestRebuild OnDetailsPanelRequestRebuild  
Protected variable FDelegateHandle OnDynamicMeshComponentChangedHandle  
Protected variable EMeshVertexSculptBrushType PendingStampType  
Protected variable UProperty TObjectPtr< AInternalToolFrameworkActor > PreviewMeshActor  
Protected variable TArray< int > RangeQueryTriBuffer  
Protected variable TArray< FVector3d > ROIPositionBuffer  
Protected variable TArray< FVector3d > ROIPrevPositionBuffer  
Protected variable double SculptMaxFixedHeight  
Public variable UProperty TObjectPtr< UVertexBrushSculptProperties > SculptProperties Properties that control sculpting
Protected variable FRandomStream StampRandomStream  
Protected variable TFuture< void > StampUpdateOctreeFuture  
Protected variable TArray< FVector3d > SymmetricROIPositionBuffer  
Protected variable TArray< FVector3d > SymmetricROIPrevPositionBuffer  
Protected variable TArray< int > SymmetricVertexROI  
Protected variable TPimplPtr< UE::Geometry::FMeshPlanarSymmetry > Symmetry  
Public variable UProperty TObjectPtr< UMeshSymmetryProperties > SymmetryProperties  
Protected variable TArray< int32 > TriangleComponentIDs  
Protected variable TArray< int > TriangleROIArray  
Protected variable UE::Geometry::FUniqueIndexSet TriangleROIBuilder  
Protected variable TArray< UE::Geometry::FIndex3i > TriangleROIInBuf  
Protected variable TFuture< bool > UndoNormalsFuture  
Protected variable TFuture< bool > UndoUpdateBaseMeshFuture  
Protected variable TFuture< bool > UndoUpdateOctreeFuture  
Protected variable TArray< int > VertexROI  
Protected variable UE::Geometry::FUniqueIndexSet VertexROIBuilder  

Functions

  Type Name Description
Protected function TFuture< void >  
Protected function void  
Protected function void  
Protected function bool

GetBaseMeshNearest ( int32 VertexID,
const FVector3d& Position,
double SearchRadius,
FVector3d& TargetPosOut,
FVector3d& TargetNormalOut
)

  
Protected function bool

IsHitTriangleBackFacing ( int32 TriangleID,
const FDynamicMesh3* QueryMesh
)

  
Protected function void

OnDynamicMeshComponentChanged ( UDynamicMeshComponent* Component,
const FMeshVertexChange* Change,
bool bRevert
)

 Realtime visualization
Protected function Const double

SampleBrushAlpha ( const FSculptBrushStamp& Stamp,
const FVector3d& Position
)

  
Public function Virtual void

SetActiveBrushType ( int32 Identifier
)

  
Public function Virtual void

SetActiveFalloffType ( int32 Identifier
)

  
Public function Virtual void

SetRegionFilterType ( int32 Identifier
)

  
Protected function void  
Protected function Virtual void  
Protected function void

UpdateBaseMesh ( const TSet< int32 >* TriangleROI
)

  
Public function Virtual void  
Protected function bool

UpdateBrushPosition ( const FRay& WorldRay
)

  
Protected function void  
Protected function void

UpdateROI ( const FVector3d& BrushPos
)

  
Protected function bool

UpdateStampPosition ( const FRay& WorldRay
)

  
Protected function void  
Protected function void  

Overridden from UMeshSculptToolBase

  Type Name Description
Public function Virtual void  
Protected function Virtual int32

FindHitSculptMeshTriangle ( const FRay3d& LocalRay
)

  
Protected function Virtual int32

FindHitTargetMeshTriangle ( const FRay3d& LocalRay
)

  
Protected function Virtual FDynamicMesh3 *  
Protected function Virtual Const const FDynamicMesh3 *  
Protected function Virtual UBaseDynamicMeshComponent * Subclass must implement this and return relevant rendering component
Public function Virtual void Client currently needs to implement these...
Protected function Virtual void UMeshSculptToolBase API.
Protected function Virtual UPreviewMesh *

MakeBrushIndicatorMesh ( UObject* Parent,
UWorld* World
)

 Called by InitializeIndicator to create a mesh for the brush ROI indicator. Default is sphere.
Protected function Virtual void

OnBeginStroke ( const FRay& WorldRay
)

  
Protected function Virtual void  
Protected function Virtual Const bool  
Protected function Virtual void

UpdateHoverStamp ( const FFrame3d& StampFrameWorld
)

  

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

OnPropertyModified ( UObject* PropertySet,
FProperty* Property
)

 Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes
Public function Virtual void

OnTick ( float DeltaTime
)

 Allow the Tool to do any necessary processing on Tick
Public function Virtual void Allow the Tool to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ()

 Register InputBehaviors, etc
Public function Virtual void

Shutdown ( EToolShutdownType ShutdownType
)

 Called by ToolManager to shut down the Tool

Overridden from IHoverBehaviorTarget

  Type Name Description
Public function Virtual bool

OnUpdateHover ( const FInputDeviceRay& DevicePos
)

 Update active hover sequence with new input position

Typedefs

Name Description
OnInteractiveToolDetailsPanelRequestRebuild OnDetailsPanelRequestRebuild is broadcast by the tool when it detects it needs to have it's details panel rebuilt outside of normal rebuilding triggers, such as changing property set objects.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page