view_item.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-2016 CERN
 * Copyright (C) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[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
 */
 
#ifndef __VIEW_ITEM_H
#define __VIEW_ITEM_H
 
#include <vector>
#include <bitset>
#include <math/box2.h>
#include <inspectable.h>
 
 
namespace KIGFX
{
// Forward declarations
class VIEW;
class VIEW_ITEM_DATA;
 
enum VIEW_UPDATE_FLAGS {
 NONE = 0x00, 
 APPEARANCE = 0x01, 
 COLOR = 0x02, 
 GEOMETRY = 0x04, 
 LAYERS = 0x08, 
 INITIAL_ADD = 0x10, 
 REPAINT = 0x20, 
 ALL = 0xef 
};
 
enum VIEW_VISIBILITY_FLAGS {
 VISIBLE = 0x01, 
 HIDDEN = 0x02 
};
 
class VIEW_ITEM : public INSPECTABLE
{
public:
 VIEW_ITEM() :
 m_viewPrivData( nullptr ),
 m_forcedTransparency( 0.0 )
 {
 }
 
 virtual ~VIEW_ITEM();
 
 VIEW_ITEM( const VIEW_ITEM& aOther ) = delete;
 VIEW_ITEM& operator=( const VIEW_ITEM& aOther ) = delete;
 
 virtual const BOX2I ViewBBox() const = 0;
 
 virtual void ViewDraw( int aLayer, VIEW* aView ) const
 {}
 
 virtual void ViewGetLayers( int aLayers[], int& aCount ) const = 0;
 
 virtual double ViewGetLOD( int aLayer, VIEW* aView ) const
 {
 // By default always show the item
 return 0.0;
 }
 
 VIEW_ITEM_DATA* viewPrivData() const
 {
 return m_viewPrivData;
 }
 
 void SetForcedTransparency( double aForcedTransparency )
 {
 m_forcedTransparency = aForcedTransparency;
 }
 
 double GetForcedTransparency() const
 {
 return m_forcedTransparency;
 }
 
private:
 friend class VIEW;
 
 VIEW_ITEM_DATA* m_viewPrivData;
 double m_forcedTransparency; 
};
 
} // namespace KIGFX
 
#endif