description: Call this from subclass default constructor.

code: TBaseCharacterFXEditorCommands ( const [FName](API\Runtime\Core\UObject\FName) InContextName, const [FText](API\Runtime\Core\Internationalization\FText) & InContextDesc, const [FName](API\Runtime\Core\UObject\FName) InContextParent, const [FName](API\Runtime\Core\UObject\FName) InStyleSetName )


description: Inherited fromUAssetEditorand called inUAssetEditor::Initialize. Override this to create a subclass ofFBaseCharacterFXEditorToolkit.

module: BaseCharacterFXEditor

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FBaseAssetToolkit](API\Editor\UnrealEd\Tools\FBaseAssetToolkit) > CreateToolkit()


className: TBaseCharacterFXEditorCommands

description: Home for FUICommandInfos used by the editor

code: template<typename CommandContextType> class TBaseCharacterFXEditorCommands : public [TInteractiveToolCommands< CommandContextType >](API\Editor\UnrealEd\Tools\TInteractiveToolCommands)

AcceptOrCompleteActiveTool

type: TSharedPtr<FUI...


description: Returns the asset editor instance interface, so that its window can be focused, for example.

code: virtual [IAssetEditorInstance](API\Editor\UnrealEd\Subsystems\IAssetEditorInstance) * GetInstanceInterface()


description: Retrieve stored objects to edit

code: virtual void GetObjectsToEdit ( [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & OutObjects )


description: Store objects to edit and callUAssetEditor::Initialize

code: virtual void Initialize ( const [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) >> & InObjects )


className: UBaseCharacterFXEditor

description: However, since we're using a mode and the Interactive Tools Framework, a lot of our business logic ends up inside the mode and the tools, not the subsystem. The front-facing code is mostly in the asset editor toolkit, though the mode toolkit has most of the things that deal with the toolbar on the left.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class UBaseCharacterFXEditor : public [UAssetEditor](API\Editor\UnrealEd\Tools\UAssetEditor)

OriginalObjectsToEdit

type: TArray<TObject...

description: Note that things like CloseWindow, FocusWindow, and IsPrimaryEditor seem to be called on the toolkit, not the editor class, so they are overriden there.


description: Handles nested tools and notifies InteractiveToolsContext.

code: void AcceptActiveToolActionOrTool()


description: Override these to specify supported ToolTargets and tools.

code: virtual void AddToolTargetFactories()


description: Called by InitializeTargets; override to populate tool targets for given assets.

code: virtual void CreateToolTargets ( const [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) >> & AssetsIn )


code: void CancelActiveToolActionOrTool()


code: virtual void Enter()


code: virtual void Exit()


description: Called by the corresponding EditorToolkit. Creates ToolTargets from OriginalObjectsToEdit. Override to add custom per-target setup.

code: virtual void InitializeTargets ( const [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) >> & AssetsIn )


code: virtual void RegisterTools()


code: virtual FBox SceneBoundingBox() const


className: UBaseCharacterFXEditorMode

description: The CharacterFX EditorMode stores much of the inter-tool state, including ToolTargets.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class UBaseCharacterFXEditorMode : public [UEdMode](API\Editor\UnrealEd\Tools\UEdMode)

description: Stores original input objects

ToolTargets

description: Tool targets created from OriginalObjectsToEdit (and 1:1 with that array) that provide us with dynamic meshes


description: Removes RegisterLayoutExtensions callback from the module corresponding toGetModuleName()

code: virtual void Deinitialize()


className: EditorSidePanelAreaName

description: Identifier for the Layout extension in BaseCharacterFXEditorToolkit's StandaloneDefaultLayout.

code: static const [FName](API\Runtime\Core\UObject\FName) EditorSidePanelAreaName = "BaseCharacterFXEditorSidePanelArea";


description: OVERRIDE THIS.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetModuleName() const


description: Adds RegisterLayoutExtensions as a callback to the module corresponding toGetModuleName()

code: virtual void Initialize ( [FSubsystemCollectionBase](API\Runtime\Engine\Subsystems\FSubsystemCollectionBase) & Collection )


description: Docks the editor Mode tab in the Editor side panel area of the layout.

code: virtual void RegisterLayoutExtensions ( [FLayoutExtender](API\Runtime\Slate\Framework\Docking\FLayoutExtender) & Extender )


className: UBaseCharacterFXEditorUISubsystem

description: Interchange layer to manage built in tab locations within the editor's layout.


description: Copyright Epic Games Tools LLC Licenced under the Unreal Engine EULA

module: BinkMediaPlayer

code: [FString](API\Runtime\Core\Containers\FString) BinkUE4CookOnTheFlyPath ( [FString](API\Runtime\Core\Containers\FString) path, const TCHAR * filename )


className: EBinkMediaPlayerBinkBufferModes

description: Enumerates available bink buffering modes.

code: enum EBinkMediaPlayerBinkBufferModes { BMASM_Bink_Stream, BMASM_Bink_PreloadAll, BMASM_Bink_StreamUntilResident, BMASM_Bink_MAX, }


className: EBinkMediaPlayerBinkDrawStyle

code: enum EBinkMediaPlayerBinkDrawStyle { BMASM_Bink_DS_RenderToTexture, BMASM_Bink_DS_OverlayFillScreenWithAspectRatio, BMASM_Bink_DS_OverlayOriginalMovieSize, BMASM_Bink_DS_OverlayFillScreen, BMASM_Bink_DS_OverlaySpecificDestinationRectangle, BMASM_Bink_DS_MAX, }


className: EBinkMediaPlayerBinkSoundTrack

description: Enumerates available used to specify the sounds to open at playback w/ bink movies.

code: enum EBinkMediaPlayerBinkSoundTrack { BMASM_Bink_Sound_None, BMASM_Bink_Sound_Simple, BMASM_Bink_Sound_LanguageOverride, BMASM_Bink_Sound_51, BMASM_Bink_Sound_51LanguageOverride, BMASM_Bink_Sound_71, BMASM_Bink_Sound_71LanguageOverride, BMASM_Bink_Sound_MAX, }


className: FOnBinkMediaPlayerMediaClosed

description: Multicast delegate that is invoked when a media player's media has been closed.

code: class FOnBinkMediaPlayerMediaClosed


className: FOnBinkMediaPlayerMediaEvent

description: Multicast delegate that is invoked when a media event occurred in the player.

code: class FOnBinkMediaPlayerMediaEvent


className: FOnBinkMediaPlayerMediaOpened

description: Multicast delegate that is invoked when a media player's media has been opened.

code: class FOnBinkMediaPlayerMediaOpened


className: FOnBinkMediaPlayerMediaReachedEnd

description: Multicast delegate that is invoked when a media player's media has finished playing.

code: class FOnBinkMediaPlayerMediaReachedEnd


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Bink") static void Bink_DrawOverlays()


className: UBinkFunctionLibrary

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UBinkFunctionLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)


description: UMediaPlayerBase overrides not already part of the build provided by RAD virtualTSharedRefGetPlayerFacade() const override; virtual bool IsPreparing() const override { return !IsReady(); } virtual bool OpenSource(UMediaSource* InMediaSource) override;

code: virtual void BeginDestroy()


description: Pause

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool CanPause() const


description: Play

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool CanPlay() const


description: GetUrl


className: FOnMediaChanged

description: Gets an event delegate that is invoked when media has been opened or closed.

code: class FOnMediaChanged : public TBaseMulticastDelegate_NoParams< void >


description: Draws this bink to the specified texture

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") void Draw ( [UTexture](API\Runtime\Engine\Engine\UTexture) * texture, bool tonemap, int out_nits, float alpha, bool srgb_decode, bool hdr )


description: Return a one line description of an object for viewing in the thumbnail view of the generic browser


code: FIntPoint GetDimensions() const


code: float GetFrameRate() const


description: Seek


description: SupportsRate

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") float GetRate() const


description: Return the stat id to use for this tickable

code: virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const


description: OpenUrl

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") const [FString](API\Runtime\Core\Containers\FString) & GetUrl() const


description: Callback for when the media player has closed a media source.

code: void HandleMediaPlayerMediaClosed()


description: Callback for when the media player has opened a new media source.

code: void HandleMediaPlayerMediaOpened ( [FString](API\Runtime\Core\Containers\FString) OpenedUrl )


description: Initializes the media player.

code: void InitializePlayer()


description: OpenUrl

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool IsInitialized() const


description: SetLooping

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool IsLooping() const


description: Pause

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool IsPaused() const


description: Play

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool IsPlaying() const


description: Stop

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool IsStopped() const


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object is ready to be ticked. This is required for example for allUObjectderived classes as they might be loaded async and therefore won't be ready immediately.
true if object is ready to be ticked, false otherwise.

code: virtual bool IsTickable() const


description:
Used to determine whether the object should be ticked in the editor. Defaults to false since that is the previous behavior.
true if this tickable object can be ticked in the editor

code: virtual bool IsTickableInEditor() const


description: GetUrl

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool OpenUrl ( const [FString](API\Runtime\Core\Containers\FString) & NewUrl )


code: bool Open ( const [FString](API\Runtime\Core\Containers\FString) & Url )


description: SetRate


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Seek


description: Rewind

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool Seek ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InTime )


description: IsLooping

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool SetLooping ( bool InLooping )


description: Changes the media's volume

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") void SetVolume ( float Rate )


description: SupportsRate

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool SetRate ( float Rate )


description: Play


description: SupportsSeeking

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool SupportsRate ( float Rate, bool Unthinned ) const


description: SupportsSeeking

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool SupportsScrubbing() const


description: SupportsScrubbing

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|BinkMediaPlayer") bool SupportsSeeking() const


description: Pure virtual that must be overloaded by the inheriting class. It will be called from within LevelTick.cpp after ticking all actors or from the rendering thread (depending on bIsRenderingThreadObject)

code: virtual void Tick ( float DeltaTime )


className: UBinkMediaPlayer

