description: Returns true if a non-recoverable error has occurred.

code: virtual bool HasError() const


description: The size of the decode PCM buffer size.

module: BinkAudioDecoder

code: virtual uint32 GetMaxFrameSizeSamples() const


description: Parse the header information from the input source buffer data. This is dependent on compression format.

code: virtual bool ParseHeader ( const uint8 * InSrcBufferData, uint32 InSrcBufferDataSize, [FSoundQualityInfo](API\Developer\TargetPlatform\Interfaces\FSoundQualityInfo) * QualityInfo )


description: Optional method to allow decoder to prepare to loop.

code: virtual void PrepareToLoop()


description: Seeks to time (Some formats might not be seekable)

code: virtual void SeekToTime ( const float SeekTime )


code: virtual ~FBinkAudioInfo()


className: FBinkAudioInfo

description: Decoder thunk to the Bink Audio libraries. Also manages file parsing for the cooked data.

code: class FBinkAudioInfo : public [IStreamedCompressedInfo](API\Runtime\Engine\IStreamedCompressedInfo)

bErrorStateLatch

type: bool

Decoder

type: BinkAudioDecode...

MaxCompSpaceNeeded

description: Copied from header during ParseHeader

RawMemory

type: uint8 *


className: FBlueprintWarningSettings

module: BlueprintRuntime

code: struct FBlueprintWarningSettings

WarningBehavior

type: EBlueprintWarni...

WarningDescription

type: FText

WarningIdentifier

type: FName


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IBlueprintRuntime](API\Runtime\BlueprintRuntime\IBlueprintRuntime) & Get()


code: void PropagateWarningSettings()


className: IBlueprintRuntime

description: The public interface to this module

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


code: UBlueprintRuntimeSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UBlueprintRuntimeSettings

description: Implements the settings for the BlueprintRuntime module

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

WarningSettings

type: TArray<FBluepr...


module: BuildPatchServices

code: namespace BuildPatchServices { uint64 BuildPatchServices::CalculateRequiredDiskSpace ( const IBuildManifestPtr & CurrentManifest, const IBuildManifestRef & BuildManifest, const [EInstallMode](API\Runtime\BuildPatchServices\BuildPatchServices__EInstallMode) & InstallMode, const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & InstallTags ) }


description: Namespace to declares the progress type enum

code: namespace BuildPatchServices { enum EBuildPatchState { Queued = 0, Initializing, Resuming, Downloading, Installing, MovingToInstall, SettingAttributes, BuildVerification, CleanUp, PrerequisitesInstall, Completed, Paused, NUM_PROGRESS_STATES, } }


description: An enum defining the desired policy for requesting an optimised delta.

code: namespace BuildPatchServices { enum EDeltaPolicy { TryFetchContinueWithout, Expect, Skip, } }


description: An enum type to describe supported features of a certain manifest.

code: namespace BuildPatchServices { enum EFeatureLevel { Original = 0, CustomFields, StartStoringVersion, DataFileRenames, StoresIfChunkOrFileData, StoresDataGroupNumbers, ChunkCompressionSupport, StoresPrerequisitesInfo, StoresChunkFileSizes, StoredAsCompressedUClass, UNUSED_0, UNUSED_1, StoresChunkDataShaHashes, StoresPrerequisiteIds, StoredAsBinaryData, VariableSizeChunksWithoutWindowSizeChunkInfo, VariableSizeChunks, UsesRuntimeGeneratedBuildId, UsesBuildTimeGeneratedBuildId, LatestPlusOne, Latest = (LatestPlusOne - 1), LatestNoChunks = StoresChunkFileSizes, LatestJson = StoresPrerequisiteIds, FirstOptimisedDelta = UsesRuntimeGeneratedBuildId, StoresUniqueBuildId = UsesRuntimeGeneratedBuildId, BrokenJsonVersion = 255, Invalid = -1, } }


description: An enum defining the installation mode that should be used.

code: namespace BuildPatchServices { enum EInstallMode { StageFiles, DestructiveInstall, NonDestructiveInstall, PrereqOnly, } }


description:
Returns the string representation of the EDeltaPolicy value. Used for analytics and logging only.
the enum's string representation.

code: namespace BuildPatchServices { const [FString](API\Runtime\Core\Containers\FString) & BuildPatchServices::EnumToString ( const [EDeltaPolicy](API\Runtime\BuildPatchServices\BuildPatchServices__EDeltaPolicy) & DeltaPolicy ) }


description:
Returns the string representation of the EInstallMode value. Used for analytics and logging only.
the enum's string representation.

code: namespace BuildPatchServices { const [FString](API\Runtime\Core\Containers\FString) & BuildPatchServices::EnumToString ( const [EInstallMode](API\Runtime\BuildPatchServices\BuildPatchServices__EInstallMode) & InstallMode ) }


description:
Returns the string representation of the EVerifyMode value. Used for analytics and logging only.
the enum's string representation.

code: namespace BuildPatchServices { const [FString](API\Runtime\Core\Containers\FString) & BuildPatchServices::EnumToString ( const [EVerifyMode](API\Runtime\BuildPatchServices\BuildPatchServices__EVerifyMode) & VerifyMode ) }


description: An enum defining the possible causes for a verification failure.

code: namespace BuildPatchServices { enum EVerifyError { FileMissing, OpenFileFailed, HashCheckFailed, FileSizeFailed, } }


description: An enum defining the verification mode that should be used.

code: namespace BuildPatchServices { enum EVerifyMode { ShaVerifyAllFiles, ShaVerifyTouchedFiles, FileSizeCheckAllFiles, FileSizeCheckTouchedFiles, } }


description:
Returns the string representation of the EFeatureLevel value. Used for analytics and logging only.
The string representation.

code: namespace BuildPatchServices { const TCHAR * BuildPatchServices::FeatureLevelToString ( const [EFeatureLevel](API\Runtime\BuildPatchServices\BuildPatchServices__EFeatureLeve-) & FeatureLevel ) }


description:
Parses the provided string into the relevant EFeatureLevel value, if it matches.
true if successfully parsed.

code: namespace BuildPatchServices { bool BuildPatchServices::FeatureLevelFromString ( const TCHAR * FeatureLevelString, [EFeatureLevel](API\Runtime\BuildPatchServices\BuildPatchServices__EFeatureLeve-) & FeatureLevel ) }


description:
Based on the source and destination manifests, get the filename for the delta that optimises patching from source to destination.
the CloudDir relative delta filename.

code: namespace BuildPatchServices { [FString](API\Runtime\Core\Containers\FString) BuildPatchServices::GetChunkDeltaFilename ( const IBuildManifestRef & SourceManifest, const IBuildManifestRef & DestinationManifest ) }


code: namespace BuildPatchServices { IBuildManifestPtr BuildPatchServices::MergeDeltaManifest ( const IBuildManifestRef & Manifest, const IBuildManifestRef & Delta ) }


description:
Returns theFTextrepresentation of the specified EBuildPatchState value. Used for displaying to the user.
The display text associated with the progress step.

code: namespace BuildPatchServices { const [FText](API\Runtime\Core\Internationalization\FText) & BuildPatchServices::StateToText ( const [EBuildPatchState](API\Runtime\BuildPatchServices\BuildPatchServices__EBuildPatchS-) & State ) }


description:
Returns the string representation of the EBuildPatchState value. Used for analytics and logging only.
The enum's string value.

code: namespace BuildPatchServices { const [FString](API\Runtime\Core\Containers\FString) & BuildPatchServices::StateToString ( const [EBuildPatchState](API\Runtime\BuildPatchServices\BuildPatchServices__EBuildPatchS-) & State ) }


description: Construct with an array of action objects

code: FBuildInstallerConfiguration ( [TArray](API\Runtime\Core\Containers\TArray)< [FInstallerAction](API\Runtime\BuildPatchServices\FInstallerAction) > InstallerActions )


description: Copy constructor.

code: FBuildInstallerConfiguration ( const [FBuildInstallerConfiguration](API\Runtime\BuildPatchServices\FBuildInstallerConfiguration) & CopyFrom )


description: RValue constructor to allow move semantics.

code: FBuildInstallerConfiguration ( [FBuildInstallerConfiguration](API\Runtime\BuildPatchServices\FBuildInstallerConfiguration) && MoveFrom )


className: FBuildInstallerConfiguration

description: Defines a list of all the options of an installation task.

code: struct FBuildInstallerConfiguration

BackupDirectory

type: FString

description: The directory for placing files that are believed to have local changes, before we overwrite them. Empty string will use module's global setting. If both empty, the feature disables.

bAllowConcurrentExecution

description: Whether to allow this installation to run concurrently with any existing installations.

bRunRequiredPrereqs

description: Whether to run the prerequisite installer provided if it hasn't been ran before on this machine.

ChunkDatabaseFiles

type: TArray<FString...

description: The list of chunk database filenames that will be used to pull patch data from.

CloudDirectories

description: The list of cloud directory roots that will be used to pull patch data from. Empty array will use module's global setting.

DeltaPolicy

type: EDeltaPolicy

description: The policy to follow for requesting an optimised delta.

InstallDirectory

description: The directory to install to.

InstallerActions

type: TArray<FInstal...

description: The array of intended actions to perform.

InstallMode

type: EInstallMode

description: The mode for installation.

StagingDirectory

description: The directory for storing the intermediate files. This would usually be inside the InstallDirectory. Empty string will use module's global setting.

VerifyMode

type: EVerifyMode

description: The mode for verification. This will be overridden for any files referenced by a repair action.


className: FBuildInstallStreamerConfiguration

description: Defines a list of all the options of a build streamer class.

bMainThreadDelegates

description: Whether completion delegates should be called on main thread, or the streamer's thread,.

bShouldBatch

description: Whether the streamer should batch all requests into each cycle.

CloudDirectories

description: The list of cloud directory roots that will be used to pull patch data from. Empty array will use module's global setting..

Manifest

type: IBuildManifestP...


className: FBuildInstallStreamerStats

description: The collection of statistics gathered by the build streamer class.

code: struct FBuildInstallStreamerStats

AverageRequestTime

type: double

BundleRequestsCancelled

description: Float BundleMegaBytesDownloaded;

FileRequestsCompleted

description: Float FileMegaBytesDownloaded;

TotalMegaBytesDownloaded

type: float


