description: Useful for resolving tick order issue.

code: void ForceTick()


description: Get current CombinedBundleStatus for everything setup to track.

module: InstallBundleManager

code: const [FCombinedProgress](API\Runtime\InstallBundleManager\FInstallBundleCombinedProgressTr-\FCombinedProgres-) & GetCurrentCombinedProgress() const


code: [FInstallBundleCombinedProgressTracker](API\Runtime\InstallBundleManager\FInstallBundleCombinedProgressTr-) & operator= ( const [FInstallBundleCombinedProgressTracker](API\Runtime\InstallBundleManager\FInstallBundleCombinedProgressTr-) & Other )


code: [FInstallBundleCombinedProgressTracker](API\Runtime\InstallBundleManager\FInstallBundleCombinedProgressTr-) & operator= ( [FInstallBundleCombinedProgressTracker](API\Runtime\InstallBundleManager\FInstallBundleCombinedProgressTr-) && Other )


description: Setup tracking for all bundles required in the supplied BundleContentState.

code: void SetBundlesToTrackFromContentState ( const [FInstallBundleCombinedContentState](API\Runtime\InstallBundleManager\FInstallBundleCombinedContentSta-) & BundleContentState, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FName](API\Runtime\Core\UObject\FName) > BundlesToTrack )


code: FInstallBundleCombinedProgressTracker ( const [FInstallBundleCombinedProgressTracker](API\Runtime\InstallBundleManager\FInstallBundleCombinedProgressTr-) & Other )


description: BAutoTick Whehter this tracker should automatically Tick

code: FInstallBundleCombinedProgressTracker ( bool bAutoTick )


code: FInstallBundleCombinedProgressTracker ( [FInstallBundleCombinedProgressTracker](API\Runtime\InstallBundleManager\FInstallBundleCombinedProgressTr-) && Other )


className: FInstallBundleCombinedProgressTracker

description: Handles calculating the bundle status by combining progress from all of its Prerequisites. Allows you to display one progress percent that is weighted based on all bundles' values.


className: FInstallBundleContentState

code: struct FInstallBundleContentState

State

type: EInstallBundleI...

Version

type: TMap< EInstallB...

Weight

type: float


code: FInstallBundleManagerKeepAwake ( bool bNeedsRendering )


className: FInstallBundleManagerKeepAwake

description: Keep the engine awake via RAII when running as an embedded app.

code: class FInstallBundleManagerKeepAwake : public [FEmbeddedKeepAwake](API\Runtime\Core\Misc\FEmbeddedKeepAwake)


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: FInstallBundleManagerModule

description: Currently empty implementation for InstallBundleModule until things are moved in here.

code: class FInstallBundleManagerModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: bDidDisableScreensaver

code: static bool bDidDisableScreensaver = false;


className: DisableCount

code: static int DisableCount = 0;


code: [FInstallBundleManagerScreenSaverControl](API\Runtime\InstallBundleManager\FInstallBundleManagerScreenSaver-) & operator= ( [FInstallBundleManagerScreenSaverControl](API\Runtime\InstallBundleManager\FInstallBundleManagerScreenSaver-) && Other )


code: FInstallBundleManagerScreenSaverControl ( const [FInstallBundleManagerScreenSaverControl](API\Runtime\InstallBundleManager\FInstallBundleManagerScreenSaver-) & Other )


code: FInstallBundleManagerScreenSaverControl ( [FInstallBundleManagerScreenSaverControl](API\Runtime\InstallBundleManager\FInstallBundleManagerScreenSaver-) && Other )


code: [FInstallBundleManagerScreenSaverControl](API\Runtime\InstallBundleManager\FInstallBundleManagerScreenSaver-) & operator= ( const [FInstallBundleManagerScreenSaverControl](API\Runtime\InstallBundleManager\FInstallBundleManagerScreenSaver-) & Other )


className: FInstallBundleManagerScreenSaverControl


className: FInstallBundlePauseInfo

code: struct FInstallBundlePauseInfo

BundleName

type: FName

PauseFlags

type: EInstallBundleP...


className: FInstallBundleProgress

code: struct FInstallBundleProgress

Status

type: EInstallBundleS...


className: FInstallBundleReleaseRequestResultInfo

Result

type: EInstallBundleR...


className: FInstallBundleRequestResultInfo

code: struct FInstallBundleRequestResultInfo

bContentWasInstalled

type: bool

OptionalErrorCode

type: FString

OptionalErrorText

type: FText

description: Currently, these just forward BPT Error info.


className: FInstallBundleRequestInfo

code: struct FInstallBundleRequestInfo

BundlesEnqueued

type: TArray<FName>


className: FInstallBundleSourceAsyncInitInfo

code: struct FInstallBundleSourceAsyncInitInfo : public [FInstallBundleSourceInitInfo](API\Runtime\InstallBundleManager\FInstallBundleSourceInitInfo)


className: FInstallBundleSourceInitInfo

code: struct FInstallBundleSourceInitInfo

Result

type: EInstallBundleM...


className: FInstallBundleSourcePauseInfo

code: struct FInstallBundleSourcePauseInfo

bDidPauseChange

description: True if the bundle actually transitioned to/from paused, which is different than the flags changing


description: Persisted Bundle Info communicated from bundle source to bundle manager on startup.


className: FInstallBundleSourceProgress

code: struct FInstallBundleSourceProgress


className: FInstallBundleSourceUpdateBundleInfo

description: Bundle Info communicated from bundle source to bundle manager at any time.

LastAccessTime

type: FDateTime


bContentWasRemoved

description: Indicates content was actually removed and bundle manager should consider this bundle as no longer installed.


code: bool DidBundleSourceDoWork() const


AdditionalRootDirs

type: TArray<FString...

NonUFSShaderLibPaths

type: TSet<FString>

description: Support platforms that need shaderlibs in the physical FS.

OptionalErrorText

description: Forward any errors from the underlying implementation for a specific source Currently, these just forward BPT Error info


code: static bool IsEnabled()


code: FInstallBundleSuppressAnalytics()


code: ~FInstallBundleSuppressAnalytics()


className: FInstallBundleSuppressAnalytics

description: Helper to safely suppress installer analytics that will restore previous state when going out of scope.

code: struct FInstallBundleSuppressAnalytics : public [FNoncopyable](API\Runtime\Core\Templates\FNoncopyable)


code: void CallOnComplete()


className: FInstallBundleTask

code: typedef [FAsyncTask](API\Runtime\Core\Async\FAsyncTask)< [FInstallBundleWork](API\Runtime\InstallBundleManager\FInstallBundleWork) > FInstallBundleTask


code: FInstallBundleWork()


code: FInstallBundleWork ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void()> InWork, [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void()> InOnComplete )


className: FInstallBundleWork

code: class FInstallBundleWork : public [FNonAbandonableTask](API\Runtime\Core\Async\FNonAbandonableTask)


code: virtual const [FBundlePersistentStats](API\Runtime\InstallBundleManager\FBundlePersistentStats) * GetBundleStat ( [FName](API\Runtime\Core\UObject\FName) BundleName ) const


code: virtual const [FSessionPersistentStats](API\Runtime\InstallBundleManager\FSessionPersistentStats) * GetSessionStat ( const [FString](API\Runtime\Core\Containers\FString) & SessionName ) const


code: virtual void IncrementBundlePersistentCounter ( [FName](API\Runtime\Core\UObject\FName) BundleName, [ECountStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-_1) CounterToUpdate )


code: virtual void IncrementSessionPersistentCounter ( const [FString](API\Runtime\Core\Containers\FString) & SessionName, [ECountStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-_1) CounterToUpdate )


description: NOTE! These 2 functions are not virtual as we call them in the construct/deconstructor!

code: void InitializeBase()


description: Goes through this Session's RequiredBundles and loads data from disk for those bundles. Allows us to make sure we have full data in memory from disk without having to know the previous runs AnalyticsID to call StatsBegin on that bundle. NOTE: You should still call StatsBegin on the listed bundles before Starting/Incrementing/ETC any analytics! This just ensures that the previous run data exists for this given session!

code: virtual void LoadRequiredBundleDataFromDiskForSession ( const [FString](API\Runtime\Core\Containers\FString) & SessionName )


code: virtual void OnApp_EnteringBackground()


code: virtual void OnApp_EnteringForeground()


description: Called whenever we start a timer NOTE: doesn't get called by timer's being Start/Stopped for bShouldAutoHandleFGBGStats

code: virtual void OnTimerStartedForStat ( [FPersistentStatsBase](API\Runtime\InstallBundleManager\FPersistentStatsBase) & BundleStatForTimer, [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) TimerStarted )


code: virtual void RemoveBundleStats ( [FName](API\Runtime\Core\UObject\FName) BundleName )


description: Called whenever we stop a timer NOTE: doesn't get called by timer's being Start/Stopped for bShouldAutoHandleFGBGStats

code: virtual void OnTimerStoppedForStat ( [FPersistentStatsBase](API\Runtime\InstallBundleManager\FPersistentStatsBase) & BundleStatForTimer, [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) TimerStarted )


description: Deletes persistent stat information from our stats for this Session/Bundle to reduce memory useage.

code: virtual void RemoveSessionStats ( const [FString](API\Runtime\Core\Containers\FString) & SessionName )


code: virtual void ResetDirtyStatUpdate()


code: virtual void ResetTimerUpdate()


code: virtual void SaveAllDirtyStatsToDisk()


description: Starts Bundle Persistent Stat Tracking for the given BundleName. Will automatically load applicable data from the disk and reset that cache if the ExpectedAnalyticsID doesn't match the one previously serialized. Uses FInstallBundleStatsContainerBase::GetBaseExpectedAnalyticsID if an ExpectedAnalyticsID is not passed in or empty

