gwnavruntime/queries/segmentcangoquery.h Source File

segmentcangoquery.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 
8 #pragma once
9 
16 
17 
18 namespace Kaim
19 {
20 
21 
40 template <class TraverseLogic>
42 {
43 public:
44  // ------------------------------ Functions -----------------------------
45 
47  virtual ~SegmentCanGoQuery() {}
48 
49  // ---------------------------------- Functions to set up the query ----------------------------------
50 
54  void BindToDatabase(Database* database);
55 
62  void Initialize(const Vec3f& startPos, const Vec3f& destPos, KyFloat32 radius);
63 
64  // ---------------------------------- write accessors for query inputs ----------------------------------
65 
69  void SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr);
70 
73  void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);
74 
75  // ---------------------------------- write accessors for query parameters ----------------------------------
76 
79  void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);
80 
83  void SetDynamicOutputMode(DynamicOutputMode savingMode);
84 
85  // ---------------------------------- Query framework functions ----------------------------------
86 
87  virtual void Advance(WorkingMemory* workingMemory);
88 
90  void PerformQuery(WorkingMemory* workingMemory = nullptr);
91 
92  // ---------------------------------- Accessors ----------------------------------
93 
94  SegmentCanGoQueryResult GetResult() const;
95  const Vec3f& GetStartPos() const;
96  const Vec3f& GetDestPos() const;
97  const NavTrianglePtr& GetStartTrianglePtr() const;
98  const NavTrianglePtr& GetDestTrianglePtr() const;
99  KyFloat32 GetRadius() const;
100  DynamicOutputMode GetDynamicOutputMode() const;
101  QueryDynamicOutput* GetQueryDynamicOutput() const;
102 
103  const PositionSpatializationRange& GetPositionSpatializationRange() const;
104 
105 public: // internal
106  void PerformQueryWithInputCoordPos(WorkingMemory* workingMemory);
107  void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos);
108  void SetDestIntegerPos(const WorldIntegerPos& destIntegerPos);
109  const WorldIntegerPos& GetStartIntegerPos() const;
110  const WorldIntegerPos& GetDestIntegerPos() const;
111 };
112 
113 }
114 
116 
117 
Base class for SegmentCanGoQuery.
Definition: basesegmentcangoquery.h:36
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 SetPositionSpatializationRange(const PositionSpatializationRange &positionSpatializationRange)
Write accessor for m_positionSpatializationRange.
Definition: segmentcangoquery.inl:30
void SetDynamicOutputMode(DynamicOutputMode savingMode)
Write accessor for m_dynamicOutputMode.
Definition: segmentcangoquery.inl:45
SegmentCanGoQueryResult
Enumerates the possible results of a SegmentCanGoQuery.
Definition: basesegmentcangoquery.h:20
DynamicOutputMode
Enumerates possible ways of storing collected data by a query in a QueryDynamicOutput object...
Definition: querydynamicoutput.h:21
void SetStartTrianglePtr(const NavTrianglePtr &startTrianglePtr)
Set The NavMesh triangle that corresponds to m_startPos3f.
Definition: segmentcangoquery.inl:25
This class is a runtime container for all NavData that represents the world from the point of view of...
Definition: database.h:57
void BindToDatabase(Database *database)
Binds the query with the specified Database, clears all the inputs and outputs and sets all other par...
Definition: segmentcangoquery.inl:14
void SetQueryDynamicOutput(QueryDynamicOutput *queryDynamicOutput)
Write accessor for m_queryDynamicOutput.
Definition: segmentcangoquery.inl:50
The Autodesk Navigation namespace.
Definition: gamekitcrowddispersion.cpp:17
void PerformQuery(WorkingMemory *workingMemory=nullptr)
If workingMemory param is nullptr, m_database.GetWorkingMemory() will be used.
Definition: segmentcangoquery.inl:89
The SegmentCanGoQuery class tests whether a line segment-with a specified half-width (m_radius)-can m...
Definition: segmentcangoquery.h:41
Utilities for dealing with NavData coordinates, which are expressed in a world space based on integer...
Definition: worldintegerpos.h:19
virtual void Advance(WorkingMemory *workingMemory)
This function is called by the QueryQueue to process one step on the query.
Definition: segmentcangoquery.inl:82
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
float KyFloat32
float
Definition: types.h:32
3d vector using 32bits floating points.
Definition: vec3f.h:16