Stg Namespace Reference

The Stage library uses its own namespace. More...

Namespaces
namespace	Gl
Classes
class	Ancestor
class	Block
class	BlockGroup
class	Bounds
class	Camera
class	Color
class	CtrlArgs
class	Geom
class	LogEntry
class	Model
	Model class More...
class	ModelActuator
	ModelActuator class More...
class	ModelBlinkenlight
class	ModelBlobfinder
	ModelBlobfinder class More...
class	ModelCamera
	ModelCamera class More...
class	ModelFiducial
	ModelFiducial class More...
class	ModelGripper
class	ModelLaser
	ModelLaser class More...
class	ModelLightIndicator
class	ModelPosition
	ModelPosition class More...
class	ModelRanger
	ModelRanger class More...
class	OrthoCamera
class	PerspectiveCamera
class	Pose
class	PowerPack
class	Ray
class	RaytraceResult
class	Size
struct	stg_blinkenlight_t
class	stg_bounds3d_t
struct	stg_fov_t
class	stg_point3_t
class	stg_point_int_t
class	stg_point_t
struct	stg_rotrect_t
class	StripPlotVis
class	Velocity
class	Visualizer
class	World
	World class More...
class	WorldGui
Typedefs
typedef std::set< Block * >	BlockPtrSet
typedef std::vector< Cell * >	CellPtrVec
typedef Model (	creator_t )(World , Model , const std::string &type)
typedef std::set< Model * >	ModelPtrSet
typedef std::vector< Model * >	ModelPtrVec
typedef std::vector < stg_point_int_t >	PointIntVec
typedef bool	stg_bool_t
typedef uint32_t	stg_id_t
typedef double	stg_joules_t
typedef double	stg_kg_t
typedef double	stg_meters_t
typedef int(*	stg_model_callback_t )(Model mod, void user)
typedef unsigned long	stg_msec_t
typedef double	stg_radians_t
typedef bool(*	stg_ray_test_func_t )(Model candidate, Model finder, const void *arg)
typedef RaytraceResult	stg_raytrace_result_t
typedef struct timeval	stg_time_t
typedef uint64_t	stg_usec_t
typedef double	stg_watts_t
typedef int(*	stg_world_callback_t )(World world, void user)
Enumerations
enum	{ FiducialNone = 0 }
enum	stg_laser_return_t { LaserTransparent = 0, LaserVisible, LaserBright }
Functions
double	constrain (double val, double minval, double maxval)
double	dtor (double d)
template<class T , class C >
void	EraseAll (T thing, C &cont)
void	Init (int argc, char *argv[])
bool	InitDone ()
double	normalize (double a)
void	RegisterModels ()
double	rtod (double r)
double	sgn (double a)
int	sgn (int a)
int	stg_rotrects_from_image_file (const char filename, stg_rotrect_t rects, unsigned int rect_count, unsigned int widthp, unsigned int heightp)
stg_point_t *	stg_unit_square_points_create ()
const char *	Version ()
Variables
const char	AUTHORS []
const double	billion = 1e9
const char	COPYRIGHT []
const char	DESCRIPTION []
const char	LICENSE []
const double	million = 1e6
const double	thousand = 1e3
const char	WEBSITE [] = "http://playerstage.org"

Detailed Description

The Stage library uses its own namespace.

Typedef Documentation

typedef std::set<Block*> Stg::BlockPtrSet

Set of pointers to Blocks.

Definition at line 95 of file stage.hh.

typedef std::vector<Cell*> Stg::CellPtrVec

Vector of pointers to Cells.

Definition at line 98 of file stage.hh.

typedef Model*(* Stg::creator_t)(World *, Model *, const std::string &type)

Definition at line 86 of file stage.hh.

typedef std::set<Model*> Stg::ModelPtrSet

Set of pointers to Models.

Definition at line 89 of file stage.hh.

typedef std::vector<Model*> Stg::ModelPtrVec

Set of pointers to Models.

Definition at line 92 of file stage.hh.

typedef std::vector<stg_point_int_t> Stg::PointIntVec

Definition at line 462 of file stage.hh.

typedef bool Stg::stg_bool_t

boolean

Definition at line 208 of file stage.hh.

typedef uint32_t Stg::stg_id_t

Value that uniquely identifies a model

Definition at line 181 of file stage.hh.

typedef double Stg::stg_joules_t

Joules: unit of energy

Definition at line 202 of file stage.hh.

typedef double Stg::stg_kg_t

Kilograms: unit of mass

Definition at line 199 of file stage.hh.

typedef double Stg::stg_meters_t

Metres: floating point unit of distance

Definition at line 184 of file stage.hh.

typedef int(* Stg::stg_model_callback_t)(Model *mod, void *user)

Define a callback function type that can be attached to a record within a model and called whenever the record is set.

Definition at line 527 of file stage.hh.

typedef unsigned long Stg::stg_msec_t

Milliseconds: unit of (short) time

Definition at line 193 of file stage.hh.

typedef double Stg::stg_radians_t

Radians: unit of angle

Definition at line 187 of file stage.hh.

typedef bool(* Stg::stg_ray_test_func_t)(Model *candidate, Model *finder, const void *arg)