code: virtual void StartBundlePersistentStatTracking ( [FName](API\Runtime\Core\UObject\FName) BundleName, const [FString](API\Runtime\Core\Containers\FString) & ExpectedAnalyticsID, bool bForceResetStatData )


code: virtual void StartBundlePersistentStatTimer ( [FName](API\Runtime\Core\UObject\FName) BundleName, [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) TimerToStart )


description: Starts Session Persistent Stat Tracking under the given SessionName. Will automatically load applicable data from the disk and reset that cache if the ExpectedAnalyticsID doesn't match the one previously serialized. Uses FInstallBundleStatsContainerBase::GetBaseExpectedAnalyticsID if an ExpectedAnalyticsID is not passed in or empty

code: virtual void StartSessionPersistentStatTracking ( const [FString](API\Runtime\Core\Containers\FString) & SessionName, const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & RequiredBundles, const [FString](API\Runtime\Core\Containers\FString) & ExpectedAnalyticsID, bool bForceResetStatData )


code: virtual void StartSessionPersistentStatTimer ( const [FString](API\Runtime\Core\Containers\FString) & SessionName, [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) TimerToStart )


code: virtual void StopBundlePersistentStatTracking ( [FName](API\Runtime\Core\UObject\FName) BundleName, bool bStopAllActiveTimers )


code: virtual void StopBundlePersistentStatTimer ( [FName](API\Runtime\Core\UObject\FName) BundleName, [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) TimerToStop )


code: virtual void StopSessionPersistentStatTracking ( const [FString](API\Runtime\Core\Containers\FString) & SessionName, bool bStopAllActiveTimers )


code: virtual void StopSessionPersistentStatTimer ( const [FString](API\Runtime\Core\Containers\FString) & SessionName, [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) TimerToStop )


code: virtual bool Tick ( float dt )


code: virtual void UpdateBundlePersistentStatTimer ( [FName](API\Runtime\Core\UObject\FName) BundleName, [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) TimerToUpdate )


code: virtual void UpdateSessionPersistentStatTimer ( const [FString](API\Runtime\Core\Containers\FString) & SessionName, [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) TimerToUpdate )


description: Stops active foreground timers when going to background and starts applicable background version Also increments background counters

code: virtual void UpdateStatsForBackground ( [FPersistentStatsBase](API\Runtime\InstallBundleManager\FPersistentStatsBase) & StatToUpdate )


description: Stops active background timers and resumes applicable foreground timers Also increments foreground counters

code: virtual void UpdateStatsForForeground ( [FPersistentStatsBase](API\Runtime\InstallBundleManager\FPersistentStatsBase) & StatToUpdate )


code: FPersistentStatContainerBase()


code: virtual ~FPersistentStatContainerBase()


className: FPersistentStatContainerBase

description: Helper class to handle holding a collection of Bundle and Session stats.

code: class FPersistentStatContainerBase

bShouldAutoHandleFGBGStats

description: Determines if we should automatically Start,Stop,and Update the _FG and _BG versions of our timer stats.

bShouldAutoUpdateTimersInTick

description: These settings determine if we auto-update our Timer stats on a tick.

bShouldSaveDirtyStatsOnTick

description: These settings determine how we handle saving our stats to disk.

type: FDelegateHandle

PerBundlePersistentStatMap

type: TMap<FName,FB...

SessionPersistentStatMap

type: TMap<FString, ...

TimerAutoUpdateTimeRemaining

description: Internal counter used to track when we need to run our timer update during tick.

TimerDirtyStatUpdateTimeRemaining

description: Internal counter used to track when we need to update all of our dirty stats.


description: Helper function that generates a basic ExpectedAnalyticsID from device and UE information

code: static const [FString](API\Runtime\Core\Containers\FString) GetBaseExpectedAnalyticsID()


code: const int * GetCountStatData ( [ECountStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-_1) StatToGet ) const


description: Returns Full Path to look for our persistent stat cache

code: const [FString](API\Runtime\Core\Containers\FString) GetFullPathForStatFile() const


code: const [FPersistentTimerData](API\Runtime\InstallBundleManager\FPersistentTimerData) * GetTimingStatData ( [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) StatToGet ) const


description: Helper to try and reconcile offline and active timers after we load data from disk.

code: void HandleTimerStatsAfterDataLoad()


code: bool HasCountStat ( [ECountStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-_1) StatToCheck ) const


code: bool HasTimingStat ( [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) StatToCheck ) const


code: bool IsActive() const


code: void IncrementCountStat ( [PersistentStats::ECountStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-_1) StatToUpdate )


code: bool IsDirty() const


code: bool IsTimingStatStarted ( [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) StatToUpdate ) const


code: void ResetStats ( const [FString](API\Runtime\Core\Containers\FString) & NewAnalyticsSessionID )


description: Called after we load data but before we process any of it. Useful for fixing up the data loaded from disk before it changes or is acted upon by anything else NOTE: A call to LoadStatsFromDisk will not necessarily call this! It will only be called when data is actually pulled from the disk, and its possible to skip pulling data from the disk!

code: void OnLoadingDataFromDisk()


description: Function that allows you to load stats from disk. Returns true if stats were either loaded from disk now, or previously were loaded from disk. NOTE: This does not begin stat collection, so you should still call StatsBegin on this before handling any stats!

code: bool LoadStatsFromDisk()


description: We should not ever really be serializing this base class. Kept it here for reference.

code: virtual void Serialize ( [FJsonSerializerBase](API\Runtime\Json\Serialization\FJsonSerializerBase) & Serializer, bool bFlatObject )


description: Saves the persistent stat data to disk in the location returned byGetFullPathForStatFile()Returns True if that save succeeds and false otherwise.

code: bool SaveStatsToDisk()


code: void StartTimingStat ( [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) StatToUpdate )


description: Tries to load persistent stats from disk and determine if we need to resume our previous persistent session or start a new one.

code: void StatsBegin ( const [FString](API\Runtime\Core\Containers\FString) & ExpectedAnalyticsID, bool bForceResetData )


description: Tries to set this stat pool as "inactive".Bydefault also stop all active timers. NOTE: If you don't stop all active timers future calls to UpdateTimingStat will still increment this value and save it off!

code: void StatsEnd ( bool bStopAllActiveTimers )


code: void StopAllActiveTimers()


code: void StopTimingStat ( [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) StatToUpdate, bool UpdateTimerOnStop )


code: void UpdateAllActiveTimers()


description: Protected so we can only construct the derived versions of this Base class.

code: FPersistentStatsBase()


code: void UpdateTimingStat ( [ETimingStatNames](API\Runtime\InstallBundleManager\InstallBundleUti-) StatToUpdate )


code: virtual ~FPersistentStatsBase()


className: FPersistentStatsBase

description: Both ContentRequests and Individual Bundles use this to track data respective to themselves. Keeps us from having to write serialization / loading data for both cases that would be the same

code: class FPersistentStatsBase : public [FJsonSerializable](API\Runtime\Json\Serialization\FJsonSerializable)

bIsActive

description: We don't serialize these as they are tracking behavior and not stats.

TimingStatsMap

description: Serialized Stat Data.


description: Abstract method that needs to be supplied using the macros


code: FPersistentTimerData()


className: FPersistentTimerData

code: class FPersistentTimerData : public [FJsonSerializable](API\Runtime\Json\Serialization\FJsonSerializable)

CurrentValue

type: double


code: void AddRequiredBundles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & RequiredBundlesToAdd )


code: void AddRequiredBundles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & RequiredBundlesToAdd )


description: Implementation for FInstallBundleStatsContainerBase.

code: virtual const [FString](API\Runtime\Core\Containers\FString) GetFullPathForStatFile() const


description: Populates the passed inTArraywith all the required bundles' names.

code: void GetRequiredBundles ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutRequiredBundles ) const


description: Removes all Required Bundle Names except the ones in the NewRequiredBundlesList. If no NewRequiredBundlesList is supplied, just erases all RequiredBundles. This includes ones loaded from the persistent cache from previous runs. This re-saves the persistent cache file so they will be removed completely.

code: void ResetRequiredBundles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & NewRequiredBundles )


code: virtual void Serialize ( [FJsonSerializerBase](API\Runtime\Json\Serialization\FJsonSerializerBase) & Serializer, bool bFlatObject )


description: Remove default constructor as we require a ContentRequestName in the constructor.


code: FSessionPersistentStats ( const [FString](API\Runtime\Core\Containers\FString) & ContentRequestNameIn )


className: FSessionPersistentStats

description: Tracks a set of bundles and stats for a named session. This way you can have stats across multiple bundle installs grouped by some naming convention.

code: class FSessionPersistentStats : public [InstallBundleUtil::PersistentStats::FPersistentStatsBase](API\Runtime\InstallBundleManager\FPersistentStatsBase)


code: virtual void AddEnvironmentWantsPatchCheckBackCompatDelegate ( [FName](API\Runtime\Core\UObject\FName) Tag, FInstallBundleManagerEnvironmentWantsPatchCheck Delegate )


code: void CancelAllGetInstallStateRequestsForTag ( [FName](API\Runtime\Core\UObject\FName) RequestTag )


code: void CancelAllGetContentStateRequestsForTag ( [FName](API\Runtime\Core\UObject\FName) RequestTag )


code: void CancelAllGetContentStateRequests ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


code: virtual ~FSessionPersistentStats()


code: void CancelAllGetInstallStateRequests ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


code: void CancelRequestRemoveContentOnNextInit ( [FName](API\Runtime\Core\UObject\FName) BundleName )


code: void CancelRequestRemoveContentOnNextInit ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames )


code: void CancelUpdateContent ( [FName](API\Runtime\Core\UObject\FName) BundleName )


code: void CancelUpdateContent ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames )


