Files
UnrealEngineUWP/Engine/Source/Runtime/AIModule/Private/EnvironmentQuery/EnvQueryTest.cpp
Michael Trepka 68ebbfaa28 Fixed Clang compile error
#codereview Lukasz.Furman

[CL 2472623 by Michael Trepka in Main branch]
2015-03-09 13:20:36 -04:00

410 lines
14 KiB
C++

// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.
#include "AIModulePrivate.h"
#include "EnvironmentQuery/EnvQueryOption.h"
#include "EnvironmentQuery/EnvQueryContext.h"
#include "EnvironmentQuery/EnvQueryManager.h"
#include "EnvironmentQuery/Contexts/EnvQueryContext_Item.h"
#include "EnvironmentQuery/Items/EnvQueryItemType_VectorBase.h"
#include "EnvironmentQuery/Items/EnvQueryItemType_ActorBase.h"
#include "EnvironmentQuery/EnvQueryTest.h"
#define LOCTEXT_NAMESPACE "EnvQueryGenerator"
UEnvQueryTest::UEnvQueryTest(const FObjectInitializer& ObjectInitializer) : Super(ObjectInitializer)
{
TestPurpose = EEnvTestPurpose::FilterAndScore;
Cost = EEnvTestCost::Low;
FilterType = EEnvTestFilterType::Range;
ScoringEquation = EEnvTestScoreEquation::Linear;
ClampMinType = EEnvQueryTestClamping::None;
ClampMaxType = EEnvQueryTestClamping::None;
BoolValue.DefaultValue = true;
ScoringFactor.DefaultValue = 1.0f;
bWorkOnFloatValues = true;
}
void UEnvQueryTest::NormalizeItemScores(FEnvQueryInstance& QueryInstance)
{
if (!IsScoring())
{
return;
}
ScoringFactor.BindData(QueryInstance.Owner.Get(), QueryInstance.QueryID);
float ScoringFactorValue = ScoringFactor.GetValue();
float MinScore = 0;
float MaxScore = -BIG_NUMBER;
if (ClampMinType == EEnvQueryTestClamping::FilterThreshold)
{
FloatValueMin.BindData(QueryInstance.Owner.Get(), QueryInstance.QueryID);
MinScore = FloatValueMin.GetValue();
}
else if (ClampMinType == EEnvQueryTestClamping::SpecifiedValue)
{
ScoreClampMin.BindData(QueryInstance.Owner.Get(), QueryInstance.QueryID);
MinScore = ScoreClampMin.GetValue();
}
if (ClampMaxType == EEnvQueryTestClamping::FilterThreshold)
{
FloatValueMax.BindData(QueryInstance.Owner.Get(), QueryInstance.QueryID);
MaxScore = FloatValueMax.GetValue();
}
else if (ClampMaxType == EEnvQueryTestClamping::SpecifiedValue)
{
ScoreClampMax.BindData(QueryInstance.Owner.Get(), QueryInstance.QueryID);
MaxScore = ScoreClampMax.GetValue();
}
FEnvQueryItemDetails* DetailInfo = QueryInstance.ItemDetails.GetData();
if ((ClampMinType == EEnvQueryTestClamping::None) ||
(ClampMaxType == EEnvQueryTestClamping::None)
)
{
for (int32 ItemIndex = 0; ItemIndex < QueryInstance.Items.Num(); ItemIndex++, DetailInfo++)
{
if (!QueryInstance.Items[ItemIndex].IsValid())
{
continue;
}
float TestValue = DetailInfo->TestResults[QueryInstance.CurrentTest];
if (TestValue != UEnvQueryTypes::SkippedItemValue)
{
if (ClampMinType == EEnvQueryTestClamping::None)
{
MinScore = FMath::Min(MinScore, TestValue);
}
if (ClampMaxType == EEnvQueryTestClamping::None)
{
MaxScore = FMath::Max(MaxScore, TestValue);
}
}
}
}
DetailInfo = QueryInstance.ItemDetails.GetData();
if (MinScore != MaxScore)
{
for (int32 ItemIndex = 0; ItemIndex < QueryInstance.ItemDetails.Num(); ItemIndex++, DetailInfo++)
{
if (QueryInstance.Items[ItemIndex].IsValid() == false)
{
continue;
}
float WeightedScore = 0.0f;
float& TestValue = DetailInfo->TestResults[QueryInstance.CurrentTest];
if (TestValue != UEnvQueryTypes::SkippedItemValue)
{
const float ClampedScore = FMath::Clamp(TestValue, MinScore, MaxScore);
const float NormalizedScore = (ClampedScore - MinScore) / (MaxScore - MinScore);
// TODO? Add an option to invert the normalized score before applying an equation.
const float NormalizedScoreForEquation = /*bMirrorNormalizedScore ? (1.0f - NormalizedScore) :*/ NormalizedScore;
switch (ScoringEquation)
{
case EEnvTestScoreEquation::Linear:
WeightedScore = ScoringFactorValue * NormalizedScoreForEquation;
break;
case EEnvTestScoreEquation::InverseLinear:
{
// For now, we're avoiding having a separate flag for flipping the direction of the curve
// because we don't have usage cases yet and want to avoid too complex UI. If we decide
// to add that flag later, we'll need to remove this option, since it should just be "mirror
// curve" plus "Linear".
float InverseNormalizedScore = (1.0f - NormalizedScoreForEquation);
WeightedScore = ScoringFactorValue * InverseNormalizedScore;
break;
}
case EEnvTestScoreEquation::Square:
WeightedScore = ScoringFactorValue * (NormalizedScoreForEquation * NormalizedScoreForEquation);
break;
case EEnvTestScoreEquation::Constant:
// I know, it's not "constant". It's "Constant, or zero". The tooltip should explain that.
WeightedScore = (NormalizedScoreForEquation > 0) ? ScoringFactorValue : 0.0f;
break;
default:
break;
}
}
else
{
TestValue = 0.0f;
WeightedScore = 0.0f;
}
#if USE_EQS_DEBUGGER
DetailInfo->TestWeightedScores[QueryInstance.CurrentTest] = WeightedScore;
#endif
QueryInstance.Items[ItemIndex].Score += WeightedScore;
}
}
}
bool UEnvQueryTest::IsContextPerItem(TSubclassOf<UEnvQueryContext> CheckContext) const
{
return CheckContext == UEnvQueryContext_Item::StaticClass();
}
FVector UEnvQueryTest::GetItemLocation(FEnvQueryInstance& QueryInstance, int32 ItemIndex) const
{
return QueryInstance.ItemTypeVectorCDO ?
QueryInstance.ItemTypeVectorCDO->GetItemLocation(QueryInstance.RawData.GetData() + QueryInstance.Items[ItemIndex].DataOffset) :
FVector::ZeroVector;
}
FRotator UEnvQueryTest::GetItemRotation(FEnvQueryInstance& QueryInstance, int32 ItemIndex) const
{
return QueryInstance.ItemTypeVectorCDO ?
QueryInstance.ItemTypeVectorCDO->GetItemRotation(QueryInstance.RawData.GetData() + QueryInstance.Items[ItemIndex].DataOffset) :
FRotator::ZeroRotator;
}
AActor* UEnvQueryTest::GetItemActor(FEnvQueryInstance& QueryInstance, int32 ItemIndex) const
{
return QueryInstance.ItemTypeActorCDO ?
QueryInstance.ItemTypeActorCDO->GetActor(QueryInstance.RawData.GetData() + QueryInstance.Items[ItemIndex].DataOffset) :
NULL;
}
void UEnvQueryTest::PostLoad()
{
Super::PostLoad();
UpdateNodeVersion();
}
void UEnvQueryTest::UpdateNodeVersion()
{
VerNum = EnvQueryTestVersion::Latest;
}
FText UEnvQueryTest::DescribeFloatTestParams() const
{
FText FilterDesc;
if (IsFiltering())
{
switch (FilterType)
{
case EEnvTestFilterType::Minimum:
FilterDesc = FText::Format(LOCTEXT("FilterAtLeast", "at least {0}"), FText::FromString(FloatValueMin.ToString()));
break;
case EEnvTestFilterType::Maximum:
FilterDesc = FText::Format(LOCTEXT("FilterUpTo", "up to {0}"), FText::FromString(FloatValueMax.ToString()));
break;
case EEnvTestFilterType::Range:
FilterDesc = FText::Format(LOCTEXT("FilterBetween", "between {0} and {1}"),
FText::FromString(FloatValueMin.ToString()), FText::FromString(FloatValueMax.ToString()));
break;
default:
break;
}
}
FNumberFormattingOptions NumberFormattingOptions;
NumberFormattingOptions.MaximumFractionalDigits = 2;
FText ScoreDesc;
if (!IsScoring())
{
ScoreDesc = LOCTEXT("DontScore", "don't score");
}
else if (ScoringEquation == EEnvTestScoreEquation::Constant)
{
FText FactorDesc = ScoringFactor.IsDynamic() ?
FText::FromString(ScoringFactor.ToString()) :
FText::Format(FText::FromString("x{0}"), FText::AsNumber(FMath::Abs(ScoringFactor.DefaultValue), &NumberFormattingOptions));
ScoreDesc = FText::Format(FText::FromString("{0} [{1}]"), LOCTEXT("ScoreConstant", "constant score"), FactorDesc);
}
else if (ScoringFactor.IsDynamic())
{
ScoreDesc = FText::Format(FText::FromString("{0}: {1}"), LOCTEXT("ScoreFactor", "score factor"), FText::FromString(ScoringFactor.ToString()));
}
else
{
FText ScoreSignDesc = (ScoringFactor.DefaultValue > 0) ? LOCTEXT("Greater", "greater") : LOCTEXT("Lesser", "lesser");
FText ScoreValueDesc = FText::AsNumber(FMath::Abs(ScoringFactor.DefaultValue), &NumberFormattingOptions);
ScoreDesc = FText::Format(FText::FromString("{0} {1} [x{2}]"), LOCTEXT("ScorePrefer", "prefer"), ScoreSignDesc, ScoreValueDesc);
}
return FilterDesc.IsEmpty() ? ScoreDesc : FText::Format(FText::FromString("{0}, {1}"), FilterDesc, ScoreDesc);
}
FText UEnvQueryTest::DescribeBoolTestParams(const FString& ConditionDesc) const
{
FText FilterDesc;
if (IsFiltering() && FilterType == EEnvTestFilterType::Match)
{
FilterDesc = BoolValue.IsDynamic() ?
FText::Format(FText::FromString("{0} {1}: {2}"), LOCTEXT("FilterRequire", "require"), FText::FromString(ConditionDesc), FText::FromString(BoolValue.ToString())) :
FText::Format(FText::FromString("{0} {1}{2}"), LOCTEXT("FilterRequire", "require"), BoolValue.DefaultValue ? FText::GetEmpty() : LOCTEXT("NotWithSpace", "not "), FText::FromString(ConditionDesc));
}
FNumberFormattingOptions NumberFormattingOptions;
NumberFormattingOptions.MaximumFractionalDigits = 2;
FText ScoreDesc;
if (!IsScoring())
{
ScoreDesc = LOCTEXT("DontScore", "don't score");
}
else if (ScoringEquation == EEnvTestScoreEquation::Constant)
{
FText FactorDesc = ScoringFactor.IsDynamic() ?
FText::FromString(ScoringFactor.ToString()) :
FText::Format(FText::FromString("x{0}"), FText::AsNumber(FMath::Abs(ScoringFactor.DefaultValue), &NumberFormattingOptions));
ScoreDesc = FText::Format(FText::FromString("{0} [{1}]"), LOCTEXT("ScoreConstant", "constant score"), FactorDesc);
}
else if (ScoringFactor.IsDynamic())
{
ScoreDesc = FText::Format(FText::FromString("{0}: {1}"), LOCTEXT("ScoreFactor", "score factor"), FText::FromString(ScoringFactor.ToString()));
}
else
{
FText ScoreSignDesc = (ScoringFactor.DefaultValue > 0) ? FText::GetEmpty() : LOCTEXT("NotWithSpace", "not ");
FText ScoreValueDesc = FText::AsNumber(FMath::Abs(ScoringFactor.DefaultValue), &NumberFormattingOptions);
ScoreDesc = FText::Format(FText::FromString("{0} {1}{2} [x{3}]"), LOCTEXT("ScorePrefer", "prefer"), ScoreSignDesc, FText::FromString(ConditionDesc), ScoreValueDesc);
}
return FilterDesc.IsEmpty() ? ScoreDesc : FText::Format(FText::FromString("{0}, {1}"), FilterDesc, ScoreDesc);
}
void UEnvQueryTest::SetWorkOnFloatValues(bool bWorkOnFloats)
{
bWorkOnFloatValues = bWorkOnFloats;
// Make sure FilterType is set to a valid value.
if (bWorkOnFloats)
{
if (FilterType == EEnvTestFilterType::Match)
{
FilterType = EEnvTestFilterType::Range;
}
ScoringEquation = EEnvTestScoreEquation::Linear;
}
else
{
if (FilterType != EEnvTestFilterType::Match)
{
FilterType = EEnvTestFilterType::Match;
}
// Scoring MUST be Constant for boolean tests.
ScoringEquation = EEnvTestScoreEquation::Constant;
}
UpdatePreviewData();
}
#if WITH_EDITOR
void UEnvQueryTest::PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent)
{
Super::PostEditChangeProperty(PropertyChangedEvent);
if (PropertyChangedEvent.Property)
{
if (PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(UEnvQueryTest, TestPurpose) ||
PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(UEnvQueryTest, FilterType) ||
PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(UEnvQueryTest, ClampMaxType) ||
PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(UEnvQueryTest, ClampMinType) ||
PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(UEnvQueryTest, ScoringEquation) ||
PropertyChangedEvent.Property->GetFName() == GET_MEMBER_NAME_CHECKED(UEnvQueryTest, ScoringFactor))
{
UpdatePreviewData();
}
}
}
#endif
void UEnvQueryTest::UpdatePreviewData()
{
#if WITH_EDITORONLY_DATA && WITH_EDITOR
const int32 MaxSamples = 11;
static float SamplesLinear[MaxSamples] = { 0.0f };
static float SamplesSquare[MaxSamples] = { 0.0f };
static float SamplesConstant[MaxSamples] = { 0.0f };
static bool bSamplesInitialized = false;
if (!bSamplesInitialized)
{
bSamplesInitialized = true;
for (int32 Idx = 0; Idx < MaxSamples; Idx++)
{
const float XValue = 1.0f * Idx / (MaxSamples - 1);
SamplesLinear[Idx] = XValue;
SamplesSquare[Idx] = XValue * XValue;
SamplesConstant[Idx] = 0.5f; // just for looks on preview, not the actual value
}
}
const float* AllSamples[] = { SamplesLinear, SamplesSquare, SamplesLinear, SamplesConstant };
int32 EquationType = (ScoringEquation >= ARRAY_COUNT(AllSamples)) ? EEnvTestScoreEquation::Constant : (EEnvTestScoreEquation::Type)ScoringEquation;
if (TestPurpose == EEnvTestPurpose::Filter)
{
// pure filtering won't apply any scoring, draw flat line
EquationType = EEnvTestScoreEquation::Constant;
}
const float* SamplesArray = AllSamples[EquationType];
bool bInversed = ScoringFactor.GetValue() < 0.0f;
if (EquationType == EEnvTestScoreEquation::InverseLinear)
{
bInversed = !bInversed;
}
for (int32 Idx = 0; Idx < MaxSamples; Idx++)
{
PreviewData.Samples[Idx] = bInversed ? (1.0f - SamplesArray[Idx]) : SamplesArray[Idx];
}
PreviewData.bShowClampMin = (ClampMinType != EEnvQueryTestClamping::None);
PreviewData.bShowClampMax = (ClampMaxType != EEnvQueryTestClamping::None);
const bool bCanFilter = (TestPurpose != EEnvTestPurpose::Score);
PreviewData.bShowFilterHigh = ((FilterType == EEnvTestFilterType::Maximum) || (FilterType == EEnvTestFilterType::Range)) && bCanFilter;
PreviewData.bShowFilterLow = ((FilterType == EEnvTestFilterType::Minimum) || (FilterType == EEnvTestFilterType::Range)) && bCanFilter;
PreviewData.FilterLow = 0.2f;
PreviewData.FilterHigh = 0.8f;
PreviewData.ClampMin = (ClampMinType == EEnvQueryTestClamping::FilterThreshold) ? PreviewData.FilterLow : 0.3f;
PreviewData.ClampMax = (ClampMaxType == EEnvQueryTestClamping::FilterThreshold) ? PreviewData.FilterHigh : 0.7f;
if (PreviewData.bShowClampMin)
{
const int32 FixedIdx = FMath::TruncToInt(PreviewData.ClampMin * 10.0f);
for (int32 Idx = 0; Idx < FixedIdx; Idx++)
{
PreviewData.Samples[Idx] = PreviewData.Samples[FixedIdx];
}
}
if (PreviewData.bShowClampMax)
{
const int32 FixedIdx = FMath::TruncToInt(PreviewData.ClampMax * 10.0f) + 1;
for (int32 Idx = FixedIdx + 1; Idx < MaxSamples; Idx++)
{
PreviewData.Samples[Idx] = PreviewData.Samples[FixedIdx];
}
}
#endif
}
#undef LOCTEXT_NAMESPACE