description: This class is represents a media URL along with a corresponding media player for exposing media playback functionality to the Engine and to Blueprints.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, HideCategories=(Object)) class UBinkMediaPlayer : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [FTickableGameObject](API\Runtime\Engine\FTickableGameObject)

BinkBufferMode

type: TEnumAsByte<EB...

description: Used to specify the how the video should be buffered.

BinkDestinationLowerRight

description: Used to specify the sounds to open at playback.

BinkDrawStyle

description: Used to specify how the movie is drawn.

BinkLayerDepth

description: Used to specify the render order.

bnk

type: BINKPLUGIN *...

CurrentBinkBufferMode

description: Holds the bink buffer mode of the currently loaded media source.

CurrentBinkSoundTrack

description: Holds the bink sound track of the currently loaded media source.

CurrentBinkSoundTrackStart

description: Holds the bink sound track start of the currently loaded media source.

CurrentDrawStyle

type: EBinkMediaPlaye...

CurrentUrl

type: FString

description: Note - not serialized.

DelayedOpen

type: uint32: 1

description: To reduce memory use, don't immediately open the bink until it is first played.

Looping

description: Whether playback should loop when it reaches the end.

MediaChangedEvent

type: FOnMediaChanged

description: Holds a delegate that is executed when media has been opened or closed.

OnMediaClosed

type: FOnBinkMediaPla...

description: Holds a delegate that is invoked when a media source has been closed.

OnMediaOpened

description: Holds a delegate that is invoked when a media source has been opened.

OnPlaybackSuspended

description: A delegate that is invoked when media playback has been suspended.

overlayHook

type: FDelegateHandle

paused

type: bool

StartImmediately

description: Whether playback start immediately, or wait for blueprint to start it.

URL

description: The path or URL to the media file to be played.


code: void UpdateTexture ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FTexture2DRHIRef ref, void * nativePtr, int width, int height, bool isEditor, bool tonemap, int output_nits, float alpha, bool srgb_decode, bool is_hdr )


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


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Implemented by subclasses to create a new resource for the texture.

code: virtual [FTextureResource](API\Runtime\Engine\FTextureResource) * CreateResource()


description: Clears this texture to transparent-black.


description: Because properties are destroyed here,Super::FinishDestroy()should always be called at the end of your child class'sFinishDestroy()method, rather than at the beginning.

code: virtual void FinishDestroy()


description: Return a one line description of an object for viewing in the thumbnail view of the generic browser


description: The material value type of this texture.

code: virtual EMaterialValueType GetMaterialType() const


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


description: the width of the surface represented by the texture.

code: virtual float GetSurfaceWidth() const


description: Get Texture Class

code: virtual ETextureClass GetTextureClass() const


code: void HandleMediaPlayerMediaChanged()


description:
Called to check if the object is ready for FinishDestroy. This is called after BeginDestroy to check the completion of the potentially asynchronous object cleanup.
True if the object's asynchronous cleanup has completed and it is ready for FinishDestroy to be called.

code: virtual bool IsReadyForFinishDestroy()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Sets the media player asset to be used for this texture.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|MediaTexture") void SetMediaPlayer ( [UBinkMediaPlayer](API\Plugins\BinkMediaPlayer\UBinkMediaPlayer) * InMediaPlayer )


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


className: UBinkMediaTexture

description: note: derives directly fromUTexture, not fromUTexture2DorUTexture2DDynamicmaybe should have beenUTexture2DDynamic?

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Compression, LevelOfDetail, Object)) class UBinkMediaTexture : public [UTexture](API\Runtime\Engine\Engine\UTexture)

AddressX

type: TEnumAsByte< Te...

description: The addressing mode to use for the X axis.

AddressY

description: The addressing mode to use for the Y axis.

Alpha

type: float

description: Alpha_value is just a constant blend value for entire video frame.

CachedDimensions

type: FIntPoint

CurrentMediaPlayer

type: UBinkMediaPlaye...

DecodeSRGB

description: Enable decoding of sRGB to Linear inside Bink when drawing to this texture.

MediaPlayer

type: TObjectPtr<UBi...

description: The MediaPlayer asset to stream video from.

OutputNits

description: When tonemapping, set this for to desired output nits capability for the current display.

PixelFormat

type: TEnumAsByte< EP...

description: The Pixel Format for the texture.

ReleasePlayerFence

type: FRenderCommandF...

Tonemap

description: Whether to enable tonemaping for the video.


module: BlackmagicCore

code: namespace BlackmagicDesign { enum EAudioBitDepth { Signed_16Bits, Signed_32Bits, } }


code: namespace BlackmagicDesign { enum EAudioChannelConfiguration { Channels_2 = 2, Channels_8 = 8, Channels_16 = 16, } }


code: namespace BlackmagicDesign { enum EAudioSampleRate { SR_48kHz = 48000, } }


code: namespace BlackmagicDesign { enum EFieldDominance { Progressive, Interlaced, ProgressiveSegmentedFrame, } }


code: namespace BlackmagicDesign { enum EFullPixelFormat { pf_8BitBGRA, pf_8BitYUV, pf_10BitRGB, pf_10BitRGBXLE, pf_10BitYUV, pf_10BitRGBX, } }


code: namespace BlackmagicDesign { enum EHDRMetaDataColorspace { Rec601, Rec709, Rec2020, } }


code: namespace BlackmagicDesign { enum EHDRMetaDataEOTF { SDR, HDR, PQ, HLG, } }


code: namespace BlackmagicDesign { enum ELinkConfiguration { SingleLink, DualLink, QuadLinkTSI, QuadLinkSqr, } }


code: namespace BlackmagicDesign { enum EPixelColor { YCbCr, RGB, } }


code: namespace BlackmagicDesign { enum EPixelFormat { pf_8Bits, pf_10Bits, } }


code: namespace BlackmagicDesign { enum ERHI { Invalid, D3D11, D3D12, Cuda, Vulkan, } }


code: namespace BlackmagicDesign { enum ETimecodeFormat { TCF_None, TCF_LTC, TCF_VITC1, TCF_Auto, } }


code: namespace BlackmagicDesign { template<class T> bool BlackmagicDesign::operator== ( const [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr)< T > & lhs, std::nullptr_t rhs ) }


code: namespace BlackmagicDesign { template<class T> bool BlackmagicDesign::operator== ( std::nullptr_t lhs, const [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr)< T > & rhs ) }


code: namespace BlackmagicDesign { template<class T> bool BlackmagicDesign::operator!= ( const [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr)< T > & lhs, std::nullptr_t rhs ) }


code: namespace BlackmagicDesign { template<class T> bool BlackmagicDesign::operator!= ( std::nullptr_t lhs, const [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr)< T > & rhs ) }


description: Configure Logging

code: namespace BlackmagicDesign { void BlackmagicDesign::SetLoggingCallbacks ( [LoggingCallbackPtr](API\Plugins\BlackmagicCore\LoggingCallbackPtr) LogInfoFunc, [LoggingCallbackPtr](API\Plugins\BlackmagicCore\LoggingCallbackPtr) LogWarningFunc, [LoggingCallbackPtr](API\Plugins\BlackmagicCore\LoggingCallbackPtr) LogErrorFunc, [LoggingCallbackPtr](API\Plugins\BlackmagicCore\LoggingCallbackPtr) LogVerboseFunc ) }


className: DeviceInfo

code: struct DeviceInfo


className: FormatedTextSize

code: static const int32_t FormatedTextSize = 64;


code: bool GetDeviceInfo ( int32_t InDeviceIndex, [DeviceInfo](API\Plugins\BlackmagicCore\BlackmagicDeviceScanner\DeviceInfo) & OutDeviceInfo ) const


code: bool GetDeviceTextId ( int32_t InDeviceIndex, [FormatedTextType](API\Plugins\BlackmagicCore\BlackmagicDeviceScanner\FormatedTextType) & OutTextId ) const


code: int32_t GetNumDevices() const


code: [BlackmagicDeviceScanner](API\Plugins\BlackmagicCore\BlackmagicDeviceScanner) & operator= ( const [BlackmagicDeviceScanner](API\Plugins\BlackmagicCore\BlackmagicDeviceScanner) & )


code: BlackmagicDeviceScanner ( const [BlackmagicDeviceScanner](API\Plugins\BlackmagicCore\BlackmagicDeviceScanner) & )


code: ~BlackmagicDeviceScanner()


className: BlackmagicDeviceScanner

description: BlackmagicDeviceScannerdefinition

code: class BlackmagicDeviceScanner


code: int32_t GetNumSupportedFormat() const


code: [BlackmagicVideoFormats](API\Plugins\BlackmagicCore\BlackmagicVideoFormats) & operator= ( const [BlackmagicVideoFormats](API\Plugins\BlackmagicCore\BlackmagicVideoFormats) & )


code: [VideoFormatDescriptor](API\Plugins\BlackmagicCore\BlackmagicVideoFormats\VideoFormatDescriptor) GetSupportedFormat ( int32_t InIndex ) const


className: VideoFormatDescriptor

code: struct VideoFormatDescriptor

VideoFormatIndex

type: FBlackmagicVide...


code: BlackmagicVideoFormats ( const [BlackmagicVideoFormats](API\Plugins\BlackmagicCore\BlackmagicVideoFormats) & )


code: BlackmagicVideoFormats ( int32_t InDeviceId, bool bForOutput )


className: BlackmagicVideoFormats

description: BlackmagicVideoFormatsdefinition

code: struct BlackmagicVideoFormats


code: bool operator== ( [FAudioFormat](API\Plugins\BlackmagicCore\FAudioFormat) & Other ) const


className: FAudioFormat

description: FAudioFormatdefinition

code: struct FAudioFormat

BitDepth

type: EAudioBitDepth

ChannelConfigration

type: EAudioChannelCo...


className: FAudioSamplesDescriptor

code: struct FAudioSamplesDescriptor

AudioBuffer

type: uint8_t *

Timecode

type: FTimecode


className: FBaseFrameData

code: struct FBaseFrameData


description: Whether a blackmagic card can be used.

code: bool CanUseBlackmagicCard()


description: Whether the API is initialized.

code: bool IsInitialized()


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