code: EInstallBundleResult FlushCache ( FInstallBundleManagerFlushCacheCompleteDelegate Callback, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) LogVerbosityOverride )


code: EInstallBundleResult FlushCache ( FInstallBundleSourceOrCache SourceOrCache, FInstallBundleManagerFlushCacheCompleteDelegate Callback, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) LogVerbosityOverride )


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProviderET](API\Runtime\AnalyticsET\IAnalyticsProviderET) > GetAnalyticsProvider() const


code: [TOptional](API\Runtime\Core\IO\TOptional)< [FInstallBundleProgress](API\Runtime\InstallBundleManager\FInstallBundleProgress) > GetBundleProgress ( [FName](API\Runtime\Core\UObject\FName) BundleName ) const


code: virtual const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IInstallBundleSource](API\Runtime\InstallBundleManager\IInstallBundleSource) > GetBundleSource ( EInstallBundleSourceType SourceType ) const


code: [TOptional](API\Runtime\Core\IO\TOptional)< [FInstallBundleCacheStats](API\Runtime\InstallBundleManager\FInstallBundleCacheStats) > GetCacheStats ( FInstallBundleSourceOrCache SourceOrCache, EInstallBundleCacheDumpToLog DumpToLog, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) LogVerbosityOverride )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) GetContentState ( [FName](API\Runtime\Core\UObject\FName) BundleName, EInstallBundleGetContentStateFlags Flags, bool bAddDependencies, FInstallBundleGetContentStateDelegate Callback, [FName](API\Runtime\Core\UObject\FName) RequestTag )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) GetContentState ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames, EInstallBundleGetContentStateFlags Flags, bool bAddDependencies, FInstallBundleGetContentStateDelegate Callback, [FName](API\Runtime\Core\UObject\FName) RequestTag )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FInstallBundleCacheStats](API\Runtime\InstallBundleManager\FInstallBundleCacheStats) > GetCacheStats ( EInstallBundleCacheDumpToLog DumpToLog, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) LogVerbosityOverride )


description: Less expensive version ofGetContentState()that only returns install state Synchronous versions return null if bundle manager is not yet initialized

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) GetInstallState ( [FName](API\Runtime\Core\UObject\FName) BundleName, bool bAddDependencies, FInstallBundleGetInstallStateDelegate Callback, [FName](API\Runtime\Core\UObject\FName) RequestTag )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) GetInstallState ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames, bool bAddDependencies, FInstallBundleGetInstallStateDelegate Callback, [FName](API\Runtime\Core\UObject\FName) RequestTag )


code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FInstallBundleCombinedInstallState](API\Runtime\InstallBundleManager\FInstallBundleCombinedInstallSta-), EInstallBundleResult > GetInstallStateSynchronous ( [FName](API\Runtime\Core\UObject\FName) BundleName, bool bAddDependencies ) const


code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FInstallBundleCombinedInstallState](API\Runtime\InstallBundleManager\FInstallBundleCombinedInstallSta-), EInstallBundleResult > GetInstallStateSynchronous ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames, bool bAddDependencies ) const


code: bool HasBundleSource ( EInstallBundleSourceType SourceType ) const


className: InitCompleteDelegate


code: virtual void Initialize()


className: InstallBundleCompleteDelegate


code: bool IsNullInterface() const


className: PausedBundleDelegate


code: void PauseUpdateContent ( [FName](API\Runtime\Core\UObject\FName) BundleName )


className: PatchCheckCompleteDelegate


code: void PauseUpdateContent ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames )


code: void PopInitErrorCallback()


code: void PopInitErrorCallback ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


code: void PopInitErrorCallback ( const void * InUserObject )


code: void RequestPausedBundleCallback()


code: virtual void RemoveEnvironmentWantsPatchCheckBackCompatDelegate ( [FName](API\Runtime\Core\UObject\FName) Tag )


code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FInstallBundleRequestInfo](API\Runtime\InstallBundleManager\FInstallBundleRequestInfo), EInstallBundleResult > RequestReleaseContent ( [FName](API\Runtime\Core\UObject\FName) ReleaseName, EInstallBundleReleaseRequestFlags Flags, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > KeepNames, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) LogVerbosityOverride )


code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FInstallBundleRequestInfo](API\Runtime\InstallBundleManager\FInstallBundleRequestInfo), EInstallBundleResult > RequestReleaseContent ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > ReleaseNames, EInstallBundleReleaseRequestFlags Flags, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > KeepNames, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) LogVerbosityOverride )


code: void RequestRemoveContentOnNextInit ( [FName](API\Runtime\Core\UObject\FName) RemoveName, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > KeepNames )


code: void RequestRemoveContentOnNextInit ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > RemoveNames, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > KeepNames )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) PushInitErrorCallback ( FInstallBundleManagerInitErrorHandler Callback )


code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FInstallBundleRequestInfo](API\Runtime\InstallBundleManager\FInstallBundleRequestInfo), EInstallBundleResult > RequestUpdateContent ( [FName](API\Runtime\Core\UObject\FName) BundleName, EInstallBundleRequestFlags Flags, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) LogVerbosityOverride, [InstallBundleUtil::FContentRequestSharedContextPtr](API\Runtime\InstallBundleManager\FContentRequestSharedContextPtr) RequestSharedContext )


code: void ResumeUpdateContent ( [FName](API\Runtime\Core\UObject\FName) BundleName )


code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FInstallBundleRequestInfo](API\Runtime\InstallBundleManager\FInstallBundleRequestInfo), EInstallBundleResult > RequestUpdateContent ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames, EInstallBundleRequestFlags Flags, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) LogVerbosityOverride, [InstallBundleUtil::FContentRequestSharedContextPtr](API\Runtime\InstallBundleManager\FContentRequestSharedContextPtr) RequestSharedContext )


code: void ResumeUpdateContent ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames )


code: virtual void SetErrorSimulationCommands ( const [FString](API\Runtime\Core\Containers\FString) & CommandLine )


code: virtual void StartPatchCheck()


code: virtual void StopSessionPersistentStatTracking ( const [FString](API\Runtime\Core\Containers\FString) & SessionName )


code: virtual void StartSessionPersistentStatTracking ( const [FString](API\Runtime\Core\Containers\FString) & SessionName, const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & RequiredBundles, const [FString](API\Runtime\Core\Containers\FString) & ExpectedAnalyticsID, bool bForceResetStatData, const [FInstallBundleCombinedContentState](API\Runtime\InstallBundleManager\FInstallBundleCombinedContentSta-) * State )


code: void UpdateContentRequestFlags ( [FName](API\Runtime\Core\UObject\FName) BundleName, EInstallBundleRequestFlags AddFlags, EInstallBundleRequestFlags RemoveFlags )


code: virtual ~IInstallBundleManager()


code: void UpdateContentRequestFlags ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames, EInstallBundleRequestFlags AddFlags, EInstallBundleRequestFlags RemoveFlags )


className: IInstallBundleManager

code: class IInstallBundleManager : public [TSharedFromThis< IInstallBundleManager >](API\Runtime\Core\Templates\TSharedFromThis)


description: Called before the module has been unloaded

code: virtual void PreUnloadCallback()


className: IInstallBundleManagerModule

description: Base Module Interface for InstallBundleManager implementation modules

code: class IInstallBundleManagerModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)

InstallBundleManager

type: TSharedPtr<IIn...

LastInstallBundleManager

type: TWeakPtr<IInst...


description: Bundle manager will not call AsyncInit again until the bundle source calls back that it is complete It will be retried indefinitely until init is successful.

code: void AsyncInit ( FInstallBundleSourceInitDelegate Callback )


description: Call to cancel the removal of any content scheduled for removal the next time the source is initialized Returns true if all bundles were canceled

code: virtual bool CancelRequestRemoveContentOnNextInit ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames )


description: Sets callbacks to Install Bundle Manager for dynamically discovered bundles UpdateCallback - Call to add or update bundle info from this source. Must be called when there are no requests for the bundle. LostRelevanceCallback - Allows bundle manager to clean up bundles if they are no longer relevant to any source

code: virtual void AsyncInit_SetUpdateBundleInfoCallback ( FInstallBundleSourceUpdateBundleInfoDelegate UpdateCallback, FInstallBundleLostRelevanceForSourceDelegate LostRelevanceCallback )


description: Cancel the install for the specified bundles.

code: virtual void CancelBundles ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames )


description: Currently only called after AsyncInit initialization. Provides information about bundles this source knows about back to bundle manager.

code: void AsyncInit_QueryBundleInfo ( FInstallBundleSourceQueryBundleInfoDelegate OnCompleteCallback )


code: virtual void CheckForContentPatch ( FInstallBundleSourceContentPatchResultDelegate Callback )


description: Finds all dependencies for InBundleName, including InBundleName SkippedUnknownBundles contains any unknown bundles that may have been found

code: [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetBundleDependencies ( [FName](API\Runtime\Core\UObject\FName) InBundleName, [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > * SkippedUnknownBundles ) const


className: FRequestUpdateContentBundleContext

BundleName

type: FName

CompleteCallback

type: FInstallBundleC...

PausedCallback

type: FInstallBundleP...

RequestSharedContext

type: TSharedPtr<Ins...


className: FRequestReleaseContentBundleContext

CompleteCallback

type: FInstallBundleR...

Flags

type: EInstallBundleR...


description: Derived classes should implement this if their content install will take a significant amount of time.

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FInstallBundleSourceProgress](API\Runtime\InstallBundleManager\FInstallBundleSourceProgress) > GetBundleProgress ( [FName](API\Runtime\Core\UObject\FName) BundleName ) const


description: Gets the state of content on disk BundleNames contains all dependencies and has been deduped

code: void GetContentState ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames, EInstallBundleGetContentStateFlags Flags, FInstallBundleGetContentStateDelegate Callback )


