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

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

   
Name UCubeGridTool
Type class
Header File /Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsExp/Public/CubeGridTool.h
Include Path #include "CubeGridTool.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Structs

Name Remarks
FSelection  

Enums

Protected

Name Remarks
EMode  
EMouseState  

Typedefs

Name Type Remarks Include Path
FCubeGrid UE::Geometry::FCubeGrid   CubeGridTool.h

Constants

Name Type Remarks Include Path
CtrlModifierID const int32   CubeGridTool.h
ShiftModifierID const int32   CubeGridTool.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasInitialGridPivot bool   CubeGridTool.h  
InitialGridPivot FVector3d   CubeGridTool.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanApplyPreview()

   CubeGridTool.h  

virtual void ClearSelection ( bool bEmitChange
)

   CubeGridTool.h  

virtual bool IsInCornerMode()

   CubeGridTool.h  

virtual bool IsInDefaultMode()

   CubeGridTool.h  

virtual void RequestAction ( ECubeGridToolAction ActionType
)

   CubeGridTool.h  

virtual void RevertToDefaultMode()

   CubeGridTool.h  

virtual void SetChangesMade ( bool bChangesMadeIn
)

   CubeGridTool.h  

virtual void SetCornerSelection ( bool CornerSelectedFlags
)

   CubeGridTool.h  

virtual void SetCurrentExtrudeAmount ( int32 ExtrudeAmount
)

   CubeGridTool.h  

virtual void SetCurrentMeshTransform ( const FTransform& TransformIn
)

   CubeGridTool.h  

void SetInitialGridPivot ( FVector3d PivotPos
)

   CubeGridTool.h  

virtual void SetSelection ( const FSelection& Selection,
bool bEmitChange
)

   CubeGridTool.h  

virtual void SetTarget ( TObjectPtr< UToolTarget > TargetIn
)

   CubeGridTool.h  

virtual void SetWorld ( UWorld* World
)

   CubeGridTool.h  

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

 Used by undo/redo. CubeGridTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual bool CanAccept()

   CubeGridTool.h  

virtual void DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

   CubeGridTool.h  

virtual bool HasAccept()

   CubeGridTool.h  

virtual bool HasCancel()

   CubeGridTool.h  

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

   CubeGridTool.h  

virtual void OnTick ( float DeltaTime
)

   CubeGridTool.h  

virtual void RegisterActions ( FInteractiveToolActionSet& ActionSet
)

   CubeGridTool.h  

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

   CubeGridTool.h  

virtual void Setup()

   CubeGridTool.h  

virtual void Shutdown ( EToolShutdownType ShutdownType
)

   CubeGridTool.h  

Overridden from IClickDragBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit CanBeginClickDragSequence ( const FInputDeviceRay& PressPos
)

 IClickDragBehaviorTarget. CubeGridTool.h  

virtual void OnClickDrag ( const FInputDeviceRay& DragPos
)

   CubeGridTool.h  

virtual void OnClickPress ( const FInputDeviceRay& PressPos
)

   CubeGridTool.h  

virtual void OnClickRelease ( const FInputDeviceRay& ReleasePos
)

   CubeGridTool.h  

virtual void OnTerminateDragSequence()

   CubeGridTool.h  

Overridden from IModifierToggleBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual void OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

   CubeGridTool.h  

Overridden from IHoverBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos
)

 IHoverBehaviorTarget. CubeGridTool.h  

virtual void OnBeginHover ( const FInputDeviceRay& DevicePos
)

   CubeGridTool.h  

virtual void OnEndHover()

   CubeGridTool.h  

virtual bool OnUpdateHover ( const FInputDeviceRay& DevicePos
)

   CubeGridTool.h  

Overridden from IDynamicMeshOperatorFactory

Name Remarks Include Path Unreal Specifiers

virtual TUniquePtr< UE::Geometry::FDynamicMeshOperator > MakeNewOperator()

 IDynamicMeshOperatorFactory API. CubeGridTool.h  

Overridden from IInteractiveToolNestedAcceptCancelAPI

Name Remarks Include Path Unreal Specifiers