code: virtual void ShutdownModule()


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

code: virtual void StartupModule()


className: FBlackmagicCoreModule

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


className: FBlackmagicVideoFormat

code: typedef int32_t FBlackmagicVideoFormat


code: bool operator== ( [FChannelInfo](API\Plugins\BlackmagicCore\FChannelInfo) & Other ) const


className: FChannelInfo

description: FChannelInfodefinition

code: struct FChannelInfo


code: bool operator== ( [FFormatInfo](API\Plugins\BlackmagicCore\FFormatInfo) & Other ) const


className: FFormatInfo

description: FFormatInfodefinition Information about a given frame desc

code: struct FFormatInfo

FieldDominance

type: EFieldDominance

FrameRateNumerator

description: Framerate

Width

description: Image Width & Weight in texels


className: FFrameDescriptor

code: struct FFrameDescriptor : public [BlackmagicDesign::FBaseFrameData](API\Plugins\BlackmagicCore\FBaseFrameData)


code: struct FFrameDescriptor_GPUDMA : public [BlackmagicDesign::FBaseFrameData](API\Plugins\BlackmagicCore\FBaseFrameData)

RHITexture

type: FRHITexture...


className: FHDRMetaData

description: HDR Metadata.

code: struct FHDRMetaData

bIsAvailable

description: Whether the data contained in this struct is valid.

ColorSpace

type: EHDRMetaDataCol...

description: Target color space.

DisplayPrimariesBlueX

type: double

description: Blue chromaticity X coordinate.

DisplayPrimariesBlueY

description: Blue chromaticity Y coordinate.

DisplayPrimariesGreenX

description: Green chromaticity X coordinate.

DisplayPrimariesGreenY

description: Green chromaticity Y coordinate.

DisplayPrimariesRedX

description: Red chromaticity X coordinate.

DisplayPrimariesRedY

description: Red chromaticity Y coordinate.

EOTF

type: EHDRMetaDataEOT...

description: HDR Transfer function.

MaxContentLightLevel

description: Max content light level.

MaxDisplayLuminance

description: Max display mastering luminance.

MaxFrameAverageLightLevel

description: Max frame average light level.

MinDisplayLuminance

description: Min display mastering luminance.

WhitePointX

description: White point X coordinate.

WhitePointY

description: White point Y coordinate.


className: FInputChannelOptions

description: FInputChannelOptionsdefinition

code: struct FInputChannelOptions

bAutoDetect

type: bool

FormatInfo

type: FFormatInfo

PixelFormat

type: EPixelFormat

TimecodeFormat

type: ETimecodeFormat


className: FOutputChannelOptions

description: FOutputChannelOptionsdefinition

code: struct FOutputChannelOptions

AudioSampleRate

type: EAudioSampleRat...

HDRMetadata

type: FHDRMetaData

description: HDR Metadata.

LinkConfiguration

type: ELinkConfigurat...


code: bool operator== ( const [FTimecode](API\Plugins\BlackmagicCore\FTimecode) & Other ) const


className: FTimecode

description: FTimecodedefinition limited to 30fps

code: struct FTimecode


code: bool operator== ( const [FUniqueIdentifier](API\Plugins\BlackmagicCore\FUniqueIdentifier) & rhs ) const


code: FUniqueIdentifier ( int32_t InIdentifier )


className: FUniqueIdentifier

description: FUniqueIdentifierdefinition

code: struct FUniqueIdentifier


code: virtual &126;FFrameBufferHolder&40;&41;


className: FFrameBufferHolder

description: An empty type to expose. The real job is done in an internal child implementation.

code: struct FFrameBufferHolder


className: FFrameReceivedBufferHolders

description: A container for video and audio buffer holders. These holders prevent internal buffers from being released while they are in use.

code: struct FFrameReceivedBufferHolders

AudioBufferHolder

type: TSharedPtr<FFr...


className: FFrameReceivedInfo

code: struct FFrameReceivedInfo

AudioBuffer

type: void *

description: Audio.

bHaveTimecode

description: Timecode.

FullPixelFormat

type: EFullPixelForma...

VideoBuffer

description: Video.


code: virtual void OnFrameReceived ( const [FFrameReceivedInfo](API\Plugins\BlackmagicCore\IInputEventCallback\FFrameReceivedInfo) & )


code: void OnFrameFormatChanged ( const [FFormatInfo](API\Plugins\BlackmagicCore\FFormatInfo) & NewFormat )


code: virtual void OnFrameReceived ( const [FFrameReceivedInfo](API\Plugins\BlackmagicCore\IInputEventCallback\FFrameReceivedInfo) &, [FFrameReceivedBufferHolders](API\Plugins\BlackmagicCore\IInputEventCallback\FFrameReceivedBufferHolders) & )


code: void OnInitializationCompleted ( bool bSuccess )


code: void OnInterlacedOddFieldEvent ( long long FrameNumber )


code: void OnShutdownCompleted()


code: virtual ~IInputEventCallback()


className: IInputEventCallback

description: IInputEventCallbackdefinition

code: struct IInputEventCallback


className: FFrameSentInfo

code: struct FFrameSentInfo


code: void OnInterlacedOddFieldEvent()


code: void OnOutputFrameCopied ( const [FFrameSentInfo](API\Plugins\BlackmagicCore\IOutputEventCallback\FFrameSentInfo) & InFrameInfo )


code: virtual ~IOutputEventCallback()


className: IOutputEventCallback

description: IOutputEventCallbackdefinition

code: struct IOutputEventCallback


className: LoggingCallbackPtr

code: typedef void(*)(const TCHAR *Format,...) LoggingCallbackPtr


className: ReferencePtr::operator const T *

code: operator const T *() const


className: ReferencePtr::operator T *

code: operator T *()


code: [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr) & operator= ( [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr) && InAutoPointer )


code: ReferencePtr ( T * InPointer )


code: ReferencePtr ( const [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr)< T > & InAutoPointer )


code: ReferencePtr ( [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr) && InAutoPointer )


className: ReferencePtr

code: template<class T> class ReferencePtr


code: [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr) & operator= ( const [ReferencePtr](API\Plugins\BlackmagicCore\ReferencePtr) & InAutoPointer )


className: EBlackmagicHDRMetadataEOTF

description: HDR Transfer function. Must match Blackmagic::EBlackmagicHDRMetadataEOTF.

module: BlackmagicMedia

code: enum EBlackmagicHDRMetadataEOTF { SDR, HDR, PQ, HLG, }


className: EBlackmagicHDRMetadataGamut

description: HDR Color Gamut. Must match Blackmagic::EBlackmagicHDRMetadataGamut.

code: enum EBlackmagicHDRMetadataGamut { Rec709, Rec2020, }


className: EBlackmagicMediaAudioChannel

description: Available number of audio channel supported by Unreal Engine & Capture card.

code: enum EBlackmagicMediaAudioChannel { Stereo2, Surround8, }


className: EBlackmagicMediaSourceColorFormat

description: Native data format.

code: enum EBlackmagicMediaSourceColorFormat { YUV8, YUV10, }


className: EBlackmagicMediaTimecodeFormat

description: Available timecode formats that Blackmagic support.

code: enum EBlackmagicMediaTimecodeFormat { None, LTC, VITC, }


code: virtual [UMediaSource](API\Runtime\MediaAssets\UMediaSource) * CreateMediaSource ( const [FMediaIOConfiguration](API\Plugins\MediaIOCore\FMediaIOConfiguration) & InConfiguration, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Outer ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOConfiguration](API\Plugins\MediaIOCore\FMediaIOConfiguration) > GetConfigurations() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOConfiguration](API\Plugins\MediaIOCore\FMediaIOConfiguration) > GetConfigurations ( bool bAllowInput, bool bAllowOutput ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOConnection](API\Plugins\MediaIOCore\FMediaIOConnection) > GetConnections() const


code: virtual [FMediaIOConfiguration](API\Plugins\MediaIOCore\FMediaIOConfiguration) GetDefaultConfiguration() const


code: virtual [FMediaIOMode](API\Plugins\MediaIOCore\FMediaIOMode) GetDefaultMode() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIODevice](API\Plugins\MediaIOCore\FMediaIODevice) > GetDevices() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOMode](API\Plugins\MediaIOCore\FMediaIOMode) > GetModes ( const [FMediaIODevice](API\Plugins\MediaIOCore\FMediaIODevice) & InDevice, bool bInOutput ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOInputConfiguration](API\Plugins\MediaIOCore\FMediaIOInputConfiguration) > GetInputConfigurations() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOOutputConfiguration](API\Plugins\MediaIOCore\FMediaIOOutputConfiguration) > GetOutputConfigurations() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOVideoTimecodeConfiguration](API\Plugins\MediaIOCore\FMediaIOVideoTimecodeConfigurati-) > GetTimecodeConfigurations() const


code: virtual bool ShowInputKeyInSelector() const


code: virtual bool ShowInputTransportInSelector() const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) ToText ( const [FMediaIOConnection](API\Plugins\MediaIOCore\FMediaIOConnection) & InConnection ) const


code: virtual bool ShowOutputKeyInSelector() const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) ToText ( const [FMediaIOOutputConfiguration](API\Plugins\MediaIOCore\FMediaIOOutputConfiguration) & InMode ) const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) ToText ( const [FMediaIOConfiguration](API\Plugins\MediaIOCore\FMediaIOConfiguration) & InConfiguration, bool bInIsAutoDetected ) const


className: FBlackmagicDeviceProvider

description: Implementation ofIMediaIOCoreDeviceProviderfor Blackmagic

code: class FBlackmagicDeviceProvider : public [IMediaIOCoreDeviceProvider](API\Plugins\MediaIOCore\IMediaIOCoreDeviceProvider)


className: FBlackmagicMediaHDROptions

description: Set of metadata describing a HDR video signal.

EOTF

type: EBlackmagicHDRM...

description: Transfer function to use for converting the video signal to an optical signal.

Gamut

description: The color gamut of the video signal.


description: true if the Blackmagic card can be used

code: bool CanBeUsed() const