description: Returns content version in a "-" format.


description: Whether this source has been initialized or not.


description: UpdateContentRequestFlags - Allow some flags to be updated for in flight requests Currently only CheckForCellularDataUsage is supported

code: virtual EInstallBundleRequestFlags GetModifyableContentRequestFlags() const


description: Allows this bundle source to reject bundle requests early, rather than failing them. This means that client code does not have to wait on these bundles. This may be called anytime after Init, even during AsyncInit

code: virtual EInstallBundleSourceBundleSkipReason GetBundleSkipReason ( [FName](API\Runtime\Core\UObject\FName) BundleName ) const


description: Returns a value in the [0.1, 1.0] range that allows bundles using this source to age out of the LRU cache more slowly.

code: virtual double GetSourceCacheAgeScalar() const


description: Returns a unique id for this source.


description: Returns the how this source should be weighted when combined with other sources.

code: virtual float GetSourceWeight() const


description: Called once by bundle manager after constructing the bundle source Any non-fallback errors returned will cause bundle manager to fail to initialize


code: virtual void OnBundleInfoPruned ( [FName](API\Runtime\Core\UObject\FName) InBundleName )


description: Notify bundle source that a bundle has been released If EInstallBundleReleaseRequestFlags::RemoveFilesIfPossible is set, the source should remove content from disk if present The source should set bContentWasRemoved to indicate to bundle manager that the bundle content was uninstalled BundleContexts contains all dependencies and has been deduped Bundle manager will not schedule removes at the same time as updates for the same bundle

code: virtual void RequestReleaseContent ( [FRequestReleaseContentBundleContext](API\Runtime\InstallBundleManager\IInstallBundleSource\FRequestReleaseC-) BundleContext )


description: Updates content on disk if necessary BundleContexts contains all dependencies and has been deduped

code: void RequestUpdateContent ( [FRequestUpdateContentBundleContext](API\Runtime\InstallBundleManager\IInstallBundleSource\FRequestUpdateCo-) BundleContext )


description: Returns true if content is scheduled to be removed the next time the source is initialized BundleNames contains all dependencies and has been deduped

code: virtual bool RequestRemoveContentOnNextInit ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > RemoveNames )


description: Called by bundle manager to pass through command line options to simulate errors.

code: virtual void SetErrorSimulationCommands ( const [FString](API\Runtime\Core\Containers\FString) & CommandLine )


code: virtual void UserResumeBundles ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames )


description: User Pause/Resume bundles.

code: virtual void UserPauseBundles ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames )


code: virtual void UpdateContentRequestFlags ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > BundleNames, EInstallBundleRequestFlags AddFlags, EInstallBundleRequestFlags RemoveFlags )


code: virtual ~IInstallBundleSource()


className: IInstallBundleSource

code: class IInstallBundleSource : public [TSharedFromThis< IInstallBundleSource >](API\Runtime\Core\Templates\TSharedFromThis)


description: *_BG stats are an estimate as we can not account for unexpected crashes, etc.

code: namespace InstallBundleUtil { namespace PersistentStats { enum ETimingStatNames { TotalTime_Real, TotalTime_FG, TotalTime_BG, ChunkDBDownloadTime_Real, ChunkDBDownloadTime_FG, ChunkDBDownloadTime_BG, InstallTime_Real, InstallTime_FG, InstallTime_BG, PSOTime_Real, PSOTime_FG, PSOTime_BG, NumStatNames, } } }


description: Stats used to store count information in an int format.

code: namespace InstallBundleUtil { namespace PersistentStats { enum ECountStatNames { NumResumedFromBackground, NumResumedFromLaunch, NumBackgrounded, NumStatNames, } } }


description: It would really be nice to have these in core.

code: namespace InstallBundleUtil { template<class EnumType> constexpr auto & InstallBundleUtil::CastAsUnderlying ( EnumType & Type ) }


code: namespace InstallBundleUtil { template<class EnumType> constexpr const auto & InstallBundleUtil::CastAsUnderlying ( const EnumType & Type ) }


code: namespace InstallBundleUtil { template<typename EnumType, typename StringArrType> const TCHAR * InstallBundleUtil::TLexToString ( EnumType E, const StringArrType & Strings ) }


code: namespace InstallBundleUtil { template<class EnumType> constexpr auto InstallBundleUtil::CastToUnderlying ( EnumType Type ) }


className: RangeType

code: enum &123; RangeType = 0 &125;


code: static constexpr underlying_type &40; EInstallBundleSourceType &41;


code: template<> struct TEnumRangeTraits< EInstallBundleSourceType >


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: TInstallBundleManagerModule

description: Module Interface for InstallBundleManager implementation modules

code: template<class InstallBundleManagerModuleImpl> class TInstallBundleManagerModule : public [IInstallBundleManagerModule](API\Runtime\InstallBundleManager\IInstallBundleManagerModule)


className: AInternalToolFrameworkActor

description: AInternalToolFrameworkActoris a base class for internal Actors that the ToolsFramework may spawn (for gizmos, mesh previews, etc). These Actors may need special-case handling, for example to prevent the user from selecting and deleting them.

module: InteractiveToolsFramework

code: class AInternalToolFrameworkActor : public [AActor](API\Runtime\Engine\GameFramework\AActor)

bIsSelectableInEditor

type: bool

description: Controls whether this InternalToolFrameworkActor can be selected in the Editor.


description: Returns true if this actor can EVER be selected in a level in the editor. Can be overridden by specific actors to make them unselectable.

code: virtual bool IsSelectable() const


className: FModifierTestFunction

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) &)> FModifierTestFunction


description: Register a modifier ID and an associated test function

code: void RegisterModifier ( int ModifierID, const [FModifierTestFunction](API\Runtime\InteractiveToolsFramework\BaseBehaviors\FInputBehaviorModifierStates\FModifierTestFun-) & ModifierTest )


description: true if any modifiers have been registered

code: bool HasModifiers() const


className: FInputBehaviorModifierStates

description: We don't know ahead of time what might be used to determine modifier state, which input devices might be used, etc. So the user has to register (ModifierID,ModifierTestFunction) pairs. The behavior then callsUpdateModifiers()which will query each of the test functions and notify the target object about the state of the modifier.

code: class FInputBehaviorModifierStates

ModifierIDs

type: TArray< int >

description: List of modifier IDs that have been registered

ModifierTests

type: TMap< int,FMod...

description: The modifier test function for each ID


description:
Test if target is hit by a click
hit information at this point

code: [FInputRayHit](API\Runtime\InteractiveToolsFramework\FInputRayHit) IsHitByClick ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


description: Look up the current state of each registered modifier and pass to the target

code: void UpdateModifiers ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input, [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget) * ModifiersTarget ) const


description: Notify Target that click ocurred

code: void OnClicked ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


code: virtual ~IClickBehaviorTarget()


className: IClickBehaviorTarget

description: Functions required to apply standard "Click" state machines to a target object. See USingleClickBehavior for an example of this kind of state machine.

code: class IClickBehaviorTarget : public [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget)


description: Notify Target that input position has changed

code: void OnClickDrag ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & DragPos )


description:
Test if target can begin click-drag interaction at this point
hit information at this point

code: [FInputRayHit](API\Runtime\InteractiveToolsFramework\FInputRayHit) CanBeginClickDragSequence ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & PressPos )


description: Notify Target that click release occurred

code: void OnClickRelease ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ReleasePos )


description: Notify Target that click press ocurred

code: void OnClickPress ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & PressPos )


description: Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

code: void OnTerminateDragSequence()


code: virtual ~IClickDragBehaviorTarget()


className: IClickDragBehaviorTarget

description: Functions required to apply standard "Click-Drag" state machines to a target object. See UClickDragBehavior for an example of this kind of state machine.

code: class IClickDragBehaviorTarget : public [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget)


description: Notify Target about the first click in the sequence.

code: void OnBeginClickSequence ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


description:
Test if target would like to begin sequence based on this click. Gets checked both on mouse down and mouse up.
true if target wants to begin sequence

code: bool CanBeginClickSequence ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


description: Notify Target device position has changed but a click sequence hasn't begun yet (eg for interactive previews)

code: virtual void OnBeginSequencePreview ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


description:
Notify Target about next click in sqeuence
false if Target wants to terminate sequence

code: bool OnNextSequenceClick ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


description: Notify Target device position has changed but a click hasn't ocurred yet (eg for interactive previews)

code: virtual void OnNextSequencePreview ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


description: Notify Target that click sequence has been explicitly terminated (eg by escape key, cancel tool, etc). Also called if sequence is terminated from querying target withRequestAbortClickSequence().

code: void OnTerminateClickSequence()


description: Target overrides this and returns true if it wants to abort click sequence. Behavior checks every update and if this ever returns true, terminates sequence


className: IClickSequenceBehaviorTarget

description: Target interface used by InputBehaviors that want to implement a multi-click sequence (eg such as drawing a polygon with multiple clicks)

code: class IClickSequenceBehaviorTarget : public [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget)


code: virtual ~IClickSequenceBehaviorTarget()


description: Do hover hit-test

code: [FInputRayHit](API\Runtime\InteractiveToolsFramework\FInputRayHit) BeginHoverSequenceHitTest ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & PressPos )


description: Initialize hover sequence at given position

code: void OnBeginHover ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & DevicePos )


description: Terminate active hover sequence

code: void OnEndHover()


description: Update active hover sequence with new input position

code: bool OnUpdateHover ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & DevicePos )


code: virtual ~IHoverBehaviorTarget()


className: IHoverBehaviorTarget

description: IHoverBehaviorTargetallows Behaviors to notify Tools/etc about device event data in a generic way, without requiring that all Tools know about the concept of Hovering.

