Kaim::NavFloorPtr Class Reference

#include <navfloorptr.h>

Class Description

Each instance of this class uniquely identifies a single NavFloor.

Instances of this class can be safely stored and used in subsequent frames.

Main API Functions
	NavFloorPtr (NavFloor *navFloor=0)
	NavFloorPtr (const NavFloorRawPtr &navFloorRawPtr)
bool	IsValid () const
void	Invalidate ()
bool	operator== (const NavFloorPtr &rhs) const
bool	operator!= (const NavFloorPtr &rhs) const
NavFloor *	GetNavFloor () const
const NavFloorBlob *	GetNavFloorBlob () const

Member Functions for valid instance
Precondition All these function should be called only if IsValid() returns true.
NavFloor *	GetNavFloor_Unsafe () const
const NavFloorBlob *	GetNavFloorBlob_Unsafe () const
NavFloorRawPtr	GetRawPtr () const
const CellPos &	GetCellPos () const

Constructor & Destructor Documentation

Kaim::NavFloorPtr::NavFloorPtr ( NavFloor *  navFloor = 0 )

inline

Creates an invalid NavFloorPtr.

Kaim::NavFloorPtr::NavFloorPtr ( const NavFloorRawPtr &  navFloorRawPtr )

inlineexplicit

Creates a new NavFloorPtr copying information from the provided one.

Member Function Documentation

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 KY_NULL if this object is not valid.

NavFloor * Kaim::NavFloorPtr::GetNavFloor_Unsafe ( ) const

inline

Returns a pointer to the NavFloor identified by this object.

Precondition

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 KY_NULL 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.

NavFloorRawPtr Kaim::NavFloorPtr::GetRawPtr ( ) const

inline

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

Invalidates this object.

bool Kaim::NavFloorPtr::IsValid ( ) const

inline

Returns true if this object refers to a valid NavFloor, which means a NavFloor:

1. that exists,
2. whose underlying static data (NavFloorBlob) has not been removed from the Database and
3. which is active (in term of overlap and dynamic version).

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:

• gwnavruntime/navmesh/identifiers/navfloorptr.h