SceneSnappingManager.h File Reference

#include "UObject/Object.h"
#include "Misc/Optional.h"
#include "Math/Vector.h"
#include "Math/Ray.h"
#include "Engine/HitResult.h"
#include "ToolContextInterfaces.h"
#include "SceneSnappingManager.generated.h"

Go to the source code of this file.

Classes
struct	FSceneQueryVisibilityFilter
struct	FSceneHitQueryRequest
struct	FSceneHitQueryResult
struct	FSceneSnapQueryRequest
struct	FSceneSnapQueryResult
class	USceneSnappingManager

Enumerations
enum class	ESceneSnapQueryType : uint8 {   Position = 1 , Rotation = 2 , RotationAngle = 3 , Scale = 4 ,   Transform = 5 }
enum class	ESceneSnapQueryTargetType : uint8 {   None = 0 , MeshVertex = 1 , MeshEdge = 2 , Grid = 4 ,   ObjectTransform = 8 , Custom = 16 , All = MeshVertex | MeshEdge | Grid | ObjectTransform | Custom }
enum class	ESceneSnapQueryTargetResult : uint8 { NotSnapped , Snapped , Disabled , Unsupported }

Functions
	ENUM_CLASS_FLAGS (ESceneSnapQueryTargetType)

Enumeration Type Documentation

ESceneSnapQueryTargetResult

enum class ESceneSnapQueryTargetResult : uint8

strong

Describes the result of the attempted snap operation. Note that this differs to FSceneSnapQueryResult in that it only indicates the success or failure of the snap, not the resulting data.

Enumerator
NotSnapped	Snapping was valid and attempted, but did not snap to target.
Snapped	Snapping was valid and attempted, and did snap to target. This may indicate no further snapping operations should be attempted for the given interaction.
Disabled	Snapping is valid and supported, but is disabled (usually due to a user setting).
Unsupported	The snapping query isn't valid for this Query Target.

ESceneSnapQueryTargetType

enum class ESceneSnapQueryTargetType : uint8

strong

Types of Snap Targets that a caller may want to run snap queries against.

Enumerator
None
MeshVertex	Consider any mesh vertex
MeshEdge	Consider any mesh edge
Grid	Grid Snapping
ObjectTransform	Any object with a transform representation
Custom	As defined by an FName
All

ESceneSnapQueryType

enum class ESceneSnapQueryType : uint8

strong

Types of Snap Queries that a USceneSnappingManager may support

Enumerator
Position	Position/Translation snapping
Rotation	Full rotation snapping (which could affect the axis of rotation)
RotationAngle	Snaps the rotation angle only (in degrees).
Scale	Scale snapping
Transform	Transform snapping (ie. snap to surface is both position and rotation)

Function Documentation

ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS

(

ESceneSnapQueryTargetType

)