Files
create/src/Mod/PartDesign/App/FeaturePocket.h
2026-02-07 22:53:31 -06:00

70 lines
3.1 KiB
C++

// SPDX-License-Identifier: LGPL-2.1-or-later
/***************************************************************************
* Copyright (c) 2009 Juergen Riegel <FreeCAD@juergen-riegel.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_Pocket_H
#define PARTDESIGN_Pocket_H
#include "FeatureExtrude.h"
namespace PartDesign
{
class PartDesignExport Pocket: public FeatureExtrude
{
PROPERTY_HEADER_WITH_OVERRIDE(PartDesign::Pocket);
public:
Pocket();
/** @name methods override feature */
//@{
/** Recalculate the feature
* Extrudes the Sketch in the direction of the sketch face normal
* If Type is "Length" then Length gives the extrusion length, the direction will be into the
* support If Type is "ThroughAll" then the extrusion length will be infinite If Type is
* "UpToFirst" then extrusion will stop at the first face of the support that is cut by a line
* through the centre of gravite of the sketch If Type is "UpToFace" then the extrusion will
* stop at FaceName in the support If Midplane is true, then the extrusion will extend for half
* of the length on both sides of the sketch plane The created material will be cut out of the
* sketch support
*/
App::DocumentObjectExecReturn* execute() override;
/// returns the type name of the view provider
const char* getViewProviderName() const override
{
return "PartDesignGui::ViewProviderPocket";
}
Base::Vector3d getProfileNormal() const override;
private:
static const char* TypeEnums[];
};
} // namespace PartDesign
#endif // PART_Pocket_H