virtual bool CanCurrentlyNestedAccept()

   CubeGridTool.h  

virtual bool CanCurrentlyNestedCancel()

   CubeGridTool.h  

virtual bool ExecuteNestedAcceptCommand()

   CubeGridTool.h  

virtual bool ExecuteNestedCancelCommand()

   CubeGridTool.h  

virtual bool SupportsNestedAcceptCommand()

   CubeGridTool.h  

virtual bool SupportsNestedCancelCommand()

 IInteractiveToolNestedAcceptCancelAPI. CubeGridTool.h  

Overridden from IInteractiveToolCameraFocusAPI

Name Remarks Include Path Unreal Specifiers

virtual FBox GetWorldSpaceFocusBox()

   CubeGridTool.h  

virtual bool SupportsWorldSpaceFocusBox()

 IInteractiveToolCameraFocusAPI. CubeGridTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AcceptToolAndStartNew()

   CubeGridTool.h  

void ApplyAction ( ECubeGridToolAction ActionType
)

   CubeGridTool.h  

void ApplyCornerMode ( bool bDontWaitForTick
)

   CubeGridTool.h  

void ApplyFlipSelection()

   CubeGridTool.h  

void ApplyPreview()

   CubeGridTool.h  

void ApplyPushPull ( int32 NumBlocks
)

   CubeGridTool.h  

void ApplySlide ( int32 NumBlocks
)

   CubeGridTool.h  

void AttemptToSelectCorner ( const FRay3d& WorldRay
)

   CubeGridTool.h  

FInputRayHit CanBeginMiddleClickDrag ( const FInputDeviceRay& ClickPos
)

   CubeGridTool.h  

void CancelCornerMode()

   CubeGridTool.h  

void ClearHover()

   CubeGridTool.h  

void ClearViewportButtonCustomization()

   CubeGridTool.h  

void EndSelectionChange()

   CubeGridTool.h  

bool GetHitGridFace ( const FRay& WorldRay,
UE::Geometry::FCubeGrid::FCubeFace& FaceOut
)

   CubeGridTool.h  

void GridGizmoMoved ( UTransformProxy* Proxy,
FTransform Transform
)

   CubeGridTool.h  

void InvalidatePreview ( bool bUpdateCornerLineSet
)

   CubeGridTool.h  

void OnCtrlMiddleClick ( const FInputDeviceRay& ClickPos
)

   CubeGridTool.h  

void OnMiddleClickDrag ( const FInputDeviceRay& DragPos
)

   CubeGridTool.h  

void OutputCurrentResults ( bool bSetSelection
)

   CubeGridTool.h  

void PrepForSelectionChange()

   CubeGridTool.h  

FInputRayHit RayCastSelectionPlane ( const FRay3d& WorldRay,
FVector3d& HitPointOut
)

   CubeGridTool.h  

void ResetMultiStepConsistencyData()

   CubeGridTool.h  

void SetGridPowerClamped ( int32 GridPower
)

 Parameter is signed on purpose so we can give negatives for clamping. CubeGridTool.h  

void SlideSelection ( int32 ExtrudeAmount,
bool bEmitChange
)

   CubeGridTool.h  

void StartCornerMode()

   CubeGridTool.h  

void UpdateComputeInputs()

   CubeGridTool.h  

void UpdateCornerGeometrySet()

   CubeGridTool.h  

void UpdateCornerModeLineSet()

   CubeGridTool.h  

void UpdateGizmoVisibility ( bool bVisible
)

   CubeGridTool.h  

void UpdateGridGizmo ( const FTransform& NewTransform,
bool bSilentlyUpdate
)

 Updates the gizmo controlling the cube grid transform. CubeGridTool.h  

void UpdateGridLineSet()

   CubeGridTool.h  

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

 Updates the cube grid. CubeGridTool.h  

bool UpdateHover ( const FRay& WorldRay
)

   CubeGridTool.h  

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

   CubeGridTool.h  

void UpdateOpMaterials()

   CubeGridTool.h  

void UpdateSelectionLineSet()

   CubeGridTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page