Path Class Reference

#include <path.hpp>

List of all members.

Public Member Functions
	Path ()
	~Path ()
void	read (const Reader &reader)
Vector	get_base () const
int	get_nearest_node_no (Vector reference_point) const
	returns Node index nearest to reference_point or -1 if not applicable
int	get_farthest_node_no (Vector reference_point) const
	returns Node index farthest from reference_point or -1 if not applicable
Public Attributes
std::vector< Node >	nodes
Private Types
enum	WalkMode { ONE_SHOT, PING_PONG, CIRCULAR }
Private Attributes
WalkMode	mode
Friends
class	PathWalker
Classes
class	Node
	Helper class that stores an individual node of a Path. More...

---

Detailed Description

Definition at line 28 of file path.hpp.

---

Member Enumeration Documentation

enum Path::WalkMode [private]

Enumerator:

ONE_SHOT
PING_PONG
CIRCULAR

Definition at line 68 of file path.hpp.

                {
    // moves from first to last path node and stops
    ONE_SHOT,
    // moves from first to last node then in reverse order back to first
    PING_PONG,
    // moves from last node back to the first node
    CIRCULAR
  };

---

Constructor & Destructor Documentation

Path::Path

(

)

Definition at line 27 of file path.cpp.

           :
  nodes(),
  mode()
{
}

Path::~Path

(

)

Definition at line 33 of file path.cpp.

{
}

---

Member Function Documentation

void Path::read

(

const Reader &

reader

)

Definition at line 38 of file path.cpp.

References CIRCULAR, lisp::Lisp::get(), lisp::ListIterator::item(), lisp::ListIterator::lisp(), log_warning, mode, lisp::ListIterator::next(), nodes, ONE_SHOT, PING_PONG, Path::Node::position, Path::Node::time, lisp::ListIterator::value(), Vector::x, and Vector::y.

{
  lisp::ListIterator iter(&reader);

  mode = CIRCULAR;
  while(iter.next()) {
    if(iter.item() == "mode") {
      std::string mode_string;
      if(!iter.value()->get(mode_string))
        throw std::runtime_error("Pathmode not a string");

      if(mode_string == "oneshot")
        mode = ONE_SHOT;
      else if(mode_string == "pingpong")
        mode = PING_PONG;
      else if(mode_string == "circular")
        mode = CIRCULAR;
      else {
        std::ostringstream msg;
        msg << "Unknown pathmode '" << mode_string << "' found";
        throw std::runtime_error(msg.str());
      }
      continue;
    }

    if(iter.item() != "node") {
      log_warning << "unknown token '" << iter.item() << "' in Path nodes list. Ignored." << std::endl;
      continue;
    }
    const lisp::Lisp* node_lisp = iter.lisp();

    // each new node will inherit all values from the last one
    Node node;
    node.time = 1;
    if( (!node_lisp->get("x", node.position.x) ||
         !node_lisp->get("y", node.position.y)))
      throw std::runtime_error("Path node without x and y coordinate specified");
    node_lisp->get("time", node.time);

    if(node.time <= 0)
      throw std::runtime_error("Path node with non-positive time");

    nodes.push_back(node);
  }

  if (nodes.empty())
    throw std::runtime_error("Path with zero nodes");
}

Vector Path::get_base

(

)

const

Definition at line 88 of file path.cpp.

References nodes.

{
  if(nodes.empty())
    return Vector(0, 0);

  return nodes[0].position;
}

int Path::get_nearest_node_no

(

Vector

reference_point

)

const

returns Node index nearest to reference_point or -1 if not applicable

Definition at line 97 of file path.cpp.

References nodes.

{
  int nearest_node_id = -1;
  float nearest_node_dist = 0;
  int id = 0;
  for (std::vector<Node>::const_iterator i = nodes.begin(); i != nodes.end(); i++, id++) {
    float dist = (i->position - reference_point).norm();
    if ((nearest_node_id == -1) || (dist < nearest_node_dist)) {
      nearest_node_id = id;
      nearest_node_dist = dist;
    }
  }
  return nearest_node_id;
}

int Path::get_farthest_node_no

(

Vector

reference_point

)

const

returns Node index farthest from reference_point or -1 if not applicable

Definition at line 113 of file path.cpp.

References nodes.

{
  int farthest_node_id = -1;
  float farthest_node_dist = 0;
  int id = 0;
  for (std::vector<Node>::const_iterator i = nodes.begin(); i != nodes.end(); i++, id++) {
    float dist = (i->position - reference_point).norm();
    if ((farthest_node_id == -1) || (dist > farthest_node_dist)) {
      farthest_node_id = id;
      farthest_node_dist = dist;
    }
  }
  return farthest_node_id;
}

---

Friends And Related Function Documentation

friend class PathWalker [friend]

Definition at line 66 of file path.hpp.

---

Member Data Documentation

std::vector<Node> Path::nodes

Definition at line 53 of file path.hpp.

Referenced by PathWalker::advance(), PathWalker::advance_node(), get_base(), get_farthest_node_no(), get_nearest_node_no(), PathWalker::get_pos(), PathWalker::goback_node(), PathWalker::PathWalker(), read(), and FlipLevelTransformer::transform_path().

WalkMode Path::mode [private]

Definition at line 77 of file path.hpp.

Referenced by PathWalker::advance_node(), PathWalker::goback_node(), and read().

---

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

• src/object/path.hpp
• src/object/path.cpp

---