Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages | Examples

ArMapObject Class Reference

#include <ArMap.h>

List of all members.


Detailed Description

This is a class for objects within an ArMap.

Definition at line 783 of file ArMap.h.

Public Member Functions

 ArMapObject (const ArMapObject &mapObject)
 Copy constructor.
 ArMapObject (const char *type, ArPose pose, const char *fileName, const char *iconName, const char *name, bool hasFromTo, ArPose fromPose, ArPose toPose)
 Constructor.
const char * getFileName (void) const
 Gets the fileName of the object (probably never used for maps).
ArPose getFromPose (void) const
 Gets the from pose (could be for line or box, depending).
std::list< ArLineSegmentgetFromToSegments (void)
 Gets a list of fromTo line segments that have been rotated.
const char * getIconName (void) const
 Gets the icon string of the object.
const char * getName (void) const
 Gets the name of the object (if any).
ArPose getPose (void) const
 Gets the pose of the object.
ArPose getToPose (void) const
 Gets the to pose (could be for line or box, depending).
const char * getType (void) const
 Gets the type of the object.
bool hasFromTo (void) const
 Gets the addition args of the object.
void log (void)
virtual ~ArMapObject ()
 Destructor.

Protected Attributes

std::string myFileName
ArPose myFromPose
std::list< ArLineSegmentmyFromToSegments
bool myHasFromTo
std::string myIconName
std::string myName
ArPose myPose
ArPose myToPose
std::string myType


Member Function Documentation

std::list<ArLineSegment> ArMapObject::getFromToSegments void   )  [inline]
 

Gets a list of fromTo line segments that have been rotated.

Note that this function doesn't know if it makes sense for this map object to have the line segments or not (it makes sense on a ForbiddenArea but not a ForbiddenLine)... This is just here so that everyone doesn't have to do the same calculation. Note that this might be a little more CPU/Memory intensive transfering these around, so you may want to keep a copy of them if you're using them a lot (but make sure you clear the copy if the map changes). It may not make much difference on a modern processor though (its set up this way for safety).

Definition at line 868 of file ArMap.h.


The documentation for this class was generated from the following file:
Generated on Tue Feb 20 10:51:44 2007 for Aria by  doxygen 1.4.0