gwnavruntime/queries/diskcollisionquery.h Source File

diskcollisionquery.h
Go to the documentation of this file.
1 /*
2 * Copyright 2015 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 // Primary contact: JUBA - secondary contact: NOBODY
8 #ifndef Navigation_DiskCollisionQuery_H
9 #define Navigation_DiskCollisionQuery_H
10 
15 
16 namespace Kaim
17 {
21 template<class TraverseLogic>
23 {
24 public:
25  // ---------------------------------- Public Member Functions ----------------------------------
26 
28  virtual ~DiskCollisionQuery() {}
29 
30  // ---------------------------------- Functions to set up the query ----------------------------------
31 
35  void BindToDatabase(Database* database);
36 
42  void Initialize(const Vec3f& center, KyFloat32 radius);
43 
44  // ---------------------------------- write accessors for query inputs ----------------------------------
45 
49  void SetCenterTrianglePtr(const NavTrianglePtr& centerTrianglePtr);
50 
53  void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);
54 
55  // ---------------------------------- write accessors for query parameters ----------------------------------
56 
59  void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);
60 
63  void SetDynamicOutputMode(DynamicOutputMode savingMode);
64 
65  // ---------------------------------- Query framework functions ----------------------------------
66 
67  virtual void Advance(WorkingMemory* workingMemory);
68 
72  void PerformQuery(WorkingMemory* workingMemory = KY_NULL);
73 
74  // ---------------------------------- Accessors ----------------------------------
75 
76  DiskCollisionQueryResult GetResult() const;
77  const Vec3f& GetCenterPos() const;
78  const NavTrianglePtr& GetCenterTrianglePtr() const;
79  KyFloat32 GetRadius() const;
80  DynamicOutputMode GetDynamicOutputMode() const;
81  QueryDynamicOutput* GetQueryDynamicOutput() const;
82  const PositionSpatializationRange& GetPositionSpatializationRange() const;
83 
84 public : // internal
85  void PerformQueryWithInputCoordPos(WorkingMemory* workingMemory);
86  void SetCenterIntegerPos(const WorldIntegerPos& centerIntegerPos);
87  const WorldIntegerPos& GetCenterIntegerPos() const;
88 };
89 
90 }
91 
93 
94 
95 #endif //Navigation_DiskCollisionQuery_H
96 
void SetPositionSpatializationRange(const PositionSpatializationRange &positionSpatializationRange)
Write accessor for m_positionSpatializationRange.
Definition: diskcollisionquery.inl:43
This class gather the data encountered along some query process.
Definition: querydynamicoutput.h:61
virtual void Advance(WorkingMemory *workingMemory)
This function is called by the QueryQueue to process one step on the query.
Definition: diskcollisionquery.inl:77
void SetQueryDynamicOutput(QueryDynamicOutput *queryDynamicOutput)
Write accessor for m_queryDynamicOutput.
Definition: diskcollisionquery.inl:54
void BindToDatabase(Database *database)
Binds the query with the specified Database, clears all the inputs and outputs and sets all other par...
Definition: diskcollisionquery.inl:18
#define KY_NULL
Null value.
Definition: types.h:247
Base class for DiskCollisionQuery.
Definition: basediskcollisionquery.h:36
DynamicOutputMode
Enumerates possible ways of storing crossed data from a query in a QueryDynamicOutput object...
Definition: querydynamicoutput.h:26
DiskCollisionQueryResult
Enumerates the possible results of a DiskCollisionQuery.
Definition: basediskcollisionquery.h:21
void SetDynamicOutputMode(DynamicOutputMode savingMode)
Write accessor for m_dynamicOutputMode.
Definition: diskcollisionquery.inl:49
This class is a runtime container for all NavData that represents the world from the point of view of...
Definition: database.h:64
Definition: gamekitcrowddispersion.h:20
Utilities for dealing with NavData coordinates, which are expressed in a world space based on integer...
Definition: worldintegerpos.h:21
void SetCenterTrianglePtr(const NavTrianglePtr &centerTrianglePtr)
The NavMesh triangle that corresponds to m_centerPos3f.
Definition: diskcollisionquery.inl:31
Each instance of this class uniquely identifies a single NavTriangle in a NavFloor.
Definition: navtriangleptr.h:22
void PerformQuery(WorkingMemory *workingMemory=0)
Performs the query.
Definition: diskcollisionquery.inl:84
void Initialize()
Should be called by the derived class before trying to perform the query or to push it in a QueryQueu...
Definition: iquery.h:372
float KyFloat32
Type used internally to represent a 32-bit floating-point number.
Definition: types.h:43
This class defines a three-dimensional vector whose coordinates are stored using floating-point numbe...
Definition: vec3f.h:23
The DiskCollisionQuery class attempts to place the center of a disk with a specified radius (m_radius...
Definition: diskcollisionquery.h:22