1. Epic GamesDeveloper
  3. UMeshSculptToolBase

UMeshSculptToolBase

Base Tool for mesh sculpting tools, provides some shared functionality

API > API/Plugins > API/Plugins/MeshModelingToolsExp > API/Plugins/MeshModelingToolsExp/Sculpting

Inheritance Hierarchy

References

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

Syntax

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

Remarks

Base Tool for mesh sculpting tools, provides some shared functionality

Variables

  Type Name Description
Protected variable FFrame3d ActiveBrushTargetPlaneWorld Brush Target Plane is plane that some brushes move on
Public variable UProperty TObjectPtr< UMaterialInstanceDynamic > ActiveOverrideMaterial  
Protected variable double ActivePressure  
Protected variable double ActiveStrokePathArcLen  
Protected variable double ActiveStrokeTime For tracking stroke time and length, to apply spacing and flow rate settings
Protected variable bool bBrushOpPropsVisible  
Protected variable bool bInStroke Stroke Modifiers
Protected variable bool bInvert  
Protected variable bool bIsStampPending Stamps
Protected variable UProperty bool bIsVolumetricIndicator  
Protected variable UProperty TObjectPtr< UBrushStampIndicator > BrushIndicator  
Protected variable UProperty TObjectPtr< UMaterialInstanceDynamic > BrushIndicatorMaterial  
Protected variable UProperty TObjectPtr< UPreviewMesh > BrushIndicatorMesh  
Protected variable TMap< int32, TUniquePtr< FMeshSculptBrushOpFactory > > BrushOpFactories  
Protected variable UProperty TMap< int32, TObjectPtr< UMeshSculptBrushOpProps > > BrushOpPropSets  
Public variable UProperty TObjectPtr< USculptBrushProperties > BrushProperties Properties that control brush size/etc
Protected variable UE::Geometry::FInterval1d BrushRelativeSizeRange Brush Size
Protected variable bool bSmoothing  
Protected variable FViewCameraState CameraState  
Protected variable double CurrentBrushFalloff  
Protected variable double CurrentBrushRadius  
Protected variable FSculptBrushStamp CurrentStamp  
Protected variable UE::Geometry::FTransformSRT3d CurTargetTransform Active transformation on target mesh, includes baked scale
Protected variable TValueWatcher< FVector > GizmoPositionWatcher  
Public variable UProperty TObjectPtr< UWorkPlaneProperties > GizmoProperties Properties for 3D workplane / gizmo
Protected variable TValueWatcher< FQuat > GizmoRotationWatcher  
Protected variable FSculptBrushStamp HoverStamp  
Protected variable UE::Geometry::FTransformSRT3d InitialTargetTransform Initial transformation on target mesh
Protected variable FFrame3d LastBrushFrameLocal  
Protected variable FFrame3d LastBrushFrameWorld Brush/Stroke stuff
Protected variable int32 LastBrushTriangleID  
Protected variable int LastFlowTimeStamp  
Protected variable int LastSpacingTimestamp  
Protected variable FSculptBrushStamp LastStamp  
Protected variable FRay PendingStampRay  
Protected variable EPendingWorkPlaneUpdate PendingWorkPlaneUpdate  
Public variable UProperty TObjectPtr< UCombinedTransformGizmo > PlaneTransformGizmo Plane gizmo
Public variable UProperty TObjectPtr< UTransformProxy > PlaneTransformProxy  
Protected variable TUniquePtr< FMeshSculptBrushOp > PrimaryBrushOp  
Protected variable TSharedPtr< FMeshSculptFallofFunc > PrimaryFalloff  
Protected variable UMeshSculptBrushOpProps * PrimaryVisiblePropSet  
Protected variable TArray< FBrushTypeInfo > RegisteredPrimaryBrushTypes  
Protected variable TArray< FFalloffTypeInfo > RegisteredPrimaryFalloffTypes  
Protected variable TArray< FBrushTypeInfo > RegisteredSecondaryBrushTypes  
Protected variable TUniquePtr< FMeshSculptBrushOp > SecondaryBrushOp  
Protected variable TMap< int32, TUniquePtr< FMeshSculptBrushOpFactory > > SecondaryBrushOpFactories  
Protected variable UProperty TMap< int32, TObjectPtr< UMeshSculptBrushOpProps > > SecondaryBrushOpPropSets  
Protected variable UMeshSculptBrushOpProps * SecondaryVisiblePropSet  
Protected variable FFrame3d StampRegionPlane Stamp ROI Plane is a plane used by some brush ops
Protected variable FFrame3d StrokePlane Stroke plane is a plane used by some brush ops
Protected variable UWorld * TargetWorld  
Public variable UProperty TObjectPtr< UMeshEditingViewProperties > ViewProperties Display / Material