description:
Create an Blackmagic based media player.
A new media player, or nullptr if a player couldn't be created.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaPlayer](API\Runtime\Media\IMediaPlayer), ESPMode::ThreadSafe > CreatePlayer ( [IMediaEventSink](API\Runtime\Media\IMediaEventSink) & EventSink )


code: static [IBlackmagicMediaModule](API\Plugins\BlackmagicMedia\IBlackmagicMediaModule) & Get()


description: SlateStyleSet to be used across the BlackmagicMedia module


description: true if the Blackmagic module and VideoIO.dll could be loaded

code: bool IsInitialized() const


className: IBlackmagicMediaModule

description: Interface for the Media module.

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


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Get The fixed FrameRate

code: virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetFixedFrameRate() const


description: The state of the CustomTimeStep.

code: virtual ECustomTimeStepSynchronizationState GetSynchronizationState() const


description: Returns how many syncs occurred since the last tick

code: virtual uint32 GetLastSyncCountDelta() const


description: This CustomTimeStep became the Engine's CustomTimeStep.

code: virtual bool Initialize ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Get the sync rate (not always the same as the fixed frame rate)

code: virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetSyncRate() const


description: Returns true if the Sync related functions will return valid data

code: virtual bool IsLastSyncDataValid() const


description: Whether automatic format detection is supported.

code: virtual bool SupportsFormatAutoDetection() const


description: This CustomTimeStep stop being the Engine's CustomTimeStep.

code: virtual void Shutdown ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description:
Update FApp::CurrentTime/FApp::DeltaTime and optionally wait until the end of the frame.
true if the Engine's TimeStep should also be performed; false otherwise.

code: virtual bool UpdateTimeStep ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Blocks until it gets a sync signal. Returns false if unsuccessful

code: virtual bool WaitForSync()


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


className: UBlackmagicCustomTimeStep

description: Control the Engine TimeStep via the Blackmagic Design card.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, EditInlineNew, Meta=(DisplayName="Blackmagic SDI Input", MediaIOCustomLayout="Blackmagic")) class UBlackmagicCustomTimeStep : public [UGenlockedCustomTimeStep](API\Runtime\TimeManagement\UGenlockedCustomTimeStep)

bEnableOverrunDetection

description: Enable mechanism to detect Engine loop overrunning the source

MediaConfiguration

type: FMediaIOConfigu...

description: The device, port and video settings that correspond to where the Genlock signal will be coming from


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description:
Get a Boolean media option.
The option value.

code: virtual bool GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, bool DefaultValue ) const


description:
Get a signed integer media option.
The option value.

code: virtual int64 GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, int64 DefaultValue ) const


description:
Get a string media option.
The option value.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FString](API\Runtime\Core\Containers\FString) & DefaultValue ) const


description:
Check whether the specified option is set.
true if the option is set, false otherwise.

code: virtual bool HasMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key ) const


description: GetProxies

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


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( struct [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description:
Validate the media source settings (must be implemented in child classes).
true if validation passed, false otherwise.

code: virtual bool Validate() const


description: Default constructor.

code: UBlackmagicMediaSource()


className: UBlackmagicMediaSource

description: Media source description for Blackmagic.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, HideCategories=(Platforms, Object), Meta=(MediaIOCustomLayout="Blackmagic")) class UBlackmagicMediaSource : public [UCaptureCardMediaSource](API\Plugins\MediaIOCore\UCaptureCardMediaSource)

AudioChannels

type: EBlackmagicMedi...

description: Desired number of audio channel to capture.

AutoDetectableTimecodeFormat

type: EMediaIOAutoDet...

description: Use the time code embedded in the input stream.

bCaptureAudio

description: Capture Audio from the Blackmagic source.

bCaptureVideo

description: Capture Video from the Blackmagic source.

bEncodeTimecodeInTexel

description: Burn Frame Timecode in the input texture without any frame number clipping.

bLogDropFrame

description: Log a warning when there's a drop frame.

ColorFormat

description: Native data format internally used by the device after being converted from SDI/HDMI signal.

MaxNumAudioFrameBuffer

description: Maximum number of audio frames to buffer.

MaxNumVideoFrameBuffer

description: Maximum number of video frames to buffer.

description: The device, port and video settings that correspond to the input.


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Fetch current timecode from its source. e.g. From hardware/network/file/etc. It is recommended to cache the fetched timecode.

code: virtual bool FetchTimecode ( [FQualifiedFrameTime](API\Runtime\Core\Misc\FQualifiedFrameTime) & OutFrameTime )


description: The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.

code: virtual ETimecodeProviderSynchronizationState GetSynchronizationState() const


description: This Provider became the Engine's Provider.

code: virtual bool Initialize ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Get whether this provider is currently using autodetection.

code: virtual bool IsAutoDetected() const


description: Set the autodetected flag on this provider.

code: virtual void SetIsAutoDetected ( bool bInIsAutoDetected )


description: This Provider stopped being the Engine's Provider.

code: virtual void Shutdown ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Whether this provider supports format autodetection.

code: virtual bool SupportsAutoDetected() const


code: UBlackmagicTimecodeProvider()


className: UBlackmagicTimecodeProvider

description: Class to fetch a timecode via a Blackmagic Design card.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, EditInlineNew, Meta=(DisplayName="Blackmagic SDI Input", MediaIOCustomLayout="Blackmagic")) class UBlackmagicTimecodeProvider : public [UGenlockedTimecodeProvider](API\Runtime\TimeManagement\UGenlockedTimecodeProvider)

TimecodeConfiguration

type: FMediaIOVideoTi...

description: Use the time code embedded in the input stream. Timecode format to read from a video signal.


className: EBlackmagicMediaAudioOutputChannelCount

module: BlackmagicMediaOutput

code: enum EBlackmagicMediaAudioOutputChannelCount { CH_2 = 2, CH_8 = 8, CH_16 = 16, }


className: EBlackmagicMediaOutputAudioBitDepth

code: enum EBlackmagicMediaOutputAudioBitDepth { Signed_16Bits = 16, Signed_32Bits = 32, }


className: EBlackmagicMediaOutputAudioSampleRate

code: enum EBlackmagicMediaOutputAudioSampleRate { SR_48k = 48000, }


className: EBlackmagicMediaOutputPixelFormat

description: Native data format.

code: enum EBlackmagicMediaOutputPixelFormat { PF_8BIT_YUV, PF_10BIT_YUV, }


description: Get the RGB to YUV Conversion Matrix, should be overriden for media outputs that support different color gamuts (ie. BT 2020). Will default to returning the RGBToYUV Rec709 matrix.

code: virtual const FMatrix & GetRGBToYUVConversionMatrix() const


description: Initialization method to prepare implementation for capture

code: virtual bool InitializeCapture()


code: virtual void LockDMATexture_RenderThread ( FTextureRHIRef InTexture )


description: Check whether this capture has any processing left to do.

code: virtual bool HasFinishedProcessing() const


description: Callback when the buffer was successfully copied to CPU ram. The callback in called from a critical point. If you intend to process the buffer, do so in another thread. The buffer is only valid for the duration of the callback.

code: virtual void OnFrameCaptured_RenderingThread ( const [FCaptureBaseData](API\Plugins\MediaIOCore\UMediaCapture\FCaptureBaseData) & InBaseData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaCaptureUserData](API\Plugins\MediaIOCore\FMediaCaptureUserData), ESPMode::ThreadSafe > InUserData, void * InBuffer, int32 Width, int32 Height, int32 BytesPerRow )


description: Callback when the buffer was successfully copied to CPU ram. The buffer is only valid for the duration of the callback.  SupportsAnyThreadCapture must return true in the implementation in order for this to be called.

code: virtual void OnFrameCaptured_AnyThread ( const [FCaptureBaseData](API\Plugins\MediaIOCore\UMediaCapture\FCaptureBaseData) & InBaseData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaCaptureUserData](API\Plugins\MediaIOCore\FMediaCaptureUserData), ESPMode::ThreadSafe > InUserData, const [FMediaCaptureResourceData](API\Plugins\MediaIOCore\UMediaCapture\FMediaCaptureResourceData) & InResourceData )


description: AnyThread version of the above callbacks.  SupportsAnyThreadCapture must return true in the implementation in order for this to be called.

code: virtual void OnRHIResourceCaptured_AnyThread ( const [FCaptureBaseData](API\Plugins\MediaIOCore\UMediaCapture\FCaptureBaseData) & InBaseData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaCaptureUserData](API\Plugins\MediaIOCore\FMediaCaptureUserData), ESPMode::ThreadSafe > InUserData, FTextureRHIRef InTexture )


description: Called after initialize for viewport capture type

code: virtual bool PostInitializeCaptureViewport ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSceneViewport](API\Runtime\Engine\Slate\FSceneViewport) > & InSceneViewport )


description: Callbacks when the buffer was successfully copied on the GPU ram. The callback in called from a critical point. If you intend to process the texture/buffer, do so in another thread. The texture is valid for the duration of the callback.

code: virtual void OnRHIResourceCaptured_RenderingThread ( const [FCaptureBaseData](API\Plugins\MediaIOCore\UMediaCapture\FCaptureBaseData) & InBaseData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaCaptureUserData](API\Plugins\MediaIOCore\FMediaCaptureUserData), ESPMode::ThreadSafe > InUserData, FTextureRHIRef InTexture )


description: Should we callOnFrameCaptured_RenderingThread()with a RHI resource -or- readback the memory to CPU ram and callOnFrameCaptured_RenderingThread().

code: virtual bool ShouldCaptureRHIResource() const


code: virtual void StopCaptureImpl ( bool bAllowPendingFrameToBeProcess )


description: Whether the capture callbacks can be called on any thread. If true, the _AnyThread callbacks will be used instead of the _RenderThread ones.

code: virtual bool SupportsAnyThreadCapture() const


code: virtual void UnlockDMATexture_RenderThread ( FTextureRHIRef InTexture )


code: virtual bool UpdateAudioDeviceImpl ( const [FAudioDeviceHandle](API\Runtime\Engine\FAudioDeviceHandle) & InAudioDeviceHandle )