code: class IHoverBehaviorTarget : public [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget)


description: Notify target of current modifier state

code: virtual void OnUpdateModifierState ( int ModifierID, bool bIsOn )


className: IModifierToggleBehaviorTarget

description: IModifierToggleBehaviorTargetis an interface that InputBehaviors can use to notify a target about modifier toggle states (like shift key being down, etc). The meaning of the modifier ID is client-defined (generally provided to the InputBehavior in a registration step)

code: class IModifierToggleBehaviorTarget


code: void OnMouseWheelScrollUp ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & CurrentPos )


code: void OnMouseWheelScrollDown ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & CurrentPos )


description:
The result's bHit property determines whether the mouse wheel action will be captured. (Perhaps the mouse wheel only does something when mousing over some part of a mesh)
hit information at this point

code: [FInputRayHit](API\Runtime\InteractiveToolsFramework\FInputRayHit) ShouldRespondToMouseWheel ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & CurrentPos )


code: virtual ~IMouseWheelBehaviorTarget()


className: IMouseWheelBehaviorTarget

description: Functions required to apply mouse wheel behavior

code: class IMouseWheelBehaviorTarget : public [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget)


description: current 2D position of Target Device, or zero if device does not have 2D position

code: virtual FVector2D GetClickPoint ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & input )


description: last-active supported Device

code: EInputDevices GetActiveDevice() const


description: ReturnsFDeviceButtonStatefor target active device button

code: [FDeviceButtonState](API\Runtime\InteractiveToolsFramework\FDeviceButtonState) GetButtonStateFunc ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input )


description: current 3D world ray and optional 2D position for Target Device

code: virtual [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) GetDeviceRay ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & input )


description: Return set of devices supported by this behavior


description: true if Target Button is currently held down

code: virtual bool IsDown ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & input )


description: current 3D world ray for Target Device position

code: virtual FRay GetWorldRay ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & input )


description: true if Target Button has been pressed this frame

code: virtual bool IsPressed ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & input )


description: true if Target Button was released this frame

code: virtual bool IsReleased ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & input )


description: Configure the target Mouse button to be the left button

code: virtual void SetUseLeftMouseButton()


description: Configure a custom target mouse button

code: virtual void SetUseCustomMouseButton ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< [FDeviceButtonState](API\Runtime\InteractiveToolsFramework\FDeviceButtonState)(const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) &Input)> )


description: Configure the target Mouse button to be the middle button

code: virtual void SetUseMiddleMouseButton()


description: Configure the target Mouse button to be the right button

code: virtual void SetUseRightMouseButton()


code: UAnyButtonInputBehavior()


className: UAnyButtonInputBehavior

description: The target device button is selected using the .ButtonNumber property, or you can override the relevant GetXButtonState() function if you need more control.

code: class UAnyButtonInputBehavior : public [UInputBehavior](API\Runtime\InteractiveToolsFramework\UInputBehavior)

ActiveDevice

type: EInputDevices

description: Which device is currently active

GetMouseButtonStateFunc

type: TUniqueFunction...

description: ReturnsFDeviceButtonStatefor target mouse button


description: If this is called, the Behavior has forcibly lost capture (eg due to app losing focus for example) and needs to clean up accordingly

code: virtual void ForceEndCapture ( const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & CaptureData )


description: Called afterWantsCapture()returns a capture request that was accepted

code: virtual [FInputCaptureUpdate](API\Runtime\InteractiveToolsFramework\FInputCaptureUpdate) BeginCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState, EInputCaptureSide eSide )


description: Initialize this behavior with the given Target

code: virtual void Initialize ( [IClickDragBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IClickDragBehaviorTarget) * Target )


description: Internal function that forwards click evens to Target::OnClickPress, you can customize behavior here

code: virtual void OnClickPressInternal ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input, EInputCaptureSide Side )


description: Internal function that forwards click evens to Target::OnClickDrag, you can customize behavior here

code: virtual void OnClickDragInternal ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input, const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & Data )


description: Internal function that forwards click evens to Target::OnClickRelease, you can customize behavior here

code: virtual void OnClickReleaseInternal ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input, const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & Data )


description: Called for each new input event during a capture sequence. Return Continue to keep capturing, or End to finish capturing.

code: virtual [FInputCaptureUpdate](API\Runtime\InteractiveToolsFramework\FInputCaptureUpdate) UpdateCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState, const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & CaptureData )


code: UClickDragInputBehavior()


description: Given the input state, does this Behavior want to begin capturing some input devices?

code: virtual [FInputCaptureRequest](API\Runtime\InteractiveToolsFramework\FInputCaptureRequest) WantsCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState )


className: UClickDragInputBehavior

description: If a ForceEndCapture occurs we call Target::OnTerminateDragSequence

code: class UClickDragInputBehavior : public [UAnyButtonInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UAnyButtonInputBehavior)

bInClickDrag

description: Set to true if we are in a capture

bUpdateModifiersDuringDrag

description: If true, then we will update Modifier states inUpdateCapture().

ModifierCheckFunc

type: TFunction< bool...

description: WantsCapture()will only return capture request if this function returns true (or is null)

Modifiers

type: FInputBehaviorM...

description: The modifier set for this behavior

Target

type: IClickDragBehav...

description: Click Target object


description: Which device types does this Behavior support


code: virtual void Initialize ( [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget) * Target, int ModifierID, const [FKey](API\Runtime\InputCore\FKey) & ModifierKey )


code: void Initialize ( [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget) * TargetIn, int ModifierID, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) &)> ModifierCheckFunc )


description: UInputBehaviorimplementation.

code: virtual [FInputCaptureRequest](API\Runtime\InteractiveToolsFramework\FInputCaptureRequest) WantsCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input )


code: UKeyAsModifierInputBehavior()


className: UKeyAsModifierInputBehavior

description: UKeyAsModifierInputBehaviorconverts a specific key press/release into a "Modifier" toggle via theIModifierToggleBehaviorTargetinterface. It does not capture the key press; rather, it updates the modifier its WantsCapture call. This means that the modifier won't be updated if another behavior captures the keyboard.

code: class UKeyAsModifierInputBehavior : public [UInputBehavior](API\Runtime\InteractiveToolsFramework\UInputBehavior)

Modifiers

description: Modifier set for this behavior, internally initialized with check on ModifierKey

type: IModifierToggle...

description: Modifier Target object


description: IClickDragBehaviorTargetimplementation

code: virtual [FInputRayHit](API\Runtime\InteractiveToolsFramework\FInputRayHit) CanBeginClickDragSequence ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & PressPos )


description: Call this to initialize the class

code: virtual void Initialize()


description: Notify Target that input position has changed

code: virtual void OnClickDrag ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & DragPos )


description: Notify Target that click release occurred

code: virtual void OnClickRelease ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ReleasePos )


description: Notify Target that click press ocurred

code: virtual void OnClickPress ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & PressPos )


description: Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

code: virtual void OnTerminateDragSequence()


className: ULocalClickDragInputBehavior

description: ULocalClickDragInputBehavioris an implementation ofUClickDragInputBehaviorthat also implementsIClickDragBehaviorTargetdirectly, via a set of local lambda functions. To use/customize this class the client replaces the lambda functions with their own. This avoids having to create a secondIClickDragBehaviorTargetimplementation for trivial use-cases.

CanBeginClickDragFunc

description: Lambda implementation of CanBeginClickDragSequence

OnClickDragFunc

description: Lambda implementation of OnClickDrag

OnClickPressFunc

description: Lambda implementation of OnClickPress

OnClickReleaseFunc

description: Lambda implementation of OnClickRelease

OnTerminateFunc

description: Lambda implementation of OnTerminateDragSequence


description: IHoverBehaviorTargetimplementation.

code: virtual [FInputRayHit](API\Runtime\InteractiveToolsFramework\FInputRayHit) BeginHoverSequenceHitTest ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & PressPos )


description: Initialize hover sequence at given position

code: virtual void OnBeginHover ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & DevicePos )


description: Terminate active hover sequence

code: virtual void OnEndHover()


description: Update active hover sequence with new input position

code: virtual bool OnUpdateHover ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & DevicePos )


description: IModifierToggleBehaviorTargetimplementation.

code: virtual void OnUpdateModifierState ( int ModifierID, bool bIsOn )


className: ULocalMouseHoverBehavior

description: An implementation ofUMouseHoverBehaviorthat also implementsIHoverBehaviorTargetdirectly, via a set of local lambda functions. To use/customize this class, the client replaces the lambda functions with their own. This avoids having to create a separateIHoverBehaviorTargetimplementation for trivial use-cases.

code: class ULocalMouseHoverBehavior : public [UMouseHoverBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UMouseHoverBehavior), public [IHoverBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IHoverBehaviorTarget)

BeginHitTestFunc

description: Lambda implementation of BeginHoverSequenceHitTest

OnBeginHoverFunc

description: Lambda implementation of OnBeginHover

OnEndHoverFunc

description: Lambda implementation of OnEndHover

OnUpdateHoverFunc

description: Lambda implementation of OnUpdateHover

OnUpdateModifierStateFunc

description: Lambda implementation of OnUpdateModifierState


description:
Test if target is hit by a click
hit information at this point

code: virtual [FInputRayHit](API\Runtime\InteractiveToolsFramework\FInputRayHit) IsHitByClick ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


description: Notify Target that click ocurred

code: virtual void OnClicked ( const [FInputDeviceRay](API\Runtime\InteractiveToolsFramework\FInputDeviceRay) & ClickPos )


className: ULocalSingleClickInputBehavior

description: An implementation ofUSingleClickInputBehaviorthat also implementsIClickBehaviorTargetdirectly, via a set of local lambda functions. To use/customize this class, the client replaces the lambda functions with their own. This avoids having to create a separateIClickBehaviorTargetimplementation for trivial use-cases.

