UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UInteractiveToolsContext Class Reference

#include <InteractiveToolsContext.h>

+ Inheritance diagram for UInteractiveToolsContext:

Classes

struct  FContextInitInfo
 

Public Member Functions

INTERACTIVETOOLSFRAMEWORK_API UInteractiveToolsContext ()
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetCreateInputRouterFunc (TUniqueFunction< UInputRouter *(const FContextInitInfo &)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetCreateToolManagerFunc (TUniqueFunction< UInteractiveToolManager *(const FContextInitInfo &)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetCreateToolTargetManagerFunc (TUniqueFunction< UToolTargetManager *(const FContextInitInfo &)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetCreateGizmoManagerFunc (TUniqueFunction< UInteractiveGizmoManager *(const FContextInitInfo &)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetCreateContextStoreFunc (TUniqueFunction< UContextObjectStore *(const FContextInitInfo &)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetShutdownInputRouterFunc (TUniqueFunction< void(UInputRouter *)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetShutdownToolManagerFunc (TUniqueFunction< void(UInteractiveToolManager *)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetShutdownToolTargetManagerFunc (TUniqueFunction< void(UToolTargetManager *)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetShutdownGizmoManagerFunc (TUniqueFunction< void(UInteractiveGizmoManager *)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void SetShutdownContextStoreFunc (TUniqueFunction< void(UContextObjectStore *)> Func)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void Initialize (IToolsContextQueriesAPI *QueriesAPI, IToolsContextTransactionsAPI *TransactionsAPI)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void Shutdown ()
 
virtual INTERACTIVETOOLSFRAMEWORK_API void DeactivateActiveTool (EToolSide WhichSide, EToolShutdownType ShutdownType)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void DeactivateAllActiveTools (EToolShutdownType ShutdownType)
 
INTERACTIVETOOLSFRAMEWORK_API bool CanStartTool (EToolSide WhichSide, const FString &ToolTypeIdentifier) const
 
INTERACTIVETOOLSFRAMEWORK_API bool HasActiveTool (EToolSide WhichSide) const
 
INTERACTIVETOOLSFRAMEWORK_API FString GetActiveToolName (EToolSide WhichSide) const
 
INTERACTIVETOOLSFRAMEWORK_API bool ActiveToolHasAccept (EToolSide WhichSide) const
 
INTERACTIVETOOLSFRAMEWORK_API bool CanAcceptActiveTool (EToolSide WhichSide) const
 
INTERACTIVETOOLSFRAMEWORK_API bool CanCancelActiveTool (EToolSide WhichSide) const
 
INTERACTIVETOOLSFRAMEWORK_API bool CanCompleteActiveTool (EToolSide WhichSide) const
 
INTERACTIVETOOLSFRAMEWORK_API bool StartTool (EToolSide WhichSide, const FString &ToolTypeIdentifier)
 
INTERACTIVETOOLSFRAMEWORK_API void EndTool (EToolSide WhichSide, EToolShutdownType ShutdownType)
 
INTERACTIVETOOLSFRAMEWORK_API bool IsToolActive (EToolSide WhichSide, const FString ToolIdentifier) const
 
virtual INTERACTIVETOOLSFRAMEWORK_API void PostToolNotificationMessage (const FText &Message)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void PostToolWarningMessage (const FText &Message)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FToolsContextToolNotification, const FText &)
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Public Attributes

FToolsContextToolNotification OnToolNotificationMessage
 
FToolsContextToolNotification OnToolWarningMessage
 
TObjectPtr< UInputRouterInputRouter
 
TObjectPtr< UToolTargetManagerTargetManager
 
TObjectPtr< UInteractiveToolManagerToolManager
 
TObjectPtr< UInteractiveGizmoManagerGizmoManager
 
TObjectPtr< UContextObjectStoreContextObjectStore
 

Protected Attributes

TUniqueFunction< UInputRouter *(const FContextInitInfo &)> CreateInputRouterFunc
 
TUniqueFunction< UInteractiveToolManager *(const FContextInitInfo &)> CreateToolManagerFunc
 
TUniqueFunction< UToolTargetManager *(const FContextInitInfo &)> CreateToolTargetManagerFunc
 
TUniqueFunction< UInteractiveGizmoManager *(const FContextInitInfo &)> CreateGizmoManagerFunc
 
TUniqueFunction< UContextObjectStore *(const FContextInitInfo &)> CreateContextStoreFunc
 
TUniqueFunction< void(UInputRouter *)> ShutdownInputRouterFunc
 
TUniqueFunction< void(UInteractiveToolManager *)> ShutdownToolManagerFunc
 
TUniqueFunction< void(UToolTargetManager *)> ShutdownToolTargetManagerFunc
 
TUniqueFunction< void(UInteractiveGizmoManager *)> ShutdownGizmoManagerFunc
 
TUniqueFunction< void(UContextObjectStore *)> ShutdownContextStoreFunc
 
TSoftClassPtr< UInteractiveToolManagerToolManagerClass
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Detailed Description

InteractiveToolsContext owns the core parts of an Interactive Tools Framework implementation - the InputRouter, ToolManager, GizmoManager, TargetManager, and ContextStore. In the simplest use case, UInteractiveToolsContext is just a top-level container that will keep the various UObjects alive, and provide an easy way to access them. However in a more complex situation it may be desirable to subclass and extend the ToolsContext. For example, UEdModeInteractiveToolsContext allows a ToolsContext to live within a UEdMode.

Constructor & Destructor Documentation

◆ UInteractiveToolsContext()

UInteractiveToolsContext::UInteractiveToolsContext ( )

Member Function Documentation

◆ ActiveToolHasAccept()

bool UInteractiveToolsContext::ActiveToolHasAccept ( EToolSide  WhichSide) const

◆ CanAcceptActiveTool()

bool UInteractiveToolsContext::CanAcceptActiveTool ( EToolSide  WhichSide) const

◆ CanCancelActiveTool()

bool UInteractiveToolsContext::CanCancelActiveTool ( EToolSide  WhichSide) const

◆ CanCompleteActiveTool()

bool UInteractiveToolsContext::CanCompleteActiveTool ( EToolSide  WhichSide) const

◆ CanStartTool()

bool UInteractiveToolsContext::CanStartTool ( EToolSide  WhichSide,
const FString &  ToolTypeIdentifier 
) const

◆ DeactivateActiveTool()

void UInteractiveToolsContext::DeactivateActiveTool ( EToolSide  WhichSide,
EToolShutdownType  ShutdownType 
)
virtual

◆ DeactivateAllActiveTools()

void UInteractiveToolsContext::DeactivateAllActiveTools ( EToolShutdownType  ShutdownType)
virtual

◆ DECLARE_MULTICAST_DELEGATE_OneParam()

UInteractiveToolsContext::DECLARE_MULTICAST_DELEGATE_OneParam ( FToolsContextToolNotification  ,
const FText  
)

◆ EndTool()

void UInteractiveToolsContext::EndTool ( EToolSide  WhichSide,
EToolShutdownType  ShutdownType 
)

◆ GetActiveToolName()

FString UInteractiveToolsContext::GetActiveToolName ( EToolSide  WhichSide) const

◆ HasActiveTool()

bool UInteractiveToolsContext::HasActiveTool ( EToolSide  WhichSide) const

◆ Initialize()

void UInteractiveToolsContext::Initialize ( IToolsContextQueriesAPI QueriesAPI,
IToolsContextTransactionsAPI TransactionsAPI 
)
virtual

Initialize the Context. This creates the InputRouter, ToolManager, GizmoManager, TargetManager, and ContextStore

Parameters
QueriesAPIclient-provided implementation of the API for querying the higher-evel scene state
TransactionsAPIclient-provided implementation of the API for publishing events and transactions

◆ IsToolActive()

bool UInteractiveToolsContext::IsToolActive ( EToolSide  WhichSide,
const FString  ToolIdentifier 
) const

◆ PostToolNotificationMessage()

void UInteractiveToolsContext::PostToolNotificationMessage ( const FText Message)
virtual

◆ PostToolWarningMessage()

void UInteractiveToolsContext::PostToolWarningMessage ( const FText Message)
virtual

◆ SetCreateContextStoreFunc()

void UInteractiveToolsContext::SetCreateContextStoreFunc ( TUniqueFunction< UContextObjectStore *(const FContextInitInfo &)>  Func)
virtual

◆ SetCreateGizmoManagerFunc()

void UInteractiveToolsContext::SetCreateGizmoManagerFunc ( TUniqueFunction< UInteractiveGizmoManager *(const FContextInitInfo &)>  Func)
virtual

◆ SetCreateInputRouterFunc()

void UInteractiveToolsContext::SetCreateInputRouterFunc ( TUniqueFunction< UInputRouter *(const FContextInitInfo &)>  Func)
virtual

◆ SetCreateToolManagerFunc()

void UInteractiveToolsContext::SetCreateToolManagerFunc ( TUniqueFunction< UInteractiveToolManager *(const FContextInitInfo &)>  Func)
virtual

◆ SetCreateToolTargetManagerFunc()

void UInteractiveToolsContext::SetCreateToolTargetManagerFunc ( TUniqueFunction< UToolTargetManager *(const FContextInitInfo &)>  Func)
virtual

◆ SetShutdownContextStoreFunc()

void UInteractiveToolsContext::SetShutdownContextStoreFunc ( TUniqueFunction< void(UContextObjectStore *)>  Func)
virtual

◆ SetShutdownGizmoManagerFunc()

void UInteractiveToolsContext::SetShutdownGizmoManagerFunc ( TUniqueFunction< void(UInteractiveGizmoManager *)>  Func)
virtual

◆ SetShutdownInputRouterFunc()

void UInteractiveToolsContext::SetShutdownInputRouterFunc ( TUniqueFunction< void(UInputRouter *)>  Func)
virtual

◆ SetShutdownToolManagerFunc()

void UInteractiveToolsContext::SetShutdownToolManagerFunc ( TUniqueFunction< void(UInteractiveToolManager *)>  Func)
virtual

◆ SetShutdownToolTargetManagerFunc()

void UInteractiveToolsContext::SetShutdownToolTargetManagerFunc ( TUniqueFunction< void(UToolTargetManager *)>  Func)
virtual

◆ Shutdown()

void UInteractiveToolsContext::Shutdown ( )
virtual

Shutdown Context by destroying InputRouter and ToolManager

◆ StartTool()

bool UInteractiveToolsContext::StartTool ( EToolSide  WhichSide,
const FString &  ToolTypeIdentifier 
)

Member Data Documentation

◆ ContextObjectStore

TObjectPtr<UContextObjectStore> UInteractiveToolsContext::ContextObjectStore

Current Context Object Store for this Context. Stores arbitrary objects which share data or expose APIs across interactive tools and managers belonging to this context.

◆ CreateContextStoreFunc

TUniqueFunction<UContextObjectStore* (const FContextInitInfo&)> UInteractiveToolsContext::CreateContextStoreFunc
protected

◆ CreateGizmoManagerFunc

TUniqueFunction<UInteractiveGizmoManager* (const FContextInitInfo&)> UInteractiveToolsContext::CreateGizmoManagerFunc
protected

◆ CreateInputRouterFunc

TUniqueFunction<UInputRouter* (const FContextInitInfo&)> UInteractiveToolsContext::CreateInputRouterFunc
protected

◆ CreateToolManagerFunc

TUniqueFunction<UInteractiveToolManager* (const FContextInitInfo&)> UInteractiveToolsContext::CreateToolManagerFunc
protected

◆ CreateToolTargetManagerFunc

TUniqueFunction<UToolTargetManager* (const FContextInitInfo&)> UInteractiveToolsContext::CreateToolTargetManagerFunc
protected

◆ GizmoManager

TObjectPtr<UInteractiveGizmoManager> UInteractiveToolsContext::GizmoManager

current UInteractiveGizmoManager for this Context

◆ InputRouter

TObjectPtr<UInputRouter> UInteractiveToolsContext::InputRouter

current UInputRouter for this Context

◆ OnToolNotificationMessage

FToolsContextToolNotification UInteractiveToolsContext::OnToolNotificationMessage

◆ OnToolWarningMessage

FToolsContextToolNotification UInteractiveToolsContext::OnToolWarningMessage

◆ ShutdownContextStoreFunc

TUniqueFunction<void(UContextObjectStore*)> UInteractiveToolsContext::ShutdownContextStoreFunc
protected

◆ ShutdownGizmoManagerFunc

TUniqueFunction<void(UInteractiveGizmoManager*)> UInteractiveToolsContext::ShutdownGizmoManagerFunc
protected

◆ ShutdownInputRouterFunc

TUniqueFunction<void(UInputRouter*)> UInteractiveToolsContext::ShutdownInputRouterFunc
protected

◆ ShutdownToolManagerFunc

TUniqueFunction<void(UInteractiveToolManager*)> UInteractiveToolsContext::ShutdownToolManagerFunc
protected

◆ ShutdownToolTargetManagerFunc

TUniqueFunction<void(UToolTargetManager*)> UInteractiveToolsContext::ShutdownToolTargetManagerFunc
protected

◆ TargetManager

TObjectPtr<UToolTargetManager> UInteractiveToolsContext::TargetManager

current UToolTargetManager for this Context

◆ ToolManager

TObjectPtr<UInteractiveToolManager> UInteractiveToolsContext::ToolManager

current UInteractiveToolManager for this Context

◆ ToolManagerClass

TSoftClassPtr<UInteractiveToolManager> UInteractiveToolsContext::ToolManagerClass
protected

The documentation for this class was generated from the following files: