#include <Mod/Part/App/Part2DObject.h>
Detailed Description
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 .
Public Member Functions | |
| virtual int | getAxisCount (void) const |
| returns the number of construction lines (to be used as axes) | |
| virtual Base::Axis | getAxis (int axId) const |
| retrieves an axis iterating through the construction lines of the sketch (indices start at 0) | |
| virtual void | acceptGeometry () |
| verify and accept the assigned geometry | |
methods override Feature | |
| App::DocumentObjectExecReturn * | execute (void) |
| recalculate the Feature | |
| const char * | getViewProviderName (void) const |
| returns the type name of the ViewProvider | |
 Public Member Functions inherited from Part::Feature | |
| Feature (void) | |
| Constructor. | |
| virtual short | mustExecute (void) const |
| Public Member Functions inherited from App::GeoFeature | |
| GeoFeature (void) | |
| Constructor. | |
| Base::Placement | globalPlacement () const |
| Calculates the placement in the global reference coordinate system. More... | |
| Public Member Functions inherited from App::DocumentObject | |
| DocumentObject (void) | |
| Constructor. | |
| const char * | getNameInDocument (void) const |
| returns the name which is set in the document for this object (not the name property!) | |
| App::Document * | getDocument (void) const |
| gets the document in which this Object is handled | |
| bool | testIfLinkDAGCompatible (DocumentObject *linkTo) const |
| testIfLinkIsDAG tests a link that is about to be created for circular references. More... | |
| bool | recomputeFeature () |
| Recompute only this feature. | |
| const char * | getStatusString (void) const |
| get the status Message | |
| virtual void | onLostLinkToObject (DocumentObject *) |
| void | touch (void) |
| set this document object touched (cause recomputation on dependent features) More... | |
| bool | isTouched (void) const |
| test if this document object is touched | |
| void | enforceRecompute () |
| Enforce this document object to be recomputed. | |
| bool | mustRecompute (void) const |
| Test if this document object must be recomputed. | |
| void | purgeTouched (void) |
| reset this document object touched | |
| bool | isError (void) const |
| set this feature to error | |
| void | purgeError (void) |
| remove the error from the object | |
| bool | isRecomputing () const |
| returns true if this objects is currently recomputing | |
| bool | isRestoring () const |
| returns true if this objects is currently restoring from file | |
| bool | isRemoving () const |
| returns true if this objects is currently removed from the document | |
| unsigned long | getStatus () const |
| return the status bits | |
| std::vector< App::DocumentObject * > | getOutList (void) const |
| returns a list of objects this object is pointing to by Links More... | |
| std::vector< App::DocumentObject * > | getOutListOfProperty (App::Property *) const |
| returns a list of objects linked by the property | |
| std::vector< App::DocumentObject * > | getOutListRecursive (void) const |
| returns a list of objects this object is pointing to by Links and all further descended | |
| std::vector< std::list< App::DocumentObject * > > | getPathsByOutList (App::DocumentObject *to) const |
| get all possible paths from this to another object following the OutList | |
| std::vector< App::DocumentObject * > | getInList (void) const |
| get all objects link to this object | |
| std::vector< App::DocumentObject * > | getInListRecursive (void) const |
| get all objects link directly or indirectly to this object | |
| DocumentObjectGroup * | getGroup () const |
| get group if object is part of a group, otherwise 0 is returned | |
| bool | isInInListRecursive (DocumentObject *objToTest) const |
| test if this object is in the InList and recursive further down | |
| bool | isInInList (DocumentObject *objToTest) const |
| test if this object is directly (non recursive) in the InList | |
| bool | isInOutListRecursive (DocumentObject *objToTest) const |
| test if the given object is in the OutList and recursive further down | |
| bool | isInOutList (DocumentObject *objToTest) const |
| test if this object is directly (non recursive) in the OutList | |
| void | _removeBackLink (DocumentObject *) |
| internal, used by PropertyLink to maintain DAG back links | |
| void | _addBackLink (DocumentObject *) |
| internal, used by PropertyLink to maintain DAG back links | |
| Public Member Functions inherited from App::TransactionalObject | |
| TransactionalObject (void) | |
| Constructor. | |
| Public Member Functions inherited from App::ExtensionContainer | |
| virtual Property * | getPropertyByName (const char *name) const override |
| find a property by its name | |
| virtual const char * | getPropertyName (const Property *prop) const override |
| get the name of a property | |
| virtual void | getPropertyMap (std::map< std::string, Property * > &Map) const override |
| get all properties of the class (including properties of the parent) | |
| virtual void | getPropertyList (std::vector< Property * > &List) const override |
| get all properties of the class (including properties of the parent) | |
| virtual short | getPropertyType (const Property *prop) const override |
| get the Type of a Property | |
| virtual short | getPropertyType (const char *name) const override |
| get the Type of a named Property | |
| virtual const char * | getPropertyGroup (const Property *prop) const override |
| get the Group of a Property | |
| virtual const char * | getPropertyGroup (const char *name) const override |
| get the Group of a named Property | |
| virtual const char * | getPropertyDocumentation (const Property *prop) const override |
| get the Group of a Property | |
| virtual const char * | getPropertyDocumentation (const char *name) const override |
| get the Group of a named Property | |
| Public Member Functions inherited from App::PropertyContainer | |
| PropertyContainer () | |
| virtual | ~PropertyContainer () |
| void | setPropertyStatus (unsigned char bit, bool value) |
| set the Status bit of all properties at once | |
| bool | isReadOnly (const Property *prop) const |
| check if the property is read-only | |
| bool | isReadOnly (const char *name) const |
| check if the named property is read-only | |
| bool | isHidden (const Property *prop) const |
| check if the property is hidden | |
| bool | isHidden (const char *name) const |
| check if the named property is hidden | |
| Public Member Functions inherited from Base::Persistence | |
| virtual void | SaveDocFile (Writer &) const |
| virtual void | RestoreDocFile (Reader &) |
| Public Member Functions inherited from Base::BaseClass | |
| BaseClass () | |
| Construction. | |
| virtual | ~BaseClass () |
| Destruction. | |
| Public Member Functions inherited from Part::AttachExtension | |
| virtual void | setAttacher (Attacher::AttachEngine *attacher) |
| setAttacher sets the AttachEngine object. The class takes the ownership of the pointer, it will be deleted when the class is destroyed, or when a new attacher is set. The default attacher is AttachEngine3D. More... | |
| bool | changeAttacherType (const char *typeName) |
| changeAttacherType More... | |
| virtual bool | positionBySupport (void) |
| Public Member Functions inherited from App::DocumentObjectExtension | |
| virtual void | onExtendedSettingDocument () |
| get called after setting the document | |
| virtual void | onExtendedSetupObject () |
| get called after a brand new object was created | |
| virtual void | onExtendedUnsetupObject () |
| get called when object is going to be removed from the document | |
| virtual const char * | getViewProviderExtensionName (void) const |
| Public Member Functions inherited from App::Extension | |
| virtual Property * | extensionGetPropertyByName (const char *name) const |
| find a property by its name | |
| virtual const char * | extensionGetPropertyName (const Property *prop) const |
| get the name of a property | |
| virtual void | extensionGetPropertyMap (std::map< std::string, Property * > &Map) const |
| get all properties of the class (including properties of the parent) | |
| virtual void | extensionGetPropertyList (std::vector< Property * > &List) const |
| get all properties of the class (including properties of the parent) | |
| virtual short | extensionGetPropertyType (const Property *prop) const |
| get the Type of a Property | |
| virtual short | extensionGetPropertyType (const char *name) const |
| get the Type of a named Property | |
| virtual const char * | extensionGetPropertyGroup (const Property *prop) const |
| get the Group of a Property | |
| virtual const char * | extensionGetPropertyGroup (const char *name) const |
| get the Group of a named Property | |
| virtual const char * | extensionGetPropertyDocumentation (const Property *prop) const |
| get the Group of a Property | |
| virtual const char * | extensionGetPropertyDocumentation (const char *name) const |
| get the Group of a named Property | |
| virtual void | extensionSave (Base::Writer &) const |
| virtual void | extensionRestore (Base::XMLReader &) |
| bool | extensionIsDerivedFrom (const Base::Type type) const |
Static Public Member Functions | |
| static bool | seekTrimPoints (const std::vector< Geometry * > &geomlist, int GeoId, const Base::Vector3d &point, int &GeoId1, Base::Vector3d &intersect1, int &GeoId2, Base::Vector3d &intersect2) |
| Static Public Member Functions inherited from Base::Persistence | |
| static std::string | encodeAttribute (const std::string &) |
| Encodes an attribute upon saving. | |
Additional Inherited Members | |
| Public Attributes inherited from Part::AttachExtension | |
| App::PropertyFloat | MapPathParameter |
| MapPathParameter is a parameter value for mmNormalToPath (the sketch will be mapped normal to a curve at point specified by parameter (from 0.0 to 1.0, from start to end) ) | |
| Protected Member Functions inherited from Part::Feature | |
| virtual App::DocumentObjectExecReturn * | recompute (void) |
| recompute only this object | |
| ShapeHistory | buildHistory (BRepBuilderAPI_MakeShape &, TopAbs_ShapeEnum type, const TopoDS_Shape &newS, const TopoDS_Shape &oldS) |
| Protected Member Functions inherited from App::DocumentObject | |
| virtual void | onBeforeChange (const Property *prop) |
| get called before the value is changed | |
| virtual void | onDocumentRestored () |
| get called after a document has been fully restored | |
| virtual void | onSettingDocument () |
| get called after setting the document | |
| virtual void | setupObject () |
| get called after a brand new object was created | |
| virtual void | unsetupObject () |
| get called when object is going to be removed from the document | |
| Static Protected Member Functions inherited from App::Extension | |
| static void | initExtensionSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Base::Type::instantiationMethod method=0) |
| Protected Attributes inherited from App::DocumentObject | |
| std::bitset< 32 > | StatusBits |
| Py::Object | PythonObject |
| python object of this class and all descendent | |
| App::Document * | _pDoc |
| pointer to the document this object belongs to | |
| std::string | oldLabel |
| Old label; used for renaming expressions. | |
Member Function Documentation
◆ seekTrimPoints()
|
static |
calculate the points where a curve with index GeoId 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 GeoId1 and GeoId2 specify the corresponding curves that intersect the curve GeoId.