code: static [IBuildPatchServicesModule](API\Runtime\BuildPatchServices\Interfaces\IBuildPatchServicesModule) & Get()


code: static const [BuildPatchServices::FBuildPatchServicesInitSettings](API\Runtime\BuildPatchServices\FBuildPatchServicesInitSettings) & GetSettings()


code: static bool IsAvailable()


className: ModuleName

code: static [FName](API\Runtime\Core\UObject\FName) ModuleName = TEXT("BuildPatchServices");


code: static void Set ( const [FName](API\Runtime\Core\UObject\FName) & Value, const [BuildPatchServices::FBuildPatchServicesInitSettings](API\Runtime\BuildPatchServices\FBuildPatchServicesInitSettings) & BuildPatchServicesInitSettings )


code: static void Shutdown()


className: FBuildPatchServices

code: class FBuildPatchServices


description: Default constructor. Initializes all members with default behavior values.

code: FBuildPatchServicesInitSettings()


className: FBuildPatchServicesInitSettings

description: Defines a list of all build patch services initialization settings, can be used to override default init behaviors.

code: struct FBuildPatchServicesInitSettings

ApplicationSettingsDir

description: The application settings directory.

LocalMachineConfigFileName

description: The local machine config file name.

ProjectName

description: The application project name.


description: Default constructor

code: FChunkBuildConfiguration()


className: FChunkBuildConfiguration

description: Defines a list of all options for the build chunking task.

code: struct FChunkBuildConfiguration

AppId

description: The ID of the app of this build.

AppName

description: The name of the app of this build.

AttributeListFile

description: The path to a file containing a

type: separated list of RootDirectory relative files followed by attribute keywords.

bAllowEmptyBuild

description: Allow Manifest Creation for builds with no data.

bShouldHonorReuseThreshold

description: Indicates whether data age threshold should be honored. If false, ALL data files can be reused.

bShouldMatchAnyWindowSize

description: Indicates whether any window size chunks should be matched, rather than just out output window size.

BuildVersion

description: The version string for this build.

CloudDirectory

description: The cloud directory that all patch data will be saved to. An empty value will use module's global setting.

CustomFields

type: TMap<FString, ...

description: Map of custom fields to add to the manifest.

DataAgeThreshold

description: The maximum age (in days) of existing data files which can be reused in this build.

FeatureLevel

type: EFeatureLevel

description: The client feature level to output data for.

IgnoreListFile

description: The path to a file containing a

type: separated list of RootDirectory relative files to ignore.

InputListFile

description: The path to a file containing a

type: separated list of RootDirectory relative files to read.

LaunchCommand

description: The command line that would launch this build.

LaunchExe

description: The local exe path that would launch this build.

OutputChunkWindowSize

description: The chunk window size to be used when saving out new data.

OutputFilename

description: The output manifest filename.

PrereqArgs

description: The command line arguments for the prerequisites installer.

PrereqIds

type: TSet<FString>

description: The set of identifiers which the prerequisites satisfy.

PrereqName

description: The display name of the prerequisites installer.

PrereqPath

description: The path to the prerequisites installer.

RootDirectory

description: The directory to analyze.


description: Default constructor

code: FChunkDeltaOptimiserConfiguration()


className: FChunkDeltaOptimiserConfiguration

description: Defines a list of all options for the chunk delta optimisation task.

CloudDirectory

description: The cloud directory that all patch data will be saved to. An empty value will use ManifestB's directory.

DiffAbortThreshold

description: A threshold for the original delta size, for which we would abort and not process.

ManifestAUri

description: A full file or http path for the manifest to be used as the source build.

ManifestBUri

description: A full file or http path for the manifest to be used as the destination build.

OutputChunkSize

description: The chunk size to use for saving new diff data.

ScanWindowSize

description: The window size to use for find new matches.


className: EType

description: Describes the event type.

code: enum EType { AccessLost = 0, AccessRegained, }


className: FChunkSourceEvent

description: A message describing an event that occurred for a chunk source.

code: struct FChunkSourceEvent

Event

type: EType

description: The type of event that occurred.

Location

description: The location context for the source, could be cloud root, install location, chunkdb file etc.


className: FChunkUriRequest

description: A Request for a chunk

code: struct FChunkUriRequest


className: FChunkUriResponse

description: A Response containing the actual location of the chunk

code: struct FChunkUriResponse


description: Default constructor

code: FCompactifyConfiguration()


className: FCompactifyConfiguration

description: Defines a list of all options for the cloud directory compactifier task.

code: struct FCompactifyConfiguration

bRunPreview

type: bool

description: If ran in preview mode, then the process will run in logging mode only - no files will be deleted.

CloudDirectory

description: The path to the directory to compactify.

DataAgeThreshold

description: Chunks which are not referenced by a valid manifest, and which are older than this age(in days), will be deleted.

DeletedChunkLogFile

description: The full path to a file to which a list of all chunk files deleted by compactify will be written.The output filenames will be relative to the cloud directory.


description: Handles responding to a chunk Uri request

code: virtual bool HandleRequest ( const [FChunkUriRequest](API\Runtime\BuildPatchServices\FChunkUriRequest) & Request, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([FChunkUriResponse](API\Runtime\BuildPatchServices\FChunkUriResponse))> OnResponse )


className: FDefaultMessageHandler

code: class FDefaultMessageHandler : public [BuildPatchServices::FMessageHandler](API\Runtime\BuildPatchServices\FMessageHandler)


description: Default constructor

code: FDiffManifestsConfiguration()


className: FDiffManifestsConfiguration

description: Defines a list of all options for the diff manifests task.

code: struct FDiffManifestsConfiguration

CompareTagSets

type: TArray<TSet<F...

description: Tag sets that will be used to calculate additional differential size statistics between manifests.

ManifestAUri

type: FString

OutputFilePath

description: A full file path where a JSON object will be saved for the diff details.Empty string if not desired.

TagSetA

description: The tag set to use to filter desired files from ManifestA.

TagSetB

description: The tag set to use to filter desired files from ManifestB.


className: FGenerationConfiguration

description: Temporary for use with deprecated module function.


className: FInstallationFileAction

description: A message describing an action taken to an installation file.

code: struct FInstallationFileAction

Action

description: The type of action that occurred.

Filename

description: The filename affected, relative to the install location.


description: Describes the action type.

code: enum EType { Removed = 0, Added, Updated, }


description: the manifest for the current installation, this will runtime assert if called invalidly (see TryGetCurrentManifest).


description:
Helper for getting the current manifest, or install manifest if no current manifest. One will always be valid.
the current, or the install manifest, based on validity respectively.


description: the manifest for the desired installation, this will runtime assert if called invalidly (see TryGetInstallManifest).


description:
Helper for getting the install manifest, or current manifest if no install manifest. One will always be valid.
the install, or the current manifest, based on validity respectively.


description: the install tags for the action.

code: const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & GetInstallTags() const


description: true if this action intent is to perform a fresh installation.

code: bool IsInstall() const


description: true if this action intent is to repair an existing installation.

code: bool IsRepair() const


description:
Creates an install action.
the action setup for performing an installation.

code: static [FInstallerAction](API\Runtime\BuildPatchServices\FInstallerAction) MakeInstall ( const IBuildManifestRef & Manifest, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > InstallTags )


description:
Helper for creating an install action or update action based on validity of CurrentManifest.
the action setup for performing an install or update.

code: static [FInstallerAction](API\Runtime\BuildPatchServices\FInstallerAction) MakeInstallOrUpdate ( const IBuildManifestPtr & CurrentManifest, const IBuildManifestRef & InstallManifest, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > InstallTags )


description: true if this action intent is to uninstall an installation.

code: bool IsUninstall() const


description: true if this action intent is to update an existing installation.

code: bool IsUpdate() const


description:
Creates an install action.
the action setup forcing an SHA check, and repair of all tagged files.

code: static [FInstallerAction](API\Runtime\BuildPatchServices\FInstallerAction) MakeRepair ( const IBuildManifestRef & Manifest, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > InstallTags )


description:
Creates an uninstall action.
the action setup for performing an uninstall, deleting all files referenced by the manifest.

code: static [FInstallerAction](API\Runtime\BuildPatchServices\FInstallerAction) MakeUninstall ( const IBuildManifestRef & Manifest )


description:
Creates an update action.
the action setup for performing an update.

code: static [FInstallerAction](API\Runtime\BuildPatchServices\FInstallerAction) MakeUpdate ( const IBuildManifestRef & CurrentManifest, const IBuildManifestRef & InstallManifest, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > InstallTags )


description:
Helper for getting the current manifest if nullable is preferred.
the manifest for the current installation, if valid.


description:
Helper for getting the install manifest if nullable is preferred.
true is this action intent it to perform a fresh installation.


description: Copy constructor.

code: FInstallerAction ( const [FInstallerAction](API\Runtime\BuildPatchServices\FInstallerAction) & CopyFrom )


description: RValue constructor to allow move semantics.

code: FInstallerAction ( [FInstallerAction](API\Runtime\BuildPatchServices\FInstallerAction) && MoveFrom )


className: FInstallerAction

code: struct FInstallerAction


code: FInstallerConfiguration ( const IBuildManifestRef & InInstallManifest )


code: FInstallerConfiguration ( const [FInstallerConfiguration](API\Runtime\BuildPatchServices\FInstallerConfiguration) & CopyFrom )


code: FInstallerConfiguration ( [FInstallerConfiguration](API\Runtime\BuildPatchServices\FInstallerConfiguration) && MoveFrom )


className: FInstallerConfiguration

description: DEPRECATED STRUCT. Please useFBuildInstallerConfiguration.

code: struct FInstallerConfiguration

ChunkDatabaseFiles

type: TArray<FString...

DeltaPolicy

type: EDeltaPolicy

InstallManifest

type: IBuildManifestR...


description: Handles a chunk source event message.

code: virtual void HandleMessage ( const [FChunkSourceEvent](API\Runtime\BuildPatchServices\FChunkSourceEvent) & Message )


description: Handles an installation file action message.

code: virtual void HandleMessage ( const [FInstallationFileAction](API\Runtime\BuildPatchServices\FInstallationFileAction) & Message )


description: Handles responding to a chunk Uri request

code: virtual bool HandleRequest ( const [FChunkUriRequest](API\Runtime\BuildPatchServices\FChunkUriRequest) & Request, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([FChunkUriResponse](API\Runtime\BuildPatchServices\FChunkUriResponse))> OnResponse )


