1. Epic GamesDeveloper
  3. FSnappingUtils

FSnappingUtils

API > API/Editor > API/Editor/UnrealEd

   
Name FSnappingUtils
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/SnappingUtils.h
Include Path #include "SnappingUtils.h"

Syntax

class FSnappingUtils

Constants

Name Type Remarks Include Path
EditorViewportSnapper TSharedPtr< class FEditorViewportSnapping > Built-in editor snap implementation SnappingUtils.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void AdjustPercentageBasedScale ( FVector& InOutScale
)

 Adjusts the given scale value for percentage based scaling, if enabled The input should be 0-100, and the output will be adjusted to be 0-1 SnappingUtils.h  

static void ClearSnappingHelpers ( bool bClearImmediately
)

 Clears all vertices being drawn to help a user snap SnappingUtils.h  

static void DrawSnappingHelpers ( const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

 Draws snapping helpers SnappingUtils.h  

static void EnableActorSnap ( bool bEnable
)

 Set user setting for actor snap. SnappingUtils.h  

static float GetActorSnapDistance ( bool bScalar
)

 Access user setting for distance. Fractional 0.0->100.0 SnappingUtils.h  

static TOptional< FVector > GetDeltaToNearestActor ( FVector& DragDelta,
const UWorld* InWorld
)

 Attempts to snap the selected actors to the nearest other actor SnappingUtils.h  

static void InitEditorSnappingTools()

 Initialize the snapping system SnappingUtils.h  

static bool IsRotationSnapEnabled()

   SnappingUtils.h  

static bool IsScaleSnapEnabled()

   SnappingUtils.h  

static bool IsSnapToActorEnabled()

   SnappingUtils.h  

static bool IsSnapToGridEnabled()

   SnappingUtils.h  

static void SetActorSnapDistance ( float Distance
)

 Set user setting for distance. Fractional 0.0->100.0 SnappingUtils.h  

static bool SnapActorsToNearestActor ( FVector& DragDelta,
FLevelEditorViewportClient* ViewportClient
)

 Attempts to snap the selected actors to the nearest other actor SnappingUtils.h  

static bool SnapDraggedActorsToNearestVertex ( FVector& DragDelta,
FLevelEditorViewportClient* ViewportClient
)

 Snaps actors to the nearest vertex on another actor SnappingUtils.h  

static bool SnapDragLocationToNearestVertex ( const FVector& BaseLocation,
FVector& DragDelta,
FLevelEditorViewportClient* ViewportClient,
bool bIsPivot
)

 Snaps a delta drag movement to the nearest vertex SnappingUtils.h  

static bool SnapLocationToNearestVertex ( FVector& Location,
const FVector2D& MouseLocation,
FLevelEditorViewportClient* ViewportClient,
FVector& OutVertexNormal,
bool bDrawVertHelpers
)

 Snaps a location to the nearest vertex SnappingUtils.h  

static void SnapPointToGrid ( FVector& Point,
const FVector& GridBase
)

 Snaps a point value to the positional grid SnappingUtils.h  

static void SnapRotatorToGrid ( FRotator& Rotation
)

 Snaps a rotator to the rotational grid SnappingUtils.h  

static void SnapScale ( FVector& Point,
const FVector& GridBase
)

 Snaps a scale value to the scale grid SnappingUtils.h  

static bool SnapToBSPVertex ( FVector& Location,
FVector GridBase,
FRotator& Rotation
)

   SnappingUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page