IsHitByClickFunc

description: Lambda implementation of IsHitByClick

OnClickedFunc

description: Lambda implementation of OnClicked


description: If a different hover capture begins, focus is lost, a tool starts, etc, any active hover visualization needs to terminate

code: virtual void EndHoverCapture()


description: Called afterWantsHoverCapture()returns a capture request that was accepted

code: virtual [FInputCaptureUpdate](API\Runtime\InteractiveToolsFramework\FInputCaptureUpdate) BeginHoverCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState, EInputCaptureSide eSide )


description: Which device types does this Behavior support


code: virtual void Initialize ( [IHoverBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IHoverBehaviorTarget) * Target )


description: Called on each new hover input event, ie if no other behavior is actively capturing input

code: virtual [FInputCaptureUpdate](API\Runtime\InteractiveToolsFramework\FInputCaptureUpdate) UpdateHoverCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState )


description: Given the input state, does this Behavior want to begin capturing some input devices for hover

code: virtual [FInputCaptureRequest](API\Runtime\InteractiveToolsFramework\FInputCaptureRequest) WantsHoverCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState )


code: UMouseHoverBehavior()


description: Hover support (optional)return true if this Behavior supports hover (ie passive input events)

code: virtual bool WantsHoverEvents()


className: UMouseHoverBehavior

description: Trivial InputBehavior that forwards InputBehavior hover events to a Target object via theIHoverBehaviorTargetinterface.

code: class UMouseHoverBehavior : public [UInputBehavior](API\Runtime\InteractiveToolsFramework\UInputBehavior)

Modifiers

description: The modifier set for this behavior

Target

type: IHoverBehaviorT...


description: Called afterWantsCapture()returns a capture request that was accepted

code: virtual [FInputCaptureUpdate](API\Runtime\InteractiveToolsFramework\FInputCaptureUpdate) BeginCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState, EInputCaptureSide eSide )


description: Called for each new input event during a capture sequence. Return Continue to keep capturing, or End to finish capturing.

code: virtual [FInputCaptureUpdate](API\Runtime\InteractiveToolsFramework\FInputCaptureUpdate) UpdateCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState, const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & CaptureData )


description: If this is called, the Behavior has forcibly lost capture (eg due to app losing focus for example) and needs to clean up accordingly

code: virtual void ForceEndCapture ( const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & CaptureData )


description: Initialize this behavior with the given Target

code: virtual void Initialize ( [IMouseWheelBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IMouseWheelBehaviorTarget) * Target )


description: UInputBehaviorimplementation.

code: virtual [FInputCaptureRequest](API\Runtime\InteractiveToolsFramework\FInputCaptureRequest) WantsCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input )


code: UMouseWheelInputBehavior()


className: UMouseWheelInputBehavior

code: class UMouseWheelInputBehavior : public [UAnyButtonInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UAnyButtonInputBehavior)

ModifierCheckFunc

description: WantsCapture()will only return capture request if this function returns true (or is null)

Modifiers

description: The modifier set for this behavior

type: IMouseWheelBeha...


className: ESequenceState

code: enum ESequenceState { NotStarted, WaitingForNextClick, }


code: virtual void Initialize ( [IClickSequenceBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IClickSequenceBehaviorTarget) * Target )


description: Given the input state, does this Behavior want to begin capturing some input devices?

code: virtual [FInputCaptureRequest](API\Runtime\InteractiveToolsFramework\FInputCaptureRequest) WantsCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState )


code: UMultiClickSequenceInputBehavior()


className: UMultiClickSequenceInputBehavior

description: The target will receive "preview" notifications (basically hover) during updates where there is not a release. This can be used to (eg) update a rubber-band selection end point

code: class UMultiClickSequenceInputBehavior : public [UAnyButtonInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UAnyButtonInputBehavior)

ModifierCheckFunc

description: The first click will only be accepted if this function returns true (or is null)

description: The modifier set for this behavior

State

type: ESequenceState

Target

type: IClickSequenceB...

description: Click Target object


code: virtual void Initialize ( [IClickBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IClickBehaviorTarget) * Target )


code: USingleClickInputBehavior()


className: USingleClickInputBehavior

description: The hit-test and on-clicked functions are provided by aIClickBehaviorTargetinstance.

code: class USingleClickInputBehavior : public [UAnyButtonInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UAnyButtonInputBehavior)

HitTestOnRelease

description: Hit-test is repeated on release (standard behavior). If false,

Modifiers

description: The modifier set for this behavior

type: IClickBehaviorT...

description: Click Target object


description: Internal function that forwards click evens to Target::OnClicked, you can customize behavior here

code: virtual void Clicked ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input, const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & Data )


description: Set the targets for Click and Drag interactions

code: virtual void Initialize ( [IClickBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IClickBehaviorTarget) * ClickTarget, [IClickDragBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IClickDragBehaviorTarget) * DragTarget )


description: Internal function that forwards click evens to DragTarget::OnClickDrag, you can customize behavior here

code: virtual void OnClickDragInternal ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input, const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & Data )


description: Internal function that forwards click evens to DragTarget::OnClickRelease, you can customize behavior here

code: virtual void OnClickDragReleaseInternal ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input, const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & Data )


description: Internal function that forwards click evens to ClickTarget::OnClicked, you can customize behavior here

code: virtual void OnClickedInternal ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input, const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & Data )


description: Change the Drag BehaviorTarget

code: virtual void SetDragTarget ( [IClickDragBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IClickDragBehaviorTarget) * DragTarget )


description: Internal function that forwards click evens to DragTarget::OnClickPress, you can customize behavior here

code: virtual void OnClickDragPressInternal ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & Input, EInputCaptureSide Side )


code: virtual [FInputCaptureUpdate](API\Runtime\InteractiveToolsFramework\FInputCaptureUpdate) UpdateCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState, const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & CaptureData )


code: virtual [FInputCaptureUpdate](API\Runtime\InteractiveToolsFramework\FInputCaptureUpdate) BeginCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState, EInputCaptureSide eSide )


className: USingleClickOrDragInputBehavior

description: The hit-test and on-clicked functions are provided by aIClickBehaviorTargetinstance, while anIClickDragBehaviorTargetprovides the can-click-drag/begin-drag/update-drag/end-drag functionality.

code: class USingleClickOrDragInputBehavior : public [UAnyButtonInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UAnyButtonInputBehavior)

bBeginDragIfClickTargetNotHit

description: If true (default), then if the click-mouse-down does not hit a valid click target (determined byIClickBehaviorTarget::IsHitByClick), then the Drag will be initiated

bImmediatelyBeginDragInBeginCapture

description: Flag used to communicate between WantsCapture and BeginCapture

bInDrag

description: Set to true if we are in an active drag capture, eg after rejecting possible click

CaptureSide

type: EInputCaptureSi...

description: Device capture

ClickDistanceThreshold

type: float

description: If the device moves more than this distance in 2D (pixel?) units, the interaction switches from click to drag

ClickTarget

description: Click Target object

DragTarget

description: Drag Target object

description: The modifier set for this behavior

description: Click-down position, to determine if mouse has moved far enough to swap to drag interaction

MouseDownRay

type: FRay


description: If this is called, the Behavior has forcibly lost capture (eg due to app losing focus for example) and needs to clean up accordingly

code: virtual void ForceEndCapture ( const [FInputCaptureData](API\Runtime\InteractiveToolsFramework\FInputCaptureData) & CaptureData )


description: Which device types does this Behavior support


description: Initialize this behavior with the given Target. Note that though it interacts through theIModifierToggleBehaviorTargetinterface, the modifier here captures keyboard input, unlike the modifiers in UKeyAsMOdifierInputBehavior and other places.

code: virtual void Initialize ( [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget) * Target, int ModifierID, const [FKey](API\Runtime\InputCore\FKey) & ModifierKey )


description: Given the input state, does this Behavior want to begin capturing some input devices?

code: virtual [FInputCaptureRequest](API\Runtime\InteractiveToolsFramework\FInputCaptureRequest) WantsCapture ( const [FInputDeviceState](API\Runtime\InteractiveToolsFramework\FInputDeviceState) & InputState )


code: USingleKeyCaptureBehavior()


className: USingleKeyCaptureBehavior

description: USingleKeyCaptureBehaviorcaptures a key press and routes it to target via theIModifierToggleBehaviorTargetinterface. If you want similar behavior without actually capturing the key, you should useUKeyAsModifierInputBehavior.

code: class USingleKeyCaptureBehavior : public [UInputBehavior](API\Runtime\InteractiveToolsFramework\UInputBehavior)

ModifierCheckFunc

description: WantsCapture()will only return capture request if this function returns true (or is null) Intended to be used for alt/ctrl/cmd/shift modifiers on the main key

ModifierKey

type: FKey

description: Key that is used as modifier

Modifiers

description: Modifier set for this behavior, internally initialized with check on ModifierKey

PressedButton

description: The key that was pressed to activate capture

Target

description: Modifier Target object


code: virtual bool OnDragDetected ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual bool OnKeyChar ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & InCharacterEvent )


code: virtual bool OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


code: virtual bool OnKeyUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


code: virtual bool OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


code: virtual bool OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual bool OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual void OnMouseCaptureLost ( const [FCaptureLostEvent](API\Runtime\SlateCore\Input\FCaptureLostEvent) & CaptureLostEvent )


code: virtual bool OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual bool OnMouseWheel ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


code: virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const


className: UWidgetBaseBehavior

description: If implementing this interface, please consider incrementing the LayerId if needed when overriding OnPaint.

code: class UWidgetBaseBehavior : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


className: IWidgetBaseBehavior