code: virtual ~FMessageHandler()


className: FMessageHandler

description: Base class of a message handler, this should be inherited from and passed to an installer to receive messages that you want to handle.

code: class FMessageHandler


description: Default constructor

code: FPackageChunksConfiguration()


className: FPackageChunksConfiguration

description: Defines a list of all options for the chunk packaging task.

code: struct FPackageChunksConfiguration

CloudDir

description: Cloud directory where chunks to be packaged can be found.

FeatureLevel

description: The client feature level to output data for.

ManifestFilePath

description: A full file path to the manifest to enumerate chunks from.

MaxOutputFileSize

description: The maximum desired size for each chunkdb file.

OutputFile

description: A full file path to the chunkdb file to save. Extension of .chunkdb will be added if not present.

PrevManifestFilePath

description: A full file path to a manifest describing a previous build, which will filter out saved chunks for patch only chunkdbs.

PrevTagSet

description: Optional tagset to filter the files used from PrevManifestFilePath, potentially increasing the number of chunks saved.

ResultDataFilePath

description: A full file path to use when saving the json output data.

TagSetArray

description: Optional list of tagsets to split chunkdb files on. Empty array will include all data as normal.


description: Default constructor

code: FPatchDataEnumerationConfiguration()


className: FPatchDataEnumerationConfiguration

description: Defines a list of all options for the patch data enumeration task.

bIncludeSizes

description: Whether to include files sizes.

InputFile

description: A full file path for the manifest or chunkdb to enumerate referenced data for.

OutputFile

description: A full file path to a file where the list will be saved out to.


description: An enum describing the current state of the data for a file operation that has or will be processed.

code: namespace BuildPatchServices { enum EFileOperationState { Unknown = 0, PendingLocalChunkDbData, RetrievingLocalChunkDbData, PendingLocalInstallData, RetrievingLocalInstallData, PendingRemoteCloudData, RetrievingRemoteCloudData, PendingLocalDataStore, RetrievingLocalDataStore, DataInMemoryStore, Staged, Installed, Verifying, VerifiedFail, VerifiedSuccess, NUM_States, Complete = NUM_States - 1, } }


code: namespace ECompactifyMode { enum Type { Preview, Full, } }


description: Constructor.

code: FBuildInstallStats()


className: FBuildInstallStats

description: A struct to hold stats for the build process.

code: struct FBuildInstallStats

ActiveRequestCountPeak

description: The peak number of simultaneous download requests.

AverageDiskReadSpeed

description: The average disk read speed.

AverageDiskWriteSpeed

description: The average disk write speed.

AverageDownloadSpeed

description: The average chunk download speed.

AverageMemoryStoreRetained

description: AverageMemoryStoreRetained.

AverageMemoryStoreUse

description: AverageMemoryStoreUse.

ChunksInChunkDbs

description: The number of chunks available in chunkdb files.

ChunksLocallyAvailable

description: The number of chunks locally available in the build.

ChunksQueuedForDownload

description: The number of required chunks queued for download.

CleanUpTime

description: The time spent during the clean up stage.

ConstructTime

description: The time spent during the construction stage.

DisconnectedDownloadHealthTime

description: The amount of time that was spent with Disconnected download health.

ErrorCode

description: The error code. No error results in 'OK'.

ExcellentDownloadHealthTime

description: The amount of time that was spent with Excellent download health.

FailureReasonText

type: FText

description: The localized, more generic failure reason.

FailureType

type: EBuildPatchInst...

description: The failure type for the install.

FileAttributesTime

description: The time spent during the file attribution stage.

FinalDownloadSpeed

description: The download speed registered at the end of the installation.

FinalProgress

description: Final progress state, this is the progress of the current retry attempt.

GoodDownloadHealthTime

description: The amount of time that was spent with Good download health.

InitializeTime

description: The time spent during the initialization stage.

MemoryStoreSize

description: MemoryStoreSize.

MoveFromStageTime

description: The time spent moving staged files into the installation location.

NumAbortedDownloads

description: The number of chunks we aborted as they were determined as taking too long.

NumBadDownloads

description: The number of chunks we received but were determined bad data.

NumChunkDbChunksFailed

description: The number of chunks that were not successfully loaded from provided chunkdbs.

NumChunksDownloaded

description: The total number of chunks that were downloaded.

NumChunksReadFromChunkDbs

description: The number of chunks successfully read from chunkdbs.

NumChunksRecycled

description: The number of chunks successfully recycled.

NumChunksRequired

description: The total number of chunks making up those files.

NumChunksStoreBooted

description: The number of chunks that had to be booted from the memory stores.

NumDriveStoreChunkLoads

description: The number of chunks that had to be loaded from the drive store.

NumDriveStoreLoadFailures

description: The number of chunks that failed to load from the drive store.

NumFailedDownloads

description: The number of chunks we did not successfully receive.

NumFilesConstructed

description: The total number of files constructed.

NumFilesInBuild

description: The total number of files in the build.

NumFilesOutdated

description: The total number of files outdated.

NumFilesToRemove

description: The total number of files in the previous build that can be deleted.

NumInstallRetries

description: The number of times the system looped to retry.

NumRecycleFailures

description: The number of chunks that failed to be recycled from existing build.

OkDownloadHealthTime

description: The amount of time that was spent with OK download health.

OverallRequestSuccessRate

description: The overall rate of success for download requests.

PeakDiskReadSpeed

description: The peak disk read speed.

PeakDiskWriteSpeed

description: The peak disk write speed.

PeakDownloadSpeed

description: The peak chunk download speed.

PeakMemoryStoreRetained

description: PeakMemoryStoreRetained.

PeakMemoryStoreUse

description: PeakMemoryStoreUse.

PoorDownloadHealthTime

description: The amount of time that was spent with Poor download health.

PrereqTime

description: The time spent during the prerequisite stage.

ProcessActiveTime

description: The amount of time that was spent active (un-paused).

ProcessAvailableDiskSpace

description: The total number of bytes available at the time of checking ProcessRequiredDiskSpace.

ProcessExecuteTime

description: The total time that the install process took to complete.

ProcessPausedTime

description: The amount of time that was spent paused.

ProcessRequiredDiskSpace

description: The total number of bytes required to start the installation.

ProcessSuccess

description: Whether the process was successful.

RetryFailureTypes

type: TArray< EBuildP...

TheoreticalDownloadTime

description: The theoretical download time (data/speed).

TotalDownloadedData

description: The total number of bytes downloaded.

TotalReadData

description: The total number of bytes read to disk.

TotalWrittenData

description: The total number of bytes written to disk.

VerifyTime

description: The time spent during the verification stage.


className: FBuildPatchStreamResult

code: struct FBuildPatchStreamResult


className: FDownload

description: A struct representing a download.

code: struct FDownload

Data

description: The uri for the download.

Received

description: The amount of data received so far.

Size

description: The size of the download.


code: FFileOperation ( [FString](API\Runtime\Core\Containers\FString) Filename, const [FGuid](API\Runtime\Core\Misc\FGuid) & DataId, uint64 Offest, uint64 Size, [EFileOperationState](API\Runtime\BuildPatchServices\Interfaces\BuildPatchServices__EFileOperati-) CurrentState )


className: FFileOperation

description: A struct representing a file operation to be completed.

code: struct FFileOperation

CurrentState

type: EFileOperationS...

description: The current state of this operation.

DataId

type: FGuid

description: The idea of the chunk where the data is taken from.

Filename

description: The build filename where this data section goes.

Offest

description: The offset into the file.

description: The size of the data to write.


description: Cancel the current install

code: void CancelInstall()


description:
Get whether the process was successfully complete, meaning no errors, and was not cancelled. Only valid if complete.
true if installation process completed successfully.

code: bool CompletedSuccessfully() const


description:
Get the installation configuration object
a const reference to the configuration

code: const [BuildPatchServices::FBuildInstallerConfiguration](API\Runtime\BuildPatchServices\FBuildInstallerConfiguration) & GetConfiguration() const


description:
Get the current download health rating.
the enum representing the download health


description:
Get the download speed for the current process
download speed progress

code: double GetDownloadSpeed() const


description: Deprecated* GetDownloadSpeedText has been deprecated. It will no longer be supported in the future.


description:
Get the installation error code. This includes the failure type as well as specific code associated. The value is alphanumeric. This is only guaranteed to be set once the installation has completed.
the code as a string.


description:
Get the display text for the error that occurred. Only valid to call after completion
display error text


description:
Get the type of error for a failure that has occurred.
the enum representing the type of error


description: Deprecated* GetInitialDownloadSize has been deprecated. Please use GetTotalDownloadRequired instead.

code: virtual int64 GetInitialDownloadSize() const


description: Deprecated* GetPercentageText has been deprecated. It will no longer be supported in the future.


description:
Get the status of the install process.
Status of the install process.


description:
Get the build stats for the process. This should only be called after the install has completed
A struct containing information about the build


description: Deprecated* GetStatusText has been deprecated. It will no longer be supported in the future.


description:
Get the total download bytes required to complete
the total required bytes

code: int64 GetTotalDownloadRequired() const


description:
Get the total bytes downloaded
the total bytes downloaded

code: int64 GetTotalDownloaded() const


description:
Get the update progress
A float describing progress: Between 0 and 1 for known progress, or less than 0 for unknown progress.

code: float GetUpdateProgress() const


description:
Get whether the install was canceled. Only valid if complete.
true if installation was canceled

code: bool IsCanceled() const


description:
Get whether the install failed. Only valid if complete.
true if installation was a failure

code: bool HasError() const


description:
Get whether the install has complete
true if the thread completed

code: bool IsComplete() const


description:
Get whether the install is currently paused.
true if installation is paused

code: bool IsPaused() const


description:
Get whether the install can be resumed.
true if installation is resumable

code: bool IsResumable() const


description:
Get whether the install is performing an update of an existing install.
true if installation is an update

code: bool IsUpdate() const


description: Registers a message handler with the installer.

code: void RegisterMessageHandler ( [BuildPatchServices::FMessageHandler](API\Runtime\BuildPatchServices\FMessageHandler) * MessageHandler )


description:
Begin the installation process.
true if the installation started successfully, or is already running.

code: bool StartInstallation()


