ballData.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2010 MaK Technologies, Inc.
** All rights reserved.
********************************************************************************/
/*******************************************************************************
** $RCSfile: .h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/

#ifndef BallData_H_
#define BallData_H_

#include <map>
#include <string>

class QGraphicsSvgItem;



// Enumeration defining possible ball colors
// Don't make more than 255 colors
typedef unsigned char BallColor;
static const BallColor RedBall(0);
static const BallColor BlueBall(1);
static const BallColor YellowBall(2);
static const BallColor GreenBall(3);
static const BallColor VioletBall(4);
static const BallColor AquaBall(5);
static const BallColor NumBallColors(6);


// Generic class for implementation specific object parameters
class ObjectParams
{
public:

   ObjectParams();
   virtual ~ObjectParams();

   // Get a unique ID for this object based on the object handle
   virtual const std::wstring& id() const = 0;

   // Get the object name
   virtual const std::wstring& name() const = 0;
};

// Class with all information on a single ball object
class Ball
{
public:

   Ball();
   virtual ~Ball();

   // Accessors and mutators for ball attributes and information
   BallColor color() const;
   void setColor(BallColor newColor);

   short x() const;
   void setX(short newXCoord);
   short y() const;
   void setY(short newYCoord);
   void setLocation(short newXCoord, short newYCoord);

   unsigned short size() const;
   void setSize(unsigned short newSize);

   double direction() const;
   void setDirection(double newDirection);

   unsigned short speed() const;
   void setSpeed(unsigned short newSpeed);

   // Indicates whether this federate owns the ball
   bool isMine() const;
   void setIsMine(bool newIsMine);

   // If true, ball will be deleted by the GUI at the next update
   bool isMarkedForDeletion() const;
   void markForDeletion(bool mark);

   // If true, ball will not be drawn
   bool isVisible() const;
   void setVisible(bool visible);

   // Unique object ID (based on HLA object instance handle)
   const std::wstring& id() const;

   // Object name
   const std::wstring& name() const;

   // Implementation specific information (name, type, handle, etc.)
   ObjectParams* objectParams();
   const ObjectParams* objectParams() const;

   // Takes ownership of newParams object and will delete the old
   void setObjectParams(ObjectParams* newParams);

   // Pointer to the Qt item for this ball
   QGraphicsSvgItem* graphicsItem();
   void setGraphicsItem(QGraphicsSvgItem* item);

protected:

   ObjectParams* myObjectParams;
   QGraphicsSvgItem* myGraphicsItem;
   BallColor myColor;
   short myX;
   short myY;
   short mySize;
   double myDirection;
   unsigned short mySpeed;
   bool myIsMine;
   bool myIsVisible;
   bool myMarkedForDeletion;
};

// Map of IDs to ball objects
typedef std::map<std::wstring, Ball*> BallMap;

#endif