Grail (C++)  1.3.0
A multi-platform, modular, universal engine for embedding advanced AI in games.
Consideration.hh
1 // Copyright QED Software 2023.
2 
3 #ifndef GRAIL_CONSIDERATION_H
4 #define GRAIL_CONSIDERATION_H
5 
6 #include "Evaluator.hh"
7 #include "../GrailCore/AIEntity.hh"
8 #include "../GrailCore/Blackboard.hh"
9 #include "../GrailCore/EntityBlackboardPair.hh"
10 
11 namespace grail
12 {
13 namespace evaluator
14 {
15  template <typename ContextType>
20  class Consideration : public Evaluator<ContextType>
21  {
22  public:
23  Consideration() = default;
24 
25  Consideration(const Consideration<ContextType>&) = default;
27 
28  virtual ~Consideration() = default;
29 
30  Consideration& operator =(const Consideration<ContextType>&) = default;
31  Consideration& operator =(Consideration<ContextType>&&) = default;
32 
33  virtual data::EvaluatorType GetEvaluatorType() const override final { return data::EvaluatorType::CONSIDERATION; }
34 
35  virtual std::string GetDisplayName() const { return "unnamed_consideration"; }
36 
37  protected:
43  virtual float Evaluate(const ContextType& context) const = 0;
44 
45  virtual void DebugDump(const std::map<const void*, unsigned int>&,
46  data::EvaluationDebugData& debugData) const override final
47  {
48  debugData.SetMetadata(GetDisplayName());
49  }
50 
57  virtual float
58  Evaluate(const ContextType& context, data::UtilityEvaluatorSnapshot* const snapshot) const override final
59  {
60  return Evaluate(context);
61  }
62  };
63 
64  using DefaultConsideration = Consideration<const AIEntity*>;
65  using UtilityConsideration = Consideration<EntityBlackboardPair>;
66 }
67 }
68 #endif //GRAIL_CONSIDERATION_H
grail::evaluator::Consideration::Evaluate
virtual float Evaluate(const ContextType &context) const =0
Evaluate - Abstract method, which should be overriden by the user to return proper value representing...
grail::data::EvaluationDebugData
The EvaluationDebugData class - debug data describing singular evaluator.
Definition: EvaluationDebugData.h:24
grail::evaluator::Consideration::DebugDump
virtual void DebugDump(const std::map< const void *, unsigned int > &, data::EvaluationDebugData &debugData) const override final
DebugDump - Called from EvaluateContext, which generates additional debug data for each evaluator....
Definition: Consideration.hh:45
grail::evaluator::Consideration::Evaluate
virtual float Evaluate(const ContextType &context, data::UtilityEvaluatorSnapshot *const snapshot) const override final
Evaluate - Called from EvaluateContext which also evaluates context, but without automatically fillin...
Definition: Consideration.hh:58
grail::evaluator::Evaluator
The Evaluator class - base class being able to evaluate given context and output the result.
Definition: Evaluator.hh:22
grail::evaluator::Consideration
The Consideration class - Abstract type of Evaluator representing a subset of game state.
Definition: Consideration.hh:20
grail::data::UtilityEvaluatorSnapshot
The UtilityEvaluatorSnapshot class - debug snapshot of whole evaluator tree assigned to evaluated obj...
Definition: UtilityEvaluatorSnapshot.h:26