1. Epic GamesDeveloper
  3. UAddPrimitiveTool

UAddPrimitiveTool

Base tool to create primitives

Unreal Engine C++ API Reference > Plugins > MeshModelingTools

Inheritance Hierarchy

References

   
Module MeshModelingTools
Header /Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingTools/Public/AddPrimitiveTool.h
Include #include "AddPrimitiveTool.h"

Syntax

UCLASS&40;&41;  
class UAddPrimitiveTool :  
    public USingleClickTool,  
    public IHoverBehaviorTarget,  
    public IInteractiveToolCameraFocusAPI

Remarks

Base tool to create primitives

Variables

  Type Name Description
Protected variable UProperty FString AssetName  
Protected variable EState CurrentState  
Protected variable UProperty TObjectPtr< UDragAlignmentMechanic > DragAlignmentMechanic  
Protected variable UProperty TObjectPtr< UCombinedTransformGizmo > Gizmo  
Protected variable UProperty TObjectPtr< UNewMeshMaterialProperties > MaterialProperties  
Protected variable UProperty TObjectPtr< UCreateMeshObjectTypeProperties > OutputTypeProperties Property set for type of output object (StaticMesh, Volume, etc)
Protected variable UProperty TObjectPtr< UPreviewMesh > PreviewMesh  
Protected variable UE::Geometry::FFrame3d ShapeFrame  
Protected variable UProperty TObjectPtr< UProceduralShapeToolProperties > ShapeSettings  
Protected variable UWorld * TargetWorld  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Virtual UProceduralShapeToolProperties *  
Protected function Virtual void  
Protected function Virtual Const void  
Protected function void

SetState ( EState NewState
)

  
Public function Virtual void

SetWorld ( UWorld* World
)

  
Protected function Const void  
Protected function void  

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual Const bool  
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 Allow the Tool to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ()

 Register default primary-button-click InputBehaviors
Public function Virtual void

Shutdown ( EToolShutdownType ShutdownType
)

 Called by ToolManager to shut down the Tool

Overridden from IClickBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit

IsHitByClick ( const FInputDeviceRay& ClickPos
)

 Test if the Target is hit at this 2D position / 3D ray
Public function Virtual void

OnClicked ( const FInputDeviceRay& ClickPos
)

 USingleClickTool.

Overridden from IHoverBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit Do hover hit-test
Public function Virtual void

OnBeginHover ( const FInputDeviceRay& DevicePos
)

 Initialize hover sequence at given position
Public function Virtual void Terminate active hover sequence
Public function Virtual bool

OnUpdateHover ( const FInputDeviceRay& DevicePos
)

 Update active hover sequence with new input position

Overridden from IInteractiveToolCameraFocusAPI

  Type Name Description
Public function Virtual FBox  
Public function Virtual bool

GetWorldSpaceFocusPoint ( const FRay& WorldRay,
FVector& PointOut
)

  
Public function Virtual bool IInteractiveToolCameraFocusAPI implementation.
Public function Virtual bool  

Classes

  Type Name Description
Protected class FStateChange Used to make the initial placement of the mesh undoable.  

Enums

  Type Name Description
Protected enum EState    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page