description:
Toggle the install paused state
true if the installer is now paused

code: bool TogglePauseInstall()


description: Unregisters a message handler, will no longer receive HandleMessage calls.

code: void UnregisterMessageHandler ( [BuildPatchServices::FMessageHandler](API\Runtime\BuildPatchServices\FMessageHandler) * MessageHandler )


description: Virtual destructor.

code: virtual ~IBuildInstaller()


className: IBuildInstaller

description: Interface to a Build Installer, exposes installation control, progress, and state information.

code: class IBuildInstaller


description: Copy the custom fields from another manifest into this one. If this manifest has custom fields, matching keys will be overwritten but extras will remain

code: void CopyCustomFields ( const IBuildManifestRef & Other, bool bClobber )


description:
Duplicated this manifest to create a copy. Should be used if storing a received manifest as an installed manifest which would then be unique
A shared ref to the new manifest

code: IBuildManifestRef Duplicate() const


description:
Get the App ID that this manifest belongs to
the app ID

code: uint32 GetAppID() const


description:
Get the name of the App that this manifest belongs to
the app name

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


description:
Get the list of files in this build. Filenames are all relative to an install directory
an array containing build files

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetBuildFileList() const


description:
Get the list of files in this build which match a tag from a given set. Filenames are all relative to an install directory
an array containing build files

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetBuildFileList ( const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & Tags ) const


description:
Get the list of files in this build. Filenames are all relative to an install directory. Filenames returned are a view over memory owned by the BuildManifest
an array containing build files

code: [TArray](API\Runtime\Core\Containers\TArray)< FStringView > GetBuildFileListView() const


description:
Get the size of this build
the build size in bytes

code: int64 GetBuildSize() const


description:
Get the size of the build of this set of tags
the build size of the tags in bytes

code: int64 GetBuildSize ( const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & Tags ) const


description:
Get a custom field from the manifest
An interface to the field

code: const IManifestFieldPtr GetCustomField ( const [FString](API\Runtime\Core\Containers\FString) & FieldName ) const


description:
Get the size of the download of this set of tags
the minimum download size required in bytes

code: int64 GetDeltaDownloadSize ( const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & Tags, const IBuildManifestRef & PreviousVersion ) const


code: int64 GetDeltaDownloadSize ( const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & Tags, const IBuildManifestRef & PreviousVersion, const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & PreviousTags ) const


description:
Get the size of this download, assuming fresh install
the total download size in bytes

code: int64 GetDownloadSize() const


description:
Get the size of the download of this set of tags
the download size of the tags in bytes

code: int64 GetDownloadSize ( const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & Tags ) const


description:
Gets the file hash for a given file
true if we had the hash for this file

code: bool GetFileHash ( const [FString](API\Runtime\Core\Containers\FString) & Filename, [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & OutHash ) const


description:
Returns the size of a particular file in the build
the file size.

code: int64 GetFileSize ( const [FString](API\Runtime\Core\Containers\FString) & Filename ) const


description:
Returns the total size of all files in the array
the total size of files in array.

code: int64 GetFileSize ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Filenames ) const


description:
Returns the total size of all files in the set
the total size of files in set.

code: int64 GetFileSize ( const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & Filenames ) const


description:
Get the list of install tags in this manifest
the tags referenced.

code: [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > GetFileTagList() const


description: Get the list of install tags in this manifest

code: void GetFileTagList ( [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & Tags ) const


description:
Get the command line arguments that the launch exe should be ran with
the launch command line

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


description: Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.

code: void GetOutdatedFiles ( const IBuildManifestRef & OldManifest, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & OutdatedFiles ) const


description:
Get the command line arguments that should be passed to the prerequisites installer
the prerequisites installer command line arguments

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


description:
Get the list of prereq ids that the prereq installer of this manifest satisfies
the set containing the prereq ids.

code: const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & GetPrereqIds() const


description:
Get the path to the prerequisites installer exe
local path to the prerequisites installer

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


description:
Get the name of the prerequisites installer for the app
the prerequisites installer name

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


code: void GetRemovableFiles ( const IBuildManifestRef & OldManifest, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & RemovableFiles ) const


description: Gets a list of files that are installed in InstallPath, but no longer required by this Manifest.

code: void GetRemovableFiles ( const TCHAR * InstallPath, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & RemovableFiles ) const


description:
Get the string App version that this manifest describes
the version string

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


description:
Checks the manifest format version to see if this manifest was loaded from latest data
True if the manifest was created from the latest format

code: bool NeedsResaving() const


description: Remove a custom field from the manifest

code: void RemoveCustomField ( const [FString](API\Runtime\Core\Containers\FString) & FieldName )


description:
Various functions for setting a custom field in the manifest
An interface to the field that was created

code: const IManifestFieldPtr SetCustomField ( const [FString](API\Runtime\Core\Containers\FString) & FieldName, const [FString](API\Runtime\Core\Containers\FString) & Value )


code: const IManifestFieldPtr SetCustomField ( const [FString](API\Runtime\Core\Containers\FString) & FieldName, const double & Value )


code: const IManifestFieldPtr SetCustomField ( const [FString](API\Runtime\Core\Containers\FString) & FieldName, const int64 & Value )


description:
Get the local install path to the exe that launches the App
local path to the launch exe

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


description: Call to force the exit out of all current installers, optionally blocks until threads have exited and complete delegates are called.

code: void CancelAllInstallers ( bool WaitForThreads )


className: IBuildManifest

description: Interface to a Build Manifest.

code: class IBuildManifest


description:
Processes a Build directory to create chunks for new data and produce a manifest, saved to the provided cloud directory. NOTE: This function is blocking and will not return until finished.
true if successful.

code: bool ChunkBuildDirectory ( const [BuildPatchServices::FChunkBuildConfiguration](API\Runtime\BuildPatchServices\FChunkBuildConfiguration) & Configuration )


description:
Processes a Cloud Directory to identify and delete any orphaned chunks or files. NOTE: THIS function is blocking and will not return until finished.
true if successful.

code: bool CompactifyCloudDirectory ( const [BuildPatchServices::FCompactifyConfiguration](API\Runtime\BuildPatchServices\FCompactifyConfiguration) & Configuration )


description:
Factory providing construction of a build streamer class.
an instance of anIBuildInstallStreamerimplementation.

code: IBuildInstallStreamerRef CreateBuildInstallStreamer ( [BuildPatchServices::FBuildInstallStreamerConfiguration](API\Runtime\BuildPatchServices\FBuildInstallStreamerConfigurati-) Configuration )


description:
Factory providing construction of a build installer class.
an instance of anIBuildInstallerimplementation.

code: IBuildInstallerRef CreateBuildInstaller ( [BuildPatchServices::FBuildInstallerConfiguration](API\Runtime\BuildPatchServices\FBuildInstallerConfiguration) Configuration, FBuildPatchInstallerDelegate OnComplete ) const


description:
Factory providing construction of a build statistics class.
an instance of an IBuildStatistics implementation.

code: [BuildPatchServices::IBuildStatisticsRef](API\Runtime\BuildPatchServices\Interfaces\IBuildStatisticsRef) CreateBuildStatistics ( const IBuildInstallerRef & Installer ) const


description: Virtual destructor.

code: virtual ~IBuildManifest()


description:
Factory providing construction of a patch data enumeration class.
an instance of an IPatchDataEnumeration implementation.


description:
Takes two manifests as input and outputs the details of the patch. NOTE: THIS function is blocking and will not return until finished. Don't run on main thread.
true if successful.

code: bool DiffManifests ( const [BuildPatchServices::FDiffManifestsConfiguration](API\Runtime\BuildPatchServices\FDiffManifestsConfiguration) & Configuration )


description:
Saves info for an enumeration of patch data referenced from an input file of known format, to a specified output file. NOTE: THIS function is blocking and will not return until finished.
true if successful.

code: bool EnumeratePatchData ( const [BuildPatchServices::FPatchDataEnumerationConfiguration](API\Runtime\BuildPatchServices\FPatchDataEnumerationConfigurati-) & Configuration )


className: FSimpleEvent

description: Returns an event which fires when we start a new build install.

code: class FSimpleEvent : public TBaseMulticastDelegate_NoParams< void >


description: Deprecated* Please use ChunkBuildDirectory instead.

code: virtual bool GenerateChunksManifestFromDirectory ( const [BuildPatchServices::FGenerationConfiguration](API\Runtime\BuildPatchServices\FGenerationConfiguration) & Configuration )


description:
Gets an array of prerequisite identifiers that are registered as installed on this system.
a set containing all installed prerequisite identifiers.

code: [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > GetInstalledPrereqIds() const


description:
Gets a list of currently active installers
all installers that are currently active.

code: const [TArray](API\Runtime\Core\Containers\TArray)< IBuildInstallerRef > & GetInstallers() const


description:
Loads a Build Manifest from file and returns the interface
a shared pointer to the manifest, which will be invalid if load failed.

code: IBuildManifestPtr LoadManifestFromFile ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Deprecated*MakeManifestFromJSON(const FString& ManifestJSON)has been deprecated. Please useMakeManifestFromData(const TArray& ManifestData)instead.

code: IBuildManifestPtr MakeManifestFromJSON ( const [FString](API\Runtime\Core\Containers\FString) & ManifestJSON )


description:
Constructs a Build Manifest from a data
a shared pointer to the manifest, which will be invalid if creation failed.

code: IBuildManifestPtr MakeManifestFromData ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & ManifestData )


description:
Takes two manifests as input, in order to merge together producing a new manifest containing all files. NOTE: THIS function is blocking and will not return until finished. Don't run on main thread.
true if successful.

code: bool MergeManifests ( const [FString](API\Runtime\Core\Containers\FString) & ManifestFilePathA, const [FString](API\Runtime\Core\Containers\FString) & ManifestFilePathB, const [FString](API\Runtime\Core\Containers\FString) & ManifestFilePathC, const [FString](API\Runtime\Core\Containers\FString) & NewVersionString, const [FString](API\Runtime\Core\Containers\FString) & SelectionDetailFilePath )


description:
Process a pair of manifests to produce additional delta data which reduces the patch directly between them. NOTE: This function is blocking and will not return until finished.
true if successful.

code: bool OptimiseChunkDelta ( const [BuildPatchServices::FChunkDeltaOptimiserConfiguration](API\Runtime\BuildPatchServices\FChunkDeltaOptimiserConfiguratio-) & Configuration )


description:
Packages data referenced by a manifest file into chunkdb files, supporting a maximum filesize per chunkdb. NOTE: THIS function is blocking and will not return until finished. Don't run on main thread.
true if successful.

code: bool PackageChunkData ( const [BuildPatchServices::FPackageChunksConfiguration](API\Runtime\BuildPatchServices\FPackageChunksConfiguration) & Configuration )


description: Registers an installation on this machine. This information is used to gather a list of install locations that can be used as chunk sources.

code: void RegisterAppInstallation ( IBuildManifestRef AppManifest, const [FString](API\Runtime\Core\Containers\FString) AppInstallDirectory )


description:
Saves a Build Manifest to file
If the save was successful.

code: bool SaveManifestToFile ( const [FString](API\Runtime\Core\Containers\FString) & Filename, IBuildManifestRef Manifest )


description: Sets the Analytics provider that will be used to register errors with patch/build installs

code: void SetAnalyticsProvider ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProvider](API\Runtime\Analytics\Interfaces\IAnalyticsProvider) > AnalyticsProvider )


