gwnavruntime/queries/diskexpansionquery.h Source File

diskexpansionquery.h
Go to the documentation of this file.
1 /*
2 * Copyright 2016 Autodesk, Inc. All rights reserved.
3 * Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
4 * or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
5 */
6 
7 #pragma once
8 
13 
14 namespace Kaim
15 {
16 
22 template<class TraverseLogic>
24 {
25 public:
26  // ------------------------------ Functions -----------------------------
27 
29  ~DiskExpansionQuery() {}
30 
31  // ---------------------------------- Functions to set up the query ----------------------------------
32 
36  void BindToDatabase(Database* database);
37 
43  void Initialize(const Vec3f& center, KyFloat32 radiusMax);
44 
45  // ---------------------------------- write accessors for query inputs ----------------------------------
46 
50  void SetCenterTrianglePtr(const NavTrianglePtr& centerTrianglePtr);
51 
54  void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);
55 
56  // ---------------------------------- write accessors for query parameters ----------------------------------
57 
60  void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);
61 
64  void SetSafetyDist(KyFloat32 safetyDist);
65 
68  void SetDynamicOutputMode(DynamicOutputMode savingMode);
69 
70  // ---------------------------------- Query framework functions ----------------------------------
71 
72  virtual void Advance(WorkingMemory* workingMemory);
73 
75  void PerformQuery(WorkingMemory* workingMemory = nullptr);
76 
77  // ---------------------------------- Accessors ----------------------------------
78 
79  DiskExpansionQueryResult GetResult() const;
80  const Vec3f& GetCenterPos() const;
81  const NavTrianglePtr& GetCenterTrianglePtr() const;
82  KyFloat32 GetRadiusMax() const;
83  KyFloat32 GetResultRadius() const;
84  const Vec3f& GetCollisionPos() const;
85  const NavHalfEdgePtr& GetCollisionNavHalfEdgePtr() const;
86  KyFloat32 GetSafetyDist() const;
87  DynamicOutputMode GetDynamicOutputMode() const;
88  QueryDynamicOutput* GetQueryDynamicOutput() const;
89 
90  const PositionSpatializationRange& GetPositionSpatializationRange() const;
91 
92 public: // internal
93  void PerformQueryWithInputCoordPos(WorkingMemory* workingMemory);
94  void SetCenterIntegerPos(const WorldIntegerPos& centerIntegerPos);
95  const WorldIntegerPos& GetCenterIntegerPos() const;
96 };
97 
98 }
99 
101 
102 
103 
104 
void SetQueryDynamicOutput(QueryDynamicOutput *queryDynamicOutput)
Write accessor for m_queryDynamicOutput.
Definition: diskexpansionquery.inl:34
void SetCenterTrianglePtr(const NavTrianglePtr &centerTrianglePtr)
The NavMesh triangle that corresponds to m_centerPos3f.
Definition: diskexpansionquery.inl:26
The DiskExpansionQuery class attempts to place the center of a disk at a specified position (m_center...
Definition: diskexpansionquery.h:23
This class gather the data encountered along some query process.
Definition: querydynamicoutput.h:57
Vertical range (above, below) that represents the altitude tolerance for a position to be inside the ...
Definition: positionspatializationrange.h:17
void SetSafetyDist(KyFloat32 safetyDist)
Write accessor for m_safetyDist.
Definition: diskexpansionquery.inl:30
DiskExpansionQueryResult
Enumerates the possible results of a DiskExpansionQuery.
Definition: basediskexpansionquery.h:19
DynamicOutputMode
Enumerates possible ways of storing collected data by a query in a QueryDynamicOutput object...
Definition: querydynamicoutput.h:21
This class is a runtime container for all NavData that represents the world from the point of view of...
Definition: database.h:57
Base class for DiskExpansionQuery.
Definition: basediskexpansionquery.h:35
void PerformQuery(WorkingMemory *workingMemory=nullptr)
If workingMemory param is nullptr, m_database.GetWorkingMemory() will be used.
Definition: diskexpansionquery.inl:76
The Autodesk Navigation namespace.
Definition: gamekitcrowddispersion.cpp:17
void BindToDatabase(Database *database)
Binds the query with the specified Database, clears all the inputs and outputs and sets all other par...
Definition: diskexpansionquery.inl:14
Utilities for dealing with NavData coordinates, which are expressed in a world space based on integer...
Definition: worldintegerpos.h:19
void SetPositionSpatializationRange(const PositionSpatializationRange &positionSpatializationRange)
Write accessor for m_positionSpatializationRange.
Definition: diskexpansionquery.inl:37
Each instance of this class uniquely identifies a single NavHalfEdge in a NavFloor.
Definition: navhalfedgeptr.h:16
Each instance of this class uniquely identifies a single NavTriangle in a NavFloor.
Definition: navtriangleptr.h:17
void Initialize()
Should be called by the derived class prior to perform the query or to push it in a QueryQueue...
Definition: iquery.h:220
void SetDynamicOutputMode(DynamicOutputMode savingMode)
Write accessor for m_dynamicOutputMode.
Definition: diskexpansionquery.inl:32
float KyFloat32
float
Definition: types.h:32
3d vector using 32bits floating points.
Definition: vec3f.h:16
virtual void Advance(WorkingMemory *workingMemory)
This function is called by the QueryQueue to process one step on the query.
Definition: diskexpansionquery.inl:68