matching function should return true iff the candidate block is stops the ray, false if the block transmits the ray

Definition at line 565 of file stage.hh.

typedef RaytraceResult Stg::stg_raytrace_result_t

Definition at line 696 of file stage.hh.

typedef struct timeval Stg::stg_time_t

time structure

Definition at line 190 of file stage.hh.

typedef uint64_t Stg::stg_usec_t

Microseconds: unit of (very short) time

Definition at line 196 of file stage.hh.

typedef double Stg::stg_watts_t

Watts: unit of power (energy/time)

Definition at line 205 of file stage.hh.

typedef int(* Stg::stg_world_callback_t)(World *world, void *user)

Definition at line 528 of file stage.hh.

Enumeration Type Documentation

anonymous enum

any integer value other than this is a valid fiducial ID

Enumerator:

FiducialNone

Definition at line 178 of file stage.hh.

enum Stg::stg_laser_return_t

laser return value

Enumerator:

LaserTransparent	not detected by laser model
LaserVisible	detected by laser with a reflected intensity of 0
LaserBright	detected by laser with a reflected intensity of 1

Definition at line 470 of file stage.hh.

Function Documentation

double Stg::constrain	(	double	val,
		double	minval,
		double	maxval
	)

double Stg::dtor ( double d ) [inline]

convert an angle in degrees to radians.

Definition at line 161 of file stage.hh.

template<class T , class C >

void Stg::EraseAll	(	T	thing,
		C &	cont
	)			`[inline]`

wrapper for Erase-Remove method of removing all instances of thing from container

Definition at line 575 of file stage.hh.

void Stg::Init	(	int *	argc,
		char **	argv[]
	)

Initialize the Stage library

bool Stg::InitDone ( )

returns true iff Stg::Init() has been called.

double Stg::normalize ( double a ) [inline]

Normalize an angle to within +/_ M_PI.

Definition at line 164 of file stage.hh.

void Stg::RegisterModels ( )

double Stg::rtod ( double r ) [inline]

convert an angle in radians to degrees.

Definition at line 158 of file stage.hh.

double Stg::sgn ( double a ) [inline]

take binary sign of a, either -1.0, or 1.0 if >= 0.

Definition at line 175 of file stage.hh.

int Stg::sgn ( int a ) [inline]

take binary sign of a, either -1, or 1 if >= 0

Definition at line 172 of file stage.hh.

int Stg::stg_rotrects_from_image_file	(	const char *	filename,
		stg_rotrect_t **	rects,
		unsigned int *	rect_count,
		unsigned int *	widthp,
		unsigned int *	heightp
	)

load the image file [filename] and convert it to an array of rectangles, filling in the number of rects, width and height. Memory is allocated for the rectangle array [rects], so the caller must free [rects].

stg_point_t* Stg::stg_unit_square_points_create ( )

create an array of 4 points containing the corners of a unit square.

const char* Stg::Version ( )

returns a human readable string indicating the libstage version number.

Variable Documentation

const char Stg::AUTHORS[]

Initial value:

                                        
    "Richard Vaughan, Brian Gerkey, Andrew Howard, Reed Hedges, Pooya Karimian, Toby Collett, Jeremy Asher, Alex Couture-Beil and contributors."

Author string

Definition at line 115 of file stage.hh.

const double Stg::billion = 1e9

Convenient constant

Definition at line 155 of file stage.hh.

const char Stg::COPYRIGHT[]

Initial value:

                                       
    "Copyright Richard Vaughan and contributors 2000-2009"

Copyright string

Definition at line 111 of file stage.hh.

const char Stg::DESCRIPTION[]

Initial value:

                                       
    "Robot simulation library\nPart of the Player Project"

Project description string

Definition at line 122 of file stage.hh.

const char Stg::LICENSE[]

Initial value:

 
    "Stage robot simulation library\n"                                  
    "Copyright (C) 2000-2009 Richard Vaughan and contributors\n"        
    "Part of the Player Project [http://playerstage.org]\n"             
    "\n"                                                                
    "This program is free software; you can redistribute it and/or\n"   
    "modify it under the terms of the GNU General Public License\n"     
    "as published by the Free Software Foundation; either version 2\n"  
    "of the License, or (at your option) any later version.\n"          
    "\n"                                                                
    "This program is distributed in the hope that it will be useful,\n" 
    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"  
    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n"   
    "GNU General Public License for more details.\n"                    
    "\n"                                                                
    "You should have received a copy of the GNU General Public License\n" 
    "along with this program; if not, write to the Free Software\n"     
    "Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.\n" 
    "\n"                                                                
    "The text of the license may also be available online at\n"         
    "http://www.gnu.org/licenses/old-licenses/gpl-2.0.html\n"

Project distribution license string

Definition at line 126 of file stage.hh.

const double Stg::million = 1e6

Convenient constant

Definition at line 152 of file stage.hh.

const double Stg::thousand = 1e3

Convenient constant

Definition at line 149 of file stage.hh.

const char Stg::WEBSITE[] = "http://playerstage.org"

Project website string

Definition at line 119 of file stage.hh.

Stg Namespace Reference

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation