floor_entity.cpp File Reference
#include "floor_entity.h"
#include <argos3/core/simulator/simulator.h>
#include <argos3/core/simulator/space/space.h>
#include <argos3/core/simulator/loop_functions.h>
Include dependency graph for floor_entity.cpp:

Go to the source code of this file.


class  argos::CFloorColorFromLoopFunctions
class  argos::CSpaceOperationAddCFloorEntity


 The namespace containing all the ARGoS related code.


 argos::REGISTER_ENTITY (CFloorEntity, "floor", "Carlo Pinciroli [ilpincy@gmail.com]", "1.0", "It contains the properties of the arena floor.", "The floor entity contains the properties of the arena floor. In the current\ "implementation, it contains only the color of the floor. The floor color is\" "detected by the robots' ground sensors.\\" "REQUIRED XML CONFIGURATION\\" "< arena ... >\" " ...\" "< floor id=\floor\\" " source=\SOURCE\/>\" " ...\" "</arena >\\" "The 'id' attribute is necessary and must be unique among the entities. If two\" "entities share the same id, initialization aborts.\" "The 'source' attribute specifies where to get the color of the floor from. Its\" "value, here denoted as SOURCE, can assume the following values:\\" " image The color is calculated from the passed image file\" " loop_functions The color is calculated calling the loop functions\\" "When 'source' is set to 'image', as showed in the following example, you have\" "to specify the image path in the additional attribute 'path':\\" "< arena ... >\" " ...\" "< floor id=\floor\\" " source=\image\\" " path=\/path/to/imagefile.ext\/>\" " ...\" "</arena >\\" "Many image formats are available, such as PNG, JPG, BMP, GIF and many more.\" "Refer to the FreeImage webpage for a complete list of supported image formats\" "(http://freeimage.sourceforge.net/features.html).\\" "When 'source' is set to 'loop_functions', as showed in the following example,\" "an image is implicitly created to be used as texture for graphical\" "visualizations. The algorithm that creates the texture needs to convert from\" "meters(in the arena) to pixels(of the texture). You control how many pixels\" "per meter are used with the attribute 'pixels_per_meter'. Clearly, the higher\" "value, the higher the quality, but also the slower the algorithm and the bigger\" "the texture. The algorithm is called only once at init time, so the fact that\" "it is slow is not so important. However, the image size is limited by OpenGL.\" "Every implementation has its own limit, and you should check yours if any\" "texture-related problem arises. Now for the example:\\" "< arena ... >\" " ...\" "< floor id=\floor\\" " source=\loop_functions\\" " pixels_per_meter=\100\/>\" " ...\" "</arena >\\" "OPTIONAL XML CONFIGURATION\\" "None for the time being.\", "Usable")
 argos::REGISTER_SPACE_OPERATION (CSpaceOperationAddEntity, CSpaceOperationAddCFloorEntity, CFloorEntity)