view_item.h 9.41 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 CERN
 * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
 *
 * 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
 */

/**
 * @file view_item.h
 * @brief VIEW_ITEM class definition.
 */

#ifndef __VIEW_ITEM_H
#define __VIEW_ITEM_H

33
#include <vector>
34
#include <bitset>
35
#include <math/box2.h>
36 37
#include <view/view.h>
#include <gal/definitions.h>
38

39

40
namespace KIGFX
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
{
// Forward declarations
class GAL;
class PAINTER;

/**
 * Class VIEW_ITEM -
 * is an abstract base class for deriving all objects that can be added to a VIEW.
 * It's role is to:
 * - communicte geometry, appearance and visibility updates to the associated dynamic VIEW,
 * - provide a bounding box for redraw area calculation,
 * - (optional) draw the object using the GAL API functions for PAINTER-less implementations.
 * VIEW_ITEM objects are never owned by a VIEW. A single VIEW_ITEM can belong to any number of
 * static VIEWs, but only one dynamic VIEW due to storage of only one VIEW reference.
 */
class VIEW_ITEM
{
public:
    /**
Maciej Suminski's avatar
Maciej Suminski committed
60
     * Enum VIEW_UPDATE_FLAGS.
61
     * Defines the how severely the shape/appearance of the item has been changed:
Maciej Suminski's avatar
Maciej Suminski committed
62
     * - NONE: TODO
63 64
     * - APPEARANCE: shape or layer set of the item have not been affected,
     * only colors or visibility.
Maciej Suminski's avatar
Maciej Suminski committed
65
     * - COLOR:
66
     * - GEOMETRY: shape or layer set of the item have changed, VIEW may need to reindex it.
Maciej Suminski's avatar
Maciej Suminski committed
67 68
     * - LAYERS: TODO
     * - ALL: all the flags above */
69

Maciej Suminski's avatar
Maciej Suminski committed
70
    enum VIEW_UPDATE_FLAGS {
Maciej Suminski's avatar
Maciej Suminski committed
71
        NONE        = 0x00,     /// No updates are required
72 73 74
        APPEARANCE  = 0x01,     /// Visibility flag has changed
        COLOR       = 0x02,     /// Color has changed
        GEOMETRY    = 0x04,     /// Position or shape has changed
75
        LAYERS      = 0x08,     /// Layers have changed
76
        ALL         = 0xff
77 78
    };

79
    VIEW_ITEM() : m_view( NULL ), m_visible( true ), m_requiredUpdate( ALL ),
Maciej Suminski's avatar
Maciej Suminski committed
80
                  m_groups( NULL ), m_groupsSize( 0 ) {}
81 82 83 84 85 86 87

    /**
     * Destructor. For dynamic views, removes the item from the view.
     */
    virtual ~VIEW_ITEM()
    {
        ViewRelease();
88
        delete[] m_groups;
89
    }
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

    /**
     * Function ViewBBox()
     * returns the bounding box of the item covering all its layers.
     * @return BOX2I - the current bounding box
     */
    virtual const BOX2I ViewBBox() const = 0;

    /**
     * Function ViewDraw()
     * Draws the parts of the object belonging to layer aLayer.
     * viewDraw() is an alternative way for drawing objects if
     * if there is no PAINTER assigned for the view or if the PAINTER
     * doesn't know how to paint this particular implementation of
     * VIEW_ITEM. The preferred way of drawing is to design an
     * appropriate PAINTER object, the method below is intended only
     * for quick hacks and debugging purposes.
     *
     * @param aLayer: current drawing layer
     * @param aGal: pointer to the GAL device we are drawing on
     */
Maciej Suminski's avatar
Maciej Suminski committed
111 112
    virtual void ViewDraw( int aLayer, GAL* aGal ) const
    {}
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

    /**
     * Function ViewGetLayers()
     * Returns the all the layers within the VIEW the object is painted on. For instance, a D_PAD
     * spans one or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is
     * repeatedly called for each of the layers returned by ViewGetLayers(), depending on the
     * rendering order.
     * @param aLayers[]: output layer index array
     * @param aCount: number of layer indices in aLayers[]
     */
    virtual void ViewGetLayers( int aLayers[], int& aCount ) const = 0;

    /**
     * Function ViewSetVisible()
     * Sets the item visibility.
     *
     * @param aIsVisible: whether the item is visible (on all layers), or not.
     */
    void ViewSetVisible( bool aIsVisible = true );

    /**
     * Function ViewIsVisible()
Maciej Suminski's avatar
Maciej Suminski committed
135
     * Returns information if the item is visible (or not).
136 137 138 139 140 141
     *
     * @return when true, the item is visible (i.e. to be displayed, not visible in the
     * *current* viewport)
     */
    bool ViewIsVisible() const
    {
142 143 144
        return m_visible;
    }

145 146 147 148 149 150 151 152 153 154 155
    /**
     * Function ViewGetLOD()
     * Returns the level of detail of the item. A level of detail is the minimal VIEW scale that
     * is sufficient for an item to be shown on a given layer.
     */
    virtual unsigned int ViewGetLOD( int aLayer ) const
    {
        // By default always show the item
        return 0;
    }

156 157 158 159 160
    /**
     * Function ViewUpdate()
     * For dynamic VIEWs, informs the associated VIEW that the graphical representation of
     * this item has changed. For static views calling has no effect.
     *
Maciej Suminski's avatar
Maciej Suminski committed
161
     * @param aUpdateFlags: how much the object has changed.
162
     */
Maciej Suminski's avatar
Maciej Suminski committed
163 164 165 166 167 168 169
    virtual void ViewUpdate( int aUpdateFlags = ALL )
    {
        if( m_view && m_requiredUpdate == NONE )
            m_view->MarkForUpdate( this );

        m_requiredUpdate |= aUpdateFlags;
    }
170 171 172 173 174

    /**
     * Function ViewRelease()
     * Releases the item from an associated dynamic VIEW. For static views calling has no effect.
     */
Maciej Suminski's avatar
Maciej Suminski committed
175
    virtual void ViewRelease();
176 177 178 179

protected:
    friend class VIEW;

180 181 182 183 184 185 186 187 188
    /**
     * Function getLayers()
     * Returns layer numbers used by the item.
     *
     * @param aLayers[]: output layer index array
     * @param aCount: number of layer indices in aLayers[]
     */
    virtual void getLayers( int* aLayers, int& aCount ) const;

189 190 191 192 193 194
    /**
     * Function viewAssign()
     * Assigns the item to a given dynamic VIEW. Called internally by the VIEW.
     *
     * @param aView[]: dynamic VIEW instance the item is being added to.
     */
Maciej Suminski's avatar
Maciej Suminski committed
195
    virtual void viewAssign( VIEW* aView )
196 197 198 199
    {
        // release the item from a previously assigned dynamic view (if there is any)
        ViewRelease();
        m_view = aView;
200
        deleteGroups();
201 202
    }

Maciej Suminski's avatar
Maciej Suminski committed
203 204 205
    VIEW*   m_view;             ///< Current dynamic view the item is assigned to.
    bool    m_visible;          ///< Are we visible in the current dynamic VIEW.
    int     m_requiredUpdate;   ///< Flag required for updating
206

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
    ///* Helper for storing cached items group ids
    typedef std::pair<int, int> GroupPair;

    ///* Indexes of cached GAL display lists corresponding to the item (for every layer it occupies).
    ///* (in the std::pair "first" stores layer number, "second" stores group id).
    GroupPair* m_groups;
    int        m_groupsSize;

    /**
     * Function getGroup()
     * Returns number of the group id for the given layer, or -1 in case it was not cached before.
     *
     * @param aLayer is the layer number for which group id is queried.
     * @return group id or -1 in case there is no group id (ie. item is not cached).
     */
Maciej Suminski's avatar
Maciej Suminski committed
222
    virtual int getGroup( int aLayer ) const;
223 224 225 226 227 228 229

    /**
     * Function getAllGroups()
     * Returns all group ids for the item (collected from all layers the item occupies).
     *
     * @return vector of group ids.
     */
Maciej Suminski's avatar
Maciej Suminski committed
230
    virtual std::vector<int> getAllGroups() const;
231 232 233 234 235 236 237 238

    /**
     * Function setGroup()
     * Sets a group id for the item and the layer combination.
     *
     * @param aLayer is the layer numbe.
     * @param aGroup is the group id.
     */
Maciej Suminski's avatar
Maciej Suminski committed
239
    virtual void setGroup( int aLayer, int aGroup );
240 241 242 243 244

    /**
     * Function deleteGroups()
     * Removes all of the stored group ids. Forces recaching of the item.
     */
Maciej Suminski's avatar
Maciej Suminski committed
245
    virtual void deleteGroups();
246 247 248 249 250 251 252

    /**
     * Function storesGroups()
     * Returns information if the item uses at least one group id (ie. if it is cached at all).
     *
     * @returns true in case it is cached at least for one layer.
     */
253 254
    inline virtual bool storesGroups() const
    {
255
        return m_groupsSize > 0;
256
    }
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272

    /// Stores layer numbers used by the item.
    std::bitset<VIEW::VIEW_MAX_LAYERS> m_layers;

    /**
     * Function saveLayers()
     * Saves layers used by the item.
     *
     * @param aLayers is an array containing layer numbers to be saved.
     * @param aCount is the size of the array.
     */
    virtual void saveLayers( int* aLayers, int aCount )
    {
        m_layers.reset();

        for( int i = 0; i < aCount; ++i )
273 274 275 276
        {
            // this fires on some eagle board after EAGLE_PLUGIN::Load()
            wxASSERT( unsigned( aLayers[i] ) <= unsigned( VIEW::VIEW_MAX_LAYERS ) );

277
            m_layers.set( aLayers[i] );
278
        }
279
    }
Maciej Suminski's avatar
Maciej Suminski committed
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297

    /**
     * Function viewRequiredUpdate()
     * Returns current update flag for an item.
     */
    virtual int viewRequiredUpdate() const
    {
        return m_requiredUpdate;
    }

    /**
     * Function clearUpdateFlags()
     * Marks an item as already updated, so it is not going to be redrawn.
     */
    void clearUpdateFlags()
    {
        m_requiredUpdate = NONE;
    }
298
};
299
} // namespace KIGFX
300 301

#endif