Kaim::NavFloorPtr Class Reference
#include <navfloorptr.h>
Each instance of this class uniquely identifies a single NavFloor.
Instances of this class can be safely stored and used in subsequent frames.
| Kaim::NavFloorPtr::NavFloorPtr |
( |
NavFloor * |
navFloor = nullptr | ) |
|
|
inline |
| Kaim::NavFloorPtr::NavFloorPtr |
( |
const NavFloorRawPtr & |
navFloorRawPtr | ) |
|
|
inlineexplicit |
Creates a new NavFloorPtr copying information from the provided one.
| const CellPos & Kaim::NavFloorPtr::GetCellPos |
( |
| ) |
const |
|
inline |
Returns a const reference to the CellPos that indicates the position of the cell that contains this NavFloor.
- Precondition
- This object must be valid. Its validity is not checked.
| NavFloor * Kaim::NavFloorPtr::GetNavFloor |
( |
| ) |
const |
|
inline |
Returns a pointer to the NavFloor identified by this object. Returns nullptr if this object is not valid.
| NavFloor * Kaim::NavFloorPtr::GetNavFloor_Unsafe |
( |
| ) |
const |
|
inline |
Returns a pointer to the NavFloor identified by this object.
- Precondition
- All these function should be called only if IsValid() returns true.
-
This object must be valid. Its validity is not checked.
| const NavFloorBlob * Kaim::NavFloorPtr::GetNavFloorBlob |
( |
| ) |
const |
|
inline |
Returns a const pointer to the NavFloorBlob identified by this object. Returns nullptr if this object is not valid.
| const NavFloorBlob * Kaim::NavFloorPtr::GetNavFloorBlob_Unsafe |
( |
| ) |
const |
|
inline |
Returns a const pointer to the NavFloorBlob identified by this object.
- Precondition
- This object must be valid. Its validity is not checked.
Constructs and returns a NavFloorRawPtr that refers to the same NavFloor.
- Precondition
- This object must be valid. Its validity is not checked.
| void Kaim::NavFloorPtr::Invalidate |
( |
| ) |
|
|
inline |
| bool Kaim::NavFloorPtr::IsValid |
( |
| ) |
const |
|
inline |
Returns true if this object refers to a valid NavFloor, which means a NavFloor:
- that is not null,
- whose underlying static data (NavFloorBlob) has not been removed from the Database
- which is active in the database (in terms of overlap and dynamic version) if m_navFloorPtr is invalid IsValid() sets m_navFloorPtr = nullptr as Invalidate() would do (note: his a bit questionnable to do)
| bool Kaim::NavFloorPtr::operator!= |
( |
const NavFloorPtr & |
rhs | ) |
const |
|
inline |
Returns true if this object identifies a different NavFloor from rhs.
| bool Kaim::NavFloorPtr::operator== |
( |
const NavFloorPtr & |
rhs | ) |
const |
|
inline |
Returns true if this object identifies the same NavFloor as rhs, or if both are invalid.
The documentation for this class was generated from the following file: