Navigation
API > API/Plugins > API/Plugins/WaveformEditor
| Name | FWaveformEditor |
| Type | class |
| Header File | /Engine/Plugins/Editor/WaveformEditor/Source/WaveformEditor/Public/WaveformEditor.h |
| Include Path | #include "WaveformEditor.h" |
Syntax
class FWaveformEditor :
public FAssetEditorToolkit ,
public FEditorUndoClient ,
public FGCObject ,
public FNotifyHook
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FAssetEditorToolkit → FWaveformEditor
- FEditorUndoClient → FWaveformEditor
- FGCObject → FWaveformEditor
- FNotifyHook → FWaveformEditor
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FWaveformEditor() |
WaveformEditor.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AppIdentifier | const FName | Settings Editor App Identifier | WaveformEditor.h |
| DefaultFadeInAmount | float | WaveformEditor.h | |
| DefaultFadeOutAmount | float | WaveformEditor.h | |
| EditorName | const FName | WaveformEditor.h | |
| EndTimeInvalid | const double | WaveformEditor.h | |
| PropertiesTabId | const FName | Tab Ids | WaveformEditor.h |
| ToolkitFName | const FName | WaveformEditor.h | |
| TransformationsTabId | const FName | WaveformEditor.h | |
| WaveformDisplayTabId | const FName | WaveformEditor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioComponent | TObjectPtr< UAudioComponent > | WaveformEditor.h | ||
| bCueChangeRegisteredByWaveformEditor | bool | Tracking bool to ensure we detect wave cue changes and regenerate transformations Checking the event is bound may have issues if other systems need to subscribe for wave cue array changes | WaveformEditor.h | |
| bIsInteractingWithTransformations | bool | WaveformEditor.h | ||
| bMarkerTransformationIsActive | bool | WaveformEditor.h | ||
| bWasPlayingBeforeChange | bool | WaveformEditor.h | ||
| bWasPlayingBeforeScrubbing | bool | WaveformEditor.h | ||
| CachedFadeInAmount | float | WaveformEditor.h | ||
| CachedFadeOutAmount | float | WaveformEditor.h | ||
| ChangeCuePointOriginNotificationItem | TSharedPtr< SNotificationItem > | WaveformEditor.h | ||
| FadeInType | TSubclassOf< UFadeFunction > | WaveformEditor.h | ||
| FadeOutType | TSubclassOf< UFadeFunction > | WaveformEditor.h | ||
| LastReceivedPlaybackPercent | float | WaveformEditor.h | ||
| PlaybackTimeBeforeTransformInteraction | float | WaveformEditor.h | ||
| PropertiesDetails | TSharedPtr< IDetailsView > | Properties tab | WaveformEditor.h | |
| ReimportMode | enum FWaveformEditor::EWaveEditorReimportMode | WaveformEditor.h | ||
| ReopenNotificationItem | TSharedPtr< SNotificationItem > | WaveformEditor.h | ||
| SoundWave | TObjectPtr< USoundWave > | WaveformEditor.h | ||
| StartTimeBeforeTransformInteraction | float | WaveformEditor.h | ||
| TransformationChainConfig | FWaveTransformUObjectConfiguration | WaveformEditor.h | ||
| TransformationsDetails | TSharedPtr< IDetailsView > | Transformations tab | WaveformEditor.h | |
| TransformInteractionPlayState | EAudioComponentPlayState | WaveformEditor.h | ||
| TransportController | TSharedPtr< FWaveformEditorTransportController > | Controls Transport of the audio component | WaveformEditor.h | |
| TransportCoordinator | TSharedPtr< class FSparseSampledSequenceTransportCoordinator > | Manages Transport info in waveform panel | WaveformEditor.h | |
| WaveformView | FTransformedWaveformView | WaveformEditor.h | ||
| WaveWriter | TSharedPtr< class FWaveformEditorWaveWriter > | Exports the edited waveform to a new asset | WaveformEditor.h | |
| ZoomManager | TSharedPtr< FWaveformEditorZoomController > | Controls and propagates zoom level | WaveformEditor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExportWaveform
(
bool bPromptUserToSave |
WaveformEditor.h | ||
bool Init
(
const EToolkitMode::Type Mode, |
WaveformEditor.h | ||
void OnAssetReimport
(
UObject* ReimportedObject, |
WaveformEditor.h |
Overridden from FAssetEditorToolkit
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EVisibility GetVisibilityWhileAssetCompiling() |
WaveformEditor.h | ||
virtual void InitToolMenuContext
(
FToolMenuContext& MenuContext |
WaveformEditor.h |
Overridden from IAssetEditorInstance
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetEditorName() |
WaveformEditor.h |
Overridden from IToolkit
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FText GetBaseToolkitName() |
WaveformEditor.h | ||
virtual FName GetToolkitFName() |
WaveformEditor.h | ||
virtual FLinearColor GetWorldCentricTabColorScale() |
WaveformEditor.h | ||
virtual FString GetWorldCentricTabPrefix() |
WaveformEditor.h | ||
virtual void RegisterTabSpawners
(
const TSharedRef< FTabManager >& TabManager |
FAssetEditorToolkit interface | WaveformEditor.h | |
virtual void UnregisterTabSpawners
(
const TSharedRef< FTabManager >& TabManager |
WaveformEditor.h |
Overridden from FEditorUndoClient
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool MatchesContext
(
const FTransactionContext& InContext, |
WaveformEditor.h | ||
virtual void PostRedo
(
bool bSuccess |
WaveformEditor.h | ||
virtual void PostUndo
(
bool bSuccess |
FEditorUndo interface | WaveformEditor.h |
Overridden from FNotifyHook
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void NotifyPostChange
(
const FPropertyChangedEvent& PropertyChangedEvent, |
WaveformEditor.h | ||
virtual void NotifyPreChange
(
FEditPropertyChain* PropertyAboutToChange |
FNotifyHook interface | WaveformEditor.h |