Missing comments in the PLACEMENT_TOOL class. (bb861b81) · Commits · Elphel / kicad-source-mirror

pcbnew/tools/placement_tool.h

+25 −11

Original line number	Original line	Diff line number	Diff line
	@@ -29,10 +29,6 @@

	class SELECTION_TOOL;		class SELECTION_TOOL;

	/**
	* TODO description
	*/

	class PLACEMENT_TOOL : public TOOL_INTERACTIVE		class PLACEMENT_TOOL : public TOOL_INTERACTIVE
	{		{
	public:		public:
	@@ -45,26 +41,44 @@ public:
	/// @copydoc TOOL_INTERACTIVE::Init()		/// @copydoc TOOL_INTERACTIVE::Init()
	bool Init();		bool Init();

	/// TODO		/**
			* Function AlignTop()
			* Sets Y coordinate of the selected items to the value of the top-most selected item Y coordinate.
			*/
	int AlignTop( const TOOL_EVENT& aEvent );		int AlignTop( const TOOL_EVENT& aEvent );

	/// TODO		/**
			* Function AlignBottom()
			* Sets Y coordinate of the selected items to the value of the bottom-most selected item Y coordinate.
			*/
	int AlignBottom( const TOOL_EVENT& aEvent );		int AlignBottom( const TOOL_EVENT& aEvent );

	/// TODO		/**
			* Function AlignLeft()
			* Sets X coordinate of the selected items to the value of the left-most selected item X coordinate.
			*/
	int AlignLeft( const TOOL_EVENT& aEvent );		int AlignLeft( const TOOL_EVENT& aEvent );

	/// TODO		/**
			* Function AlignRight()
			* Sets X coordinate of the selected items to the value of the right-most selected item X coordinate.
			*/
	int AlignRight( const TOOL_EVENT& aEvent );		int AlignRight( const TOOL_EVENT& aEvent );

	/// TODO		/**
			* Function DistributeHorizontally()
			* Distributes the selected items along the X axis.
			*/
	int DistributeHorizontally( const TOOL_EVENT& aEvent );		int DistributeHorizontally( const TOOL_EVENT& aEvent );

	/// TODO		/**
			* Function DistributeVertically()
			* Distributes the selected items along the Y axis.
			*/
	int DistributeVertically( const TOOL_EVENT& aEvent );		int DistributeVertically( const TOOL_EVENT& aEvent );

	private:		private:
	/// TODO		///> Sets up handlers for various events.
	void setTransitions();		void setTransitions();

	SELECTION_TOOL* m_selectionTool;		SELECTION_TOOL* m_selectionTool;