Kaim::NavGraphPtr Class Reference
#include <navgraphptr.h>
This class uniquely identifies a single NavGraph.
Instances of this class can be safely stored and used in subsequent frames.
| Kaim::NavGraphPtr::NavGraphPtr |
( |
NavGraph * |
navGraph = nullptr | ) |
|
|
inline |
Constructs a new NavGraphPtr.
- Parameters
-
| navGraph | A pointer to the NavGraph wrapped by this object. |
| NavGraph * Kaim::NavGraphPtr::GetNavGraph |
( |
| ) |
const |
|
inline |
Returns a pointer to the NavGraph that handles the graph identified by this object.
If this object is invalid, returns nullptr.
| NavGraph * Kaim::NavGraphPtr::GetNavGraph_UnSafe |
( |
| ) |
const |
|
inline |
Returns a pointer to the NavGraph that handles the graph identified by this object.
- Precondition
- This object must be valid. Its validity is not checked.
| const NavGraphBlob * Kaim::NavGraphPtr::GetNavGraphBlob |
( |
| ) |
const |
|
inline |
Returns a pointer to the NavGraphBlob identified by this object.
If this object is invalid, returns nullptr.
| const NavGraphBlob * Kaim::NavGraphPtr::GetNavGraphBlob_UnSafe |
( |
| ) |
const |
|
inline |
Returns a pointer to the NavGraphBlob identified by this object.
- Precondition
- This object must be valid. Its validity is not checked.
| void Kaim::NavGraphPtr::Invalidate |
( |
| ) |
|
|
inline |
| bool Kaim::NavGraphPtr::IsValid |
( |
| ) |
const |
|
inline |
Returns true if this object refers to a valid runtime NavGraph, which means a NavFloor that exists, whose underlying static data (NavGraphBlob) has not been removed from the Database.
| bool Kaim::NavGraphPtr::operator!= |
( |
const NavGraphPtr & |
rhs | ) |
const |
|
inline |
Returns true if this object identifies an NavGraph different from the one identified by rhs, or if only one of them is invalid.
| bool Kaim::NavGraphPtr::operator== |
( |
const NavGraphPtr & |
rhs | ) |
const |
|
inline |
Returns true if this object identifies the same NavGraph as rhs, or if both are invalid.
The documentation for this class was generated from the following file: