AI_AStar::Link Class Reference

#include <AI_AStar.h>

List of all members.


Detailed Description

Link between two A* nodes.

Public Member Functions

 Link ()
 Constructor.
void set (Node *ptr_node1, Node *ptr_node2, float f_length, float f_min, float f_max, Session *ptr_session=NULL)
 Set link.
void setUserData (void *ptr_data)
void * getUserData (void) const
 Get user data.
NodegetFirstNode (void) const
 Get first node of link.
NodegetSecondNode (void) const
 Get second node of link.
const float getMinWidth (void) const
 Get minimum link width.
const float getMaxWidth (void) const
 Get maximum link width.
const float getLength (void) const
 Get link length.
NodegetOtherNode (Node *ptr_node)
 Return pointer to node of the link which is not the given node.
SessiongetSession (void)
 Get session.

Protected Attributes

Nodem_ptr_node1
 Node 1.
Nodem_ptr_node2
 Node 2.
float m_f_length
 Length of link.
float m_f_min_width
 Minimum agent width, which can walk along this link.
float m_f_max_width
 Maximum agent width, which can walk along this link.
void * m_ptr_user_data
 Pointer to user data.
Sessionm_ptr_session
 Session into which the link belongs.

Constructor & Destructor Documentation

AI_AStar::Link::Link (  )  [inline]

Constructor.


Member Function Documentation

void AI_AStar::Link::set ( Node ptr_node1,
Node ptr_node2,
float  f_length,
float  f_min,
float  f_max,
Session ptr_session = NULL 
) [inline]

Set link.

void AI_AStar::Link::setUserData ( void *  ptr_data  ) 

void * AI_AStar::Link::getUserData ( void   )  const [inline]

Get user data.

AI_AStar::Node * AI_AStar::Link::getFirstNode ( void   )  const [inline]

Get first node of link.

AI_AStar::Node * AI_AStar::Link::getSecondNode ( void   )  const [inline]

Get second node of link.

const float AI_AStar::Link::getMinWidth ( void   )  const [inline]

Get minimum link width.

const float AI_AStar::Link::getMaxWidth ( void   )  const [inline]

Get maximum link width.

const float AI_AStar::Link::getLength ( void   )  const [inline]

Get link length.

AI_AStar::Node * AI_AStar::Link::getOtherNode ( Node ptr_node  )  [inline]

Return pointer to node of the link which is not the given node.

AI_AStar::Session * AI_AStar::Link::getSession ( void   )  [inline]

Get session.


Member Data Documentation

Node 1.

Node 2.

float AI_AStar::Link::m_f_length [protected]

Length of link.

float AI_AStar::Link::m_f_min_width [protected]

Minimum agent width, which can walk along this link.

float AI_AStar::Link::m_f_max_width [protected]

Maximum agent width, which can walk along this link.

Pointer to user data.

Session into which the link belongs.


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