FWaveformEditor

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

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  
bDeferredRenderUpdatePending bool Defer UpdateRenderElements onto a single ticker fire so heavy regen doesn't run every mouse-move. WaveformEditor.h  
bIsInteractingWithTransformations bool   WaveformEditor.h  
bMarkerTransformationIsActive bool   WaveformEditor.h  
bSoundWaveBeingDeleted bool Set to true when the editor is being closed because the SoundWave asset is being deleted or invalidated. WaveformEditor.h  
bWasPlayingBeforeChange bool   WaveformEditor.h  
bWasPlayingBeforeScrubbing bool   WaveformEditor.h  
CachedFadeInAmount float   WaveformEditor.h  
CachedFadeOutAmount float   WaveformEditor.h  
ChangeCuePointOriginNotificationItem TSharedPtr< SNotificationItem >   WaveformEditor.h  
DeferredRenderTickerHandle FTSTicker::FDelegateHandle Handle to the in-flight one-shot ticker, kept so a non-interactive supersede or the destructor can cancel the pending fire. WaveformEditor.h  
FadeInType TSubclassOf< UTransformationFadeFunction >   WaveformEditor.h  
FadeOutType TSubclassOf< UTransformationFadeFunction >   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 bIsAsync
)

   WaveformEditor.h  

const int64 GetPlayheadFramePosition()

   WaveformEditor.h  

TSharedPtr< class FSparseSampledSequenceTransportCoordinator > GetTransportCoordinator()

   WaveformEditor.h  

bool Init ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
USoundWave* SoundWaveToEdit
)

   WaveformEditor.h  

void OnAssetReimport ( UObject* ReimportedObject,
bool bSuccessfullReimport
)

   WaveformEditor.h  

void ResetPlaybackToStart()

   WaveformEditor.h  

void SkipToNextMarker()

 Skips the playhead to the next marker. WaveformEditor.h  

Public Virtual

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 bool CloseWindow ( EAssetEditorCloseReason InCloseReason
)

 FAssetEditorToolkit interface WaveformEditor.h  

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
)

   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,
const TArray< TPair< UObject*, FTransactionObjectEvent > >& TransactionObjectContexts
) const

   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,
FEditPropertyChain* PropertyThatChanged
)

   WaveformEditor.h  

virtual void NotifyPreChange ( FEditPropertyChain* PropertyAboutToChange
)

 FNotifyHook interface WaveformEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page