UCreateMeshTool

Basic functionality used creating and placing a MeshPartition.

API > API/Plugins > API/Plugins/MeshPartitionModelingToolset

Basic functionality used creating and placing a MeshPartition. Derive from this class and override functions such as GenerateAsset(), for example see MeshPartition::UCreateRectangleMeshTool

   
Name UCreateMeshTool
Type class
Header File /Engine/Plugins/Experimental/MeshPartition/Source/MeshPartitionModelingToolset/Public/MeshPartitionCreateMeshTool.h
Include Path #include "MeshPartitionCreateMeshTool.h"

Syntax

UCLASS (MinimalAPI)  
class UCreateMeshTool :  
    public USingleClickTool ,  
    public IHoverBehaviorTarget ,  
    public IInteractiveToolCameraFocusAPI ,  
    public IInteractiveToolShutdownQueryAPI

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UCreateMeshTool ( const FObjectInitializer&
)

   MeshPartitionCreateMeshTool.h  

Classes

Name Remarks
FStateChange Used to make the initial placement of the mesh undoable.

Enums

Protected

Name Remarks
EState  

Functions

Public

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void SetWorld ( UWorld* World
)

   MeshPartitionCreateMeshTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual bool CanAccept()

   MeshPartitionCreateMeshTool.h  

virtual bool HasAccept()

   MeshPartitionCreateMeshTool.h  

virtual bool HasCancel()

   MeshPartitionCreateMeshTool.h  

virtual void OnPropertyModified ( UObject* PropertySet,
FProperty* Property
)

   MeshPartitionCreateMeshTool.h  

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

   MeshPartitionCreateMeshTool.h  

virtual void Setup()

   MeshPartitionCreateMeshTool.h  

virtual void Shutdown ( EToolShutdownType ShutdownType
)

   MeshPartitionCreateMeshTool.h  

Overridden from IClickBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit IsHitByClick ( const FInputDeviceRay& ClickPos
)

   MeshPartitionCreateMeshTool.h  

virtual void OnClicked ( const FInputDeviceRay& ClickPos
)

 USingleClickTool. MeshPartitionCreateMeshTool.h  

Overridden from IHoverBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos
)

   MeshPartitionCreateMeshTool.h  

virtual void OnBeginHover ( const FInputDeviceRay& DevicePos
)

   MeshPartitionCreateMeshTool.h  

virtual void OnEndHover()

   MeshPartitionCreateMeshTool.h  

virtual bool OnUpdateHover ( const FInputDeviceRay& DevicePos
)

   MeshPartitionCreateMeshTool.h  

Overridden from IInteractiveToolCameraFocusAPI

Name Remarks Include Path Unreal Specifiers

virtual FBox GetWorldSpaceFocusBox()

   MeshPartitionCreateMeshTool.h  

virtual bool GetWorldSpaceFocusPoint ( const FRay& WorldRay,
FVector& PointOut
)

   MeshPartitionCreateMeshTool.h  

virtual bool SupportsWorldSpaceFocusBox()

 IInteractiveToolCameraFocusAPI implementation. MeshPartitionCreateMeshTool.h  

virtual bool SupportsWorldSpaceFocusPoint()

   MeshPartitionCreateMeshTool.h  

Overridden from IInteractiveToolShutdownQueryAPI

Name Remarks Include Path Unreal Specifiers

virtual EToolShutdownType GetPreferredShutdownType ( EToolShutdownReason
) const

 IInteractiveToolShutdownQueryAPI implementation. MeshPartitionCreateMeshTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

void InitSnapTarget()

   MeshPartitionCreateMeshTool.h  

void SetState ( EState NewState
)

   MeshPartitionCreateMeshTool.h  

bool SnapPreviewMeshToExisting ( const FTransform& ShapeTransform,
FVector3d& OutSnapOffset
) const

   MeshPartitionCreateMeshTool.h  

void UpdateDisplayMessage()

 Refresh the host's display w/ result of BuildDisplayMessage() MeshPartitionCreateMeshTool.h  

void UpdatePreviewPosition ( const FInputDeviceRay& ClickPos
)

   MeshPartitionCreateMeshTool.h  

void UpdateTargetSurface()

   MeshPartitionCreateMeshTool.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual void BuildDisplayMessage ( FText& OutMessage
) const

 Override to set tool-specific warning messages. MeshPartitionCreateMeshTool.h  

virtual void GenerateAsset()

   MeshPartitionCreateMeshTool.h  

virtual void GeneratePreviewMesh ( FDynamicMesh3* OutMesh
) const

   MeshPartitionCreateMeshTool.h  

virtual bool ShouldCenterXY()

   MeshPartitionCreateMeshTool.h  

virtual void UpdatePreview()

   MeshPartitionCreateMeshTool.h  

Static

Name Remarks Include Path Unreal Specifiers

static TArray< TUniquePtr< FDynamicMesh3 > > SplitMesh ( const FDynamicMesh3& InMesh,
const FVector3d SectionsPerSide
)

 Helper that maybe of use in segmenting an existing mesh in a derived class MeshPartitionCreateMeshTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page