code: virtual bool UpdateRenderTargetImpl ( [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * InRenderTarget )


code: virtual bool UpdateSceneViewportImpl ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSceneViewport](API\Runtime\Engine\Slate\FSceneViewport) > & InSceneViewport )


code: virtual bool ValidateMediaOutput() const


code: UBlackmagicMediaCapture()


className: UBlackmagicMediaCapture

description: Output Media for Blackmagic streams. The output format could be any of EBlackmagicMediaOutputPixelFormat.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UBlackmagicMediaCapture : public [UMediaCapture](API\Plugins\MediaIOCore\UMediaCapture)


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


code: virtual [UMediaCapture](API\Plugins\MediaIOCore\UMediaCapture) * CreateMediaCaptureImpl()


description: The conversion we wish to accomplish on the GPU before the DMA transfer occurs.

code: virtual [EMediaCaptureConversionOperation](API\Plugins\MediaIOCore\EMediaCaptureConversionOperation) GetConversionOperation ( [EMediaCaptureSourceType](API\Plugins\MediaIOCore\EMediaCaptureSourceType) InSourceType ) const


description: The size of the buffer we wish to capture. The size of the buffer can not change during the capture. Return UMediaOutput::RequestCaptureSourceSize if you wish to take the buffer size as the requested size.

code: virtual FIntPoint GetRequestedSize() const


description: The pixel format of the buffer we wish to capture. Some conversion are available. See EMediaCaptureConversionOperation

code: virtual EPixelFormat GetRequestedPixelFormat() const


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( struct [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description:
Validate the media output settings (must be implemented in child classes).
true if validation passed, false otherwise.

code: virtual bool Validate ( [FString](API\Runtime\Core\Containers\FString) & OutFailureReason ) const


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


className: UBlackmagicMediaOutput

description: 'Enable alpha channel support in post-processing' must be set to 'Allow through tonemapper' to enabled the Key.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Meta=(MediaIOCustomLayout="Blackmagic")) class UBlackmagicMediaOutput : public [UMediaOutput](API\Plugins\MediaIOCore\UMediaOutput)

AudioBitDepth

description: Bit depth of each audio sample.

AudioBufferSize

description: Size of the buffer that holds rendered audio samples, a bigger buffer will produce an output of greater quality but will introduce more delay.

AudioSampleRate

description: Sample rate of the audio output.

bEncodeTimecodeInTexel

description: Burn Frame Timecode on the output without any frame number clipping.

bInterlacedFieldsTimecodeNeedToMatch

description: Only make sense in interlaced mode.

bInvertKeyOutput

description: Invert Key Output

bLogDropFrame

description: Log a warning when there's a drop frame.

bOutputAudio

description: Whether to capture and output audio from the engine.

bUseMultithreadedScheduling

description: Whether to use multi threaded scheduling which should improve performance when outputting 4k and 8k content.

bWaitForSyncEvent

description: Try to maintain a the engine "Genlock" with the VSync signal.

HDROptions

type: FBlackmagicMedi...

description: HDR Metadata of the video signal.

NumberOfBlackmagicBuffers

description: Number of frame used to transfer from the system memory to the Blackmagic card.

OutputChannelCount

description: Number of audio channels to output.

OutputConfiguration

type: FMediaIOOutputC...

description: The device, port and video settings that correspond to the output.

PixelFormat

description: Native data format internally used by the device before being converted to SDI/HDMI signal.

TimecodeFormat

type: EMediaIOTimecod...

description: Whether to embed the Engine's timecode to the output frame.


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

module: BlankPlugin

code: static bool IsAvailable()


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 [IBlankPlugin](API\Plugins\BlankPlugin\IBlankPlugin) & Get()


className: IBlankPlugin

description: The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.

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


className: CalculateLocomotion

description: Calculates the locomotion speed from the animation (which may be playrate scaled), according to the analysis properties.

module: BlendSpaceMotionAnalysis

code: bool CalculateLocomotion ( float & Result, const [UBlendSpace](API\Runtime\Engine\Animation\UBlendSpace) & BlendSpace, const [ULocomotionAnalysisProperties](API\Plugins\BlendSpaceMotionAnalysis\ULocomotionAnalysisProperties) * AnalysisProperties, const [UAnimSequence](API\Runtime\Engine\Animation\UAnimSequence) & Animation, const float RateScale )


className: CalculateRootMotion

description: Calculates the root motion movement speed from the animation (which may be playrate scaled), according to the analysis properties.

code: bool CalculateRootMotion ( float & Result, const [UBlendSpace](API\Runtime\Engine\Animation\UBlendSpace) & BlendSpace, const [URootMotionAnalysisProperties](API\Plugins\BlendSpaceMotionAnalysis\URootMotionAnalysisProperties) * AnalysisProperties, const [UAnimSequence](API\Runtime\Engine\Animation\UAnimSequence) & Animation, const float RateScale )


className: EAnalysisLocomotionAxis

code: enum EAnalysisLocomotionAxis { Speed, Direction, ForwardSpeed, RightwardSpeed, UpwardSpeed, ForwardSlope, RightwardSlope, }


className: EAnalysisRootMotionAxis

code: enum EAnalysisRootMotionAxis { Speed, Direction, ForwardSpeed, RightwardSpeed, UpwardSpeed, ForwardSlope, RightwardSlope, }


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

code: virtual void ShutdownModule()


className: FBlendSpaceMotionAnalysis

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


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

code: virtual void StartupModule()


className: UCachedMotionAnalysisProperties

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UCachedMotionAnalysisProperties : public [UCachedAnalysisProperties](API\Editor\Persona\UCachedAnalysisProperties)

LocomotionFunctionAxis

type: EAnalysisLocomo...

RootMotionFunctionAxis

type: EAnalysisRootMo...


code: virtual void InitializeFromCache ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UCachedAnalysisProperties](API\Editor\Persona\UCachedAnalysisProperties) > Cache )


code: virtual void MakeCache ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UCachedAnalysisProperties](API\Editor\Persona\UCachedAnalysisProperties) > & Cache, [UBlendSpace](API\Runtime\Engine\Animation\UBlendSpace) * BlendSpace )


className: ULocomotionAnalysisProperties

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class ULocomotionAnalysisProperties : public [UAnalysisProperties](API\Runtime\Engine\Animation\UAnalysisProperties)

CharacterFacingAxis

type: EAnalysisLinear...

description: World or bone/socket axis that specifies the character's facing direction

CharacterUpAxis

description: World or bone/socket axis that specifies the character's up direction

FunctionAxis

description: Axis for the analysis function

PrimaryBoneSocket

type: FBoneSocketTarg...

description: The primary bone or socket used for analysis

SecondaryBoneSocket

description: The secondary bone or socket used for analysis


className: URootMotionAnalysisProperties

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class URootMotionAnalysisProperties : public [UAnalysisProperties](API\Runtime\Engine\Animation\UAnalysisProperties)

BoneSocket

description: The bone or socket used for analysis

EndTimeFraction

type: float

description: Fraction through each animation at which analysis ends

FunctionAxis

description: Axis for the analysis function

Space

type: EAnalysisSpace

description: The space in which to perform the analysis.

SpaceBoneSocket

description: Bone or socket that defines the analysis space (when it isn't World)

StartTimeFraction

description: Fraction through each animation at which analysis starts


module: BlueprintFileUtils


description: IModuleInterfaceimplementation


className: FBlueprintFileUtilsModule

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


description: Copies a file.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="FileUtils") static bool CopyFile ( const [FString](API\Runtime\Core\Containers\FString) & DestFilename, const [FString](API\Runtime\Core\Containers\FString) & SrcFilename, bool bReplace, bool bEvenIfReadOnly )


description:
Deletes a directory and all the files in it and optionally all sub-directories and files within it
true if the directory was succesfully deleted, false otherwise

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="FileUtils") static bool DeleteDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Directory, bool bMustExist, bool bDeleteRecursively )


description: Deletes a file.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="FileUtils") static bool DeleteFile ( const [FString](API\Runtime\Core\Containers\FString) & Filename, bool bMustExist, bool bEvenIfReadOnly )


description:
Checks if a directory exists
true if Directory exists, false otherwise

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="FileUtils") static bool DirectoryExists ( const [FString](API\Runtime\Core\Containers\FString) & Directory )


description:
Checks if a file exists
true if Filename exists, false otherwise

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="FileUtils") static bool FileExists ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description:
Finds all the files within the given directory, with optional file extension filter.
true if anything was found, false otherwise

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="FileUtils") static bool FindFiles ( const [FString](API\Runtime\Core\Containers\FString) & Directory, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundFiles, const [FString](API\Runtime\Core\Containers\FString) & FileExtension )


description:
Finds all the files and/or directories within the given directory and any sub-directories. Files can be found with anoptional file extension filter.
true if anything was found, false otherwise

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="FileUtils") static bool FindRecursive ( const [FString](API\Runtime\Core\Containers\FString) & StartDirectory, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundPaths, const [FString](API\Runtime\Core\Containers\FString) & Wildcard, bool bFindFiles, bool bFindDirectories )


description: Get the users directory. Platform specific (usually something like MyDocuments or the users home directory


description:
Makes a new directory, and optionally sub-directories
true if the directory was created, false otherwise

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="FileUtils") static bool MakeDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Path, bool bCreateTree )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="FileUtils") static bool MoveFile ( const [FString](API\Runtime\Core\Containers\FString) & DestFilename, const [FString](API\Runtime\Core\Containers\FString) & SrcFilename, bool bReplace, bool bEvenIfReadOnly )


className: UBlueprintFileUtilsBPLibrary


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


className: EHeaderViewSortMethod

module: BlueprintHeaderView

code: enum EHeaderViewSortMethod { None, SortByAccessSpecifier, SortForOptimalPadding, }


className: HeaderViewStyleSet

description: Style set for the header view

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > HeaderViewStyleSet;


className: HeaderViewTableRowStyle

description: TableRow style for the Header View Output


