smp::interface_libbot_environment Class Reference

Environment definition. More...

#include <libbot.h>

List of all members.

Public Member Functions

int set_operating_region (const region_t &region_in)
 Modifies the opearting region.
int set_goal_region (const region_t &region_in)
 Modifies the goal region.
int clear_obstacle_list ()
 Clears the list of obstacles and frees the memory they occupy.
int add_obstacle (const region_t &region_in)
 Adds a new obstacle to the set of obstacles.

Friends

class interface_libbot

Detailed Description


Member Function Documentation

int smp::interface_libbot_environment::add_obstacle ( const region_t region_in)

Adds a new obstacle to the set of obstacles.

In the libbot interface, an obstacle is a rectangular box in the three dimensional Eucliean space, usuall a region where no trajectory can cross. Note that this is solely for visualization in the libbot viewer, which has a 3D visualization capability. An obstacle for the planner can be in an arbitrary number of dimensions in a fairly arbitrary space.

Parameters:
region_inNew operating region (variable is not consumed).
Returns:
Returns 1 for success, and a non-positive value to indicate error.
int smp::interface_libbot_environment::clear_obstacle_list ( )

Clears the list of obstacles and frees the memory they occupy.

In the libbot interface, an obstacle is a rectangular box in the three dimensional Eucliean space, usuall a region where no trajectory can cross. Note that this is solely for visualization in the libbot viewer, which has a 3D visualization capability. An obstacle for the planner can be in an arbitrary number of dimensions in a fairly arbitrary space.

Returns:
Returns 1 for success, and a non-positive value to indicate error.
int smp::interface_libbot_environment::set_goal_region ( const region_t region_in)

Modifies the goal region.

In the libbot interface, the goal region is a rectangular box in the three dimesional Euclidean space, usually a box where the trajectories need to in order to accomplish the problem specification. Note that this is solely for visualization in the libbot viewer, which has a 3D visualization capability. The ``goal region'' of the planner can be in an arbitrary number of dimensions in a fairly arbitrary space.

Parameters:
region_inNew operating region (variable is not consumed).
Returns:
Returns 1 for success, and a non-positive value to indicate error.
int smp::interface_libbot_environment::set_operating_region ( const region_t region_in)

Modifies the opearting region.

In the libbot interface, the operating region is a rectangular box in the three dimesional Euclidean space, usually a bounding box for all the trajectories. Note that this is solely for visualization in the libbot viewer, which has a 3D visualization capability. The ``opearating region'' of the planner can be in an arbitrary number of dimensions in a fairly arbitrary space.

Parameters:
region_inNew operating region (variable is not consumed).
Returns:
Returns 1 for success, and a non-positive value to indicate error.

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