#include <App/GeoFeature.h>
Detailed Description
Base class of all geometric document objects.
Public Member Functions | |
| GeoFeature (void) | |
| Constructor. | |
| virtual void | transformPlacement (const Base::Placement &transform) |
| transformPlacement applies transform to placement of this shape. Override this function to propagate the change of placement to base features, for example. By the time of writing this comment, the function was only called by alignment task (Edit->Alignment) More... | |
| virtual const PropertyComplexGeoData * | getPropertyOfGeometry () const |
| virtual PyObject * | getPyObject (void) |
| getPyObject returns the Python binding object More... | |
| Base::Placement | globalPlacement () const |
| Calculates the placement in the global reference coordinate system. More... | |
 Public Member Functions inherited from App::DocumentObject | |
| virtual const char * | getViewProviderName (void) const |
| returns the type name of the ViewProvider | |
| 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... | |
| virtual short | mustExecute (void) const |
| bool | recomputeFeature () |
| Recompute only this feature. | |
| const char * | getStatusString (void) const |
| get the status Message | |
| virtual void | onLostLinkToObject (DocumentObject *) |
| virtual std::vector< PyObject * > | getPySubObjects (const std::vector< std::string > &) const |
| its used to get the python sub objects by name (e.g. by the selection) | |
| 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. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Base::Persistence | |
| static std::string | encodeAttribute (const std::string &) |
| Encodes an attribute upon saving. | |
| Protected Member Functions inherited from App::DocumentObject | |
| virtual App::DocumentObjectExecReturn * | recompute (void) |
| recompute only this object | |
| virtual App::DocumentObjectExecReturn * | execute (void) |
| virtual void | onBeforeChange (const Property *prop) |
| get called before the value is changed | |
| virtual void | onChanged (const Property *prop) |
| get called by the container when a property was 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 | |
| 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
◆ getPropertyOfGeometry()
|
virtual |
This method returns the main property of a geometric object that holds the actual geometry. For a part object this is the Shape property, for a mesh object the Mesh property and so on. The default implementation returns null.
◆ getPyObject()
|
virtual |
getPyObject returns the Python binding object
- Returns
- the Python binding object
Reimplemented from App::DocumentObject.
Reimplemented in Mesh::Feature.
◆ globalPlacement()
| Base::Placement App::GeoFeature::globalPlacement | ( | ) | const |
Calculates the placement in the global reference coordinate system.
In FreeCAD the GeoFeature placement describes the local placement of the object in its parent coordinate system. This is however not always the same as the global reference system. If the object is in a GeoFeatureGroup, hence in another local coordinate system, the Placement property does only give the local transformation. This function can be used to calculate the placement of the object in the global reference coordinate system taking all stacked local systems into account.
- Returns
- Base::Placement The transformation from the global reference coordinate system
◆ transformPlacement()
|
virtual |
transformPlacement applies transform to placement of this shape. Override this function to propagate the change of placement to base features, for example. By the time of writing this comment, the function was only called by alignment task (Edit->Alignment)
- Parameters
-
transform (input).