className: HeaderViewTextStyle

description: Text style for the Header View Output


description: Returns whether the Header View supports the given class

code: static bool IsClassHeaderViewSupported ( const [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass )


code: static void OpenHeaderViewForAsset ( [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) InAssetData )


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

code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FBlueprintHeaderViewModule

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


className: FHeaderViewSyntaxColors

Comment

type: FLinearColor


code: FHeaderViewSyntaxColors()


description: Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetCategoryName() const


description: The unique name for your section of settings, uses the class'sFName.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetSectionName() const


description: UObjectinterface

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Gets the section text, uses the classes DisplayName by default.

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetSectionText() const


code: UBlueprintHeaderViewSettings()


className: UBlueprintHeaderViewSettings

description: Settings for the Blueprint Header View Plugin

FontSize

description: Font Size for the Blueprint Header View output

SelectionColor

description: Highlight color for selected items in the Blueprint Header View output

SortMethod

type: EHeaderViewSort...

description: Sorting Method for Header View Functions and Properties

SyntaxColors

type: FHeaderViewSynt...

description: Syntax Highlighting colors for Blueprint Header View output


module: BlueprintMaterialTextureNodes


description: IModuleInterfaceimplementation


className: FBlueprintMaterialTextureNodesModule

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


description: Creates a new Material Instance Constant asset Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Create MIC Editor Only", Keywords="Create MIC", UnsafeDuringActorConstruction="true"), Category=Rendering) static [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * CreateMIC_EditorOnly ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * Material, [FString](API\Runtime\Core\Containers\FString) Name )


description: Samples an array of values from a Texture Render Target 2D. Currently only 4 channel formats are supported. Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="Render Target Sample Rectangle Editor Only", Keywords="Sample Render Target Rectangle"), Category=Rendering) static [TArray](API\Runtime\Core\Containers\TArray)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > RenderTarget_SampleRectangle_EditorOnly ( [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * InRenderTarget, [FLinearColor](API\Runtime\Core\Math\FLinearColor) InRect )


description: Samples a value from a Texture Render Target 2D. Currently only 4 channel formats are supported. Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="Render Target Sample UV Editor Only", Keywords="Sample Render Target UV"), Category=Rendering) static [FLinearColor](API\Runtime\Core\Math\FLinearColor) RenderTarget_SampleUV_EditorOnly ( [UTextureRenderTarget2D](API\Runtime\Engine\Engine\UTextureRenderTarget2D) * InRenderTarget, FVector2D UV )


description: Overrides the Blend Mode of a Material Instance Constant Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Set MIC Blend Mode Editor Only", Keywords="Set MIC Blend Mode", UnsafeDuringActorConstruction="true"), Category=Rendering) static bool SetMICBlendMode_EditorOnly ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, [TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< EBlendMode > BlendMode )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Set MIC Dithered LOD Editor Only", Keywords="Set MIC Dithered LOD Transition", UnsafeDuringActorConstruction="true"), Category=Rendering) static bool SetMICDitheredLODTransition_EditorOnly ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, bool DitheredLODTransition )


description: Overrides the IsThinSurface setting of a Material Instance Constant Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Set MIC IsThinSurface Editor Only", Keywords="Set MIC IsThinSurface", UnsafeDuringActorConstruction="true"), Category=Rendering) static bool SetMICIsThinSurface_EditorOnly ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, bool bIsThinSurface )


description: Sets a Scalar Parameter value in a Material Instance Constant Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Set MIC Scalar Parameter Editor Only", Keywords="Set MIC Scalar Parameter", UnsafeDuringActorConstruction="true"), Category=Rendering) static bool SetMICScalarParam_EditorOnly ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, [FString](API\Runtime\Core\Containers\FString) ParamName, float Value )


description: Overrides the Shading Model of a Material Instance Constant Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Set MIC Shading Model Editor Only", Keywords="Set MIC Shading Model", UnsafeDuringActorConstruction="true"), Category=Rendering) static bool SetMICShadingModel_EditorOnly ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, [TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< EMaterialShadingModel > ShadingModel )


description: Sets a Texture Parameter value in a Material Instance Constant Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Set MIC Texture Parameter Editor Only", Keywords="Set MIC Texture Parameter", UnsafeDuringActorConstruction="true"), Category=Rendering) static bool SetMICTextureParam_EditorOnly ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, [FString](API\Runtime\Core\Containers\FString) ParamName, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * Texture )


description: Overrides the Two Sided setting of a Material Instance Constant Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Set MIC Two Sided Editor Only", Keywords="Set MIC Two Sided", UnsafeDuringActorConstruction="true"), Category=Rendering) static bool SetMICTwoSided_EditorOnly ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, bool TwoSided )


description: Sets a Vector Parameter value in a Material Instance Constant Only works in the editor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(DisplayName="Set MIC Vector Parameter Editor Only", Keywords="Set MIC Vector Parameter", UnsafeDuringActorConstruction="true"), Category=Rendering) static bool SetMICVectorParam_EditorOnly ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * Material, [FString](API\Runtime\Core\Containers\FString) ParamName, [FLinearColor](API\Runtime\Core\Math\FLinearColor) Value )


description: Samples a texel from a Texture 2D with VectorDisplacement Compression

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="Texture2D Sample UV Editor Only", Keywords="Read Texture UV"), Category=Rendering) static [FLinearColor](API\Runtime\Core\Math\FLinearColor) Texture2D_SampleUV_EditorOnly ( [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * Texture, FVector2D UV )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)() static void UpdateMIC ( [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * MIC )


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


className: UBlueprintMaterialTextureNodesBPLibrary

description: For more info on custom blueprint nodes visit documentation:https://docs.unrealengine.com/ProgrammingAndScripting/Blueprints/TechnicalGuide/ExtendingBlueprints


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

module: BlueprintSnapNodes

code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FBlueprintSnapNodesModule

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


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

module: BlueprintStats

code: static [IBlueprintStatsModule](API\Plugins\BlueprintStats\IBlueprintStatsModule) & Get()


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: IBlueprintStatsModule

description: The public interface to this module

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


module: Bridge

code: static [IBridgeModule](API\Plugins\Bridge\IBridgeModule) & Get()


className: IBridgeModule

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


module: BspMode

code: static const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) & Get()


code: static const [FName](API\Runtime\Core\UObject\FName) & GetStyleSetName()


className: StyleSet

description: Singleton instances of this style.

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > StyleSet = nullptr;


code: void RegisterBspBuilderType ( class [UClass](API\Runtime\CoreUObject\UObject\UClass) * InBuilderClass, const [FText](API\Runtime\Core\Internationalization\FText) & InBuilderName, const [FText](API\Runtime\Core\Internationalization\FText) & InBuilderTooltip, const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * InBuilderIcon )


className: FBspModeStyle

description: BSP mode slate style

code: class FBspModeStyle


code: void UnregisterBspBuilderType ( class [UClass](API\Runtime\CoreUObject\UObject\UClass) * InBuilderClass )


className: IBspModeModule

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


module: CableComponent

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


className: ACableActor

description: An actor that renders a simulated cable

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Input, Replication), ShowCategories=("Input|MouseInput", "Input|TouchInput")) class ACableActor : public [AActor](API\Runtime\Engine\GameFramework\AActor)

CableComponent

type: TObjectPtr< cla...

description: Cable component that performs simulation and rendering


className: FCableParticle

description: Struct containing information about a point along the cable

code: struct FCableParticle

bFree

type: bool

description: If this point is free (simulating) or fixed to something

OldPosition

type: FVector

description: Position of point on previous iteration

Position

description: Current position of point


description: Called by owner actor on position shifting Component should update all relevant data structures to reflect new actor location

code: virtual void ApplyWorldOffset ( const FVector & InOffset, bool bWorldShift )


description: Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

code: virtual FBoxSphereBounds CalcBounds ( const FTransform & LocalToWorld ) const


description: This is called concurrently on multiple threads (but never the same component concurrently)

code: virtual void CreateRenderState_Concurrent ( [FRegisterComponentContext](API\Runtime\Engine\Components\FRegisterComponentContext) * Context )


description: Return true if socket with the given name exists

code: virtual bool DoesSocketExist ( [FName](API\Runtime\Core\UObject\FName) InSocketName ) const


description: Gets the Actor that the cable is attached to

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Cable") [AActor](API\Runtime\Engine\GameFramework\AActor) * GetAttachedActor() const


description:
Creates a proxy to represent the primitive to the scene manager in the rendering thread.
The proxy object.

code: virtual [FPrimitiveSceneProxy](API\Runtime\Engine\FPrimitiveSceneProxy) * CreateSceneProxy()


description: Gets the specificUSceneComponentthat the cable is attached to

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Cable") [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * GetAttachedComponent() const


description: Get array of locations of particles (in world space) making up the cable simulation.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Cable") void GetCableParticleLocations ( [TArray](API\Runtime\Core\Containers\TArray)< FVector > & Locations ) const


description: Return number of material elements in this primitive

code: virtual int32 GetNumMaterials() const


description:
Get world-space socket transform.
Socket transform in world space if socket if found. Otherwise it will return component's transform in world space.

code: virtual FTransform GetSocketTransform ( [FName](API\Runtime\Core\UObject\FName) InSocketName, ERelativeTransformSpace TransformSpace ) const


description: Native callback when this component is moved

code: virtual void OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags, ETeleportType Teleport )


description: Returns true if this component has any sockets

code: virtual bool HasAnySockets() const


description: Overridable internal function to respond to changes in the visibility of the component.

code: virtual void OnVisibilityChanged()


description: Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

code: virtual void OnRegister()


description: Get a list of sockets this component contains

code: virtual void QuerySupportedSockets ( [TArray](API\Runtime\Core\Containers\TArray)< [FComponentSocketDescription](API\Runtime\Engine\Engine\FComponentSocketDescription) > & OutSockets ) const


description: Called to send dynamic data for this component to the rendering thread


description: Attaches the end of the cable to a specific Component within an Actor

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Cable") void SetAttachEndTo ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, [FName](API\Runtime\Core\UObject\FName) ComponentProperty, [FName](API\Runtime\Core\UObject\FName) SocketName )


