PickupCarrier.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Damian 'Mozork' Frick
 *   Co-authors:
 *      ...
 *
 */

#ifndef _PickupCarrier_H__
#define _PickupCarrier_H__

#include "OrxonoxPrereqs.h"

#include <set>
#include <vector>

#include "core/class/OrxonoxInterface.h"

namespace orxonox
{

    // Forward-declarations.
    class MetaPickup;

    class _OrxonoxExport PickupCarrier : virtual public OrxonoxInterface
    {
        // So that the different Pickupables have full access to their PickupCarrier.
        friend class Pickupable;
        friend class PickupManager;
        // Friends.
        friend class MetaPickup;

        public:
            PickupCarrier(); 
            virtual ~PickupCarrier(); 
            virtual void preDestroy(void) override; 

            bool isTarget(const Pickupable* pickup) const; 
            PickupCarrier* getTarget(const Pickupable* pickup); 

            virtual const Vector3& getCarrierPosition(void) const = 0;

        protected:
            virtual std::vector<PickupCarrier*>* getCarrierChildren(void) const = 0;
            virtual PickupCarrier* getCarrierParent(void) const = 0;

            std::set<Pickupable*>& getPickups(void)
                { return this->pickups_; }

        private:
            std::set<Pickupable*> pickups_; 

            bool addPickup(Pickupable* pickup); 
            bool removePickup(Pickupable* pickup); 

    };
}

#endif /* _PickupCarrier_H__ */