1. Epic GamesDeveloper
  3. UCubeGridTool

UCubeGridTool

Tool that allows for blocky boolean operations on an orientable power-of-two grid.

API > API/Plugins > API/Plugins/MeshModelingToolsExp

Inheritance Hierarchy

References

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

Syntax

UCLASS ()  
class UCubeGridTool :  
    public UInteractiveTool ,  
    public IClickDragBehaviorTarget ,  
    public IHoverBehaviorTarget ,  
    public UE::Geometry::IDynamicMeshOperatorFactory ,  
    public IInteractiveToolNestedAcceptCancelAPI ,  
    public IInteractiveToolCameraFocusAPI

Remarks

Tool that allows for blocky boolean operations on an orientable power-of-two grid.

Variables

  Type Name Description
Protected variable bool bAdjustSelectionOnPreviewUpdate  
Protected variable bool bBlockUntilPreviewUpdate  
Protected variable bool bChangeSideToggle  
Protected variable bool bChangesMade Used to see if we need to update the asset that we've been modifying.
Protected variable bool bHaveHoveredSelection  
Protected variable bool bHaveSelection  
Protected variable bool bInGizmoDrag  
Protected variable int32 BlockBaseSizeWatcherIdx  
Protected variable bool bMouseDragShouldPushPull  
Protected variable bool bPreviewMayDiffer  
Protected variable bool bPreviousHaveSelection  
Protected variable bool bSelectionToggle  
Protected variable bool bSlideToggle  
Protected variable bool bWaitingToApplyPreview  
Protected variable FViewCameraState CameraState  
Protected variable UProperty TObjectPtr< UClickDragInputBehavior > ClickDragBehavior  
Protected variable TSharedPtr< const UE::Geometry::FDynamicMesh3, ESPMode::ThreadSafe > ComputeStartMesh Safe inputs for the background compute to use, untouched by undo/redo/other CurrentMesh updates.
Protected variable bool[4] CornerSelectedFlags Used in corner push/pull mode.
Protected variable UE::Geometry::FGeometrySet3 CornersGeometrySet  
Protected variable UProperty TObjectPtr< ULocalSingleClickInputBehavior > CtrlMiddleClickBehavior  
Protected variable TSharedPtr< FCubeGrid, ESPMode::ThreadSafe > CubeGrid  
Protected variable int32 CurrentBlockSizeWatcherIdx  
Protected variable int32 CurrentExtrudeAmount  
Protected variable TSharedPtr< UE::Geometry::FDynamicMesh3, ESPMode::ThreadSafe > CurrentMesh  
Protected variable TArray< UMaterialInterface * > CurrentMeshMaterials  
Protected variable UE::Geometry::FTransformSRT3d CurrentMeshTransform  
Protected variable double DragProjectedStartParam  
Protected variable FRay3d DragProjectionAxis  
Protected variable int32 DragStartExtrudeAmount  
Protected variable int32 GridFrameOrientationWatcherIdx  
Protected variable int32 GridFrameOriginWatcherIdx  
Protected variable UProperty TObjectPtr< UCombinedTransformGizmo > GridGizmo  
Protected variable UProperty TObjectPtr< UDragAlignmentMechanic > GridGizmoAlignmentMechanic  
Protected variable UProperty TObjectPtr< UTransformProxy > GridGizmoTransformProxy  
Protected variable int32 GridPowerWatcherIdx  
Protected variable UProperty TObjectPtr< UMouseHoverBehavior > HoverBehavior  
Protected variable UE::Geometry::FAxisAlignedBox3d HoveredSelectionBox  
Protected variable TSharedPtr< TArray< int32 >, ESPMode::ThreadSafe > LastOpChangedTids  
Protected variable UProperty TObjectPtr< UPreviewGeometry > LineSets  
Protected variable UProperty TObjectPtr< UNewMeshMaterialProperties > MaterialProperties  
Protected variable TSharedPtr< UE::Geometry::FDynamicMeshAABBTree3, ESPMode::ThreadSafe > MeshSpatial  
Protected variable UProperty TObjectPtr< ULocalClickDragInputBehavior > MiddleClickDragBehavior  
Protected variable FVector3d MiddleClickDragStart  
Protected variable EMode Mode Important state. Could refactor things into tool activities (like PolyEdit) someday.
Protected variable EMouseState MouseState  
Protected variable TArray< int32, TFixedAllocator< 4 > > OpMeshAddSideGroups  
Protected variable double OpMeshHeightUVOffset These are used to keep UV's and side groups consistent across multiple E/Q (push/pull) presses.
Protected variable int32 OpMeshMaterialID  
Protected variable TArray< int32, TFixedAllocator< 4 > > OpMeshSubtractSideGroups  
Protected variable UProperty TObjectPtr< UCreateMeshObjectTypeProperties > OutputTypeProperties  
Protected variable ECubeGridToolAction PendingAction  
Protected variable bool[4] PreDragCornerSelectedFlags  
Protected variable UProperty TObjectPtr< UMeshOpPreviewWithBackgroundCompute > Preview  
Protected variable FSelection PreviousSelection  
Protected variable FToolDataVisualizer SelectedCornerRenderer  
Protected variable FSelection Selection  
Protected variable UProperty TObjectPtr< UCubeGridToolProperties > Settings Properties, etc.
Protected variable UProperty TObjectPtr< UToolTarget > Target Existing asset to modify, if one was selected.
Protected variable TObjectPtr< UWorld > TargetWorld Where to make the preview, new mesh, etc.
Protected variable UProperty TObjectPtr< UCubeGridToolActions > ToolActions  

