SCircumferenceMarkerWidget Class Reference

#include <SCircumferenceMarkerWidget.h>

Inheritance diagram for SCircumferenceMarkerWidget:

Public Member Functions
void	Construct (const FArguments &InArgs)
	SCircumferenceMarkerWidget ()
virtual int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
virtual FVector2D	ComputeDesiredSize (float) const override
virtual bool	ComputeVolatility () const override
void	SetRadius (float NewRadius)
void	SetMarkerList (TArray< FCircumferenceMarkerEntry > &NewMarkerList)

Private Member Functions
	SLATE_BEGIN_ARGS (SCircumferenceMarkerWidget)
FSlateRenderTransform	GetMarkerRenderTransform (const FCircumferenceMarkerEntry &Marker, const float BaseRadius, const float HUDScale) const

Private Attributes
const FSlateBrush *	MarkerBrush
TArray< FCircumferenceMarkerEntry >	MarkerList
TAttribute< float >	Radius
TAttribute< FSlateColor >	ColorAndOpacity
bool	bColorAndOpacitySet
uint8	bReticleCornerOutsideSpreadRadius: 1

Constructor & Destructor Documentation

SCircumferenceMarkerWidget()

SCircumferenceMarkerWidget::SCircumferenceMarkerWidget

(

)

{
}

Member Function Documentation

ComputeDesiredSize()

FVector2D SCircumferenceMarkerWidget::ComputeDesiredSize ( float ) const

overridevirtual

{
    check(MarkerBrush);
    const float SampledRadius = Radius.Get();
    return FVector2D((MarkerBrush->ImageSize.X + SampledRadius) * 2.0f, (MarkerBrush->ImageSize.Y + SampledRadius) * 2.0f);
}

ComputeVolatility()

virtual bool SCircumferenceMarkerWidget::ComputeVolatility ( ) const

inlineoverridevirtual

{ return true; }

Construct()

void SCircumferenceMarkerWidget::Construct

(

const FArguments &

InArgs

)

What each marker on the circumference looks like At which angles should a marker be drawn The radius of the circle The color and opacity of the marker

{
    MarkerBrush = InArgs._MarkerBrush;
    MarkerList = InArgs._MarkerList;
    Radius = InArgs._Radius;
    bColorAndOpacitySet = InArgs._ColorAndOpacity.IsSet();
    ColorAndOpacity = InArgs._ColorAndOpacity;
}

GetMarkerRenderTransform()

FSlateRenderTransform SCircumferenceMarkerWidget::GetMarkerRenderTransform ( const FCircumferenceMarkerEntry & Marker, const float BaseRadius, const float HUDScale ) const

private

{
    // Determine the radius to use for the corners
    float XRadius = BaseRadius;
    float YRadius = BaseRadius;
    if (bReticleCornerOutsideSpreadRadius)
    {
        XRadius += MarkerBrush->ImageSize.X * 0.5f;
        YRadius += MarkerBrush->ImageSize.X * 0.5f;
    }
 
    // Get the angle and orientation for this reticle corner
    const float LocalRotationRadians = FMath::DegreesToRadians(Marker.ImageRotationAngle);
    const float PositionAngleRadians = FMath::DegreesToRadians(Marker.PositionAngle);
 
    // First rotate the corner image about the origin
    FSlateRenderTransform RotateAboutOrigin(Concatenate(FVector2D(-MarkerBrush->ImageSize.X * 0.5f, -MarkerBrush->ImageSize.Y * 0.5f), FQuat2D(LocalRotationRadians), FVector2D(MarkerBrush->ImageSize.X * 0.5f, MarkerBrush->ImageSize.Y * 0.5f)));
 
    // Move the rotated image to the right place on the spread radius
    return TransformCast<FSlateRenderTransform>(Concatenate(RotateAboutOrigin, FVector2D(XRadius * FMath::Sin(PositionAngleRadians) * HUDScale, -YRadius * FMath::Cos(PositionAngleRadians) * HUDScale)));
}

OnPaint()

