FScopedSelectionChangeEventSuppression

API > API/Editor > API/Editor/CurveEditor

Prevents FCurveEditorSelection::OnSelectionChanged from being broadcast while the constructed scope is open. Once all scopes end, and if changes to selection have been made, FCurveEditorSelection::OnSelectionChanged is broadcast exactly once. Nesting FScopedSelectionChangeEventSuppression is supported.

This is an optimization if you are going to make multiple changes to selection and want the delegate to be broadcast after you're done.

Example usage: TSharedRef MyCurveEditor = ...; { FScopedSelectionChangeEventSuppression SuppressChangeEvents(MyCurveEditor); MyCurveEditor->Selection.Toggle(FooCurveId, ECurvePointType::Key, FooKeyHandle); // Normally this would invoke OnSelectionChanged. MyCurveEditor->Selection.Toggle(BarCurveId, ECurvePointType::Key, BarKeyHandle); // So would this { FScopedSelectionChangeEventSuppression AnotherChange(MyCurveEditor); MyCurveEditor->Selection.Toggle(BazCurveId, ECurvePointType::Key, BazKeyHandle); //~ FCurveEditorSelection::OnSelectionChanged not invoked due to the outer scope. }

// ~FScopedSelectionChangeEventSuppression will now invoke FCurveEditorSelection::OnSelectionChanged once exactly. }


Name	FScopedSelectionChangeEventSuppression
Type	class
Header File	/Engine/Source/Editor/CurveEditor/Public/Selection/ScopedSelectionChangeEventSuppression.h
Include Path	#include "Selection/ScopedSelectionChangeEventSuppression.h"

Syntax

class FScopedSelectionChangeEventSuppression : public FNoncopyable

Inheritance Hierarchy

FNoncopyable → FScopedSelectionChangeEventSuppression

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FScopedSelectionChangeEventSuppression ( const TSharedRef< FCurveEditor >& InCurveEditor )		Selection/ScopedSelectionChangeEventSuppression.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~FScopedSelectionChangeEventSuppression()		Selection/ScopedSelectionChangeEventSuppression.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
WeakCurveEditor	const TWeakPtr< FCurveEditor >	Handles the case of curve editor being destroyed during the scope, which should not happen but we handle for safety.	Selection/ScopedSelectionChangeEventSuppression.h

Navigation