diff --git a/src/App/GeoFeaturePy.xml b/src/App/GeoFeaturePy.xml index 492e520567..54f7967a8f 100644 --- a/src/App/GeoFeaturePy.xml +++ b/src/App/GeoFeaturePy.xml @@ -11,37 +11,46 @@ FatherNamespace="App"> - This class does the whole placement and position handling + App.GeoFeature class.\n +Base class of all geometric document objects. +This class does the whole placement and position handling. +With the method `getPropertyOfGeometry` is possible to obtain +the main geometric property in general form, without reference +to any particular property name. - returns all possible paths to the root of the document + getPaths()\n +Returns all possible paths to the root of the document. +Note: Not implemented. - Returns the placement of the object in the global coordinate space, respecting all stacked relationships. - Note: This function is not available during recompute, as there the placements of parents can change - after the execution of this object, rendering the result wrong. + getGlobalPlacement() -> Base.Placement\n +Returns the placement of the object in the global coordinate space, respecting all stacked +relationships. +Note: This function is not available during recompute, as there the placements of parents +can change after the execution of this object, rendering the result wrong. - Returns the property name of the actual geometry or None. -For example for a part object it returns the value Shape, -for a mesh the value Mesh and so on. + getPropertyNameOfGeometry() -> str or None\n +Returns the property name of the actual geometry. +For example for a Part feature it returns the value 'Shape', for a mesh feature the value +'Mesh' and so on. If an object has no such property then None is returned. - Returns the property of the actual geometry or None. -For example for a part object it returns its Shape property, -for a mesh its Mesh property and so on. + getPropertyOfGeometry() -> object or None\n +Returns the property of the actual geometry. +For example for a Part feature it returns its Shape property, for a Mesh feature its +Mesh property and so on. If an object has no such property then None is returned. -Unlike to getPropertyNameOfGeometry this function returns the geometry, -not its name. - +Unlike to getPropertyNameOfGeometry this function returns the geometry, not its name.