description: Sets the backup directory where files that are being clobbered by repair/patch will be placed.

code: void SetBackupDirectory ( const [FString](API\Runtime\Core\Containers\FString) & BackupDir )


description: Sets the cloud directory where chunks and manifests will be pulled from and saved to.

code: void SetCloudDirectory ( [FString](API\Runtime\Core\Containers\FString) CloudDir )


description: Sets the cloud directory list where chunks and manifests will be pulled from and saved to. When downloading, if we get a failure, we move on to the next cloud option for that request.

code: void SetCloudDirectories ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > CloudDirs )


description: Sets the directory used for staging intermediate files.

code: void SetStagingDirectory ( const [FString](API\Runtime\Core\Containers\FString) & StagingDir )


description: Deprecated*StartBuildInstall(BuildPatchServices::FInstallerConfiguration, FBuildPatchBoolManifestDelegate)has been deprecated. Please use CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration, FBuildPatchInstallerDelegate) instead, followed byIBuildInstaller::StartInstallation.

code: IBuildInstallerRef StartBuildInstall ( [BuildPatchServices::FInstallerConfiguration](API\Runtime\BuildPatchServices\FInstallerConfiguration) Configuration, FBuildPatchBoolManifestDelegate OnCompleteDelegate )


description: Deprecated*StartBuildInstall(IBuildManifestPtr, IBuildManifestPtr, const FString&, FBuildPatchBoolManifestDelegate, bool, TSet)has been deprecated. Please use CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration, FBuildPatchInstallerDelegate) instead, followed byIBuildInstaller::StartInstallation.

code: IBuildInstallerPtr StartBuildInstall ( IBuildManifestPtr CurrentManifest, IBuildManifestPtr InstallManifest, const [FString](API\Runtime\Core\Containers\FString) & InstallDirectory, FBuildPatchBoolManifestDelegate OnCompleteDelegate, bool bIsRepair, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > InstallTags )


description: Deprecated*StartBuildInstallStageOnly(IBuildManifestPtr, IBuildManifestPtr, const FString&, FBuildPatchBoolManifestDelegate, bool, TSet)has been deprecated. Please use CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration, FBuildPatchInstallerDelegate) instead, followed byIBuildInstaller::StartInstallation.

code: IBuildInstallerPtr StartBuildInstallStageOnly ( IBuildManifestPtr CurrentManifest, IBuildManifestPtr InstallManifest, const [FString](API\Runtime\Core\Containers\FString) & InstallDirectory, FBuildPatchBoolManifestDelegate OnCompleteDelegate, bool bIsRepair, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > InstallTags )


description:
Unregisters an installation on this machine
returns true if successfully removed installation directory

code: bool UnregisterAppInstallation ( const [FString](API\Runtime\Core\Containers\FString) AppInstallDirectory )


description:
Searches a given directory for chunk and chunkdb files, and verifies their integrity uses the hashes in the files. NOTE: THIS function is blocking and will not return until finished. Don't run on main thread.
true if successful and no corruptions detected.

code: bool VerifyChunkData ( const [FString](API\Runtime\Core\Containers\FString) & SearchPath, const [FString](API\Runtime\Core\Containers\FString) & OutputFile )


description: Virtual destructor.

code: virtual ~IBuildPatchServicesModule()


className: IBuildPatchServicesModule

description: Interface for the services manager.

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


description: the total install size for the installation.

code: int64 GetBuildSize() const


description: the current chunkdb read speed in bytes per second.

code: double GetChunkDbReadByteSpeed() const


description: Deprecated* Please use GetMemoryChunkStoreSize instead.

code: virtual int32 GetCloudMemoryChunkStoreSize() const


description: Deprecated* Please use GetMemoryChunksBooted instead.

code: virtual int32 GetCloudMemoryChunksBooted() const


description: Deprecated* Please use GetMemoryChunksInStore instead.

code: virtual int32 GetCloudMemoryChunksInStore() const


description: Deprecated* Please use GetMemoryChunksRetained instead.

code: virtual int32 GetCloudMemoryChunksRetained() const


description: the configuration used when constructing the installer.

code: const [FBuildInstallerConfiguration](API\Runtime\BuildPatchServices\FBuildInstallerConfiguration) & GetConfiguration() const


description: an array of currently active downloads.

code: [TArray](API\Runtime\Core\Containers\TArray)< [FDownload](API\Runtime\BuildPatchServices\Interfaces\FDownload) > GetCurrentDownloads() const


description: the filename of the file currently being worked on.


description: the progress of the file currently being worked on.


description: the chunk ID currently being used to write the current file.


description: the current disk write speed in bytes per second.

code: double GetDiskWriteByteSpeed() const


description: the current disk read speed in bytes per second.

code: double GetDiskReadByteSpeed() const


description: the current download speed in bytes per second.

code: double GetDownloadByteSpeed() const


description: the total download size for the installation.

code: int64 GetDownloadSize() const


code: virtual int32 GetInstallMemoryChunkStoreSize() const


description: an array containing the states for all file write operations being performed by this installation.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FFileOperation](API\Runtime\BuildPatchServices\Interfaces\FFileOperation) > & GetFileOperationStates() const


code: virtual int32 GetInstallMemoryChunksInStore() const


code: virtual int32 GetInstallMemoryChunksBooted() const


code: virtual int32 GetInstallMemoryChunksRetained() const


description: the number of chunks that have been booted from the memory store.

code: int32 GetMemoryChunksBooted() const


description: the number of chunks currently in the memory store which are held due to multiple referencing.

code: int32 GetMemoryChunksRetained() const


description: the number of chunks currently in the memory store.

code: int32 GetMemoryChunksInStore() const


description: the total number of verify errors experienced during this installation.

code: int32 GetNumVerifyErrors() const


description: the verify error counts per error type experienced during this installation.

code: [TMap](API\Runtime\Core\Containers\TMap)< [EVerifyError](API\Runtime\BuildPatchServices\BuildPatchServices__EVerifyError), int32 > GetVerifyErrorCounts() const


description: the size in chunks of the memory store.

code: int32 GetMemoryChunkStoreSize() const


description: true if there are downloads currently active.

code: bool IsDownloadActive() const


description: true if the current operation is creating or opening files.


description: true if currently writing data to disk.

code: bool IsHardDiskActiveWrite() const


description: true if currently reading data from disk.

code: bool IsHardDiskActiveRead() const


description: Virtual destructor.

code: virtual ~IBuildStatistics()


className: IBuildStatistics

description: An interface for accessing runtime statistical information about an installer.

code: class IBuildStatistics


description:
Get the fields value as a double.
The double value.

code: double AsDouble() const


description:
Get the fields value as an int.
The int value.

code: int64 AsInteger() const


className: IManifestField

description: Interface to a manifest field, which is used for accessing custom fields in the manifest

code: class IManifestField


description:
Get the fields value as anFString.
The string value.


description: Virtual destructor.

code: virtual ~IManifestField()


code: namespace InstallErrorPrefixes { static InstallErrorPrefixes::ErrorTypeStrings = { TEXT("OK"), TEXT("DL"), TEXT("FC"), TEXT("MF"), TEXT("BV"), TEXT("SD"), TEXT("FA"), TEXT("UC"), TEXT("PQ"), TEXT("IZ"), TEXT("PL"), TEXT("DS"), }; }


description:
Enumerates the data files used and outputs them to the OutputFile specified in the configuration
Success

code: bool Run()


description:
Enumerates the data files used and outputs them into the array provided
Success

code: bool Run ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFiles )


code: virtual ~IPatchDataEnumeration()


className: IPatchDataEnumeration

code: class IPatchDataEnumeration


className: IPatchDataEnumerationPtr


className: IPatchDataEnumerationRef


className: RangeType

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


code: static constexpr underlying_type &40; BuildPatchServices::EVerifyError &41;


code: namespace TEnumRangeTraits< BuildPatchServices { template<> struct TEnumRangeTraits< BuildPatchServices::EVerifyError > }


module: CADKernel

code: void AddEntityFromArchive ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > & Entity )


code: template<typename EntityType> void AddEntityFromArchive ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< EntityType > & Entity )


code: void AddEntityToSave ( FIdent Id )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) > CreateArchiveReader ( [FSession](API\Runtime\CADKernel\CADKernel\Core\FSession) & InSession, const TCHAR * FileName )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) > CreateArchiveWriter ( [FSession](API\Runtime\CADKernel\CADKernel\Core\FSession) & InSession, const TCHAR * FileName )


code: template<typename EntityType> void operator<< ( EntityType & Entity )


code: template<typename EntityType> void Serialize ( [TArray](API\Runtime\Core\Containers\TArray)< EntityType > & EntityArray )


code: template<typename EntityType> void Serialize ( EntityType & EntityArray )


code: void Serialize ( void * Value, int64 Length )


code: void SetReferencedEntityOrAddToWaitingList ( FIdent ArchiveId, [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) ** Entity )


code: void SetReferencedEntityOrAddToWaitingList ( FIdent ArchiveId, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > & Entity )


code: void SetReferencedEntityOrAddToWaitingList ( FIdent ArchiveId, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > & Entity )


description: Archive reader constructor

