1. Epic GamesDeveloper
  3. UPCGSchedulingPolicyDistanceAndDirection

UPCGSchedulingPolicyDistanceAndDirection

SchedulingPolicyDistanceAndDirection uses distance from the generating volume and alignment with view direction to choose the most important volumes to generate.

API > API/Plugins > API/Plugins/PCG

SchedulingPolicyDistanceAndDirection uses distance from the generating volume and alignment with view direction to choose the most important volumes to generate.

Distance and Direction are calculated with respect to the Generation Source.

   
Name UPCGSchedulingPolicyDistanceAndDirection
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h
Include Path #include "RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGSchedulingPolicyDistanceAndDirection : public UPCGSchedulingPolicyBase

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bUseDirection bool Toggle whether or not direction is used to calculate the scheduling priority. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="RuntimeGeneration|Scheduling Policy Parameters"
  • Meta=(EditCondition="bShouldDisplayProperties", EditConditionHides, HideEditConditionToggle)
bUseDistance bool Toggle whether or not distance is used to calculate the scheduling priority. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="RuntimeGeneration|Scheduling Policy Parameters"
  • Meta=(EditCondition="bShouldDisplayProperties", EditConditionHides, HideEditConditionToggle)
bUseFrustumCulling bool With frustum culling enabled, only components whose bounds overlap the view frustum will be generated. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="RuntimeGeneration|Scheduling Policy Parameters"
  • Meta=(EditCondition="bShouldDisplayProperties", EditConditionHides, HideEditConditionToggle)
CleanupBoundsModifier float Multiplier to scale bounds by when comparing against the view frustum for clean up. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="RuntimeGeneration|Scheduling Policy Parameters"
  • Meta=(ClampMin=1.0f, EditCondition="bShouldDisplayProperties && bUseFrustumCulling", EditConditionHides)
DirectionWeight float Scalar value used to increase/decrease the impact of direction in the scheduling priority. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="RuntimeGeneration|Scheduling Policy Parameters"
  • Meta=(ClampMin=0.0f, UIMax=1.0f, EditCondition="bShouldDisplayProperties && bUseDirection", EditConditionHides)
DistanceWeight float   RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h
  • BlueprintReadWrite
  • Category="RuntimeGeneration|Scheduling Policy Parameters"
  • Meta=(DeprecatedProperty)
  • BlueprintGetter="GetDistanceWeight_DEPRECATED"
  • BlueprintSetter="SetDistanceWeight_DEPRECATED"
GenerateBoundsModifier float Multiplier to scale bounds by when comparing against the view frustum for generation. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="RuntimeGeneration|Scheduling Policy Parameters"
  • Meta=(ClampMin=1.0f, EditCondition="bShouldDisplayProperties && bUseFrustumCulling", EditConditionHides)
NetworkMode EPCGSchedulingPolicyNetworkMode Client/Server policy mode will determine which generation sources to consider. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="RuntimeGeneration|Scheduling Policy Parameters"

Functions

Public

Overridden from UPCGSchedulingPolicyBase

Name Remarks Include Path Unreal Specifiers

virtual double CalculatePriority ( const IPCGGenSourceBase* InGenSource,
const FBox& GenerationBounds,
bool bUse2DGrid
) const

 Calculate the runtime scheduling priority with respect to a Generation Source. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h  

virtual bool CullsBasedOnDirection()

 Should return true if this policy select cells for generation based on generation source direction (for e.g. frustum culling), and false otherwise. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h  

virtual bool IsEquivalent ( const UPCGSchedulingPolicyBase* OtherSchedulingPolicy
) const

 A SchedulingPolicy is equivalent to another SchedulingPolicy if they are the same (same ptr), or if they have the same type and parameter values. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h  

virtual bool ShouldCull ( const IPCGGenSourceBase* InGenSource,
const FBox& GenerationBounds,
bool bUse2DGrid
) const

 True if the generation source would cull the given bounds. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h  

virtual bool ShouldGenerate ( const IPCGGenSourceBase* InGenSource,
const FBox& GenerationBounds,
bool bUse2DGrid
) const

 True if the generation source would consider the given bounds for generation. RuntimeGen/SchedulingPolicies/PCGSchedulingPolicyDistanceAndDirection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page