code: class IWidgetBaseBehavior


description: Create a new instance ofACombinedTransformGizmoActor. Populate the sub-components specified by Elements with standard GizmoXComponent instances suitable for a 3-axis transformer Gizmo

code: static [ACombinedTransformGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\ACombinedTransformGizmoActor) * ConstructCustom3AxisGizmo ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContext, ETransformGizmoSubElements Elements )


description: Create a new instance ofACombinedTransformGizmoActorand populate the various sub-components with standard GizmoXComponent instances suitable for a 3-axis transformer Gizmo

code: static [ACombinedTransformGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\ACombinedTransformGizmoActor) * ConstructDefault3AxisGizmo ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContext )


description: Add standard arrow component to Actor, generally used for axis-translation

code: static [UGizmoArrowComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoArrowComponent) * AddDefaultArrowComponent ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContext, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & Color, const FVector & LocalDirection, const float Length )


code: ACombinedTransformGizmoActor()


className: ACombinedTransformGizmoActor

description: The static factory method ::ConstructDefault3AxisGizmo() creates and initializes an Actor suitable for use in a standard 3-axis Transformation Gizmo.

code: class ACombinedTransformGizmoActor : public [AGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\AGizmoActor)

AxisScaleX

type: TObjectPtr<UPr...

description: X Axis Scale Component

AxisScaleY

description: Y Axis Scale Component

AxisScaleZ

description: Z Axis Scale Component

PlaneScaleXY

description: XY Plane Scale Component

PlaneScaleXZ

description: XZ Plane Scale Component

PlaneScaleYZ

description: YZ Plane Scale Component

RotateX

description: Rotation ComponentsX Axis Rotation Component

RotateY

description: Y Axis Rotation Component

RotateZ

description: Z Axis Rotation Component

RotationSphere

description: Z Axis Rotation Component

TranslateX

description: Translation ComponentsX Axis Translation Component

TranslateXY

description: XY Plane Translation Component

TranslateXZ

description: XZ Plane Translation Component

TranslateY

description: Y Axis Translation Component

TranslateYZ

description: YZ Plane Translation Component

TranslateZ

description: Z Axis Translation Component

UniformScale

description: Scaling ComponentsUniform Scale Component


description: Add standard 3D box component to Actor.Bydefault the box is axis-aligned, centered at the specified Origin

code: static [UGizmoBoxComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoBoxComponent) * AddDefaultBoxComponent ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContext, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & Color, const FVector & Origin, const FVector & Dimensions )


description: Add standard circle component to Actor, generally used for axis-rotation

code: static [UGizmoCircleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoCircleComponent) * AddDefaultCircleComponent ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContext, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & Color, const FVector & PlaneNormal, float Radius )


description: Add standard rectangle component to Actor, generally used for plane-translation

code: static [UGizmoRectangleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoRectangleComponent) * AddDefaultRectangleComponent ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContext, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & Color, const FVector & PlaneAxis1, const FVector & PlaneAxisx2 )


description: Add standard disk component to Actor, generally used for handles

code: static [UGizmoLineHandleComponent](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoLineHandleComponent) * AddDefaultLineHandleComponent ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContext, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & Color, const FVector & PlaneNormal, const FVector & LocalDirection, const float Length, const bool bImageScale )


className: AGizmoActor

description: AGizmoActoris a base class for Actors that would be created to represent Gizmos in the scene. Currently this does not involve any special functionality, but a set of static functions are provided to create default Components commonly used in Gizmos.

code: class AGizmoActor : public [AInternalToolFrameworkActor](API\Runtime\InteractiveToolsFramework\AInternalToolFrameworkActor)


code: AIntervalGizmoActor()


description: Create a new instance ofAIntervalGizmoActorand populate the various sub-components with standard GizmoXComponent instances suitable for a 3-interval Gizmo

code: static [AIntervalGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\AIntervalGizmoActor) * ConstructDefaultIntervalGizmo ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World, [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContext )


className: AIntervalGizmoActor

description: If a particular sub-Gizmo is not required, simply set thatUPropertyto null.

code: class AIntervalGizmoActor : public [AGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\AGizmoActor)

DownIntervalComponent

type: TObjectPtr<UGi...


description: newACombinedTransformGizmoActorinstance with members initialized with Components suitable for a transformation Gizmo

code: virtual [ACombinedTransformGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\ACombinedTransformGizmoActor) * CreateNewGizmoActor ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World ) const


code: FCombinedTransformGizmoActorFactory ( [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContextIn )


className: FCombinedTransformGizmoActorFactory

description: BydefaultCreateNewGizmoActor()returns a default Gizmo Actor suitable for a three-axis transformation Gizmo, override this function to customize the Actor sub-elements.

EnableElements

type: ETransformGizmo...

description: Only these members of theACombinedTransformGizmoActorgizmo will be initialized

GizmoViewContext

type: UGizmoViewConte...

description: The default gizmos that we use need to have the current view information stored for them via the ITF context store so that they can figure out how big they are for hit testing, so this pointer needs to be set (and kept alive elsewhere) for the actor factory to work properly.


className: DefaultColor

code: static constexpr [FLinearColor](API\Runtime\Core\Math\FLinearColor) DefaultColor = FLinearColor(1.0f, 1.0f, 1.0f);


description: Reset attribute to default values.

code: void Reset()


description: Return the color value. This returns the default color value if no value has been set.


description: Set color value and override flag.

code: void SetColor ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) InColor, bool InOverridesChildState )


description: Update this state based on a child state attribute.

code: void UpdateState ( const [FGizmoElementColorAttribute](API\Runtime\InteractiveToolsFramework\BaseGizmos\FGizmoElementColorAttribute) & InChildColorAttribute )


className: FGizmoElementColorAttribute

description: Stores color state value, whether state is set and whether it overrides child state.

code: struct FGizmoElementColorAttribute

bHasValue

type: bool

description: True if value has been set.

bOverridesChildState

description: True if this attribute overrides child state attributes.

Value

type: FLinearColor

description: Color value.


description: Returns the line color corresponding to the input interaction state.

