1. Epic GamesDeveloper
  3. FUVEditor2DViewportClient

FUVEditor2DViewportClient

Client used to display a 2D view of the UV's, implemented by using a perspective viewport with a locked camera.

API > API/Plugins > API/Plugins/UVEditor

Inheritance Hierarchy

References

   
Module UVEditor
Header /Engine/Plugins/Editor/UVEditor/Source/UVEditor/Public/UVEditor2DViewportClient.h
Include #include "UVEditor2DViewportClient.h"

Syntax

class FUVEditor2DViewportClient :  
    public FEditorViewportClient ,  
    public IInputBehaviorSource

Remarks

Client used to display a 2D view of the UV's, implemented by using a perspective viewport with a locked camera.

Variables

  Type Name Description
Protected variable bool bDrawGrid  
Protected variable bool bDrawGridRulers  
Protected variable TObjectPtr< UInputBehaviorSet > BehaviorSet These get added in AddReferencedObjects for memory management.
Protected variable TObjectPtr< UCanvas > CanvasObject  
Protected variable TUniquePtr< FEditor2DScrollBehaviorTarget > ScrollBehaviorTarget Note that it's generally less hassle if the unique ptr types are complete here, not forward declared, else we get compile errors if their destruction shows up anywhere in the header.
Protected variable TObjectPtr< UUVTool2DViewportAPI > UVTool2DViewportAPI  
Protected variable TObjectPtr< UUVToolViewportButtonsAPI > ViewportButtonsAPI  
Protected variable TUniquePtr< FEditor2DMouseWheelZoomBehaviorTarget > ZoomBehaviorTarget  

Constructors

  Type Name Description
Public function  

FUVEditor2DViewportClient ( FEditorModeTools* InModeTools,
FPreviewScene* InPreviewScene,
const TWeakPtr< SEditorViewport >& InEditorViewportWidget,
UUVToolViewportButtonsAPI* ViewportButtonsAPI,
UUVTool2DViewportAPI* UVTool2DViewportAPI
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

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

DrawGrid ( const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

  
Protected function void

DrawGridRulers ( FViewport& InViewport,
FSceneView& View,
UCanvas& Canvas
)

  
Protected function void

DrawUDIMLabels ( FViewport& InViewport,
FSceneView& View,
UCanvas& Canvas
)

  
Public function bool  
Public function float  
Public function bool  
Public function float  
Public function bool  
Public function float  
Public function Const UUVToolViewportButtonsAPI::ESelectionMode  
Public function void

OverrideNearClipPlane ( float InNearPlane
)

 Overriding base class visibility.
Public function void

SetLocationGridSnapEnabled ( bool bEnabled
)

  
Public function void

SetLocationGridSnapValue ( float SnapValue
)

  
Public function void

SetRotationGridSnapEnabled ( bool bEnabled
)

  
Public function void

SetRotationGridSnapValue ( float SnapValue
)

  
Public function void

SetScaleGridSnapEnabled ( bool bEnabled
)

  
Public function void

SetScaleGridSnapValue ( float SnapValue
)

  
Public function void  

Overridden from FEditorViewportClient

  Type Name Description
Public function Virtual Const bool Whether or not the new widget mode can be set in this viewport
Public function Virtual void

Draw ( const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

 FViewElementDrawer interface
Public function Virtual void

DrawCanvas ( FViewport& InViewport,
FSceneView& View,
FCanvas& Canvas
)

 Called to draw onto the viewports 2D canvas
Public function Virtual Const UE::Widget::EWidgetMode  
Public function Virtual bool

InputKey ( const FInputKeyEventArgs& EventArgs
)

 FEditorViewportClient.
Public function Virtual void Sets the current widget mode
Public function Virtual Const bool  

Overridden from FGCObject

  Type Name Description
Public function Virtual void FGCObject.

Overridden from IInputBehaviorSource

  Type Name Description
Public function Virtual Const const UInputBehaviorSet * IInputBehaviorSource.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page