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

#include <InteractiveGizmoManager.h>

+ Inheritance diagram for UInteractiveGizmoManager:

Public Member Functions

virtual INTERACTIVETOOLSFRAMEWORK_API void RegisterGizmoType (const FString &BuilderIdentifier, UInteractiveGizmoBuilder *Builder)
 
virtual INTERACTIVETOOLSFRAMEWORK_API bool DeregisterGizmoType (const FString &BuilderIdentifier)
 
virtual INTERACTIVETOOLSFRAMEWORK_API UInteractiveGizmoCreateGizmo (const FString &BuilderIdentifier, const FString &InstanceIdentifier=FString(), void *Owner=nullptr)
 
template<typename GizmoType >
GizmoTypeCreateGizmo (const FString &BuilderIdentifier, const FString &InstanceIdentifier=FString(), void *Owner=nullptr)
 
virtual INTERACTIVETOOLSFRAMEWORK_API bool DestroyGizmo (UInteractiveGizmo *Gizmo)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void DestroyAllGizmosOfType (const FString &BuilderIdentifier)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void DestroyAllGizmosByOwner (void *Owner)
 
virtual INTERACTIVETOOLSFRAMEWORK_API TArray< UInteractiveGizmo * > FindAllGizmosOfType (const FString &BuilderIdentifier)
 
virtual INTERACTIVETOOLSFRAMEWORK_API UInteractiveGizmoFindGizmoByInstanceIdentifier (const FString &Identifier) const
 
virtual INTERACTIVETOOLSFRAMEWORK_API void DisplayMessage (const FText &Message, EToolMessageLevel Level)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void PostInvalidation ()
 
virtual INTERACTIVETOOLSFRAMEWORK_API void BeginUndoTransaction (const FText &Description)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void EndUndoTransaction ()
 
virtual INTERACTIVETOOLSFRAMEWORK_API void EmitObjectChange (UObject *TargetObject, TUniquePtr< FToolCommandChange > Change, const FText &Description)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void Tick (float DeltaTime)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void Render (IToolsContextRenderAPI *RenderAPI)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void DrawHUD (FCanvas *Canvas, IToolsContextRenderAPI *RenderAPI)
 
virtual IToolsContextQueriesAPIGetContextQueriesAPI ()
 
INTERACTIVETOOLSFRAMEWORK_API UContextObjectStoreGetContextObjectStore () const
 
virtual INTERACTIVETOOLSFRAMEWORK_API void RegisterDefaultGizmos ()
 
virtual INTERACTIVETOOLSFRAMEWORK_API UCombinedTransformGizmoCreate3AxisTransformGizmo (void *Owner=nullptr, const FString &InstanceIdentifier=FString())
 
virtual INTERACTIVETOOLSFRAMEWORK_API UCombinedTransformGizmoCreateCustomTransformGizmo (ETransformGizmoSubElements Elements, void *Owner=nullptr, const FString &InstanceIdentifier=FString())
 
virtual INTERACTIVETOOLSFRAMEWORK_API UCombinedTransformGizmoCreateCustomRepositionableTransformGizmo (ETransformGizmoSubElements Elements, void *Owner=nullptr, const FString &InstanceIdentifier=FString())
 
- 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)
 

Static Public Attributes

static INTERACTIVETOOLSFRAMEWORK_API FString DefaultAxisPositionBuilderIdentifier = TEXT("StandardXFormAxisTranslationGizmo")
 
static INTERACTIVETOOLSFRAMEWORK_API FString DefaultPlanePositionBuilderIdentifier = TEXT("StandardXFormPlaneTranslationGizmo")
 
static INTERACTIVETOOLSFRAMEWORK_API FString DefaultAxisAngleBuilderIdentifier = TEXT("StandardXFormAxisRotationGizmo")
 
static INTERACTIVETOOLSFRAMEWORK_API FString DefaultThreeAxisTransformBuilderIdentifier = TEXT("DefaultThreeAxisTransformBuilderIdentifier")
 
static INTERACTIVETOOLSFRAMEWORK_API const FString CustomThreeAxisTransformBuilderIdentifier = TEXT("CustomThreeAxisTransformBuilderIdentifier")
 
static INTERACTIVETOOLSFRAMEWORK_API const FString CustomRepositionableThreeAxisTransformBuilderIdentifier = TEXT("CustomRepositionableThreeAxisTransformBuilderIdentifier")
 