code: FCADKernelArchive ( [FSession](API\Runtime\CADKernel\CADKernel\Core\FSession) & InSession, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InRawData )


code: FCADKernelArchive ( [FSession](API\Runtime\CADKernel\CADKernel\Core\FSession) & InSession, [FArchive](API\Runtime\Core\Serialization\FArchive) & InArchive )


className: FCADKernelArchive

code: class FCADKernelArchive

Archive

type: FArchive&

ArchiveModel

type: FModel*

MemoryReader

type: TUniquePtr<FMe...

Session

type: FSession&


code: template<typename Unit> static int64 ConvertInto ( [FDuration](API\Runtime\CADKernel\CADKernel\Core\FDuration) Duration )


code: static const [FDuration](API\Runtime\CADKernel\CADKernel\Core\FDuration) Elapse ( [FTimePoint](API\Runtime\CADKernel\CADKernel\Core\FTimePoint) StartTime )


code: static const [FDuration](API\Runtime\CADKernel\CADKernel\Core\FDuration) Init()


code: static const [FTimePoint](API\Runtime\CADKernel\CADKernel\Core\FTimePoint) Now()


code: static void PrintClockElapse ( [EVerboseLevel](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EVerboseLevel) Level, const TCHAR * Indent, const TCHAR * Process, [FDuration](API\Runtime\CADKernel\CADKernel\Core\FDuration) Duration, [ETimeUnit](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__ETimeUnit) Unit )


description: All Entities are saved in the session map that allows to retrieve them according to their Id This process is automatically done during the entity creation (FEntity::MakeShared)

code: void AddEntity ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > Entity )


description: During the load of anFArchive: All Entities are saved in the session map (like Entity created in runtime) that allows to retrieve them according to their Id. Archive's entities are also saved in a temporary map for the load purpose (c.f.FEntity::Serialize) This process is automatically done during the entity creation (FEntity::MakeShared)

code: void AddEntityFromArchive ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > Entity )


description: Dedicated method for SerializeSelection

code: void AddEntityToSave ( FIdent EntityId )


code: void CadEntitiesSelection ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Entities, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & OutCadEntities ) const


description: Method to clean entity descriptions i.e. removing invalid references (like unsaved linked edges of an edge because the neighbor topological face is not saved)

code: void CleanArchiveEntities()


code: void Deserialize ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar )


description: Delete all the entities of the session

code: void Empty()


code: void ExpandSelection ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > Entities, const [TSet](API\Runtime\Core\Containers\TSet)< [EEntity](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EEntity) > & Filter, [TSet](API\Runtime\Core\Containers\TSet)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & OutSelection ) const


code: void ExpandSelection ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Entities, const [TSet](API\Runtime\Core\Containers\TSet)< [EEntity](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EEntity) > & Filter, [TSet](API\Runtime\Core\Containers\TSet)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & OutSelection ) const


code: void ExpandSelection ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Entities, const [TSet](API\Runtime\Core\Containers\TSet)< [EEntity](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EEntity) > & Filter, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & OutSelection ) const


code: void GetEntities ( const [TArray](API\Runtime\Core\Containers\TArray)< FIdent > & ids, [TArray](API\Runtime\Core\Containers\TArray)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) * > & Entities ) const


code: void GetEntitiesOfType ( [EEntity](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EEntity) Type, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & OutEntities ) const


code: void GetEntitiesOfTypes ( const [TSet](API\Runtime\Core\Containers\TSet)< [EEntity](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EEntity) > & Types, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & OutEntities ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > GetEntity ( FIdent id ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > GetFirstEntityOfType ( [EEntity](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EEntity) Type ) const


code: void GetEntities ( const [TArray](API\Runtime\Core\Containers\TArray)< FIdent > & ids, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Entities ) const


code: void GetTopologicalEntities ( const [TArray](API\Runtime\Core\Containers\TArray)< FIdent > & ids, [TArray](API\Runtime\Core\Containers\TArray)< [FTopologicalEntity](API\Runtime\CADKernel\CADKernel\Topo\FTopologicalEntity) * > & Entities ) const


code: void GetTopologicalShapeEntities ( const [TArray](API\Runtime\Core\Containers\TArray)< FIdent > & ids, [TArray](API\Runtime\Core\Containers\TArray)< [FTopologicalShapeEntity](API\Runtime\CADKernel\CADKernel\Topo\FTopologicalShapeEntity) * > & Entities ) const


code: void MeshEntitiesSelection ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Entities, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & OutMeshEntities ) const


description: Remove from database

code: void RemoveEntity ( FIdent idEntity )


description: Remove from database

code: void RemoveEntity ( [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) & Entity )


description: All entities of the session are saved in the archive

code: void Serialize ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar )


description: Recursive serialization of a selection. The selection and all the dependencies are serialized. All entities that need to be saved (added in EntitiesToBeSerialized set) for the completeness of the archive are added to the queue of entities to Serialized (NotYetSerialized).

code: void SerializeSelection ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, const [TArray](API\Runtime\Core\Containers\TArray)< FIdent > & SelectionIds )


description: Find TSharedPtrassociate to an Archive Id If the Entity is not yet created, add the entity in the waiting list

code: void SetReferencedEntityOrAddToWaitingList ( FIdent ArchiveId, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > & Entity )


description: Find TWeakPtrassociate to an Archive Id If the Entity is not yet created, add the entity in the waiting list

code: void SetReferencedEntityOrAddToWaitingList ( FIdent ArchiveId, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > & Entity )


description: Find FEntity* associate to an Archive Id If the Entity is not yet created, add the entity in the waiting list

code: void SetReferencedEntityOrAddToWaitingList ( FIdent ArchiveId, [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) ** Entity )


code: uint32 SpawnEntityIdents ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & SelectedEntities, bool bForceSpawning )


code: uint32 SpawnEntityIdent ( [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) & SelectedEntity, bool bForceSpawning )


code: uint32 SpawnEntityIdents ( const [TArray](API\Runtime\Core\Containers\TArray)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) * > & SelectedEntities, bool bForceSpawning )


code: void TopologicalEntitiesSelection ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Entities, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTopologicalEntity](API\Runtime\CADKernel\CADKernel\Topo\FTopologicalEntity) >> & OutTopoEntities, bool bFindSurfaces, bool bFindEdges, bool bFindVertices ) const


className: FDatabase

code: class FDatabase

ArchiveEntities

type: TArray<TShared...

description: Array (use as a Map>) of all the entities of an archive Each Entity is at the index of AchiveId in the array

ArchiveIdToWaitingPointers

type: TArray<TArray<...

ArchiveIdToWaitingSharedPointers

description: Array (use as a MapTArray*>>) Some Entity reference an other Entities (with aTSharedPtr).

AvailableIdents

type: TArray< FIdent ...

description: Recycling of the Id to avoid fragmented idents

DatabaseEntities

description: Array (use as a Map>) of all the entities create during the session Each Entity.Id is the index of the entity in the array

EntitiesToBeSerialized

type: TSet< FIdent >

description: Dedicated to SerializeSelection. Set of entity Ids needed to be saved

Model

type: TSharedPtr<FMo...

description: RootGeometry Entity node

NotYetSerialized

type: TQueue< FIdent ...

description: Dedicated to SerializeSelection. Queue of entity Ids waiting to be saved


className: FDuration

code: typedef uint64 FDuration


description: Deserialize the next entity in the archive.

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > Deserialize ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar )


code: const TCHAR * GetTypeName() const


code: static const TCHAR * GetTypeName ( [EEntity](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EEntity) Type )


code: bool IsTopologicalEntity() const


code: bool IsTopologicalShapeEntity() const


code: template<typename OtherEntity, typename... InArgTypes> static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< OtherEntity > MakeShared ( InArgTypes &&... Args )


code: template<typename OtherEntity> static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< OtherEntity > MakeShared ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Archive )


code: virtual void ResetMarkersRecursively() const


description: Reset Processed flags Recursively on each TSharedPtrof the array

code: static void ResetMarkersRecursivelyOnEntities ( const [TArray](API\Runtime\Core\Containers\TArray)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) * > & Array )


code: static void ResetMarkersRecursivelyOnEntities ( const [TArray](API\Runtime\Core\Containers\TArray)< [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Array )


code: static void ResetMarkersRecursivelyOnEntities ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Array )


description: Serialization of aFEntity. Each class derived fromFEntityhas to override this method (and call the direct base class override method first) E.g. class FEntityXXX : public FEntityXX { virtual voidSerialize(FCADKernelArchive& Ar)override { FEntityXX::Serialize(Ar); ... } }

code: virtual void Serialize ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar )


code: template<typename EntityType> static void ResetMarkersRecursivelyOnEntities ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< EntityType >> & Array )


description: To Serialize a TSharedPtr, the Id of theFEntityis saved in the archive (ArchiveId). At the deserialization of the archive, a map is build linking ArchiveId to theTSharedPtrof the deserialized entities. At the deserialization of a TSharedPtr, the ArchiveId of the TSharedPtris get. The map return the associatedTSharedPtr. If the Entity is not yet deserialized, theTSharedPtris add to a waiting list to be set as soon as the associated Entity is deserialized SeeFDatabasefor more details

code: static void SerializeIdent ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > & Entity, bool bSaveSelection )


code: static void ResetMarkersRecursivelyOnEntities ( const [TArray](API\Runtime\Core\Containers\TArray)< [TOrientedEntity](API\Runtime\CADKernel\CADKernel\Core\TOrientedEntity)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Array )


code: static void SerializeIdent ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) ** Entity, bool bSaveSelection )


code: template<typename EntityType> static void SerializeIdent ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, EntityType ** Entity, bool bSaveSelection )


code: template<typename EntityType> static void SerializeIdent ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< EntityType > & Entity, bool bSaveSelection )


code: template<typename EntityType> static void SerializeIdent ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< EntityType > & Entity, bool bSaveSelection )


description: SerializeIdent of each TSharedPtrof the array

code: static void SerializeIdents ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TArray](API\Runtime\Core\Containers\TArray)< [TOrientedEntity](API\Runtime\CADKernel\CADKernel\Core\TOrientedEntity)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Array )


code: static void SerializeIdents ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TArray](API\Runtime\Core\Containers\TArray)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) * > & Array, bool bSaveSelection )


code: static void SerializeIdents ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TArray](API\Runtime\Core\Containers\TArray)< [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Array, bool bSaveSelection )


