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 The 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
 */
 
#pragma once
 
#include <bitset>
#include <vector>
#include <limits>
 
#include <gal/gal.h>
#include <math/box2.h>
#include <inspectable.h>
 
#if defined( _MSC_VER )
#pragma warning( push )
#pragma warning( disable : 4275 )
#endif
 
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,
    OVERLAY_HIDDEN = 0x04   
};
 
class GAL_API VIEW_ITEM : public INSPECTABLE
{
public:
    VIEW_ITEM( bool isSCH_ITEM = false, bool isBOARD_ITEM = false ) :
            m_isSCH_ITEM( isSCH_ITEM ),
            m_isBOARD_ITEM( isBOARD_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;
 
    bool IsSCH_ITEM() const { return m_isSCH_ITEM; }
    bool IsBOARD_ITEM() const { return m_isBOARD_ITEM; }
    virtual const BOX2I ViewBBox() const = 0;
 
    virtual void ViewDraw( int aLayer, VIEW* aView ) const
    {}
 
    virtual std::vector<int> ViewGetLayers() const = 0;
 
    virtual double ViewGetLOD( int aLayer, const VIEW* aView ) const
    {
        // By default always show the item
        return LOD_SHOW;
    }
 
    VIEW_ITEM_DATA* viewPrivData() const
    {
        return m_viewPrivData;
    }
 
    void SetForcedTransparency( double aForcedTransparency )
    {
        m_forcedTransparency = aForcedTransparency;
    }
 
    double GetForcedTransparency() const
    {
        return m_forcedTransparency;
    }
 
protected:
    static constexpr double LOD_HIDE = std::numeric_limits<double>::max();
 
    static constexpr double LOD_SHOW = 0.0;
 
    static constexpr double lodScaleForThreshold( int aWhatIu, int aThresholdIu )
    {
        if( aWhatIu == 0 )
            return LOD_HIDE;
 
        return double( aThresholdIu ) / aWhatIu;
    }
 
private:
    friend class VIEW;
 
    bool            m_isSCH_ITEM;
    bool            m_isBOARD_ITEM;
    VIEW_ITEM_DATA* m_viewPrivData;
    double          m_forcedTransparency;  
};
 
} // namespace KIGFX
 
#if defined( _MSC_VER )
#pragma warning( pop )
#endif