view_group.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 *
 */
 
#pragma once
 
#include <gal/gal.h>
#include <view/view_item.h>
#include <deque>
 
namespace KIGFX
{
class GAL_API VIEW_GROUP : public VIEW_ITEM
{
public:
    VIEW_GROUP( VIEW* aView = nullptr );
    virtual ~VIEW_GROUP();
 
    // We own at least one list of raw pointers.  Don't let the compiler fill in copy c'tors that
    // will only land us in trouble.
    VIEW_GROUP( const VIEW_GROUP& ) = delete;
    VIEW_GROUP& operator=( const VIEW_GROUP& ) = delete;
 
    wxString GetClass() const override;

    virtual unsigned int GetSize() const;

    virtual void Add( VIEW_ITEM* aItem );

    virtual void Remove( VIEW_ITEM* aItem );

    virtual void Clear();
 
    virtual VIEW_ITEM* GetItem( unsigned int aIdx ) const;

    virtual const BOX2I ViewBBox() const override;

    virtual void ViewDraw( int aLayer, VIEW* aView ) const override;

    std::vector<int> ViewGetLayers() const override;

    inline virtual void SetLayer( int aLayer )
    {
        m_layer = aLayer;
    }

    void FreeItems();
 
protected:
    virtual const std::vector<VIEW_ITEM*> updateDrawList() const;
 
protected:
    int                     m_layer;
    std::vector<VIEW_ITEM*> m_groupItems;       // No ownership.
};
 
} // namespace KIGFX