static INTERACTIVETOOLSFRAMEWORK_API FString DefaultScalableSphereBuilderIdentifier = TEXT("DefaultScalableSphereBuilderIdentifier")
 

Protected Member Functions

INTERACTIVETOOLSFRAMEWORK_API UInteractiveGizmoManager ()
 
virtual INTERACTIVETOOLSFRAMEWORK_API void Initialize (IToolsContextQueriesAPI *QueriesAPI, IToolsContextTransactionsAPI *TransactionsAPI, UInputRouter *InputRouter)
 
virtual INTERACTIVETOOLSFRAMEWORK_API void Shutdown ()
 
- 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)
 

Protected Attributes

TArray< FActiveGizmoActiveGizmos
 
IToolsContextQueriesAPIQueriesAPI
 
IToolsContextTransactionsAPITransactionsAPI
 
UInputRouterInputRouter
 
TMap< FString, TObjectPtr< UInteractiveGizmoBuilder > > GizmoBuilders
 
bool bDefaultGizmosRegistered = false
 
TSharedPtr< FCombinedTransformGizmoActorFactoryGizmoActorBuilder
 

Friends

class UInteractiveToolsContext
 

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)
 

Detailed Description

UInteractiveGizmoManager allows users of the Tools framework to create and operate Gizmo instances. For each Gizmo, a (string,GizmoBuilder) pair is registered with the GizmoManager. Gizmos can then be activated via the string identifier.

Constructor & Destructor Documentation

◆ UInteractiveGizmoManager()

UInteractiveGizmoManager::UInteractiveGizmoManager ( )
protected

Member Function Documentation

◆ BeginUndoTransaction()

void UInteractiveGizmoManager::BeginUndoTransaction ( const FText Description)
virtual

Request that the Context open a Transaction, whatever that means to the current Context

Parameters
Descriptiontext description of this transaction (this is the string that appears on undo/redo in the UE Editor)

Implements IToolContextTransactionProvider.

◆ Create3AxisTransformGizmo()

UCombinedTransformGizmo * UInteractiveGizmoManager::Create3AxisTransformGizmo ( void Owner = nullptr,
const FString &  InstanceIdentifier = FString() 
)
virtual

Activate a new instance of the default 3-axis transformation Gizmo. RegisterDefaultGizmos() must have been called first.

Parameters
Owneroptional void pointer to whatever "owns" this Gizmo. Allows Gizmo to later be deleted using DestroyAllGizmosByOwner()
InstanceIdentifieroptional client-defined unique string that can be used to locate this instance
Returns
new Gizmo instance that has been created and initialized

◆ CreateCustomRepositionableTransformGizmo()

UCombinedTransformGizmo * UInteractiveGizmoManager::CreateCustomRepositionableTransformGizmo ( ETransformGizmoSubElements  Elements,
void Owner = nullptr,
const FString &  InstanceIdentifier = FString() 
)
virtual

◆ CreateCustomTransformGizmo()

UCombinedTransformGizmo * UInteractiveGizmoManager::CreateCustomTransformGizmo ( ETransformGizmoSubElements  Elements,
void Owner = nullptr,
const FString &  InstanceIdentifier = FString() 
)
virtual

Activate a new customized instance of the default 3-axis transformation Gizmo, with only certain elements included. RegisterDefaultGizmos() must have been called first.

Parameters
Elementsflags that indicate which standard gizmo sub-elements should be included
Owneroptional void pointer to whatever "owns" this Gizmo. Allows Gizmo to later be deleted using DestroyAllGizmosByOwner()
InstanceIdentifieroptional client-defined unique string that can be used to locate this instance
Returns
new Gizmo instance that has been created and initialized

◆ CreateGizmo() [1/2]

UInteractiveGizmo * UInteractiveGizmoManager::CreateGizmo ( const FString &  BuilderIdentifier,
const FString &  InstanceIdentifier = FString(),
void Owner = nullptr 
)
virtual

Try to activate a new Gizmo instance

Parameters
BuilderIdentifierstring used to identify Builder that should be called
InstanceIdentifieroptional client-defined string that can be used to locate this instance (must be unique across all Gizmos)
Ownervoid pointer to whatever "owns" this Gizmo. Allows Gizmo to later be deleted using DestroyAllGizmosByOwner()
Returns
new Gizmo instance that has been created and initialized

