Navigation
API > API/Plugins > API/Plugins/MeshModelingTools
Dynamic Mesh Sculpt Tool Class
| Name | UDynamicMeshSculptTool |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingTools/Public/DynamicMeshSculptTool.h |
| Include Path | #include "DynamicMeshSculptTool.h" |
Syntax
UCLASS (MinimalAPI)
class UDynamicMeshSculptTool : public UMeshSurfacePointTool
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → USingleSelectionTool → UMeshSurfacePointTool → UDynamicMeshSculptTool
Implements Interfaces
- IClickDragBehaviorTarget
- IModifierToggleBehaviorTarget
- IHoverBehaviorTarget
- IInputBehaviorSource
- IInteractiveToolCameraFocusAPI
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDynamicMeshSculptTool() |
DynamicMeshSculptTool.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FFrame3d | UE::Geometry::FFrame3d | DynamicMeshSculptTool.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BrushProperties | TObjectPtr< UDynamicMeshBrushProperties > | Properties that control brush size/etc | DynamicMeshSculptTool.h | |
| GizmoProperties | TObjectPtr< UFixedPlaneBrushProperties > | DynamicMeshSculptTool.h | ||
| KelvinBrushProperties | TObjectPtr< UKelvinBrushProperties > | DynamicMeshSculptTool.h | ||
| RemeshProperties | TObjectPtr< UBrushRemeshProperties > | Properties that control dynamic remeshing | DynamicMeshSculptTool.h | |
| SculptMaxBrushProperties | TObjectPtr< USculptMaxBrushProperties > | DynamicMeshSculptTool.h | ||
| SculptProperties | TObjectPtr< UDynamicMeshBrushSculptProperties > | Properties that control sculpting | DynamicMeshSculptTool.h | |
| SculptToolActions | TObjectPtr< UDynamicSculptToolActions > | DynamicMeshSculptTool.h | ||
| ViewProperties | TObjectPtr< UMeshEditingViewProperties > | DynamicMeshSculptTool.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveDragPlane | UE::Geometry::FFrame3d | DynamicMeshSculptTool.h | ||
| ActiveFixedBrushPlane | UE::Geometry::FFrame3d | DynamicMeshSculptTool.h | ||
| ActiveMeshChange | UE::Geometry::FDynamicMeshChangeTracker * | DynamicMeshSculptTool.h | ||
| ActiveOverrideMaterial | TObjectPtr< UMaterialInstanceDynamic > | DynamicMeshSculptTool.h | ||
| ActivePressure | float | DynamicMeshSculptTool.h | ||
| ActiveRemesher | TSharedPtr< FPersistentStampRemesher > | DynamicMeshSculptTool.h | ||
| ActiveVertexChange | FMeshVertexChangeBuilder * | DynamicMeshSculptTool.h | ||
| bCachedFreezeTarget | bool | DynamicMeshSculptTool.h | ||
| bEnableRemeshing | bool | DynamicMeshSculptTool.h | ||
| bHaveMeshBoundaries | bool | DynamicMeshSculptTool.h | ||
| bHaveNormalSeams | bool | DynamicMeshSculptTool.h | ||
| bHaveRemeshed | bool | DynamicMeshSculptTool.h | ||
| bHaveUVSeams | bool | DynamicMeshSculptTool.h | ||
| bInDrag | bool | DynamicMeshSculptTool.h | ||
| bInvert | bool | DynamicMeshSculptTool.h | ||
| bNormalUpdatePending | bool | DynamicMeshSculptTool.h | ||
| bRemeshPending | bool | DynamicMeshSculptTool.h | ||
| BrushEditBehavior | TWeakObjectPtr< ULocalTwoAxisPropertyEditInputBehavior > | DynamicMeshSculptTool.h | ||
| BrushIndicator | TObjectPtr< UBrushStampIndicator > | DynamicMeshSculptTool.h | ||
| BrushIndicatorMaterial | TObjectPtr< UMaterialInstanceDynamic > | DynamicMeshSculptTool.h | ||
| BrushIndicatorMesh | TObjectPtr< UPreviewMesh > | DynamicMeshSculptTool.h | ||
| BrushRelativeSizeRange | UE::Geometry::FInterval1d | DynamicMeshSculptTool.h | ||
| BrushStartCenterWorld | FVector3d | DynamicMeshSculptTool.h | ||
| BrushStartNormalWorld | FVector3d | DynamicMeshSculptTool.h | ||
| BrushTargetMesh | FDynamicMesh3 | DynamicMeshSculptTool.h | ||
| BrushTargetMeshSpatial | UE::Geometry::FDynamicMeshAABBTree3 | DynamicMeshSculptTool.h | ||
| BrushTargetNormals | UE::Geometry::FMeshNormals | DynamicMeshSculptTool.h | ||
| BrushTypeHistory | TArray< EDynamicMeshSculptBrushType > | DynamicMeshSculptTool.h | ||
| BrushTypeHistoryIndex | int | DynamicMeshSculptTool.h | ||
| BrushTypeWatcher | TValueWatcher< EDynamicMeshSculptBrushType > | DynamicMeshSculptTool.h | ||
| bSmoothing | bool | DynamicMeshSculptTool.h | ||
| bStampPending | bool | DynamicMeshSculptTool.h | ||
| bTargetDirty | bool | DynamicMeshSculptTool.h | ||
| CameraState | FViewCameraState | DynamicMeshSculptTool.h | ||
| ColorWatcher | TValueWatcher< FLinearColor > | DynamicMeshSculptTool.h | ||
| CurrentBrushRadius | double | DynamicMeshSculptTool.h | ||
| CurTargetTransform | UE::Geometry::FTransformSRT3d | DynamicMeshSculptTool.h | ||
| CustomMaterialWatcher | TValueWatcher< TWeakObjectPtr< UMaterialInterface > > | DynamicMeshSculptTool.h | ||
| DynamicMeshComponent | TObjectPtr< UOctreeDynamicMeshComponent > | DynamicMeshSculptTool.h | ||
| FlatShadingWatcher | TValueWatcher< bool > | DynamicMeshSculptTool.h | ||
| GizmoPositionWatcher | TValueWatcher< FVector > | DynamicMeshSculptTool.h | ||
| GizmoRotationWatcher | TValueWatcher< FQuat > | DynamicMeshSculptTool.h | ||
| ImageWatcher | TValueWatcher< UTexture2D * > | DynamicMeshSculptTool.h | ||
| InitialEdgeLength | double | DynamicMeshSculptTool.h | ||
| InitialTargetTransform | UE::Geometry::FTransformSRT3d | DynamicMeshSculptTool.h | ||
| LastBrushPosLocal | FVector3d | DynamicMeshSculptTool.h | ||
| LastBrushPosNormalWorld | FVector3d | DynamicMeshSculptTool.h | ||
| LastBrushPosWorld | FVector3d | DynamicMeshSculptTool.h | ||
| LastBrushTriangleID | int32 | DynamicMeshSculptTool.h | ||
| LastHitPosWorld | FVector3d | DynamicMeshSculptTool.h | ||
| LastSmoothBrushPosLocal | FVector3d | DynamicMeshSculptTool.h | ||
| LastStampType | EDynamicMeshSculptBrushType | DynamicMeshSculptTool.h | ||
| LongTransactions | UE::TransactionUtil::FLongTransactionTracker | DynamicMeshSculptTool.h | ||
| MaterialModeWatcher | TValueWatcher< EMeshEditingMaterialModes > | DynamicMeshSculptTool.h | ||
| NormalsBuffer | TArray< int > | DynamicMeshSculptTool.h | ||
| NormalsVertexFlags | TArray< bool > | DynamicMeshSculptTool.h | ||
| OnDynamicMeshComponentChangedHandle | FDelegateHandle | DynamicMeshSculptTool.h | ||
| OpacityWatcher | TValueWatcher< double > | DynamicMeshSculptTool.h | ||
| PendingStampRay | FRay | DynamicMeshSculptTool.h | ||
| PendingStampType | EDynamicMeshSculptBrushType | DynamicMeshSculptTool.h | ||
| PendingTargetUpdate | TFuture< void > | DynamicMeshSculptTool.h | ||
| PendingWorkPlaneUpdate | EPendingWorkPlaneUpdate | DynamicMeshSculptTool.h | ||
| PlaneTransformGizmo | TObjectPtr< UCombinedTransformGizmo > | Plane gizmo | DynamicMeshSculptTool.h | |
| PlaneTransformProxy | TObjectPtr< UTransformProxy > | DynamicMeshSculptTool.h | ||
| PreviewMeshActor | TObjectPtr< AInternalToolFrameworkActor > | DynamicMeshSculptTool.h | ||
| RemeshFinalTriangleROI | TSet< int32 > | DynamicMeshSculptTool.h | ||
| RemeshRemovedTriangles | TSet< int32 > | DynamicMeshSculptTool.h | ||
| ROIPositionBuffer | TArray< FVector3d > | DynamicMeshSculptTool.h | ||
| SculptMaxFixedHeight | double | DynamicMeshSculptTool.h | ||
| ShowWireframeWatcher | TValueWatcher< bool > | DynamicMeshSculptTool.h | ||
| StampTimestamp | int | DynamicMeshSculptTool.h | ||
| TargetWorld | UWorld * | DynamicMeshSculptTool.h | ||
| TransparentColorWatcher | TValueWatcher< FLinearColor > | DynamicMeshSculptTool.h | ||
| TriangleROI | TSet< int > | DynamicMeshSculptTool.h | ||
| TriangleROIBuilder | UE::Geometry::FUniqueIndexSet | DynamicMeshSculptTool.h | ||
| TwoSidedWatcher | TValueWatcher< bool > | DynamicMeshSculptTool.h | ||
| UpdateROITriBuffer | TArray< int > | DynamicMeshSculptTool.h | ||
| VertexROI | TArray< int > | DynamicMeshSculptTool.h | ||
| VertexROIBuilder | UE::Geometry::FUniqueIndexSet | DynamicMeshSculptTool.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DecreaseBrushRadiusAction() |
DynamicMeshSculptTool.h | ||
virtual void DecreaseBrushRadiusSmallStepAction() |
DynamicMeshSculptTool.h | ||
virtual void DecreaseBrushSpeedAction() |
DynamicMeshSculptTool.h | ||
virtual void DiscardAttributes() |
DynamicMeshSculptTool.h | ||
virtual bool GetEnableRemeshing() |
DynamicMeshSculptTool.h | ||
virtual void IncreaseBrushRadiusAction() |
DynamicMeshSculptTool.h | ||
virtual void IncreaseBrushRadiusSmallStepAction() |
DynamicMeshSculptTool.h | ||
virtual void IncreaseBrushSpeedAction() |
DynamicMeshSculptTool.h | ||
virtual void NextHistoryBrushModeAction() |
DynamicMeshSculptTool.h | ||
virtual void PreviousHistoryBrushModeAction() |
DynamicMeshSculptTool.h | ||
virtual void SetEnableRemeshing
(
bool bEnable |
DynamicMeshSculptTool.h | ||
virtual void SetWorld
(
UWorld* World |
DynamicMeshSculptTool.h |
Overridden from UMeshSurfacePointTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool HitTest
(
const FRay& Ray, |
DynamicMeshSculptTool.h | ||
virtual void OnBeginDrag
(
const FRay& Ray |
DynamicMeshSculptTool.h | ||
virtual void OnCancelDrag() |
DynamicMeshSculptTool.h | ||
virtual void OnEndDrag
(
const FRay& Ray |
DynamicMeshSculptTool.h | ||
virtual void OnUpdateDrag
(
const FRay& Ray |
DynamicMeshSculptTool.h |
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DrawHUD
(
FCanvas* Canvas, |
DynamicMeshSculptTool.h | ||
virtual bool HasAccept() |
DynamicMeshSculptTool.h | ||
virtual bool HasCancel() |
DynamicMeshSculptTool.h | ||
| DynamicMeshSculptTool.h | |||
virtual void OnTick
(
float DeltaTime |
DynamicMeshSculptTool.h | ||
virtual void RegisterActions
(
FInteractiveToolActionSet& ActionSet |
DynamicMeshSculptTool.h | ||
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
DynamicMeshSculptTool.h | ||
virtual void Setup() |
DynamicMeshSculptTool.h | ||
virtual void Shutdown
(
EToolShutdownType ShutdownType |
DynamicMeshSculptTool.h |
Overridden from IInteractiveToolCameraFocusAPI
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBox GetWorldSpaceFocusBox() |
IInteractiveToolCameraFocusAPI override to focus on brush w/ 'F'. | DynamicMeshSculptTool.h |
Overridden from IHoverBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit BeginHoverSequenceHitTest
(
const FInputDeviceRay& PressPos |
DynamicMeshSculptTool.h | ||
virtual bool OnUpdateHover
(
const FInputDeviceRay& DevicePos |
DynamicMeshSculptTool.h |