code: template<typename EntityType> static void SerializeIdents ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TArray](API\Runtime\Core\Containers\TArray)< EntityType * > & Array, bool bSaveSelection )


code: static void SerializeIdents ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Array, bool bSaveSelection )


code: template<typename EntityType> static void SerializeIdents ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TArray](API\Runtime\Core\Containers\TArray)< [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< EntityType >> & Array, bool bSaveSelection )


code: template<typename EntityType> static void SerializeIdents ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< EntityType >> & Array, bool bSaveSelection )


code: static void SerializeIdent ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > & Entity, bool bSaveSelection )


code: bool SetId ( [FDatabase](API\Runtime\CADKernel\CADKernel\Core\FDatabase) & Database )


code: virtual void SpawnIdent ( [FDatabase](API\Runtime\CADKernel\CADKernel\Core\FDatabase) & Database )


description: Spawn Ident on each FEntity* of the array

code: static void SpawnIdentOnEntities ( [TArray](API\Runtime\Core\Containers\TArray)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) * > & Array, [FDatabase](API\Runtime\CADKernel\CADKernel\Core\FDatabase) & Database )


description: Spawn Ident on each TSharedPtrof the array

code: static void SpawnIdentOnEntities ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Array, [FDatabase](API\Runtime\CADKernel\CADKernel\Core\FDatabase) & Database )


code: static void SpawnIdentOnEntities ( [TArray](API\Runtime\Core\Containers\TArray)< [TOrientedEntity](API\Runtime\CADKernel\CADKernel\Core\TOrientedEntity)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Array, [FDatabase](API\Runtime\CADKernel\CADKernel\Core\FDatabase) & Database )


code: template<typename EntityType> static void SpawnIdentOnEntities ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< EntityType >> & Array, [FDatabase](API\Runtime\CADKernel\CADKernel\Core\FDatabase) & Database )


className: TypesNames

code: static const TCHAR * TypesNames = { TEXT("UndefinedEntity"), TEXT("Curve"), TEXT("Surface"), TEXT("Edge Link"), TEXT("Vertex Link"), TEXT("Edge"), TEXT("Face"), TEXT("Link"), TEXT("Loop"), TEXT("Vertex"), TEXT("Shell"), TEXT("Body"), TEXT("Model"), TEXT("Mesh Model"), TEXT("Mesh"), TEXT("Group"), TEXT("Criterion"), TEXT("Property"), nullptr };


className: FEntity

code: class FEntity : public [TSharedFromThis< FEntity >](API\Runtime\Core\Templates\TSharedFromThis), public [UE::CADKernel::FHaveStates](API\Runtime\CADKernel\CADKernel\Core\FHaveStates)

Id

type: FIdent


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntityGeom](API\Runtime\CADKernel\CADKernel\Core\FEntityGeom) > ApplyMatrix ( const [FMatrixH](API\Runtime\CADKernel\CADKernel\Math\FMatrixH) & InMatrix ) const


code: virtual void Serialize ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar )


className: FEntityGeom

code: class FEntityGeom : public [UE::CADKernel::FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity)


description: Return ((States & EHaveStates::HasMarker3) == EHaveStates::HasMarker3);

code: bool HasMarker1And2() const


code: virtual bool IsDegenerated() const


code: virtual bool IsDeletedOrDegenerated() const


code: virtual bool IsNotToOrAlreadyProcess() const


code: virtual bool IsNotToProcess() const


code: virtual bool IsProcessed() const


code: virtual bool IsProcessedDeletedOrDegenerated() const


code: virtual bool IsToProcess() const


code: virtual void ResetDegenerated() const


code: void ResetProcessedMarker() const


code: void ResetToProcessMarker() const


code: void ResetWaitingMarker() const


code: void Serialize ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar )


code: virtual void SetAsDegenerated() const


code: void SetProcessedMarker() const


code: void SetToProcessMarker() const


className: FHaveStates

code: class FHaveStates

States

type: EHaveStates


code: void CompleteDictionary ( const [FMetadataDictionary](API\Runtime\CADKernel\CADKernel\Core\FMetadataDictionary) & MetaData )


code: void ExtractMetaData ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & OutMetaData ) const


code: void SetColorId ( const uint32 & InColorId )


code: void SetLayer ( const int32 InLayerId )


code: void SetHostId ( const int32 InHostId )


code: void SetMaterialId ( const uint32 & InMaterialId )


code: void SetName ( const [FString](API\Runtime\Core\Containers\FString) & InName )


code: void SetPatchId ( int32 InPatchId )


className: FMetadataDictionary

code: class FMetadataDictionary


code: void Add ( const [FPairOfIndex](API\Runtime\CADKernel\CADKernel\Core\FPairOfIndex) Values )


code: int32 & operator[] ( const int32 Index )


code: const int32 & operator[] ( const int32 Index ) const


code: FPairOfIndex ( int32 InValue1 )


className: Undefined

code: static const [FPairOfIndex](API\Runtime\CADKernel\CADKernel\Core\FPairOfIndex) Undefined;


code: FPairOfIndex ( int32 InValue1, int32 InValue2 )


className: FPairOfIndex

code: struct FPairOfIndex


description: Add a database defined by a RawData in the current session database Entity ID is set for all loaded entities

code: void AddDatabase ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InRawData )


code: double GetGeometricTolerance() const


description: Load and add a database in the current session database Entity ID is set for all loaded entities

code: void LoadDatabase ( const TCHAR * FilePath )


description: Save the database as a FAchive in a file Mandatory: all entity have to have a defined ID Use SpawnEntityIdent if needed

code: void SaveDatabase ( const TCHAR * FilePath )


description: Save a selection and all the dependencies as a FAchive in a file Mandatory: all entity have to have a defined ID Use SpawnEntityIdent if needed

code: void SaveDatabase ( const TCHAR * FileName, const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & Entities )


code: void SaveDatabase ( const TCHAR * FileName, const [TArray](API\Runtime\Core\Containers\TArray)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) * > & Entities )


code: void SaveDatabase ( const TCHAR * FileName, [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) & Entity )


code: void SaveDatabase ( const TCHAR * FileName, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > Entity )


code: void Serialize ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar )


description: For stitching purpose, stitching can generate new body needing a host id. To avoid duplicate, the first generated host id can be set.

code: void SetFirstNewHostId ( int32 StartHostId )


description: Tolerance must not be modified as soon as a geometric entity has been build.

code: void SetGeometricTolerance ( double NewTolerance )


description: To be consistent, all entity to save have to had an Id. This method browses all sub entities and set their Id if needed

code: uint32 SpawnEntityIdent ( [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) & SelectedEntity, bool bForceSpawning )


code: uint32 SpawnEntityIdents ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) >> & SelectedEntities, bool bForceSpawning )


code: uint32 SpawnEntityIdents ( const [TArray](API\Runtime\Core\Containers\TArray)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) * > & SelectedEntities, bool bForceSpawning )


code: FSession ( double InGeometricTolerance )


className: FSession

code: class FSession

Database

type: FDatabase

GeometricTolerance

type: double


code: void DefineLogFile ( const [FString](API\Runtime\Core\Containers\FString) & LogFilePath, [EVerboseLevel](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EVerboseLevel) Level )


code: void DefineSpyFile ( const [FString](API\Runtime\Core\Containers\FString) & SpyFilePath )


code: static [FSystem](API\Runtime\CADKernel\CADKernel\Core\FSystem) & Get()


code: [FConsole](API\Runtime\CADKernel\CADKernel\UI\FConsole) & GetConsole() const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FArchive](API\Runtime\Core\Serialization\FArchive) > GetLogFile() const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FArchive](API\Runtime\Core\Serialization\FArchive) > GetSpyFile() const


code: [FVisu](API\Runtime\CADKernel\CADKernel\UI\FVisu) * GetVisu() const


code: void Initialize ( bool bIsDll, const [FString](API\Runtime\Core\Containers\FString) & LogFilePath, const [FString](API\Runtime\Core\Containers\FString) & SpyFilePath )


code: void SetConsole ( [FConsole](API\Runtime\CADKernel\CADKernel\UI\FConsole) * InConsole )


code: void SetProgressManager ( [FProgressManager](API\Runtime\CADKernel\CADKernel\UI\FProgressManager) * InProgressManager )


code: void SetVerboseLevel ( [EVerboseLevel](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EVerboseLevel) Level )


code: void SetViewer ( [FVisu](API\Runtime\CADKernel\CADKernel\UI\FVisu) * NewViewer )


className: FTimePoint

code: typedef uint64 FTimePoint


className: FSystem

code: class FSystem

Console

type: FConsole*

DefaultConsole

type: FConsole

DefaultProgressManager

type: FProgressManage...

DefaultVisu

type: FVisu

LogFile

type: TSharedPtr<FAr...

LogLevel

type: EVerboseLevel

ProductName

type: FString

Viewer

type: FVisu*


className: Instance

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FSystem](API\Runtime\CADKernel\CADKernel\Core\FSystem) > Instance = nullptr;


code: [TOrientedEntity](API\Runtime\CADKernel\CADKernel\Core\TOrientedEntity) & operator= ( [TOrientedEntity](API\Runtime\CADKernel\CADKernel\Core\TOrientedEntity) && )


code: [TOrientedEntity](API\Runtime\CADKernel\CADKernel\Core\TOrientedEntity) & operator= ( const [TOrientedEntity](API\Runtime\CADKernel\CADKernel\Core\TOrientedEntity) & )


code: TOrientedEntity ( [TOrientedEntity](API\Runtime\CADKernel\CADKernel\Core\TOrientedEntity) && )


code: TOrientedEntity ( const [TOrientedEntity](API\Runtime\CADKernel\CADKernel\Core\TOrientedEntity) & )


code: TOrientedEntity ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< KeyType > InEntity, [EOrientation](API\Runtime\CADKernel\CADKernel\Geo\UE__CADKernel__EOrientation) InDirection )


className: TOrientedEntity

code: template<typename KeyType> class TOrientedEntity

Direction

type: EOrientation

Entity

type: TSharedPtr< Key...


description: this will eventually be reconciled with what the Geometry team is using.

code: namespace UE { namespace CADKernel { enum ETimeUnit { NanoSeconds = 0, MicroSeconds = 1, MilliSeconds, Seconds, } } }