description: Attaches the end of the cable to a specific Component

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Cable") void SetAttachEndToComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * Component, [FName](API\Runtime\Core\UObject\FName) SocketName )


description: Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.

code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


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


className: UCableComponent

description: Component that allows you to specify custom triangle mesh geometry

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Object, Physics, Activation, "Components|Activation"), EditInlineNew, Meta=(BlueprintSpawnableComponent), ClassGroup=Rendering) class UCableComponent : public [UMeshComponent](API\Runtime\Engine\Components\UMeshComponent)

AttachEndTo

type: FComponentRefer...

description: Actor or Component that the defines the end position of the cable

AttachEndToSocketName

type: FName

description: Socket name on the AttachEndTo component to attach to

bAttachEnd

description: Should we fix the end to something (using AttachEndTo and EndLocation), or leave it free.

bAttachStart

description: Should we fix the start to something, or leave it free.

bEnableCollision

description: EXPERIMENTAL.

bEnableStiffness

description: Add stiffness constraints to cable.

bUseSubstepping

description: When false, will still wait for SubstepTime to elapse before updating, but will only run the cable simulation once using all of accumulated simulation time

CableForce

description: Force vector (world space) applied to all particles in cable.

CableGravityScale

description: Scaling applied to world gravity affecting this cable.

CableLength

description: Rest length of the cable

CableWidth

description: How wide the cable geometry is

CollisionFriction

description: If collision is enabled, control how much sliding friction is applied when cable is in contact.

EndLocation

description: End location of cable, relative to AttachEndTo (or AttachEndToSocketName) if specified, otherwise relative to cable component.

NumSegments

description: How many segments the cable has

NumSides

description: Number of sides of the cable geometry

SolverIterations

description: The number of solver iterations controls how 'stiff' the cable is

SubstepTime

description: Controls the simulation substep time for the cable

TileMaterial

description: How many times to repeat the material along the length of the cable


className: ECacheTrackRecorderState

module: CacheTrackRecorder

code: enum ECacheTrackRecorderState { Starting, PreRecord, TickingAfterPre, Started, Stopped, Cancelled, }


className: FCacheRecorderParameters

description: Structure housing all configurable parameters for a take recorder instance

Project

type: FCacheRecorderP...

StartFrame

type: FFrameNumber

User

type: FCacheRecorderU...


code: FCacheRecorderProjectParameters()


className: FCacheRecorderProjectParameters

bCacheTrackRecorderControlsClockTime

description: If true then take recorder will control the sequencer timing when recording with a fixed editor time step.

bRecordTimecode

description: If enabled, timecode will be recorded into each actor track

bShowNotifications

description: Whether to show notification windows or not when recording

bStartAtCurrentTimecode

description: If enabled, track sections will start at the current timecode. Otherwise, 0.

DefaultSlate

type: FString

description: The default name to use for the Slate information

RecordingClockSource

type: EUpdateClockSou...

description: The clock source to use when recording


code: FCacheRecorderUserParameters()


className: FCacheRecorderUserParameters

bMaximizeViewport

description: Whether to maximize the viewport (enter Immersive Mode) when recording

bResetPlayhead

description: Reset playhead to beginning of the playback range when starting recording

bStopAtPlaybackEnd

description: Automatically stop recording when reaching the end of the playback range

EngineTimeDilation

description: The engine time dilation to apply during the recording


description: Called to cancel the recording

code: void Cancel()


description: Retrieve the currently active take recorder instance

code: static [UCacheTrackRecorder](API\Plugins\CacheTrackRecorder\Recorder\UCacheTrackRecorder) * GetActiveRecorder()


description: Get the current state of this recorder


description: Utility method to record a single cache track

code: static void RecordCacheTrack ( [IMovieSceneCachedTrack](API\Runtime\MovieScene\Tracks\IMovieSceneCachedTrack) * Track, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISequencer](API\Editor\Sequencer\ISequencer) > Sequencer, [FCacheRecorderParameters](API\Plugins\CacheTrackRecorder\Recorder\FCacheRecorderParameters) Parameters )


className: FCachedTrackSource

Recorder

type: TObjectPtr<UMo...

Track

type: IMovieSceneCach...


description: Initialize a new recording with the specified parameters. Fails if another recording is currently in progress.

code: bool Initialize ( [ULevelSequence](API\Runtime\LevelSequence\ULevelSequence) * LevelSequence, const [TArray](API\Runtime\Core\Containers\TArray)< [IMovieSceneCachedTrack](API\Runtime\MovieScene\Tracks\IMovieSceneCachedTrack) * > & CacheTracks, const [FString](API\Runtime\Core\Containers\FString) & Slate, const [FCacheRecorderParameters](API\Plugins\CacheTrackRecorder\Recorder\FCacheRecorderParameters) & InParameters, [FText](API\Runtime\Core\Internationalization\FText) * OutError )


description: Utility method to record several cache tracks at once

code: static void RecordCacheTracks ( const [TArray](API\Runtime\Core\Containers\TArray)< [IMovieSceneCachedTrack](API\Runtime\MovieScene\Tracks\IMovieSceneCachedTrack) * > & CacheTracks, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISequencer](API\Editor\Sequencer\ISequencer) > Sequencer, [FCacheRecorderParameters](API\Plugins\CacheTrackRecorder\Recorder\FCacheRecorderParameters) Parameters )


description: Utility method to record all the cache tracks selected in sequencer

code: static void RecordSelectedTracks ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISequencer](API\Editor\Sequencer\ISequencer) > Sequencer, [FCacheRecorderParameters](API\Plugins\CacheTrackRecorder\Recorder\FCacheRecorderParameters) Parameters )


description: Called to stop the recording

code: void Stop()


className: UCacheTrackRecorder

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class UCacheTrackRecorder : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


module: CADInterfaces

code: typedef void A3DAsmModelFile


description: Access the sequence asset that this recorder is recording into

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Cache Recorder") [ULevelSequence](API\Runtime\LevelSequence\ULevelSequence) * GetSequence() const


code: typedef void A3DAsmPartDefinition


description: The time at which to record. Taken from the Sequencer global time, otherwise based on timecode


code: typedef void A3DRiRepresentationItem


code: namespace CADLibrary { enum EModelerType { ModelerUnknown = 0, ModelerCatia = 2, ModelerCatiaV5 = 3, ModelerCadds = 4, ModelerUnigraphics = 5, ModelerParasolid = 6, ModelerEuclid = 7, ModelerIges = 9, ModelerUnisurf = 10, ModelerVda = 11, ModelerStl = 12, ModelerWrl = 13, ModelerDxf = 14, ModelerAcis = 15, ModelerProE = 16, ModelerStep = 18, ModelerIdeas = 19, ModelerJt = 20, ModelerSlw = 22, ModelerCgr = 23, ModelerPrc = 24, ModelerXvl = 25, ModelerHpgl = 26, ModelerTopSolid = 27, ModelerOneSpaceDesigner = 28, Modeler3dxml = 29, ModelerInventor = 30, ModelerPostScript = 31, ModelerPDF = 32, ModelerU3D = 33, ModelerIFC = 34, ModelerDWG = 35, ModelerDWF = 36, ModelerSE = 37, ModelerOBJ = 38, ModelerKMZ = 39, ModelerDAE = 40, Modeler3DS = 41, ModelerRhino = 43, ModelerXML = 44, Modeler3mf = 45, ModelerScs = 46, Modeler3dHtml = 47, ModelerHsf = 48, ModelerGltf = 49, ModelerRevit = 50, ModelerFBX = 51, ModelerStepXML = 52, ModelerPLMXML = 53, ModelerNavisworks = 54, ModelerLast, } }


code: namespace CADLibrary { namespace TechSoftUtils { [A3DTopoFace](API\Plugins\CADInterfaces\A3DTopoFace) * CADLibrary::TechSoftUtils::CreateTopoFaceWithNaturalLoop ( [A3DSurfBase](API\Plugins\CADInterfaces\A3DSurfBase) * CarrierSurface ) } }


code: namespace CADLibrary { namespace TechSoftUtils { [A3DAsmPartDefinition](API\Plugins\ParametricSurface\A3DAsmPartDefinition) * CADLibrary::TechSoftUtils::CreatePart ( [TArray](API\Runtime\Core\Containers\TArray)< [A3DRiRepresentationItem](API\Plugins\ParametricSurface\A3DRiRepresentationItem) * > & RepresentationItems ) } }


code: namespace CADLibrary { namespace TechSoftUtils { [A3DTopoEdge](API\Plugins\CADInterfaces\A3DTopoEdge) * CADLibrary::TechSoftUtils::CreateTopoEdge() } }


code: namespace CADLibrary { namespace TechSoftUtils { [A3DRiRepresentationItem](API\Plugins\ParametricSurface\A3DRiRepresentationItem) * CADLibrary::TechSoftUtils::CreateRIBRep ( [A3DTopoShell](API\Plugins\CADInterfaces\A3DTopoShell) * TopoShellPtr ) } }


code: namespace CADLibrary { namespace TechSoftUtils { [A3DCrvNurbs](API\Plugins\CADInterfaces\A3DCrvNurbs) * CADLibrary::TechSoftUtils::CreateTrimNurbsCurve ( [A3DCrvNurbs](API\Plugins\CADInterfaces\A3DCrvNurbs) * CurveNurbsPtr, double UMin, double UMax, bool bIs2D ) } }


code: namespace CADLibrary { namespace TechSoftUtils { int32 CADLibrary::TechSoftUtils::SetEntityGraphicsColor ( [A3DEntity](API\Plugins\ParametricSurface\A3DEntity) * InEntity, [FColor](API\Runtime\Core\Math\FColor) Color ) } }


className: ECADInterfaceAvailability

code: enum ECADInterfaceAvailability { Unknown, Available, Unavailable, }


code: FArchiveBody ( [FCadId](API\Plugins\CADTools\FCadId) Id, const [FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject) & Parent, [EMesher](API\Plugins\CADTools\CADLibrary__EMesher) InMesher )


