pns_placement_algo.h

Go to the documentation of this file.

/*
 * KiRouter - a push-and-(sometimes-)shove PCB router
 *
 * Copyright (C) 2013-2014 CERN
 * Copyright (C) 2016-2023 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __PNS_PLACEMENT_ALGO_H
#define __PNS_PLACEMENT_ALGO_H
 
#include <math/vector2d.h>
 
#include "pns_algo_base.h"
#include "pns_sizes_settings.h"
#include "pns_itemset.h"
 
namespace PNS {
 
class ROUTER;
class ITEM;
class NODE;
 
class PLACEMENT_ALGO : public ALGO_BASE
{
public:
 PLACEMENT_ALGO( ROUTER* aRouter ) :
 ALGO_BASE( aRouter ) {};
 
 virtual ~PLACEMENT_ALGO () {};
 
 virtual bool Start( const VECTOR2I& aP, ITEM* aStartItem ) = 0;
 
 virtual bool Move( const VECTOR2I& aP, ITEM* aEndItem ) = 0;
 
 virtual bool FixRoute( const VECTOR2I& aP, ITEM* aEndItem, bool aForceFinish = false ) = 0;
 
 virtual std::optional<VECTOR2I> UnfixRoute() { return std::nullopt; };
 
 virtual bool CommitPlacement() { return false; };
 
 virtual bool AbortPlacement() { return false; };
 
 virtual bool HasPlacedAnything() const { return false; }
 
 virtual bool ToggleVia( bool aEnabled )
 {
 return false;
 }
 
 virtual bool IsPlacingVia() const
 {
 return false;
 }
 
 virtual bool SetLayer( int aLayer )
 {
 return false;
 }
 
 virtual const ITEM_SET Traces() = 0;
 
 virtual const VECTOR2I& CurrentStart() const = 0;
 
 virtual const VECTOR2I& CurrentEnd() const = 0;
 
 virtual const std::vector<NET_HANDLE> CurrentNets() const = 0;
 
 virtual int CurrentLayer() const = 0;
 
 virtual NODE* CurrentNode( bool aLoopsRemoved = false ) const = 0;
 
 virtual void FlipPosture()
 {
 }
 
 virtual void UpdateSizes( const SIZES_SETTINGS& aSizes )
 {
 }
 
 virtual void SetOrthoMode ( bool aOrthoMode )
 {
 }
 
 virtual void GetModifiedNets( std::vector<NET_HANDLE> &aNets ) const
 {
 }
};
 
}
 
#endif