FieldOfViewNetObjectPrioritizer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Iris/ReplicationSystem/Prioritization/LocationBasedNetObjectPrioritizer.h"
#include "Net/Core/NetBitArray.h"
#include "Math/VectorRegister.h"
#include "UObject/StrongObjectPtr.h"
#include "FieldOfViewNetObjectPrioritizer.generated.h"
 
class FMemStackBase;
 
UCLASS(transient, config=Engine)
class UFieldOfViewNetObjectPrioritizerConfig : public UNetObjectPrioritizerConfig
{
    GENERATED_BODY()
 
public:
    /* Inner sphere radius that will set InnerSpherePriority on objects in it. */
    UPROPERTY(Config)
    float InnerSphereRadius = 3000.0f;
 
    UPROPERTY(Config)
    float InnerSpherePriority = 1.0f;
 
    /* Outer sphere radius that will set OuterSpherePriority on objects in it. */
    UPROPERTY(Config)
    float OuterSphereRadius = 10000.0f;
 
    UPROPERTY(Config)
    float OuterSpherePriority = 0.2f;
 
    /* The field of view used to form the cone. */
    UPROPERTY(Config)
    float ConeFieldOfViewDegrees = 45.0f;
 
    UPROPERTY(Config)
    float InnerConeLength = 3000.0f;
 
    UPROPERTY(Config)
    float ConeLength = 20000.0f;
 
    UPROPERTY(Config)
    float MinConePriority = 0.2f;
 
    UPROPERTY(Config)
    float MaxConePriority = 1.0f;
 
    UPROPERTY(Config)
    float LineOfSightWidth = 200.0f;
 
    UPROPERTY(Config)
    float LineOfSightPriority = 1.0f;
    
    UPROPERTY(Config)
    float OutsidePriority = 0.1f;
};
 
UCLASS(Transient, MinimalAPI)
class UFieldOfViewNetObjectPrioritizer : public ULocationBasedNetObjectPrioritizer
{
    GENERATED_BODY()
 
protected:
    // UNetObjectPrioritizer interface
    IRISCORE_API virtual void Init(FNetObjectPrioritizerInitParams& Params) override;
    IRISCORE_API virtual void Deinit() override;
    IRISCORE_API virtual void Prioritize(FNetObjectPrioritizationParams&) override;
 
protected:
    struct FPriorityCalculationConstants
    {
        // Cone constants
        VectorRegister InnerConeLength;
        VectorRegister ConeLength;
        // OuterConeLength - InnerConeLength
        VectorRegister ConeLengthDiff;
        // 1/ConeLengthDiff
        VectorRegister InvConeLengthDiff;
        // ConeLength/ConeRadius for cone radius calculations at various distances.
        VectorRegister ConeRadiusFactor;
        VectorRegister InnerConePriority;
        VectorRegister OuterConePriority;
        // OuterConePriority - InnerConePriority 
        VectorRegister ConePriorityDiff;
 
        // Inner and outer sphere constants
        VectorRegister InnerSphereRadiusSqr;
        VectorRegister OuterSphereRadiusSqr;
        VectorRegister InnerSpherePriority;
        VectorRegister OuterSpherePriority;
 
        // Line of sight constants
        VectorRegister LineOfSightRadiusSqr;
        VectorRegister LineOfSightPriority;
 
        // Outside priority
        VectorRegister OutsidePriority;
    };
 
    struct FBatchParams
    {
        FPriorityCalculationConstants PriorityCalculationConstants;
        UE::Net::FReplicationView View;
        uint32 ConnectionId;
 
        uint32 ObjectCount;
        VectorRegister* Positions;
        float* Priorities;
    };
 
protected:
    void PrepareBatch(FBatchParams& BatchParams, const FNetObjectPrioritizationParams& PrioritizationParams, uint32 ObjectIndexStartOffset);
    void PrioritizeBatch(FBatchParams& BatchParams);
    void FinishBatch(const FBatchParams& BatchParams, FNetObjectPrioritizationParams& PrioritizationParams, uint32 ObjectIndexStartOffset);
    void SetupBatchParams(FBatchParams& OutBatchParams, const FNetObjectPrioritizationParams& PrioritizationParams, uint32 MaxBatchObjectCount, FMemStackBase& Mem);
    void SetupCalculationConstants(FPriorityCalculationConstants& OutConstants);
 
    TStrongObjectPtr<UFieldOfViewNetObjectPrioritizerConfig> Config;
};