Files
create/src/Mod/Part/App/Part2DObject.h
Abdullah Tahiri e8d5d69314 Part: Part2DObject::seekTrimPoints rename parameters
====================================================

This function takes parameters named GeoId, which evoke the Sketcher GeoId and which
indeed are used by the sketcher. However, these indices are just indices of the provided
geometry list. Therefore:
1. The are never negative (no matter if a corresponding Sketcher GeoId is external or not).
2. They do not have reserved indices for axes.
3. Most importantly, not found GeoId1 and GeoId2 are coded as -1, which for the Sketcher has
a well defined meaning (axis), whereas the Sketcher uses Constraint::GeoUndef as undefined or
not present/ not found index, which currently is -2000.

For these reasons, it was judged appropriate to rename the parameters and documentation to
emphasise that this function is unrelated and dettached from any Sketcher knowledge, and that
indices are just normal indices of a vector.
2021-03-21 06:56:23 +01:00

111 lines
4.7 KiB
C++

/***************************************************************************
* Copyright (c) 2008 Jürgen Riegel <juergen.riegel@web.de> *
* *
* 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 PART_PART2DOBJECT_H
#define PART_PART2DOBJECT_H
#include <App/PropertyStandard.h>
#include <Base/Axis.h>
#include "PartFeature.h"
#include "AttachExtension.h"
class TopoDS_Face;
namespace Part
{
class Geometry;
/** 2D Shape
* This is a specialized version of the PartShape for use with
* flat (2D) geometry. The Z direction has always to be 0.
* The position and orientation of the Plane this 2D geometry is
* referenced is defined by the Placement property. It also
* has a link to a supporting Face which defines the position
* in space where it is located. If the support is changed the
* static method positionBySupport() is used to calculate a
* new position for the Part2DObject.
* This object can be used stand alone or for constraint
* geometry as its descend Sketcher::SketchObject .
*/
class PartExport Part2DObject : public Part::Feature, public Part::AttachExtension
{
PROPERTY_HEADER_WITH_EXTENSIONS(Part::Part2DObject);
public:
Part2DObject();
virtual void transformPlacement(const Base::Placement &transform) override;
/// returns the number of construction lines (to be used as axes)
virtual int getAxisCount(void) const;
/// retrieves an axis iterating through the construction lines of the sketch (indices start at 0)
virtual Base::Axis getAxis(int axId) const;
/// verify and accept the assigned geometry
virtual void acceptGeometry();
/** calculate the points where a curve with index geometryIndex should be trimmed
* with respect to the rest of the curves contained in the list geomlist
* and a picked point. The outputs intersect1 and intersect2 specify the
* tightest boundaries for trimming around the picked point and the
* indexes geometryIndex1 and geometryIndex2 specify the corresponding curves that intersect
* the curve geometryIndex.
*
* If intersection is found, the associated geometryIndex1 or geometryIndex2 retuns -1.
*/
static bool seekTrimPoints(const std::vector<Geometry *> &geomlist,
int geometryIndex, const Base::Vector3d &point,
int &geometryIndex1, Base::Vector3d &intersect1,
int &geometryIndex2, Base::Vector3d &intersect2);
static const int H_Axis;
static const int V_Axis;
static const int N_Axis;
/** @name methods override Feature */
//@{
/// recalculate the Feature
App::DocumentObjectExecReturn *execute(void) override;
/// returns the type name of the ViewProvider
const char* getViewProviderName(void) const override {
return "PartGui::ViewProvider2DObject";
}
//@}
void Restore(Base::XMLReader &reader) override;
protected:
void handleChangedPropertyType(Base::XMLReader &reader, const char * TypeName, App::Property * prop) override;
void handleChangedPropertyName(Base::XMLReader &reader, const char * TypeName, const char *PropName) override;
};
typedef App::FeaturePythonT<Part2DObject> Part2DObjectPython;
} //namespace Part
#endif // PART_PART2DOBJECT_H