Functions

  Type Name Description
Protected function void  
Protected function void  
Protected function void

ApplyCornerMode ( bool bDontWaitForTick
)

  
Protected function void  
Protected function void  
Protected function void

ApplyPushPull ( int32 NumBlocks
)

  
Protected function void

ApplySlide ( int32 NumBlocks
)

  
Protected function void

AttemptToSelectCorner ( const FRay3d& WorldRay
)

  
Protected function FInputRayHit  
Protected function void  
Protected function void  
Public function Virtual void

ClearSelection ( bool bEmitChange
)

  
Protected function void  
Protected function void  
Protected function bool  
Protected function void

GridGizmoMoved ( UTransformProxy* Proxy,
FTransform Transform
)

  
Protected function void

InvalidatePreview ( bool bUpdateCornerLineSet
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function void

OnCtrlMiddleClick ( const FInputDeviceRay& ClickPos
)

  
Protected function void

OnMiddleClickDrag ( const FInputDeviceRay& DragPos
)

  
Protected function void

OutputCurrentResults ( bool bSetSelection
)

  
Protected function void  
Protected function FInputRayHit

RayCastSelectionPlane ( const FRay3d& WorldRay,
FVector3d& HitPointOut
)

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

SetChangesMade ( bool bChangesMadeIn
)

  
Public function Virtual void

SetCornerSelection ( bool CornerSelectedFlags
)

  
Public function Virtual void

SetCurrentExtrudeAmount ( int32 ExtrudeAmount
)

  
Public function Virtual void

SetCurrentMeshTransform ( const FTransform& TransformIn
)

  
Protected function void

SetGridPowerClamped ( int32 GridPower
)

 Parameter is signed on purpose so we can give negatives for clamping.
Public function void  
Public function Virtual void

SetSelection ( const FSelection& Selection,
bool bEmitChange
)

  
Public function Virtual void

SetTarget ( TObjectPtr< UToolTarget > TargetIn
)

  
Public function Virtual void

SetWorld ( UWorld* World
)

  
Protected function void

SlideSelection ( int32 ExtrudeAmount,
bool bEmitChange
)

  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void

UpdateGizmoVisibility ( bool bVisible
)

  
Protected function void

UpdateGridGizmo ( const FTransform& NewTransform,
bool bSilentlyUpdate
)

 Updates the gizmo controlling the cube grid transform.
Protected function void  
Protected function void

UpdateGridTransform ( const FTransform& NewTransform,
bool bUpdateDetailPanel,
bool bTriggerDetailPanelRebuild
)

 Updates the cube grid.
Protected function bool

UpdateHover ( const FRay& WorldRay
)

  
Protected function void

UpdateHoverLineSet ( bool bHaveHover,
const UE::Geometry::FAxisAlignedBox3d& HoveredBox
)

  
Protected function void  
Protected function void  
Public function Virtual void

UpdateUsingMeshChange ( const UE::Geometry::FDynamicMeshChange& MeshChange,
bool bRevert
)

 Used by undo/redo.

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual Const bool  
Public function Virtual void

DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

 Allow the Tool to do any custom screen space drawing
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

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 ()

 Called by ToolManager to initialize the Tool after ToolBuilder::BuildTool() has been called
Public function Virtual void

Shutdown ( EToolShutdownType ShutdownType
)

 Called by ToolManager to shut down the Tool

Overridden from IClickDragBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit IClickDragBehaviorTarget.
Public function Virtual void

OnClickDrag ( const FInputDeviceRay& DragPos
)

 Notify Target that input position has changed
Public function Virtual void

OnClickPress ( const FInputDeviceRay& PressPos
)

 Notify Target that click press ocurred
Public function Virtual void

OnClickRelease ( const FInputDeviceRay& ReleasePos
)

 Notify Target that click release occurred
Public function Virtual void Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

Overridden from IModifierToggleBehaviorTarget

  Type Name Description
Public function Virtual void

OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

 Notify target of current modifier state

Overridden from IHoverBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit IHoverBehaviorTarget.
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 IDynamicMeshOperatorFactory

  Type Name Description
Public function Virtual TUniquePtr< UE::Geometry::FDynamicMeshOperator > IDynamicMeshOperatorFactory API.

Overridden from IInteractiveToolNestedAcceptCancelAPI

  Type Name Description
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool Called by Editor levels to tell the implementor (eg Tool) to execute a nested Accept action
Public function Virtual bool Called by Editor levels to tell the implementor (eg Tool) to execute a nested Cancel action
Public function Virtual bool  
Public function Virtual bool IInteractiveToolNestedAcceptCancelAPI.

Overridden from IInteractiveToolCameraFocusAPI

  Type Name Description
Public function Virtual FBox  
Public function Virtual bool IInteractiveToolCameraFocusAPI.

Classes

  Type Name Description
Public struct FSelection    

Enums

  Type Name Description
Protected enum EMode    
Protected enum EMouseState    

Typedefs

Name Description
FCubeGrid  

Constants

Name Description
CtrlModifierID  
ShiftModifierID  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page