code: namespace UE { namespace CADKernel { enum EEntity { None = 0, Curve, Surface, EdgeLink, VertexLink, TopologicalEdge, TopologicalFace, TopologicalLink, TopologicalLoop, TopologicalVertex, Shell, Body, Model, MeshModel, Mesh, Group, Criterion, Property, EntityTypeEnd, } } }


code: namespace UE { namespace CADKernel { enum EValue { Entity, OrientedEntity, Point, Matrix, Integer, Double, String, Boolean, Tuple, List, Array, } } }


code: namespace UE { namespace CADKernel { enum EVerboseLevel { NoVerbose = 0, Spy, Log, Debug, } } }


code: namespace UE { namespace CADKernel { namespace Ident { static UE::CADKernel::Ident::Undefined = (FIdent)-1; } } }


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntityGeom](API\Runtime\CADKernel\CADKernel\Core\FEntityGeom) > ApplyMatrix ( const [FMatrixH](API\Runtime\CADKernel\CADKernel\Math\FMatrixH) & InMatrix ) const


code: virtual double ComputeLength ( const [FLinearBoundary](API\Runtime\CADKernel\CADKernel\Math\FLinearBoundary) & InBoundary, double Tolerance ) const


code: virtual double ComputeLength2D ( const [FLinearBoundary](API\Runtime\CADKernel\CADKernel\Math\FLinearBoundary) & InBoundary, double Tolerance ) const


description: Specific method for curve family to instantiate the correct derived class ofFCurve

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FEntity](API\Runtime\CADKernel\CADKernel\Core\FEntity) > Deserialize ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Archive )


description: Evaluate exact 2D point of the curve at the input Coordinate The function can only be used with 2D curve (Dimension == 2)

code: virtual void Evaluate2DPoint ( double Coordinate, [FPoint2D](API\Runtime\CADKernel\CADKernel\Math\FPoint2D) & OutPoint ) const


description: Evaluate exact 3D point of the curve at the input Coordinate The function can only be used with 3D curve (Dimension == 3)

code: virtual [FPoint2D](API\Runtime\CADKernel\CADKernel\Math\FPoint2D) Evaluate2DPoint ( double Coordinate ) const


code: virtual void Evaluate2DPoint ( double Coordinate, [FCurvePoint2D](API\Runtime\CADKernel\CADKernel\Geo\FCurvePoint2D) & OutPoint, int32 DerivativeOrder ) const


description: Evaluate exact 2D points of the curve at the input Coordinates The function can only be used with 2D curve (Dimension == 2)

code: virtual void Evaluate2DPoints ( const [TArray](API\Runtime\Core\Containers\TArray)< double > & Coordinates, [TArray](API\Runtime\Core\Containers\TArray)< [FPoint2D](API\Runtime\CADKernel\CADKernel\Math\FPoint2D) > & OutPoints ) const


code: virtual void Evaluate2DPoints ( const [TArray](API\Runtime\Core\Containers\TArray)< double > & Coordinates, [TArray](API\Runtime\Core\Containers\TArray)< [FCurvePoint2D](API\Runtime\CADKernel\CADKernel\Geo\FCurvePoint2D) > & OutPoints, int32 DerivativeOrder ) const


code: virtual [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) EvaluatePoint ( double Coordinate ) const


code: virtual void EvaluatePoint ( double Coordinate, [FCurvePoint](API\Runtime\CADKernel\CADKernel\Geo\FCurvePoint) & OutPoint, int32 DerivativeOrder ) const


description: Evaluate exact 3D points of the curve at the input Coordinates The function can only be used with 3D curve (Dimension == 3)

code: virtual void EvaluatePoints ( const [TArray](API\Runtime\Core\Containers\TArray)< double > & Coordinates, [TArray](API\Runtime\Core\Containers\TArray)< [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) > & OutPoints ) const


code: virtual void EvaluatePoints ( const [TArray](API\Runtime\Core\Containers\TArray)< double > & Coordinates, [TArray](API\Runtime\Core\Containers\TArray)< [FCurvePoint](API\Runtime\CADKernel\CADKernel\Geo\FCurvePoint) > & OutPoints, int32 DerivativeOrder ) const


description: Linear deformation of the curve along the axis [Start point, End point] so that the nearest extremity is at the desired position and the other is not modified

code: virtual void ExtendTo ( const [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) & DesiredPosition )


code: virtual void ExtendTo ( const [FPoint2D](API\Runtime\CADKernel\CADKernel\Math\FPoint2D) & DesiredPosition )


code: void FindNotDerivableCoordinates ( int32 DerivativeOrder, [TArray](API\Runtime\Core\Containers\TArray)< double > & OutNotDerivableCoordinates ) const


code: virtual void FindNotDerivableCoordinates ( const [FLinearBoundary](API\Runtime\CADKernel\CADKernel\Math\FLinearBoundary) & InBoundary, int32 DerivativeOrder, [TArray](API\Runtime\Core\Containers\TArray)< double > & OutNotDerivableCoordinates ) const


code: const [FLinearBoundary](API\Runtime\CADKernel\CADKernel\Math\FLinearBoundary) & GetBoundary() const


code: virtual [EEntity](API\Runtime\CADKernel\CADKernel\Core\UE__CADKernel__EEntity) GetEntityType() const


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCurve](API\Runtime\CADKernel\CADKernel\Geo\Curves\FCurve) > MakeBezierCurve ( const [TArray](API\Runtime\Core\Containers\TArray)< [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) > & InPoles )


code: virtual double GetLength ( double Tolerance ) const


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCurve](API\Runtime\CADKernel\CADKernel\Geo\Curves\FCurve) > MakeNurbsCurve ( FNurbsCurveData & InNurbsData )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCurve](API\Runtime\CADKernel\CADKernel\Geo\Curves\FCurve) > MakeSplineCurve ( const [TArray](API\Runtime\Core\Containers\TArray)< [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) > & InPoles, const [TArray](API\Runtime\Core\Containers\TArray)< [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) > & ArriveTangents, const [TArray](API\Runtime\Core\Containers\TArray)< [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) > & LeaveTangents )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCurve](API\Runtime\CADKernel\CADKernel\Geo\Curves\FCurve) > MakeSplineCurve ( const [TArray](API\Runtime\Core\Containers\TArray)< [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) > & InPoles )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCurve](API\Runtime\CADKernel\CADKernel\Geo\Curves\FCurve) > MakeSplineCurve ( const [TArray](API\Runtime\Core\Containers\TArray)< [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) > & InPoles, const [TArray](API\Runtime\Core\Containers\TArray)< [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) > & Tangents )


code: void Offset ( const [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) & OffsetDirection )


description: Make a new curve based on the new bounds. If the new bound is nearly equal to the initial bound, no curve is made (return TSharedPtr())

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCurve](API\Runtime\CADKernel\CADKernel\Geo\Curves\FCurve) > MakeBoundedCurve ( const [FLinearBoundary](API\Runtime\CADKernel\CADKernel\Math\FLinearBoundary) & InBoundary )


code: virtual void Presample ( const [FLinearBoundary](API\Runtime\CADKernel\CADKernel\Math\FLinearBoundary) & InBoundary, double Tolerance, [TArray](API\Runtime\Core\Containers\TArray)< double > & OutSampling ) const


description: Generate a pre-sampling of the curve saved in OutCoordinates. This sampling is light enough to allow a fast computation, precise enough to compute accurately meshing criteria

code: void Presample ( [TArray](API\Runtime\Core\Containers\TArray)< double > & OutSampling, double Tolerance ) const


description: Rebound the curve, if not possible make a new curve based on the new bounds.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FCurve](API\Runtime\CADKernel\CADKernel\Geo\Curves\FCurve) > Rebound ( const [FLinearBoundary](API\Runtime\CADKernel\CADKernel\Math\FLinearBoundary) & InBoundary )


description: TODO static TSharedPtrMakeConeCurve(const double InToleranceGeometric, const FMatrixH& InMatrix, double InStartRadius, double InConeAngle, const FSurfacicBoundary& InBoundary); static TSharedPtrMakeCylinderCurve(const double InToleranceGeometric, const FMatrixH& InMatrix, const double InRadius, const FSurfacicBoundary& InBoundary); static TSharedPtrMakePlaneCurve(const double InToleranceGeometric, const FMatrixH& InMatrix, const FSurfacicBoundary& InBoundary); static TSharedPtrMakeSphericalCurve(const double InToleranceGeometric, const FMatrixH& InMatrix, double InRadius, const FSurfacicBoundary& InBoundary); static TSharedPtrMakeTorusCurve(const double InToleranceGeometric, const FMatrixH& InMatrix, double InMajorRadius, double InMinorRadius, const FSurfacicBoundary& InBoundary);

code: virtual void Serialize ( [FCADKernelArchive](API\Runtime\CADKernel\CADKernel\Core\FCADKernelArchive) & Ar )


code: FCurve ( const [FLinearBoundary](API\Runtime\CADKernel\CADKernel\Math\FLinearBoundary) & InBounds, int8 InDimension )


className: FCurve

code: class FCurve : public [UE::CADKernel::FEntityGeom](API\Runtime\CADKernel\CADKernel\Core\FEntityGeom)

Boundary

type: FLinearBoundary

GlobalLength

type: TCache< double ...


description: Fast computation of the point in the parametric space of the carrier surface. This approximation is based on FSurfacicPolyline::Polyline

code: [FPoint2D](API\Runtime\CADKernel\CADKernel\Math\FPoint2D) Approximate2DPoint ( double InCoordinate ) const


code: void Approximate2DPoints ( const [TArray](API\Runtime\Core\Containers\TArray)< double > & InCoordinates, [TArray](API\Runtime\Core\Containers\TArray)< [FPoint2D](API\Runtime\CADKernel\CADKernel\Math\FPoint2D) > & OutPoints ) const


code: [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) Approximate3DPoint ( double InCoordinate ) const


description: Fast computation of the 3D point of the curve. This approximation is based on FSurfacicPolyline::Polyline

code: void Approximate3DPoints ( const [TArray](API\Runtime\Core\Containers\TArray)< double > & InCoordinates, [TArray](API\Runtime\Core\Containers\TArray)< [FPoint](API\Runtime\CADKernel\CADKernel\Math\FPoint) > & OutPoints ) const