className: FArchiveBody

code: class FArchiveBody : public [CADLibrary::FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject)

bIsFromCad

description: Non serialized fields

ColorFaceSet

type: TSet<FMaterial...

MeshActorUId

type: FCadUuid

Mesher

type: EMesher

ParentId

type: FCadId


code: bool SetNameWithAttributeValue ( const TCHAR * Key )


code: FArchiveCADObject ( [FCadId](API\Plugins\CADTools\FCadId) Id, const [FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject) & Parent )


code: virtual ~FArchiveCADObject()


className: FArchiveColor

code: class FArchiveColor

Color

type: FColor

Id

type: FMaterialUId


className: FArchiveCADObject

code: class FArchiveCADObject : public [CADLibrary::FArchiveGraphicProperties](API\Plugins\CADTools\FArchiveGraphicProperties)

MetaData

type: TMap<FString, ...

TransformMatrix

type: FMatrix

Unit

type: double


code: FArchiveColor ( [FMaterialUId](API\Plugins\CADTools\FMaterialUId) InId )


code: FArchiveInstance ( [FCadId](API\Plugins\CADTools\FCadId) Id, const [FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject) & Parent )


className: FArchiveInstance

description: An instance is link to its reference but It also save its tree of override occurrence children

code: class FArchiveInstance : public [CADLibrary::FArchiveWithOverridenChildren](API\Plugins\CADInterfaces\FArchiveWithOverridenChildren)

bIsExternalReference

type: bool


code: FArchiveMaterial ( [FMaterialUId](API\Plugins\CADTools\FMaterialUId) InId )


code: FArchiveOverrideOccurrence()


className: FArchiveMaterial

code: class FArchiveMaterial

Material

type: FCADMaterial


code: FArchiveOverrideOccurrence ( [FCadId](API\Plugins\CADTools\FCadId) Id, const [FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject) & Parent )


className: FArchiveOverrideOccurrence

description: This class save the override data of an occurrence. Indeed, some tools/formats allows to override some occurrences of the instances of a reference (e.g. only the 4th occurrence of C is hidden in the graph below) A

code: class FArchiveOverrideOccurrence : public [CADLibrary::FArchiveWithOverridenChildren](API\Plugins\CADInterfaces\FArchiveWithOverridenChildren)


code: void AddChild ( const [FCadId](API\Plugins\CADTools\FCadId) ChildId )


code: void CopyMetaData ( [FArchiveUnloadedReference](API\Plugins\CADInterfaces\FArchiveUnloadedReference) & Reference )


code: void MoveTemp ( [FArchiveUnloadedReference](API\Plugins\CADInterfaces\FArchiveUnloadedReference) & Reference )


code: FArchiveReference ( [FCadId](API\Plugins\CADTools\FCadId) Id, const [FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject) & Reference )


className: FArchiveReference

code: class FArchiveReference : public [CADLibrary::FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject)

Children

type: TArray<FCadId...


code: [FArchiveBody](API\Plugins\CADInterfaces\FArchiveBody) & AddBody ( [FArchiveReference](API\Plugins\CADInterfaces\FArchiveReference) & Parent, [EMesher](API\Plugins\CADTools\CADLibrary__EMesher) InMesher )


code: void AddExternalReferenceFile ( const [FArchiveUnloadedReference](API\Plugins\CADInterfaces\FArchiveUnloadedReference) & Reference )


code: [FArchiveInstance](API\Plugins\CADInterfaces\FArchiveInstance) & AddInstance ( const [FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject) & Parent )


code: [FArchiveReference](API\Plugins\CADInterfaces\FArchiveReference) & AddOccurrence ( [FArchiveReference](API\Plugins\CADInterfaces\FArchiveReference) & Parent )


code: [FArchiveOverrideOccurrence](API\Plugins\CADInterfaces\FArchiveOverrideOccurrence) & AddOverrideOccurrence ( [FArchiveWithOverridenChildren](API\Plugins\CADInterfaces\FArchiveWithOverridenChildren) & Parent )


code: [FArchiveReference](API\Plugins\CADInterfaces\FArchiveReference) & AddReference ( [FArchiveUnloadedReference](API\Plugins\CADInterfaces\FArchiveUnloadedReference) & )


code: [FArchiveReference](API\Plugins\CADInterfaces\FArchiveReference) & AddReference ( [FArchiveInstance](API\Plugins\CADInterfaces\FArchiveInstance) & Parent )


code: [FArchiveUnloadedReference](API\Plugins\CADInterfaces\FArchiveUnloadedReference) & AddUnloadedReference ( [FArchiveInstance](API\Plugins\CADInterfaces\FArchiveInstance) & Parent )


code: void DeserializeMockUpFile ( const TCHAR * Filename )


code: [FArchiveBody](API\Plugins\CADInterfaces\FArchiveBody) & GetBody ( const [FCadId](API\Plugins\CADTools\FCadId) CadId )


code: [FArchiveInstance](API\Plugins\CADInterfaces\FArchiveInstance) & GetInstance ( const [FCadId](API\Plugins\CADTools\FCadId) CadId )


code: [FArchiveOverrideOccurrence](API\Plugins\CADInterfaces\FArchiveOverrideOccurrence) & GetOverrideOccurrence ( const [FCadId](API\Plugins\CADTools\FCadId) CadId )


code: [FArchiveReference](API\Plugins\CADInterfaces\FArchiveReference) & GetReference ( const [FCadId](API\Plugins\CADTools\FCadId) CadId )


code: bool IsABody ( const [FCadId](API\Plugins\CADTools\FCadId) CadId ) const


code: [FArchiveUnloadedReference](API\Plugins\CADInterfaces\FArchiveUnloadedReference) & GetUnloadedReference ( const [FCadId](API\Plugins\CADTools\FCadId) CadId )


code: bool IsAReference ( [FCadId](API\Plugins\CADTools\FCadId) CadId ) const


code: bool IsAInstance ( const [FCadId](API\Plugins\CADTools\FCadId) CadId ) const


code: bool IsAUnloadedReference ( const [FCadId](API\Plugins\CADTools\FCadId) CadId ) const


code: int32 ReferencesCount() const


code: void RemoveLastOccurrence()


code: void RemoveLastUnloadedReference()


code: void Reserve ( uint32 * ComponentCount )


code: void SerializeMockUp ( const TCHAR * Filename )


className: FArchiveSceneGraph

code: class FArchiveSceneGraph

Bodies

type: TArray<FArchiv...

CADIdToIndex

type: TArray< int32 >

ColorHIdToColor

type: TMap<FMaterial...

ExternalReferenceFiles

type: TArray<FFileDe...


code: FArchiveUnloadedReference()


code: FArchiveUnloadedReference ( [FCadId](API\Plugins\CADTools\FCadId) Id, const [FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject) & Parent )


className: FArchiveUnloadedReference

code: class FArchiveUnloadedReference : public [CADLibrary::FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject)

bIsUnloaded

description: Not serialized

ExternalFile

type: FFileDescriptor


code: void AddOverridenChild ( const [FCadId](API\Plugins\CADTools\FCadId) ChildId )


code: FArchiveWithOverridenChildren()


code: FArchiveWithOverridenChildren ( [FCadId](API\Plugins\CADTools\FCadId) Id, const [FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject) & Parent )


className: FArchiveWithOverridenChildren

code: class FArchiveWithOverridenChildren : public [CADLibrary::FArchiveCADObject](API\Plugins\CADInterfaces\FArchiveCADObject)


code: [FBodyMesh](API\Plugins\CADTools\FBodyMesh) & AddBodyMesh ( [FCadId](API\Plugins\CADTools\FCadId) BodyId, [FArchiveBody](API\Plugins\CADInterfaces\FArchiveBody) & Body )


code: [FFileDescriptor](API\Plugins\CADTools\FFileDescriptor) & AddExternalRef ( const [FFileDescriptor](API\Plugins\CADTools\FFileDescriptor) & InFileDescription )


code: [FArchiveColor](API\Plugins\CADInterfaces\FArchiveColor) & AddColor ( [FMaterialUId](API\Plugins\CADTools\FMaterialUId) ColorId )


code: [FFileDescriptor](API\Plugins\CADTools\FFileDescriptor) & AddExternalRef ( const TCHAR * InFilePath, const TCHAR * InConfiguration, const TCHAR * InRootFilePath )


code: [FArchiveMaterial](API\Plugins\CADInterfaces\FArchiveMaterial) & AddMaterial ( [FMaterialUId](API\Plugins\CADTools\FMaterialUId) MaterialId )


code: void ExportMeshArchiveFile()


code: void ExportSceneGraphFile()


code: void ExportValidationData()


code: [FArchiveColor](API\Plugins\CADInterfaces\FArchiveColor) * FindColor ( [FMaterialUId](API\Plugins\CADTools\FMaterialUId) ColorId )


code: [FArchiveMaterial](API\Plugins\CADInterfaces\FArchiveMaterial) * FindMaterial ( [FMaterialUId](API\Plugins\CADTools\FMaterialUId) MaterialId )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FBodyMesh](API\Plugins\CADTools\FBodyMesh) > & GetBodyMeshes() const


code: const [FString](API\Runtime\Core\Containers\FString) GetBodyCachePath ( uint32 BodyHash ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FBodyMesh](API\Plugins\CADTools\FBodyMesh) > & GetBodyMeshes()


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


description: the path of CAD cache file

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


code: const [FFileDescriptor](API\Plugins\CADTools\FFileDescriptor) & GetCADFileDescription() const


code: [FFileDescriptor](API\Plugins\CADTools\FFileDescriptor) & GetExternalReferences ( int32 Index )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FFileDescriptor](API\Plugins\CADTools\FFileDescriptor) > & GetExternalRefSet() const


code: const [FImportParameters](API\Plugins\CADTools\FImportParameters) & GetImportParameters() const


code: uint32 GetGeomFileHash() const


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


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


code: void GetMeshStatsToCsv ( int32 & FaceCount, int32 & VertexCount )