Functions

  Type Name Description
Protected function Virtual void

AccumulateStrokeTime ( float DeltaTime
)

  
Protected function void  
Protected function Virtual void  
Protected function Virtual void

CommitResult ( UBaseDynamicMeshComponent* Component,
bool bModifiedTopology
)

 Subclass can override this to change what results are written.
Protected function Virtual FFrame3d

ComputeStampRegionPlane ( const FFrame3d& StampFrame,
const TSet< int32 >& StampTriangles,
bool bIgnoreDepth,
bool bViewAligned,
bool bInvDistFalloff
)

  
Protected function Virtual FFrame3d

ComputeStampRegionPlane ( const FFrame3d& StampFrame,
const TArray< int32 >& StampTriangles,
bool bIgnoreDepth,
bool bViewAligned,
bool bInvDistFalloff
)

  
Protected function Virtual void

ConfigureIndicator ( bool bVolumetric
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Protected function Virtual int32

FindHitSculptMeshTriangle ( const FRay3d& LocalRay
)

  
Protected function Virtual int32

FindHitTargetMeshTriangle ( const FRay3d& LocalRay
)

  
Protected function Virtual TUniquePtr< FMeshSculptBrushOp > &  
Protected function Virtual Const double  
Protected function Virtual FDynamicMesh3 *  
Protected function Virtual Const const FDynamicMesh3 *  
Protected function Const bool  
Protected function Const const FFrame3d &  
Protected function Const const FFrame3d &  
Protected function Const int32  
Protected function Virtual double  
Protected function Virtual Const double  
Protected function Virtual Const double  
Protected function Virtual double  
Protected function Virtual Const const FFrame3d &  
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Protected function Virtual bool  
Protected function Const FRay3d

GetLocalRay ( const FRay& WorldRay
)

  
Protected function Virtual Const const FRay &  
Public function Const const TArray< FBrushTypeInfo > &  
Public function Const const TArray< FFalloffTypeInfo > &  
Public function Const const TArray< FBrushTypeInfo > &  
Protected function Virtual FDynamicMesh3 *  
Protected function Virtual Const const FDynamicMesh3 *  
Protected function Virtual UBaseDynamicMeshComponent * Subclass must implement this and return relevant rendering component
Protected function Virtual Const float Temporal Flow Rate defines the frequency of stamp placement. 1 is max rate, 0 is no stamps. Defaults to BrushProperties->FlowRate, but subclasses can re-use that setting for other things.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void Client currently needs to implement these...
Protected function Virtual void  
Protected function Virtual void Subclasses should call this to create indicator in their Setup()
Protected function void Subclass calls this to set up editing component
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Protected function Virtual UPreviewMesh *

MakeBrushIndicatorMesh ( UObject* Parent,
UWorld* World
)

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

OnBeginStroke ( const FRay& WorldRay
)

  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void

PlaneTransformChanged ( UTransformProxy* Proxy,
FTransform Transform
)

  
Public function Virtual void  
Protected function void

RegisterBrushType ( int32 Identifier,
FText Name,
TUniquePtr< FMeshSculptBrushOpFactory > Factory,
UMeshSculptBrushOpProps* PropSet
)

  
Protected function void  
Protected function void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function void

SetActivePrimaryBrushType ( int32 Identifier
)

  
Protected function void

SetActiveSecondaryBrushType ( int32 Identifier
)

  
Protected function void

SetBrushOpPropsVisibility ( bool bVisible
)

  
Protected function Virtual void

SetFixedSculptPlaneFromWorldPos ( const FVector& Position,
const FVector& Normal,
EPendingWorkPlaneUpdate UpdateType
)

  
Protected function Virtual void

SetIndicatorVisibility ( bool bVisible
)

  
Public function Virtual void Set the active falloff type for the primary brush
Protected function Virtual void

SetViewPropertiesEnabled ( bool bNewValue
)

  
Public function Virtual void

SetWorld ( UWorld* World
)

  
Protected function Virtual Const bool  
Protected function void

UpdateBrushFrameWorld ( const FVector3d& NewPosition,
const FVector3d& NewNormal
)

  
Protected function Virtual bool

UpdateBrushPositionOnActivePlane ( const FRay& WorldRay
)

  
Protected function Virtual bool

UpdateBrushPositionOnSculptMesh ( const FRay& WorldRay,
bool bFallbackToViewPlane
)

  
Protected function Virtual bool

UpdateBrushPositionOnTargetMesh ( const FRay& WorldRay,
bool bFallbackToViewPlane
)

  
Protected function Virtual void

UpdateBrushTargetPlaneFromHit ( const FRay& WorldRay,
const FHitResult& Hit
)

  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void

UpdateFixedSculptPlanePosition ( const FVector& Position
)

  
Protected function Virtual void

UpdateFixedSculptPlaneRotation ( const FQuat& Rotation
)

  
Protected function Virtual void

UpdateFlatShadingSetting ( bool bNewValue
)

  
Protected function Virtual void  
Protected function Virtual void

UpdateHoverStamp ( const FFrame3d& StampFrameWorld
)

  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void

UpdateOpacitySetting ( double Opacity
)

  
Protected function Virtual void When in a stroke, this function determines when a new stamp should be emitted, based on spacing and flow rate settings
Protected function Virtual void

UpdateStrokeReferencePlaneForROI ( const FFrame3d& StampFrame,
const TArray< int32 >& TriangleROI,
bool bViewAligned
)

  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void

UpdateTwoSidedSetting ( bool bOn
)

  
Protected function Virtual void

UpdateWireframeVisibility ( bool bNewValue
)

  
Protected function Virtual void  

Overridden from UMeshSurfacePointTool

  Type Name Description
Public function Virtual bool

HitTest ( const FRay& Ray,
FHitResult& OutHit
)

 UMeshSurfacePointTool API.
Public function Virtual void

OnBeginDrag ( const FRay& Ray
)

 This function is called when the user begins a click-drag-release interaction
Public function Virtual void

OnEndDrag ( const FRay& Ray
)

 This function is called when the user releases the button driving a click-drag-release interaction
Public function Virtual void

OnUpdateDrag ( const FRay& Ray
)

 This function is called each frame that the user is in a click-drag-release interaction

Overridden from UInteractiveTool

  Type Name Description
Protected function Virtual void

OnTick ( float DeltaTime
)

 Allow the Tool to do any necessary processing on Tick
Public function Virtual void Override this function to register the set of Actions this Tool supports, using FInteractiveToolActionSet::RegisterAction.
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 IInteractiveToolCameraFocusAPI

  Type Name Description
Public function Virtual FBox IInteractiveToolCameraFocusAPI override to focus on brush w/ 'F'.

Classes

  Type Name Description
Public struct FBrushTypeInfo Brush Types  
Public struct FFalloffTypeInfo Falloff types  

Enums

  Type Name Description
Protected enum EPendingWorkPlaneUpdate    

Typedefs

Name Description
FFrame3d  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page