Kaim::NavGraphRawPtr Class Reference

Kaim::NavGraphRawPtr Class Reference

#include <navgraphrawptr.h>

Class Description

This class uniquely identifies a NavGraph that has been loaded.

Instances of this class can be safely stored and used in subsequent frames. When you are finished with an instance of this class, call Invalidate() to free its allocated resources. It is important to call Invalidate() before destroying the World.

Public Member Functions

 NavGraphRawPtr (NavGraph *navGraph=nullptr)
 Constructs a new NavGraphRawPtr. More...
 
bool IsValid () const
 Returns true if this object refers to a valid NavGraph. More...
 
void Invalidate ()
 Invalidates this object. More...
 
bool operator== (const NavGraphRawPtr &rhs) const
 Returns true if this object identifies the same NavGraph as navGraphPtr, or if both are invalid. More...
 
NavGraphGetNavGraph () const
 Returns a reference to the NavGraph that handles the NavGraph. More...
 

Constructor & Destructor Documentation

Kaim::NavGraphRawPtr::NavGraphRawPtr ( NavGraph navGraph = nullptr)
inline

Constructs a new NavGraphRawPtr.

Parameters
navGraphA reference to the NavGraph we want the NavGraphRawPtr refers to.

Member Function Documentation

NavGraph * Kaim::NavGraphRawPtr::GetNavGraph ( ) const
inline

Returns a reference to the NavGraph that handles the NavGraph.

Precondition
This object must be valid. Its validity is not checked.
void Kaim::NavGraphRawPtr::Invalidate ( )
inline

Invalidates this object.

bool Kaim::NavGraphRawPtr::IsValid ( ) const
inline

Returns true if this object refers to a valid NavGraph.

bool Kaim::NavGraphRawPtr::operator== ( const NavGraphRawPtr rhs) const
inline

Returns true if this object identifies the same NavGraph as navGraphPtr, or if both are invalid.


The documentation for this class was generated from the following file: