Navigation
API > API/Plugins > API/Plugins/AudioInsights
Loosely based on SCurveTimelineView TODO move this to a more general place like the Audio Widgets plugin once it's further developed
| Name | SAudioCurveView |
| Type | class |
| Header File | /Engine/Plugins/AudioInsights/Source/AudioInsights/Public/Views/SAudioCurveView.h |
| Include Path | #include "Views/SAudioCurveView.h" |
Syntax
class SAudioCurveView : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SAudioCurveView
- FSlateControlledConstruction → SWidget → SCompoundWidget → SAudioCurveView
Structs
| Name | Remarks |
|---|---|
| FArguments | |
| FCurveMetadata |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCurvePoint | TPair< double, float > | A curve point is a (double XValue, float YValue) pair. | Views/SAudioCurveView.h |
| FOnScrubPositionChanged | TBaseDelegate_TwoParams< void, double, float > | Views/SAudioCurveView.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Construct the widget | Views/SAudioCurveView.h | |
FText GetCurveToolTipDisplayNameText() |
Views/SAudioCurveView.h | ||
FText GetCurveToolTipXValueText() |
Views/SAudioCurveView.h | ||
FText GetCurveToolTipYValueText() |
Views/SAudioCurveView.h | ||
FFloatInterval GetYAxisRange() |
Views/SAudioCurveView.h | ||
float LocalYToValue
(
const FVector2f AllottedLocalSize, |
Views/SAudioCurveView.h | ||
void SetCurvesMetadata
(
TSharedPtr< TMap< uint64, FCurveMetadata > > InMetadataPerCurve |
Views/SAudioCurveView.h | ||
void SetCurvesPointData
(
TSharedPtr< TMap< uint64, TArray< FCurvePoint > > > InCurvesPointData |
Views/SAudioCurveView.h | ||
void SetYAxisRange
(
const FFloatInterval& InRange |
Views/SAudioCurveView.h | ||
void SetYValueFormattingOptions
(
const FNumberFormattingOptions InValueFormattingOptions |
Views/SAudioCurveView.h | ||
float ValueToLocalY
(
const FVector2f AllottedLocalSize, |
Helper functions for converting between widget local Y position and a given data value (within DataRange). | Views/SAudioCurveView.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BroadcastScrubPosition() |
Views/SAudioCurveView.h | ||
TSharedRef< SToolTip > CreateCurveTooltip() |
Views/SAudioCurveView.h | ||
int32 PaintCrosshair
(
const FGeometry& MyGeometry, |
Views/SAudioCurveView.h | ||
int32 PaintCurves
(
const FGeometry& AllottedGeometry, |
Views/SAudioCurveView.h | ||
int32 PaintGridLines
(
const FGeometry& AllottedGeometry, |
Views/SAudioCurveView.h | ||
int32 PaintYAxisLabels
(
const FGeometry& AllottedGeometry, |
Views/SAudioCurveView.h | ||
void UpdateCurveToolTip
(
const FGeometry& MyGeometry, |
Views/SAudioCurveView.h | ||
void UpdateYDataRange() |
Views/SAudioCurveView.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Views/SAudioCurveView.h | ||
virtual FReply OnMouseButtonUp
(
const FGeometry& MyGeometry, |
Views/SAudioCurveView.h | ||
virtual void OnMouseLeave
(
const FPointerEvent& MouseEvent |
Views/SAudioCurveView.h | ||
virtual FReply OnMouseMove
(
const FGeometry& MyGeometry, |
Views/SAudioCurveView.h | ||
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Views/SAudioCurveView.h | ||
| Views/SAudioCurveView.h | |||
virtual FReply OnPreviewMouseButtonDown
(
const FGeometry& MyGeometry, |
Views/SAudioCurveView.h | ||
virtual bool SupportsKeyboardFocus() |
Views/SAudioCurveView.h |