◆ CreateGizmo() [2/2]

template<typename GizmoType >
GizmoType * UInteractiveGizmoManager::CreateGizmo ( const FString &  BuilderIdentifier,
const FString &  InstanceIdentifier = FString(),
void Owner = nullptr 
)
inline

Try to activate a new Gizmo instance

Parameters
BuilderIdentifierstring used to identify Builder that should be called
InstanceIdentifieroptional client-defined string that can be used to locate this instance (must be unique across all Gizmos)
Ownervoid pointer to whatever "owns" this Gizmo. Allows Gizmo to later be deleted using DestroyAllGizmosByOwner()
Returns
new Gizmo instance that has been created and initialized, and cast to template type

◆ DeregisterGizmoType()

bool UInteractiveGizmoManager::DeregisterGizmoType ( const FString &  BuilderIdentifier)
virtual

Remove a GizmoBuilder from the set of known GizmoBuilders

Parameters
BuilderIdentifieridentification string that was passed to RegisterGizmoType()
Returns
true if Builder was found and deregistered

◆ DestroyAllGizmosByOwner()

void UInteractiveGizmoManager::DestroyAllGizmosByOwner ( void Owner)
virtual

Destroy all Gizmos that are owned by the given pointer

Parameters
Ownerpointer that was passed to CreateGizmo

◆ DestroyAllGizmosOfType()

void UInteractiveGizmoManager::DestroyAllGizmosOfType ( const FString &  BuilderIdentifier)
virtual

Destroy all Gizmos that were created by the identified GizmoBuilder

Parameters
BuilderIdentifierthe Builder string registered with RegisterGizmoType

◆ DestroyGizmo()

bool UInteractiveGizmoManager::DestroyGizmo ( UInteractiveGizmo Gizmo)
virtual

Shutdown and remove a Gizmo

Parameters
Gizmothe Gizmo to shutdown and remove
Returns
true if the Gizmo was found and removed

◆ DisplayMessage()

void UInteractiveGizmoManager::DisplayMessage ( const FText Message,
EToolMessageLevel  Level 
)
virtual

Post a message via the Transactions API

◆ DrawHUD()

void UInteractiveGizmoManager::DrawHUD ( FCanvas Canvas,
IToolsContextRenderAPI RenderAPI 
)
virtual

Let active Gizmos do screen space drawing. Called by UInteractiveToolsContext

◆ EmitObjectChange()

void UInteractiveGizmoManager::EmitObjectChange ( UObject TargetObject,
TUniquePtr< FToolCommandChange Change,
const FText Description 
)
virtual

Forward an FChange object to the Context

Parameters
TargetObjectthe object that the FChange applies to
Changethe change object that the Context should insert into the transaction history
Descriptiontext description of this change (this is the string that appears on undo/redo in the UE Editor)

Implements IToolContextTransactionProvider.

◆ EndUndoTransaction()

void UInteractiveGizmoManager::EndUndoTransaction ( )
virtual

Request that the Context close and commit the open Transaction

Implements IToolContextTransactionProvider.

◆ FindAllGizmosOfType()

TArray< UInteractiveGizmo * > UInteractiveGizmoManager::FindAllGizmosOfType ( const FString &  BuilderIdentifier)
virtual

Find all the existing Gizmo instances that were created by the identified GizmoBuilder

Parameters
BuilderIdentifierthe Builder string registered with RegisterGizmoType
Returns
list of found Gizmos

◆ FindGizmoByInstanceIdentifier()

UInteractiveGizmo * UInteractiveGizmoManager::FindGizmoByInstanceIdentifier ( const FString &  Identifier) const
virtual

Find the Gizmo that was created with the given instance identifier

Parameters
Identifierthe InstanceIdentifier that was passed to CreateGizmo()
Returns
the found Gizmo, or null

◆ GetContextObjectStore()

UContextObjectStore * UInteractiveGizmoManager::GetContextObjectStore ( ) const
Returns
the context object store from the owning tools context.

◆ GetContextQueriesAPI()

virtual IToolsContextQueriesAPI * UInteractiveGizmoManager::GetContextQueriesAPI ( )
inlinevirtual
Returns
current IToolsContextQueriesAPI

◆ Initialize()

