FreeCAD/src/Mod/PartDesign/App/FeatureGroove.h

77 lines
3.2 KiB
C++

/******************************************************************************
* Copyright (c)2012 Jan Rheinlaender <jrheinlaender@users.sourceforge.net> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library 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 Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
******************************************************************************/
#ifndef PARTDESIGN_Groove_H
#define PARTDESIGN_Groove_H
#include <App/PropertyUnits.h>
#include "FeatureSubtractive.h"
namespace PartDesign
{
class PartDesignExport Groove : public Subtractive
{
PROPERTY_HEADER(PartDesign::Groove);
public:
Groove();
App::PropertyVector Base;
App::PropertyVector Axis;
App::PropertyAngle Angle;
/** if this property is set to a valid link, both Axis and Base properties
* are calculated according to the linked line
*/
App::PropertyLinkSub ReferenceAxis;
/** @name methods override feature */
//@{
/** Recalculate the feature
* Revolves the Sketch around the given Axis (with basepoint Base)
* The angle of the revolution is given by Angle.
* If Midplane is true, then the revolution will extend for half of Angle on both sides of the sketch plane.
* If Reversed is true then the direction of revolution will be reversed.
* The created material will be cut out of the sketch support
*/
App::DocumentObjectExecReturn *execute(void);
short mustExecute() const;
/// returns the type name of the view provider
const char* getViewProviderName(void) const {
return "PartDesignGui::ViewProviderGroove";
}
//@}
/// suggests a value for Reversed flag so that material is always removed from the support
bool suggestReversed(void);
protected:
/// updates Axis from ReferenceAxis
void updateAxis(void);
};
} //namespace PartDesign
#endif // PART_Groove_H