code: [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetLineColor ( EGizmoElementInteractionState InteractionState )


className: FGizmoElementLineRenderStateAttributes

description: Line render state structure.

HoverLineColor

type: FGizmoElementCo...

description: Hover line color.

InteractLineColor

description: Interact line color.

LineColor

description: Line color.


description: Update this line render state based on a child mesh render state attribute.

code: void Update ( [FGizmoElementLineRenderStateAttributes](API\Runtime\InteractiveToolsFramework\BaseGizmos\FGizmoElementLin-) & InChildAttributes )


description: Return the material value.

code: const [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * GetMaterial() const


description: Set material value and override flag.

code: void SetMaterial ( [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) > InColor, bool InOverridesChildState )


code: void UpdateState ( const [FGizmoElementMaterialAttribute](API\Runtime\InteractiveToolsFramework\BaseGizmos\FGizmoElementMaterialAttribute) & InChildMaterialAttribute )


className: FGizmoElementMaterialAttribute

description: Stores material state value, whether state is set and whether it overrides child state.

code: struct FGizmoElementMaterialAttribute

Value

type: TWeakObjectPtr<...

description: Material value.


description: Returns the material corresponding to the input interaction state.

code: const [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * GetMaterial ( EGizmoElementInteractionState InteractionState )


description: Returns mesh vertex color.

code: [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetVertexColor ( EGizmoElementInteractionState InteractionState )


description: Update this mesh render state based on a child mesh render state attribute.

code: void Update ( [FGizmoElementMeshRenderStateAttributes](API\Runtime\InteractiveToolsFramework\BaseGizmos\FGizmoElementMes-) & InChildAttributes )


className: FGizmoElementMeshRenderStateAttributes

description: Mesh render state structure.

HoverMaterial

type: FGizmoElementMa...

description: Hover material.

HoverVertexColor

description: Hover mesh vertex color.

InteractMaterial

description: Interact material.

InteractVertexColor

description: Interact mesh vertex color.

Material

description: Default material.

VertexColor

description: Mesh vertex color.


code: FGizmoFloatParameterChange ( float StartValue )


code: float GetChangeDelta() const


className: FGizmoFloatParameterChange

description: FGizmoVec2ParameterChangerepresents a change in the value of anIGizmoFloatParameterSource.IGizmoFloatParameterSourceimplementations use this to track changes and emit delta information.

code: struct FGizmoFloatParameterChange


code: FGizmoVec2ParameterChange ( const FVector2D & StartValue )


description: Various implementations ofIGizmoVec2ParameterSourceFGizmoVec2ParameterChangerepresents a change in the value of anIGizmoVec2ParameterSource.IGizmoVec2ParameterSourceimplementations use this to track changes and emit delta information.

code: struct FGizmoVec2ParameterChange


description: newAIntervalGizmoActorinstance with members initialized with Components suitable for a transformation Gizmo

code: virtual [AIntervalGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\AIntervalGizmoActor) * CreateNewGizmoActor ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World ) const


code: FIntervalGizmoActorFactory ( [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * GizmoViewContextIn )


code: FVector2D GetChangeDelta() const


className: FIntervalGizmoActorFactory

description: BydefaultCreateNewGizmoActor()returns a default Gizmo Actor suitable for a three-axis Interval Gizmo, override this function to customize the Actor sub-elements.

code: class FIntervalGizmoActorFactory

GizmoViewContext

description: Needs to be set (and kept alive elsewhere) so that created handle gizmos can adjust their length according to view (when not using world-scaling).


className: FSeparateScaleProvider

description: FSeparateScaleProviderprovides TFunction-implementable API that sets/gets a Scaling Vector from an external source.

code: struct FSeparateScaleProvider

GetScale

type: TFunction< FVec...

SetScale

type: TFunction< void...


code: bool InheritFromContext() const


description: true if Toggle is currently set to Enabled/On, under the current configuration

code: bool IsEnabled() const


code: FToolContextOptionalToggle()


code: void UpdateContextValue ( bool bNewValue )


code: FToolContextOptionalToggle ( bool bEnabled, bool bSetInheritFromContext )


className: FToolContextOptionalToggle

description: FToolContextOptionalToggleis used to store a boolean flag where the value of the boolean may either be set directly, or it may be set by querying some external context. This struct does not directly do anything, it just wraps up the multiple flags/states needed to provide such functionality

code: struct FToolContextOptionalToggle


description: Reverts change to the object

code: virtual void Revert ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: Makes the change to the object

code: virtual void Apply ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: Describes this change (for debugging)

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString() const


className: FTransformProxyChange

description: FTransformProxyChangetracks a change to the base transform for a TransformProxy

code: class FTransformProxyChange : public [FToolCommandChange](API\Runtime\InteractiveToolsFramework\FToolCommandChange)

From

type: FTransform


code: virtual void BeginChange()


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FToolCommandChange](API\Runtime\InteractiveToolsFramework\FToolCommandChange) > EndChange()


code: virtual [UObject](API\Runtime\CoreUObject\UObject\UObject) * GetChangeTarget()


code: FTransformProxyChangeSource ( [UTransformProxy](API\Runtime\InteractiveToolsFramework\BaseGizmos\UTransformProxy) * ProxyIn )


code: virtual ~FTransformProxyChangeSource()


className: FTransformProxyChangeSource

description: FTransformProxyChangeSourcegeneratesFTransformProxyChangeinstances on Begin/End. Instances of this class can (for example) be attached to aUGizmoTransformChangeStateTargetfor use TransformGizmo change tracking.

code: class FTransformProxyChangeSource : public [IToolCommandChangeSource](API\Runtime\InteractiveToolsFramework\IToolCommandChangeSource)

ActiveChange

type: TUniquePtr<FTr...

bOverrideSetPivotMode

description: If true, the emitted changes will always have bSetPivotMode set to true, regardless of the current proxy settings.


description: Find the closest point to QueryPoint that is on the circle defined by CircleOrigin, CircleNormal, and CircleRadius.

code: namespace GizmoMath { void GizmoMath::ClosetPointOnCircle ( const FVector & QueryPoint, const FVector & CircleOrigin, const FVector & CircleNormal, float CircleRadius, FVector & ClosestPointOut ) }


description:
Project the input Point into the plane defined by PlaneOrigin and PlaneNormal, and then calculate it's UV coordinates in the space defined by the plane axes PlaneAxis1 and PlaneAxis2
the UV coordinates

code: namespace GizmoMath { FVector2D GizmoMath::ComputeCoordinatesInPlane ( const FVector & Point, const FVector & PlaneOrigin, const FVector & PlaneNormal, const FVector & PlaneAxis1, const FVector & PlaneAxis2 ) }


description:
Project the input Point into the plane defined by PlaneOrigin and PlaneNormal, and then measure it's signed angle relative to the in-plane X and Y axes defined by PlaneAxis1 and PlaneAxis2
the signed angle

code: namespace GizmoMath { float GizmoMath::ComputeAngleInPlane ( const FVector & Point, const FVector & PlaneOrigin, const FVector & PlaneNormal, const FVector & PlaneAxis1, const FVector & PlaneAxis2 ) }


description: Orthogonal vector

code: namespace GizmoMath { FVector GizmoMath::GetOrthogonalVector ( const FVector & V ) }


description: Find the intersection of two floating point intervals in which the interval inputs contain pairs of floats sorted in increasing order. Returns the number of intersections intersection and intersection results in increasing order.

code: namespace GizmoMath { template<typename RealType> void GizmoMath::IntervalIntervalIntersection ( const RealType Interval0, const RealType Interval1, int & OutNumIntersections, RealType & OutResult0, RealType & OutResult1 ) }


description: Construct two mutually-perpendicular unit vectors BasisAxis1Out and BasisAxis2Out which are orthogonal to PlaneNormal

code: namespace GizmoMath { void GizmoMath::MakeNormalPlaneBasis ( const FVector & PlaneNormal, FVector & BasisAxis1Out, FVector & BasisAxis2Out ) }


description: Find the closest pair of points on a 3D line and 3D ray. Returns the points and line-equation parameters on both the line and ray.

code: namespace GizmoMath { void GizmoMath::NearestPointOnLineToRay ( const FVector & LineOrigin, const FVector & LineDirection, const FVector & RayOrigin, const FVector & RayDirection, FVector & NearestLinePointOut, float & LineParameterOut, FVector & NearestRayPointOut, float & RayParameterOut ) }


description: Find the nearest point to QueryPoint on the line defined by LineOrigin and LineDirection. Returns this point and the associated line-equation parameter

code: namespace GizmoMath { void GizmoMath::NearestPointOnLine ( const FVector & LineOrigin, const FVector & LineDirection, const FVector & QueryPoint, FVector & NearestPointOut, float & LineParameterOut ) }


description:
Project a point onto the line defined by LineOrigin and LineDirection
projected point

code: namespace GizmoMath { FVector GizmoMath::ProjectPointOntoLine ( const FVector & Point, const FVector & LineOrigin, const FVector & LineDirection ) }


description:
Project the input Point onto the plane defined by PlaneOrigin and PlaneNormal,
Nearest position to Point lying in the plane

code: namespace GizmoMath { FVector GizmoMath::ProjectPointOntoPlane ( const FVector & Point, const FVector & PlaneOrigin, const FVector & PlaneNormal ) }


description: Find the intersection of the ray defined by RayOrigin and RayDirection with the cone defined by ConeCenter, ConeDirection, ConeCosAngle, and ConeHeight. Where ConeCosAngle is the cosine of the cone opening angle, defined as the angle at the apex between the cone's axis and slant edge. Returns intersection success/failure in bOutIntersects and the hit depth parameter along the ray for the first intersection in OutHitDepth.

code: namespace GizmoMath { template<typename RealType> void GizmoMath::RayConeIntersection ( const FVector & ConeCenter, const FVector & ConeDirection, RealType ConeCosAngle, RealType ConeHeight, const FVector & RayOrigin, const FVector & RayDirection, bool & bIntersectsOut, RealType & OutHitDepth ) }


description: Find the intersection of the ray defined by RayOrigin and RayDirection with the cylinder defined by CylinderCenter, CylinderAxis, CylinderRadius, and CylinderHeight. Returns intersection success/failure in bOutIntersects and the hit depth parameter along the ray for the first intersection in OutHitDepth.

code: namespace GizmoMath { template<typename RealType> void GizmoMath::RayCylinderIntersection ( const FVector & CylinderCenter, const FVector & CylinderAxis, RealType CylinderRadius, RealType CylinderHeight, const FVector & RayOrigin, const FVector & RayDirection, bool & bIntersectsOut, RealType & OutHitDepth ) }


description: Find the intersection of the ray defined by RayOrigin and RayDirection with the plane defined by PlaneOrigin and PlaneNormal. Returns intersection success/failure in bIntersectsOut and the intersection point in PlaneIntersectionPointOut

code: namespace GizmoMath { void GizmoMath::RayPlaneIntersectionPoint ( const FVector & PlaneOrigin, const FVector & PlaneNormal, const FVector & RayOrigin, const FVector & RayDirection, bool & bIntersectsOut, FVector & PlaneIntersectionPointOut ) }


description: Find the intersection of the ray defined by RayOrigin and RayDirection with the sphere defined by SphereOrigin and SphereRadius. Returns intersection success/failure in bIntersectsOut and the intersection point in SphereIntersectionPointOut

code: namespace GizmoMath { void GizmoMath::RaySphereIntersection ( const FVector & SphereOrigin, const float SphereRadius, const FVector & RayOrigin, const FVector & RayDirection, bool & bIntersectsOut, FVector & SphereIntersectionPointOut ) }


description:
Round Value to nearest step of Increment
snapped/rounded value

code: namespace GizmoMath { template<typename RealType> RealType GizmoMath::SnapToIncrement ( RealType Value, RealType Increment ) }


description:
This is a local estimate and is increasingly incorrect as the 3D point gets further from Location
Conversion factor between pixel and world-space coordinates at 3D point Location in View.

code: namespace GizmoRenderingUtil { float GizmoRenderingUtil::CalculateLocalPixelToWorldScale ( const [FSceneView](API\Runtime\Engine\FSceneView) * View, const FVector & Location ) }


code: namespace GizmoRenderingUtil { float GizmoRenderingUtil::CalculateLocalPixelToWorldScale ( const [UGizmoViewContext](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoViewContext) * ViewContext, const FVector & Location ) }


description: OutWorldFlattenScale vector to be applied in world space, can be used to flatten excluded dimension in orthographic views as it reverses the scale in that dimension.

code: namespace GizmoRenderingUtil { float GizmoRenderingUtil::CalculateViewDependentScaleAndFlatten ( const [FSceneView](API\Runtime\Engine\FSceneView) * View, const FVector & Location, const float Scale, FVector & OutWorldFlattenScale ) }


description: Utility function that always returns a 3D coordinate system (ie plane normal and perpendicular axes). Internally callsGetTangentVectors()if available, otherwise constructs arbitrary mutually perpendicular vectors.

code: void GetAxisFrame ( FVector & PlaneNormalOut, FVector & PlaneAxis1Out, FVector & PlaneAxis2Out ) const


description: Direction Vector of axis

code: FVector GetDirection() const


description: Origin Point of axis

code: FVector GetOrigin() const


description: Only valid ifHasTangentVectors()returns true

code: virtual void GetTangentVectors ( FVector & TangentXOut, FVector & TangentYOut ) const