1. Epic GamesDeveloper
  3. FScopedMovementUpdate

FScopedMovementUpdate

[FScopedMovementUpdate](API\Runtime\Engine\Engine\FScopedMovementUpdate) creates a new movement scope, within which propagation of moves may be deferred until the end of the outermost scope that does not defer updates.

Unreal Engine C++ API Reference > Runtime > Engine > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Engine/ScopedMovementUpdate.h
Include #include "Engine/ScopedMovementUpdate.h"

Syntax

class FScopedMovementUpdate : private FNoncopyable

Remarks

FScopedMovementUpdate creates a new movement scope, within which propagation of moves may be deferred until the end of the outermost scope that does not defer updates. Moves within this scope will avoid updates such as UpdateBounds(), OnUpdateTransform(), UpdatePhysicsVolume(), UpdateChildTransforms() etc until the move is committed (which happens when the last deferred scope goes out of context).

Note that non-deferred scopes are not allowed within outer scopes that defer updates, and any attempt to use one will change the inner scope to use deferred updates.

Variables

  Type Name Description
Protected variable uint8: 1 bDeferUpdates  
Protected variable uint8: 1 bHasMoved  
Protected variable TScopedBlockingHitArray BlockingHits  
Protected variable uint8: 1 bRequireOverlapsEventFlag  
Protected variable EOverlapState CurrentOverlapState  
Protected variable int32 FinalOverlapCandidatesIndex  
Protected variable FVector InitialRelativeLocation  
Protected variable FRotator InitialRelativeRotation  
Protected variable FVector InitialRelativeScale  
Protected variable FTransform InitialTransform  
Protected variable FScopedMovementUpdate * OuterDeferredScope  
Protected variable USceneComponent * Owner  
Protected variable TScopedOverlapInfoArray PendingOverlaps  
Protected variable ETeleportType TeleportType  

Constructors

  Type Name Description
Public function  

FScopedMovementUpdate ( USceneComponent* Component,
EScopedUpdate::Type ScopeBehavior,
bool bRequireOverlapsEventFlagToQueueOverlaps
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Add blocking hit that will get processed once the move is committed.
Public function void

AppendOverlapsAfterMove ( const TOverlapArrayView& NewPendingOverlaps,
bool bSweep,
bool bIncludesOverlapsAtEnd
)

 Add overlaps to the queued overlaps array.
Public function void Force full overlap update once this scope finishes.
Public function Const const FScopedMovementUpdate * Get the scope containing this scope. A scope only has an outer scope if they both defer updates.
Protected function Const TOptional< TOverlapArrayView >

GetOverlapsAtEnd ( UPrimitiveComponent& PrimComponent,
TInlineOverlapInfoArray& OutEndOverlaps,
bool bTransformChanged
)

 Fills in the list of overlaps at the end location (in EndOverlaps).
Public function Const const TScopedBlockingHitArray & Returns the list of pending blocking hits, which will be used for notifications once the move is committed.
Public function Const const TScopedOverlapInfoArray & Returns the pending overlaps within this scope.
Public function Const bool

HasMoved ( EHasMovedTransformOption CheckTransform
)

 Returns whether movement has occurred at all during this scope, optionally checking if the transform is different (since changing scale does not go through a move).
Public function Const bool Returns true if there are pending overlaps queued in this scope.
Public function void Clear overlap state at current location, we don't know what it is.
Public function Const bool Return true if deferring updates, false if updates are applied immediately.
Public function Const bool Returns true if the Component's transform differs from that at the start of the scoped update.
Public function void Keep current pending overlaps after a move but make note that there was movement (just a symmetric rotation).
Public function Const bool Returns true if we require GetGenerateOverlapEvents() on both the moving object and the overlapped object to add them to the pending overlaps list.
Public function void Revert movement to the initial location of the Component at the start of the scoped update.
Public function void

SetHasTeleported ( ETeleportType InTeleportType
)

 Registers that this move is a teleport
Protected function bool

SetWorldLocationAndRotation ( FVector NewLocation,
const FQuat& NewQuat,
bool bNoPhysics,
ETeleportType Teleport
)

  

Enums

  Type Name Description
Public enum EHasMovedTransformOption    
Public enum EOverlapState    

Typedefs

Name Description
TScopedBlockingHitArray  
TScopedOverlapInfoArray  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page