void UInteractiveGizmoManager::Initialize ( IToolsContextQueriesAPI QueriesAPI,
IToolsContextTransactionsAPI TransactionsAPI,
UInputRouter InputRouter 
)
protectedvirtual

Initialize the GizmoManager with the necessary Context-level state. UInteractiveToolsContext calls this, you should not.

◆ PostInvalidation()

void UInteractiveGizmoManager::PostInvalidation ( )
virtual

Request an Invalidation via the Transactions API (ie to cause a repaint, etc)

◆ RegisterDefaultGizmos()

void UInteractiveGizmoManager::RegisterDefaultGizmos ( )
virtual

Register default gizmo types

◆ RegisterGizmoType()

void UInteractiveGizmoManager::RegisterGizmoType ( const FString &  BuilderIdentifier,
UInteractiveGizmoBuilder Builder 
)
virtual

Register a new GizmoBuilder

Parameters
BuilderIdentifierstring used to identify this Builder
Buildernew GizmoBuilder instance

◆ Render()

void UInteractiveGizmoManager::Render ( IToolsContextRenderAPI RenderAPI)
virtual

Render any active Gizmos. Called by UInteractiveToolsContext.

◆ Shutdown()

void UInteractiveGizmoManager::Shutdown ( )
protectedvirtual

Shutdown the GizmoManager. Called by UInteractiveToolsContext.

◆ Tick()

void UInteractiveGizmoManager::Tick ( float  DeltaTime)
virtual

Tick any active Gizmos. Called by UInteractiveToolsContext

Friends And Related Symbol Documentation

◆ UInteractiveToolsContext

Member Data Documentation

◆ ActiveGizmos

TArray<FActiveGizmo> UInteractiveGizmoManager::ActiveGizmos
protected

set of Currently-active Gizmos

◆ bDefaultGizmosRegistered

bool UInteractiveGizmoManager::bDefaultGizmosRegistered = false
protected

◆ CustomRepositionableThreeAxisTransformBuilderIdentifier

const FString UInteractiveGizmoManager::CustomRepositionableThreeAxisTransformBuilderIdentifier = TEXT("CustomRepositionableThreeAxisTransformBuilderIdentifier")
static

◆ CustomThreeAxisTransformBuilderIdentifier

const FString UInteractiveGizmoManager::CustomThreeAxisTransformBuilderIdentifier = TEXT("CustomThreeAxisTransformBuilderIdentifier")
static

◆ DefaultAxisAngleBuilderIdentifier

FString UInteractiveGizmoManager::DefaultAxisAngleBuilderIdentifier = TEXT("StandardXFormAxisRotationGizmo")
static

◆ DefaultAxisPositionBuilderIdentifier

FString UInteractiveGizmoManager::DefaultAxisPositionBuilderIdentifier = TEXT("StandardXFormAxisTranslationGizmo")
static

◆ DefaultPlanePositionBuilderIdentifier

FString UInteractiveGizmoManager::DefaultPlanePositionBuilderIdentifier = TEXT("StandardXFormPlaneTranslationGizmo")
static

◆ DefaultScalableSphereBuilderIdentifier

FString UInteractiveGizmoManager::DefaultScalableSphereBuilderIdentifier = TEXT("DefaultScalableSphereBuilderIdentifier")
static

◆ DefaultThreeAxisTransformBuilderIdentifier

FString UInteractiveGizmoManager::DefaultThreeAxisTransformBuilderIdentifier = TEXT("DefaultThreeAxisTransformBuilderIdentifier")
static

◆ GizmoActorBuilder

TSharedPtr<FCombinedTransformGizmoActorFactory> UInteractiveGizmoManager::GizmoActorBuilder
protected

◆ GizmoBuilders

TMap<FString, TObjectPtr<UInteractiveGizmoBuilder> > UInteractiveGizmoManager::GizmoBuilders
protected

Current set of named GizmoBuilders

◆ InputRouter

UInputRouter* UInteractiveGizmoManager::InputRouter
protected

Current InputRouter (Context owns this)

◆ QueriesAPI

IToolsContextQueriesAPI* UInteractiveGizmoManager::QueriesAPI
protected

Current Context-Queries implementation

◆ TransactionsAPI

IToolsContextTransactionsAPI* UInteractiveGizmoManager::TransactionsAPI
protected

Current Transactions implementation


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