FSnappingUtils

Windows
MacOS
Linux

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/SnappingUtils.h

Include

#include "SnappingUtils.h"

Syntax

class FSnappingUtils

Functions

Name Description

Public function Static

void

 

ClearSnappingHelpers

(
    bool bClearImmediately
)

Clears all vertices being drawn to help a user snap

Public function Static

void

 

DrawSnappingHelpers

(
    const FSceneView* View,
    FPrimitiveDrawInterface* PDI
)

Draws snapping helpers

Public function Static

void

 

EnableActorSnap

(
    bool bEnable
)

Set user setting for actor snap.

Public function Static

float

 

GetActorSnapDistance

(
    bool bScalar
)

Access user setting for distance. Fractional 0.0->100.0

Public function Static

void

 

InitEditorSnappingTools()

Initialize the snapping system

Public function Static

bool

 

IsRotationSnapEnabled()

Public function Static

bool

 

IsScaleSnapEnabled()

Public function Static

bool

 

IsSnapToActorEnabled()

Public function Static

bool

 

IsSnapToGridEnabled()

Public function Static

void

 

SetActorSnapDistance

(
    float Distance
)

Set user setting for distance. Fractional 0.0->100.0

Public function Static

bool

 

SnapActorsToNearestActor

(
    FVector& DragDelta,
    FLevelEditorViewportClient* Vi...
)

Attempts to snap the selected actors to the nearest other actor

Public function Static

bool

 

SnapDraggedActorsToNearestVertex

(
    FVector& DragDelta,
    FLevelEditorViewportClient* Vi...
)

Snaps actors to the nearest vertex on another actor

Public function Static

bool

 

SnapDragLocationToNearestVertex

(
    const FVector& BaseLocation,
    FVector& DragDelta,
    FLevelEditorViewportClient* Vi...
)

Snaps a delta drag movement to the nearest vertex

Public function Static

bool

 

SnapLocationToNearestVertex

(
    FVector& Location,
    const FVector2D& MouseLocation,
    FLevelEditorViewportClient* Vi...,
    FVector& OutVertexNormal,
    bool bDrawVertHelpers
)

Snaps a location to the nearest vertex

Public function Static

void

 

SnapPointToGrid

(
    FVector& Point,
    const FVector& GridBase
)

Snaps a point value to the positional grid

Public function Static

void

 

SnapRotatorToGrid

(
    FRotator& Rotation
)

Snaps a rotator to the rotational grid

Public function Static

void

 

SnapScale

(
    FVector& Point,
    const FVector& GridBase
)

Snaps a scale value to the scale grid

Public function Static

bool

 

SnapToBSPVertex

(
    FVector& Location,
    FVector GridBase,
    FRotator& Rotation
)

Constants

Name

Description

EditorViewportSnapper

Built-in editor snap implementation

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback