Navigation
API > API/Plugins > API/Plugins/MeshModelingTools
| Name | FMeshSculptBrushOp |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingTools/Public/Sculpting/MeshBrushOpBase.h |
| Include Path | #include "Sculpting/MeshBrushOpBase.h" |
Syntax
class FMeshSculptBrushOp
Derived Classes
FMeshSculptBrushOp derived class hierarchy
- FBaseKelvinletBrushOp
- FEraseSculptLayerBrushOp
- FEraseToBaseMeshBrushOp
- FFlattenBrushOp
- FMeshTriangleGroupEditBrushOp
- FInflateBrushOp
- FMeshVertexColorBrushOp
- FMoveBrushOp
- FPinchBrushOp
- FPlaneBrushOp
- FSingleNormalSculptBrushOp
- FSmoothBrushOp
- FSmoothFillBrushOp
- FSurfaceMaxSculptBrushOp
- FSurfaceSculptBrushOp
- FViewAlignedSculptBrushOp
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FMeshSculptBrushOp() |
Sculpting/MeshBrushOpBase.h |
Enums
Public
| Name | Remarks |
|---|---|
| EBrushRegionType | Determines what region of a mesh a brush wants to affect. |
| EReferencePlaneType | Determines what kind of reference plane the brush wants to use (which will be accessed via CurrentOptions.ConstantReferencePlane) |
| EStampAlignmentType | Determines how the brush expects its local frame to be aligned as the mouse is moved. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentOptions | FSculptBrushOptions | Sculpting/MeshBrushOpBase.h | ||
| Falloff | TSharedPtr< FMeshSculptFallofFunc > | Sculpting/MeshBrushOpBase.h | ||
| PropertySet | TWeakObjectPtr< UMeshSculptBrushOpProps > | Sculpting/MeshBrushOpBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ApplyStamp
(
const FDynamicMesh3* Mesh, |
Sculpting/MeshBrushOpBase.h | ||
virtual void BeginStroke
(
const FDynamicMesh3* Mesh, |
Sculpting/MeshBrushOpBase.h | ||
virtual void CancelStroke() |
Sculpting/MeshBrushOpBase.h | ||
virtual void ConfigureOptions
(
const FSculptBrushOptions& Options |
Sculpting/MeshBrushOpBase.h | ||
virtual void EndStroke
(
const FDynamicMesh3* Mesh, |
Sculpting/MeshBrushOpBase.h | ||
virtual bool GetAlignStampToView() |
Sculpting/MeshBrushOpBase.h | ||
virtual EBrushRegionType GetBrushRegionType() |
Determines what region of a mesh a brush wants to affect. | Sculpting/MeshBrushOpBase.h | |
virtual ESculptBrushOpTargetType GetBrushTargetType() |
Overrideable Brush Op configuration things | Sculpting/MeshBrushOpBase.h | |
const FMeshSculptFallofFunc & GetFalloff() |
Sculpting/MeshBrushOpBase.h | ||
PropType * GetPropertySetAs () |
Sculpting/MeshBrushOpBase.h | ||
const PropType * GetPropertySetAs () |
Sculpting/MeshBrushOpBase.h | ||
virtual EReferencePlaneType GetReferencePlaneType() |
Determines what kind of plane (if any) the brush wants to be stored at the start of the stroke in CurrentOptions.ConstantReferencePlane. | Sculpting/MeshBrushOpBase.h | |
virtual EStampAlignmentType GetStampAlignmentType() |
Determines how the brush expects its local frame to be aligned as the mouse is moved. | Sculpting/MeshBrushOpBase.h | |
virtual bool IgnoreZeroMovements() |
Sculpting/MeshBrushOpBase.h | ||
virtual bool SupportsStrokeType
(
EMeshSculptStrokeType StrokeType |
Sculpting/MeshBrushOpBase.h | ||
virtual bool SupportsVariableSpacing() |
Sculpting/MeshBrushOpBase.h | ||
virtual bool UseLastStampFrameOnZeroMovement () |
If this is true and there is no mouse movement, the stamp will be applied with the same Local/World frames as the previous application. | Sculpting/MeshBrushOpBase.h | |
virtual bool UsesAlpha() |
Sculpting/MeshBrushOpBase.h | ||
virtual bool WantsStampRegionPlane() |
Whether the brush wants an average plane to be computed at each stamp application out of the affected triangles (accessed through Stamp.RegionPlane) | Sculpting/MeshBrushOpBase.h |