int32 SCircumferenceMarkerWidget::OnPaint ( const FPaintArgs & Args, const FGeometry & AllottedGeometry, const FSlateRect & MyCullingRect, FSlateWindowElementList & OutDrawElements, int32 LayerId, const FWidgetStyle & InWidgetStyle, bool bParentEnabled ) const

overridevirtual

{
    const bool bIsEnabled = ShouldBeEnabled(bParentEnabled);
    const ESlateDrawEffect DrawEffects = bIsEnabled ? ESlateDrawEffect::None : ESlateDrawEffect::DisabledEffect;
    const FVector2D LocalCenter = AllottedGeometry.GetLocalPositionAtCoordinates(FVector2D(0.5f, 0.5f));
 
    const bool bDrawMarkers = (MarkerList.Num() > 0) && (MarkerBrush != nullptr);
 
    if (bDrawMarkers == true)
    {
        const FLinearColor MarkerColor = bColorAndOpacitySet ?
            ColorAndOpacity.Get().GetColor(InWidgetStyle) :
            (InWidgetStyle.GetColorAndOpacityTint() * MarkerBrush->GetTint(InWidgetStyle));
 
        if (MarkerColor.A > KINDA_SMALL_NUMBER)
        {
            const float BaseRadius = Radius.Get();
            const float ApplicationScale = GetDefault<UUserInterfaceSettings>()->ApplicationScale;
            for (const FCircumferenceMarkerEntry& Marker : MarkerList)
            {
                const FSlateRenderTransform MarkerTransform = GetMarkerRenderTransform(Marker, BaseRadius, ApplicationScale);
 
                const FPaintGeometry Geometry(AllottedGeometry.ToPaintGeometry(MarkerBrush->ImageSize, FSlateLayoutTransform(LocalCenter - (MarkerBrush->ImageSize * 0.5f)), MarkerTransform, FVector2D(0.0f, 0.0f)));
                FSlateDrawElement::MakeBox(OutDrawElements, LayerId, Geometry, MarkerBrush, DrawEffects, MarkerColor);
            }
        }
    }
 
    return LayerId;
}

SetMarkerList()

void SCircumferenceMarkerWidget::SetMarkerList

(

TArray< FCircumferenceMarkerEntry > &

NewMarkerList

)

{
    MarkerList = NewMarkerList;
}

SetRadius()

void SCircumferenceMarkerWidget::SetRadius

(

float

NewRadius

)

{
    if (Radius.IsBound() || (Radius.Get() != NewRadius))
    {
        Radius = NewRadius;
        Invalidate(EInvalidateWidgetReason::Layout);
    }
}

SLATE_BEGIN_ARGS()

SCircumferenceMarkerWidget::SLATE_BEGIN_ARGS ( SCircumferenceMarkerWidget )

inlineprivate

        : _MarkerBrush(FCoreStyle::Get().GetBrush("Throbber.CircleChunk"))
        , _Radius(48.0f)
    {
    }

Member Data Documentation

bColorAndOpacitySet

bool SCircumferenceMarkerWidget::bColorAndOpacitySet

private

bReticleCornerOutsideSpreadRadius

uint8 SCircumferenceMarkerWidget::bReticleCornerOutsideSpreadRadius

private

Whether reticle corner images are placed outside the spread radius

ColorAndOpacity

TAttribute<FSlateColor> SCircumferenceMarkerWidget::ColorAndOpacity

private

Color and opacity of the markers

MarkerBrush

const FSlateBrush* SCircumferenceMarkerWidget::MarkerBrush

private

What each marker on the circumference looks like

MarkerList

TArray<FCircumferenceMarkerEntry> SCircumferenceMarkerWidget::MarkerList

private

Angles around the reticle center to place ReticleCornerImage icons

Radius

TAttribute<float> SCircumferenceMarkerWidget::Radius

private

The radius of the circle

---

The documentation for this class was generated from the following files:

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/WeaponSystem/Source/WeaponSystem/Public/Widgets/SCircumferenceMarkerWidget.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/WeaponSystem/Source/WeaponSystem/Private/Widgets/SCircumferenceMarkerWidget.cpp