[bindings] Format with yapf (precommit will reformat)

This commit is contained in:
Frank Martinez
2025-10-07 12:07:42 -05:00
parent d4d7cabdc5
commit 0d0689341b
254 changed files with 885 additions and 311 deletions

View File

@@ -4,6 +4,7 @@ from __future__ import annotations
from Base.PyObjectBase import PyObjectBase
class ApplicationDirectories(PyObjectBase):
"""
Provides access to the directory versioning methods of its C++ counterpart.

View File

@@ -12,6 +12,7 @@ from Base.Matrix import Matrix
from StringHasher import StringHasher
from typing import Any, Final
@export(
Namespace="Data",
Reference=True,
@@ -36,18 +37,14 @@ class ComplexGeoData(Persistence):
...
@constmethod
def getFacesFromSubElement(
self,
) -> tuple[list[Vector], list[tuple[int, int, int]]]:
def getFacesFromSubElement(self, ) -> tuple[list[Vector], list[tuple[int, int, int]]]:
"""
Return vertexes and faces from a sub-element.
"""
...
@constmethod
def getLinesFromSubElement(
self,
) -> tuple[list[Vector], list[tuple[int, int]]]:
def getLinesFromSubElement(self, ) -> tuple[list[Vector], list[tuple[int, int]]]:
"""
Return vertexes and lines from a sub-element.
"""
@@ -136,6 +133,7 @@ class ComplexGeoData(Persistence):
Return the mapped element name
"""
...
BoundBox: Final[BoundBox] = ...
"""Get the bounding box (BoundBox) of the complex geometric data."""

View File

@@ -6,6 +6,7 @@ from PropertyContainer import PropertyContainer
from DocumentObject import DocumentObject
from typing import Final, Sequence
class Document(PropertyContainer):
"""
This is the Document class.

View File

@@ -9,6 +9,7 @@ from DocumentObjectGroup import DocumentObjectGroup
from ExtensionContainer import ExtensionContainer
from typing import Any, Final, List, Optional, Union, Tuple
class DocumentObject(ExtensionContainer):
"""
This is the father of all classes handled by the document

View File

@@ -4,6 +4,7 @@ from __future__ import annotations
from Extension import Extension
class DocumentObjectExtension(Extension):
"""
Base class for all document object extensions

View File

@@ -4,6 +4,7 @@ from __future__ import annotations
from DocumentObject import DocumentObject
class DocumentObjectGroup(DocumentObject):
"""
This class handles document objects in group

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from typing import Final, Any
from Base.PyObjectBase import PyObjectBase
class Extension(PyObjectBase):
"""
Base class for all extensions

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from Base.Metadata import export, constmethod
from PropertyContainer import PropertyContainer
@export(
Initialization=True,
Constructor=True,

View File

@@ -6,6 +6,7 @@ from DocumentObject import DocumentObject
from Base.Placement import Placement
from typing import Any, Final, Optional
class GeoFeature(DocumentObject):
"""
App.GeoFeature class.

View File

@@ -4,6 +4,7 @@ from __future__ import annotations
from GroupExtension import GroupExtension
class GeoFeatureGroupExtension(GroupExtension):
"""
Author: Werner Mayer (wmayer@users.sourceforge.net)

View File

@@ -6,9 +6,8 @@ from Base.Metadata import export
from DocumentObjectExtension import DocumentObjectExtension
from typing import Any, List
@export(
Include="App/DocumentObjectGroup.h",
)
@export(Include="App/DocumentObjectGroup.h", )
class GroupExtension(DocumentObjectExtension):
"""
Extension class which allows grouping of document objects

View File

@@ -6,9 +6,8 @@ from Base.Metadata import export
from DocumentObjectExtension import DocumentObjectExtension
from typing import Any, Final, List, Tuple, Optional, Union, overload
@export(
Include="App/Link.h",
)
@export(Include="App/Link.h", )
class LinkBaseExtension(DocumentObjectExtension):
"""
Link extension base class
@@ -57,11 +56,17 @@ class LinkBaseExtension(DocumentObjectExtension):
...
@overload
def getLinkPropertyInfo(self, /) -> tuple: ...
def getLinkPropertyInfo(self, /) -> tuple:
...
@overload
def getLinkPropertyInfo(self, index: int, /) -> tuple: ...
def getLinkPropertyInfo(self, index: int, /) -> tuple:
...
@overload
def getLinkPropertyInfo(self, name: str, /) -> tuple: ...
def getLinkPropertyInfo(self, name: str, /) -> tuple:
...
def getLinkPropertyInfo(self, arg: Any = None, /) -> tuple:
"""
getLinkPropertyInfo(): return a tuple of (name,type,doc) for all supported properties.

View File

@@ -6,15 +6,14 @@ from Base.Metadata import export, class_declarations
from Base.PyObjectBase import PyObjectBase
from typing import Any, overload
@export(
Constructor=True,
Delete=True,
)
@class_declarations(
"""public:
@class_declarations("""public:
static Base::Color toColor(PyObject* value);
"""
)
""")
class Material(PyObjectBase):
"""
App.Material class.

View File

@@ -8,6 +8,7 @@ from typing import List, Tuple, TypeAlias
MeasureType: TypeAlias = object
@export(
Constructor=False,
Delete=True,

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export, class_declarations
from Base.PyObjectBase import PyObjectBase
from typing import Any, List, Dict, overload, Optional
@export(
Constructor=True,
Delete=True,
@@ -52,13 +53,20 @@ class Metadata(PyObjectBase):
"""
@overload
def __init__(self) -> None: ...
def __init__(self) -> None:
...
@overload
def __init__(self, metadata: "Metadata") -> None: ...
def __init__(self, metadata: "Metadata") -> None:
...
@overload
def __init__(self, file: str) -> None: ...
def __init__(self, file: str) -> None:
...
@overload
def __init__(self, bytes: bytes) -> None: ...
def __init__(self, bytes: bytes) -> None:
...
Name: str = ""
"""String representing the name of this item."""

View File

@@ -4,6 +4,7 @@ from __future__ import annotations
from GeoFeatureGroupExtension import GeoFeatureGroupExtension
class OriginGroupExtension(GeoFeatureGroupExtension):
"""
Author: Alexander Golubev (fatzer2@gmail.com)

View File

@@ -4,6 +4,7 @@ from __future__ import annotations
from GeoFeature import GeoFeature
class Part(GeoFeature):
"""
Author: Juergen Riegel (FreeCAD@juergen-riegel.net)

View File

@@ -6,9 +6,8 @@ from Base.Metadata import export, constmethod
from Base.Persistence import Persistence
from typing import Any, Final, Union, List, Optional
@export(
DisableNotify=True,
)
@export(DisableNotify=True, )
class PropertyContainer(Persistence):
"""
App.PropertyContainer class.

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export, constmethod
from Base.BaseClass import BaseClass
from typing import Any, Final, overload, Dict
@export(
Constructor=True,
Reference=True,
@@ -19,9 +20,13 @@ class StringHasher(BaseClass):
"""
@overload
def getID(self, txt: str, base64: bool = False, /) -> Any: ...
def getID(self, txt: str, base64: bool = False, /) -> Any:
...
@overload
def getID(self, id: int, base64: bool = False, /) -> Any: ...
def getID(self, id: int, base64: bool = False, /) -> Any:
...
def getID(self, arg: Any, base64: bool = False, /) -> Any:
"""
getID(txt|id, base64=False) -> StringID

View File

@@ -6,16 +6,15 @@ from Base.Metadata import export, constmethod, class_declarations
from Base.BaseClass import BaseClass
from typing import Any, Final, List
@export(
Include="App/StringHasher.h",
Reference=True,
)
@class_declarations(
"""private:
@class_declarations("""private:
friend class StringID;
int _index = 0;
"""
)
""")
class StringID(BaseClass):
"""
This is the StringID class
@@ -30,6 +29,7 @@ class StringID(BaseClass):
Check if two StringIDs are the same
"""
...
Value: Final[int] = 0
"""Return the integer value of this ID"""

View File

@@ -4,6 +4,7 @@ from __future__ import annotations
from DocumentObjectExtension import DocumentObjectExtension
class SuppressibleExtension(DocumentObjectExtension):
"""
Author: Florian Foinant-Willig (flachyjoe@users.sourceforge.net)

View File

@@ -8,6 +8,7 @@ from Vector import Vector
from Placement import Placement
from typing import overload
@export(
Constructor=True,
Delete=True,

View File

@@ -6,6 +6,7 @@ from Metadata import constmethod
from PyObjectBase import PyObjectBase
from typing import List, Final
class BaseClass(PyObjectBase):
"""
This is the base class

View File

@@ -8,6 +8,7 @@ from Vector import Vector
from Matrix import Matrix
from typing import overload, Any, Final, Tuple, Union
@export(
TwinPointer="BoundBox3d",
Constructor=True,
@@ -136,11 +137,17 @@ class BoundBox(PyObjectBase):
...
@overload
def add(self, minMax: Vector, /) -> None: ...
def add(self, minMax: Vector, /) -> None:
...
@overload
def add(self, minMax: Tuple[float, float, float], /) -> None: ...
def add(self, minMax: Tuple[float, float, float], /) -> None:
...
@overload
def add(self, x: float, y: float, z: float, /) -> None: ...
def add(self, x: float, y: float, z: float, /) -> None:
...
def add(self, *args: Any, **kwargs: Any) -> None:
"""
add(minMax) -> None
@@ -186,9 +193,13 @@ class BoundBox(PyObjectBase):
...
@overload
def closestPoint(self, point: Vector, /) -> Vector: ...
def closestPoint(self, point: Vector, /) -> Vector:
...
@overload
def closestPoint(self, x: float, y: float, z: float, /) -> Vector: ...
def closestPoint(self, x: float, y: float, z: float, /) -> Vector:
...
@constmethod
def closestPoint(self, *args: Any, **kwargs: Any) -> Vector:
"""
@@ -209,14 +220,18 @@ class BoundBox(PyObjectBase):
...
@overload
def intersect(self, boundBox2: "BoundBox", /) -> bool: ...
def intersect(self, boundBox2: "BoundBox", /) -> bool:
...
@overload
def intersect(
self,
base: Union[Vector, Tuple[float, float, float]],
dir: Union[Vector, Tuple[float, float, float]],
/,
) -> bool: ...
) -> bool:
...
def intersect(self, *args: Any) -> bool:
"""
intersect(boundBox2) -> bool
@@ -279,11 +294,17 @@ class BoundBox(PyObjectBase):
...
@overload
def move(self, displacement: Vector, /) -> None: ...
def move(self, displacement: Vector, /) -> None:
...
@overload
def move(self, displacement: Tuple[float, float, float], /) -> None: ...
def move(self, displacement: Tuple[float, float, float], /) -> None:
...
@overload
def move(self, x: float, y: float, z: float, /) -> None: ...
def move(self, x: float, y: float, z: float, /) -> None:
...
def move(self, *args: Any, **kwargs: Any) -> None:
"""
move(displacement) -> None
@@ -303,11 +324,17 @@ class BoundBox(PyObjectBase):
...
@overload
def scale(self, factor: Vector, /) -> None: ...
def scale(self, factor: Vector, /) -> None:
...
@overload
def scale(self, factor: Tuple[float, float, float], /) -> None: ...
def scale(self, factor: Tuple[float, float, float], /) -> None:
...
@overload
def scale(self, x: float, y: float, z: float, /) -> None: ...
def scale(self, x: float, y: float, z: float, /) -> None:
...
def scale(self, *args: Any, **kwargs: Any) -> None:
"""
scale(factor) -> None
@@ -351,11 +378,17 @@ class BoundBox(PyObjectBase):
...
@overload
def isInside(self, object: Vector, /) -> bool: ...
def isInside(self, object: Vector, /) -> bool:
...
@overload
def isInside(self, object: "BoundBox", /) -> bool: ...
def isInside(self, object: "BoundBox", /) -> bool:
...
@overload
def isInside(self, x: float, y: float, z: float, /) -> bool: ...
def isInside(self, x: float, y: float, z: float, /) -> bool:
...
def isInside(self, *args: Any) -> bool:
"""
isInside(object) -> bool

View File

@@ -10,6 +10,7 @@ from Placement import Placement
from Rotation import Rotation
from typing import Union
@export(
Constructor=True,
Delete=True,

View File

@@ -8,6 +8,7 @@ from PyObjectBase import PyObjectBase
from enum import IntEnum
from typing import overload, Union, Tuple, Sequence
class ScaleType(IntEnum):
Other = -1
NoScaling = 0
@@ -15,6 +16,7 @@ class ScaleType(IntEnum):
NonUniformLeft = 2
Uniform = 3
@export(
TwinPointer="Matrix4D",
Constructor=True,
@@ -107,9 +109,13 @@ class Matrix(PyObjectBase):
"""The matrix elements."""
@overload
def move(self, vector: Vector, /) -> None: ...
def move(self, vector: Vector, /) -> None:
...
@overload
def move(self, x: float, y: float, z: float, /) -> None: ...
def move(self, x: float, y: float, z: float, /) -> None:
...
def move(self, *args) -> None:
"""
move(vector) -> None
@@ -129,11 +135,17 @@ class Matrix(PyObjectBase):
...
@overload
def scale(self, vector: Vector, /) -> None: ...
def scale(self, vector: Vector, /) -> None:
...
@overload
def scale(self, x: float, y: float, z: float, /) -> None: ...
def scale(self, x: float, y: float, z: float, /) -> None:
...
@overload
def scale(self, factor: float, /) -> None: ...
def scale(self, factor: float, /) -> None:
...
def scale(self, *args) -> None:
"""
scale(vector) -> None
@@ -335,9 +347,13 @@ class Matrix(PyObjectBase):
...
@overload
def multiply(self, matrix: "Matrix", /) -> "Matrix": ...
def multiply(self, matrix: "Matrix", /) -> "Matrix":
...
@overload
def multiply(self, vector: Vector, /) -> Vector: ...
def multiply(self, vector: Vector, /) -> Vector:
...
@constmethod
def multiply(self, obj: Union["Matrix", Vector], /) -> Union["Matrix", Vector]:
"""

View File

@@ -1,31 +1,40 @@
# SPDX-License: LGPL-2.1-or-later
from __future__ import annotations
"""
This file keeps auxiliary metadata to be used by the Python API stubs.
"""
def export(**kwargs):
"""
A decorator to attach metadata to a class.
"""
...
def constmethod(method): ...
def no_args(method): ...
def constmethod(method):
...
def no_args(method):
...
def forward_declarations(source_code):
"""
A decorator to attach forward declarations to a class.
"""
...
def class_declarations(source_code):
"""
A decorator to attach forward declarations to a class.
"""
...
def sequence_protocol(**kwargs):
"""
A decorator to attach sequence protocol metadata to a class.

View File

@@ -6,6 +6,7 @@ from Metadata import constmethod
from BaseClass import BaseClass
from typing import Final
class Persistence(BaseClass):
"""
Base.Persistence class.

View File

@@ -9,6 +9,7 @@ from Rotation import Rotation as RotationPy
from Vector import Vector
from typing import Sequence, overload
@export(
Constructor=True,
Delete=True,
@@ -119,7 +120,8 @@ class Placement(PyObjectBase):
@overload
def rotate(
self, center: Sequence[float], axis: Sequence[float], angle: float, *, comp: bool = False
) -> None: ...
) -> None:
...
@overload
def rotate(self, center: Vector, axis: Vector, angle: float, *, comp: bool = False) -> None:

View File

@@ -4,6 +4,7 @@ from __future__ import annotations
from PyObjectBase import PyObjectBase
class Precision(PyObjectBase):
"""
This is the Precision class

View File

@@ -2,6 +2,7 @@
from __future__ import annotations
class PyObjectBase:
"""
The most base class for Python bindings.

View File

@@ -7,6 +7,7 @@ from PyObjectBase import PyObjectBase
from typing import overload, Final, Tuple, Union
from Unit import Unit as UnitPy
@export(
NumberProtocol=True,
RichCompare=True,
@@ -55,9 +56,13 @@ class Quantity(PyObjectBase):
# fmt: on
@overload
def toStr(self, /) -> str: ...
def toStr(self, /) -> str:
...
@overload
def toStr(self, decimals: int, /) -> str: ...
def toStr(self, decimals: int, /) -> str:
...
@constmethod
def toStr(self, decimals: int = ..., /) -> str:
"""
@@ -76,13 +81,21 @@ class Quantity(PyObjectBase):
...
@overload
def getValueAs(self, unit: str, /) -> float: ...
def getValueAs(self, unit: str, /) -> float:
...
@overload
def getValueAs(self, translation: float, unit_signature: int, /) -> float: ...
def getValueAs(self, translation: float, unit_signature: int, /) -> float:
...
@overload
def getValueAs(self, unit: UnitPy, /) -> float: ...
def getValueAs(self, unit: UnitPy, /) -> float:
...
@overload
def getValueAs(self, quantity: "Quantity", /) -> float: ...
def getValueAs(self, quantity: "Quantity", /) -> float:
...
@constmethod
def getValueAs(self, *args) -> float:
"""
@@ -98,9 +111,13 @@ class Quantity(PyObjectBase):
...
@overload
def __round__(self, /) -> int: ...
def __round__(self, /) -> int:
...
@overload
def __round__(self, ndigits: int, /) -> float: ...
def __round__(self, ndigits: int, /) -> float:
...
@constmethod
def __round__(self, ndigits: int = ..., /) -> Union[int, float]:
"""
@@ -108,4 +125,3 @@ class Quantity(PyObjectBase):
When an argument is passed, work like built-in round(x, ndigits).
"""
...

View File

@@ -8,6 +8,7 @@ from Vector import Vector
from Matrix import Matrix
from typing import overload, Tuple, List, Final
@export(
Constructor=True,
Delete=True,

View File

@@ -6,17 +6,16 @@ from Metadata import export, forward_declarations, constmethod
from PyObjectBase import PyObjectBase
from typing import List, Final
@export(
Twin="BaseType",
TwinPointer="BaseType",
Delete=True,
)
@forward_declarations(
"""
@forward_declarations("""
namespace Base {
using BaseType = Type;
}"""
)
}""")
class Type(PyObjectBase):
"""
BaseTypePy class.

View File

@@ -7,6 +7,7 @@ from PyObjectBase import PyObjectBase
from Quantity import Quantity
from typing import Final, Tuple, overload
@export(
NumberProtocol=True,
RichCompare=True,
@@ -30,7 +31,9 @@ class Unit(PyObjectBase):
"""
@overload
def __init__(self) -> None: ...
def __init__(self) -> None:
...
@overload
def __init__(
self,
@@ -42,13 +45,20 @@ class Unit(PyObjectBase):
i6: float,
i7: float,
i8: float,
) -> None: ...
) -> None:
...
@overload
def __init__(self, quantity: Quantity) -> None: ...
def __init__(self, quantity: Quantity) -> None:
...
@overload
def __init__(self, unit: Unit) -> None: ...
def __init__(self, unit: Unit) -> None:
...
@overload
def __init__(self, string: str) -> None: ...
def __init__(self, string: str) -> None:
...
Type: Final[str] = ...
"""holds the unit type as a string, e.g. 'Area'."""

View File

@@ -6,6 +6,7 @@ from Metadata import export, constmethod, sequence_protocol, class_declarations
from PyObjectBase import PyObjectBase
from typing import overload, Sequence
@export(
TwinPointer="Vector3d",
Include="Base/Vector3D.h",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export, constmethod
from Base.BaseClass import BaseClass
from typing import Any, Final, Tuple, Dict
@export(
Constructor=True,
Delete=True,
@@ -45,6 +46,7 @@ class AxisOrigin(BaseClass):
Output Coin path leading to the returned element detail.
"""
...
AxisLength: float = 0.0
"""Get/set the axis length."""

View File

@@ -6,6 +6,7 @@ from Base.Metadata import constmethod
from Base.PyObjectBase import PyObjectBase
from typing import Any, Dict, List, Optional
class Command(PyObjectBase):
"""
FreeCAD Python wrapper of Command functions

View File

@@ -7,6 +7,7 @@ from Base.Persistence import Persistence
from Base.Matrix import Matrix
from typing import Any, Final, List, Optional
class Document(Persistence):
"""
This is a Document class
@@ -227,6 +228,7 @@ class Document(Persistence):
obj : Gui.ViewProvider
"""
...
ActiveObject: Any = ...
"""The active object of the document."""

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export, constmethod
from Base.BaseClass import BaseClass
from typing import Any, Final, List, Dict, Tuple, overload
@export(
Include="Gui/ViewProviderLink.h",
Constructor=True,
@@ -26,13 +27,21 @@ class LinkView(BaseClass):
...
@overload
def setMaterial(self, material: None, /) -> None: ...
def setMaterial(self, material: None, /) -> None:
...
@overload
def setMaterial(self, material: Any, /) -> None: ...
def setMaterial(self, material: Any, /) -> None:
...
@overload
def setMaterial(self, material: List[Any], /) -> None: ...
def setMaterial(self, material: List[Any], /) -> None:
...
@overload
def setMaterial(self, material: Dict[int, Any], /) -> None: ...
def setMaterial(self, material: Dict[int, Any], /) -> None:
...
def setMaterial(self, material: Any, /) -> None:
"""
setMaterial(Material): set the override material of the entire linked object
@@ -49,11 +58,14 @@ class LinkView(BaseClass):
"""
...
@overload
def setType(self, type: int, /) -> None:
...
@overload
def setType(self, type: int, /) -> None: ...
@overload
def setType(self, type: int, sublink: bool, /) -> None: ...
def setType(self, type: int, sublink: bool, /) -> None:
...
def setType(self, type: int, sublink: bool = True, /) -> None:
"""
setType(type, sublink=True): set the link type.
@@ -70,11 +82,17 @@ class LinkView(BaseClass):
...
@overload
def setTransform(self, matrix: Any, /) -> None: ...
def setTransform(self, matrix: Any, /) -> None:
...
@overload
def setTransform(self, matrix: List[Any], /) -> None: ...
def setTransform(self, matrix: List[Any], /) -> None:
...
@overload
def setTransform(self, matrix: Dict[int, Any], /) -> None: ...
def setTransform(self, matrix: Dict[int, Any], /) -> None:
...
def setTransform(self, matrix: Any, /) -> None:
"""
setTransform(matrix): set transformation of the linked object
@@ -104,11 +122,17 @@ class LinkView(BaseClass):
...
@overload
def setLink(self, obj: Any, /) -> None: ...
def setLink(self, obj: Any, /) -> None:
...
@overload
def setLink(self, obj: Any, subname: str, /) -> None: ...
def setLink(self, obj: Any, subname: str, /) -> None:
...
@overload
def setLink(self, obj: Any, subname: List[str], /) -> None: ...
def setLink(self, obj: Any, subname: List[str], /) -> None:
...
def setLink(self, obj: Any, subname: Any = None, /) -> None:
"""
setLink(object): Set the link
@@ -152,6 +176,7 @@ class LinkView(BaseClass):
Get children view objects
"""
...
LinkedView: Final[Any] = ...
"""The linked view object"""

View File

@@ -3,9 +3,8 @@
from Base.Metadata import export
from Base.BaseClass import BaseClass
@export(
Include="Gui/Navigation/NavigationStyle.h",
)
@export(Include="Gui/Navigation/NavigationStyle.h", )
class NavigationStyle(BaseClass):
"""
This is the base class for navigation styles

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from Workbench import Workbench
from warnings import deprecated
@export(
Twin="PythonBaseWorkbench",
TwinPointer="PythonBaseWorkbench",

View File

@@ -4,6 +4,7 @@ from Base.Metadata import export
from Base.BaseClass import BaseClass
from typing import Any, Final, Tuple
@export(
Include="Gui/Selection/SelectionObject.h",
Delete=True,
@@ -31,6 +32,7 @@ class SelectionObject(BaseClass):
isObjectTypeOf(type) -> Bool
"""
...
ObjectName: Final[str] = ""
"""Name of the selected object"""

View File

@@ -8,6 +8,7 @@ from App.ExtensionContainer import ExtensionContainer
from typing import Any, Final, List, Optional
import enum
class ViewProvider(ExtensionContainer):
"""
This is the ViewProvider base class
@@ -341,6 +342,7 @@ class ViewProvider(ExtensionContainer):
Default to active view. Optional.
"""
...
Annotation: Any = ...
"""A pivy Separator to add a custom scenegraph to this ViewProvider."""

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from ViewProvider import ViewProvider
from typing import Any, Final
class ViewProviderDocumentObject(ViewProvider):
"""
This is the ViewProvider base class
@@ -18,6 +19,7 @@ class ViewProviderDocumentObject(ViewProvider):
Update the view representation of the object
"""
...
Object: Any = ...
"""Set/Get the associated data object"""

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from Base.Metadata import constmethod
from App.Extension import Extension
class ViewProviderExtension(Extension):
"""
Base class for all view provider extensions

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from Base.Metadata import no_args
from ViewProviderDocumentObject import ViewProviderDocumentObject
class ViewProviderGeometryObject(ViewProviderDocumentObject):
"""
This is the ViewProvider geometry class

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from ViewProviderDocumentObject import ViewProviderDocumentObject
from typing import Any, Final
class ViewProviderLink(ViewProviderDocumentObject):
"""
This is the ViewProviderLink class

View File

@@ -6,9 +6,8 @@ from Base.Metadata import export
from Base.BaseClass import BaseClass
from typing import Any, List, Dict
@export(
Include="Gui/Workbench.h",
)
@export(Include="Gui/Workbench.h", )
class Workbench(BaseClass):
"""
This is the base class for workbenches

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from App.Part import Part
@export(
Include="Mod/Assembly/App/AssemblyLink.h",
Namespace="Assembly",

View File

@@ -8,6 +8,7 @@ from Base.Metadata import constmethod, export
from App.Part import Part
@export(Include="Mod/Assembly/App/AssemblyObject.h", Namespace="Assembly")
class AssemblyObject(Part):
"""
@@ -152,10 +153,10 @@ class AssemblyObject(Part):
Args:
fileName: The name of the file where the ASMT will be exported."""
...
@constmethod
def getDownstreamParts(
self, start_part: "App.DocumentObject", joint_to_ignore: "App.DocumentObject", /
) -> list["App.DocumentObject"]:
def getDownstreamParts(self, start_part: "App.DocumentObject", joint_to_ignore: "App.DocumentObject",
/) -> list["App.DocumentObject"]:
"""
Finds all parts connected to a start_part that are not connected to ground
when a specific joint is ignored.

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from App.DocumentObjectGroup import DocumentObjectGroup
@export(Include="Mod/Assembly/App/BomGroup.h", Namespace="Assembly")
class BomGroup(DocumentObjectGroup):
"""

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from Base.Metadata import export
from Spreadsheet.Sheet import Sheet
@export(
Include="Mod/Assembly/App/BomObject.h",
FatherInclude="Mod/Spreadsheet/App/SheetPy.h",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from App.DocumentObjectGroup import DocumentObjectGroup
@export(Include="Mod/Assembly/App/JointGroup.h", Namespace="Assembly")
class JointGroup(DocumentObjectGroup):
"""

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from App.DocumentObjectGroup import DocumentObjectGroup
@export(Include="Mod/Assembly/App/SimulationGroup.h", Namespace="Assembly")
class SimulationGroup(DocumentObjectGroup):
"""

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from App.DocumentObjectGroup import DocumentObjectGroup
@export(Include="Mod/Assembly/App/ViewGroup.h", Namespace="Assembly")
class ViewGroup(DocumentObjectGroup):
"""

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from App.DocumentObject import DocumentObject
from Gui.ViewProvider import ViewProvider
@export(Include="Mod/Assembly/Gui/ViewProviderAssembly.h", Namespace="AssemblyGui")
class ViewProviderAssembly(ViewProvider):
"""

View File

@@ -5,6 +5,7 @@ from typing import Any, Final
from Base.BaseClass import BaseClass
from Base.Metadata import export
@export(
Include="Mod/CAM/App/Area.h",
Namespace="Path",
@@ -95,6 +96,7 @@ class Area(BaseClass):
def abort(self, **kwargs) -> Any:
"""Abort the current operation."""
...
Sections: Final[list]
"""List of sections in this area."""

View File

@@ -4,6 +4,7 @@ from Base.Metadata import class_declarations, constmethod, export
from Base.Persistence import Persistence
from Base.Placement import Placement
@export(
Include="Mod/CAM/App/Command.h",
Namespace="Path",
@@ -31,6 +32,7 @@ class Command(Persistence):
def transform(self, placement: Placement, /) -> Command:
"""transform(Placement): returns a copy of this command transformed by the given placement"""
...
Name: str
"""The name of the command"""

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from App.DocumentObject import DocumentObject
@export(
Include="Mod/CAM/App/FeatureArea.h",
Namespace="Path",
@@ -28,5 +29,6 @@ class FeatureArea(DocumentObject):
Same usage as Path.Area.setParams(). This function stores the parameters in the properties.
"""
...
WorkPlane: Any
"""The current workplane. If no plane is set, it is derived from the added shapes."""

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from App.DocumentObject import DocumentObject
@export(
Include="Mod/CAM/App/FeaturePathCompound.h",
TwinPointer="FeatureCompound",

View File

@@ -5,6 +5,7 @@ from typing import Any, Final
from Base.Metadata import constmethod, export
from Base.Persistence import Persistence
@export(
Include="Mod/CAM/App/Path.h",
Twin="Toolpath",
@@ -54,6 +55,7 @@ class Path(Persistence):
def getCycleTime(self) -> Any:
"""return the cycle time estimation for this path in s"""
...
Length: Final[float]
"""the total length of this path in mm"""

View File

@@ -5,6 +5,7 @@ from typing import Any, Final
from Base.BaseClass import BaseClass
from Base.Metadata import constmethod, export
@export(
Include="Mod/CAM/App/Voronoi.h",
Namespace="Path",
@@ -81,6 +82,7 @@ class Voronoi(BaseClass):
def numSegments(self) -> Any:
"""Return number of input segments"""
...
Cells: Final[list]
"""List of all cells of the voronoi diagram"""

View File

@@ -5,6 +5,7 @@ from typing import Any, Final
from Base.BaseClass import BaseClass
from Base.Metadata import constmethod, export
@export(
Include="Mod/CAM/App/VoronoiCell.h",
Namespace="Path",
@@ -39,6 +40,7 @@ class VoronoiCell(BaseClass):
def getSource(self) -> Any:
"""Returns the Source for the cell"""
...
Index: Final[int]
"""Internal id of the element."""

View File

@@ -5,6 +5,7 @@ from typing import Any, Final
from Base.BaseClass import BaseClass
from Base.Metadata import constmethod, export
@export(
Include="Mod/CAM/App/VoronoiEdge.h",
Namespace="Path",
@@ -69,6 +70,7 @@ class VoronoiEdge(BaseClass):
def getSegmentAngle(self) -> Any:
"""Returns the angle (in degree) of the segments if the edge was formed by two segments"""
...
Index: Final[int]
"""Internal id of the element."""

View File

@@ -5,6 +5,7 @@ from typing import Any, Final
from Base.BaseClass import BaseClass
from Base.Metadata import constmethod, export
@export(
Include="Mod/CAM/App/VoronoiVertex.h",
Namespace="Path",
@@ -24,6 +25,7 @@ class VoronoiVertex(BaseClass):
def toPoint(self) -> Any:
"""Returns a Vector - or None if not possible"""
...
Index: Final[int]
"""Internal id of the element."""

View File

@@ -7,6 +7,7 @@ from typing import Any, Final
from Base.BaseClass import BaseClass
from Base.Metadata import export
@export(
FatherInclude="Base/BaseClassPy.h",
Include="Mod/CAM/PathSimulator/App/PathSim.h",
@@ -51,5 +52,6 @@ class PathSim(BaseClass):
Apply a single path command on the stock starting from placement."""
...
Tool: Final[Any]
"""Return current simulation tool."""

View File

@@ -8,6 +8,7 @@ from Base.BaseClass import BaseClass
from Base.Metadata import export
from Metadata import no_args
@export(
Include="Mod/CAM/PathSimulator/AppGL/CAMSim.h",
FatherInclude="Base/BaseClassPy.h",

View File

@@ -8,6 +8,7 @@ from Base.Metadata import constmethod, export
from App.ComplexGeoData import ComplexGeoData
@export(
Include="Mod/Fem/App/FemMesh.h",
Namespace="Fem",
@@ -260,6 +261,7 @@ class FemMesh(ComplexGeoData):
def getIdByElementType(self) -> Any:
"""Return a tuple of IDs to a given element type"""
...
Nodes: Final[dict]
"""Dictionary of Nodes by ID (int ID:Vector())"""

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from Fem.FemPostFilter import FemPostFilter
@export(
Include="Mod/Fem/App/FemPostBranchFilter.h",
Namespace="Fem",

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from Fem.FemPostObject import FemPostObject
@export(
Include="Mod/Fem/App/FemPostFilter.h",
Namespace="Fem",

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from App.GeoFeature import GeoFeature
@export(
Include="Mod/Fem/App/FemPostObject.h",
Namespace="Fem",

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from Fem.FemPostObject import FemPostObject
@export(
Include="Mod/Fem/App/FemPostPipeline.h",
Namespace="Fem",

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from Gui.ViewProviderGeometryObject import ViewProviderGeometryObject
@export(
Include="Mod/Fem/Gui/ViewProviderFemConstraint.h",
Namespace="FemGui",
@@ -32,6 +33,7 @@ class ViewProviderFemConstraint(ViewProviderGeometryObject):
filename : str
Open Inventor file."""
...
SymbolNode: Final[Any]
"""A pivy SoSeparator with the nodes of the constraint symbols"""

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from Gui.ViewProviderGeometryObject import ViewProviderGeometryObject
@export(
Include="Mod/Fem/Gui/ViewProviderFemMesh.h",
Namespace="FemGui",
@@ -43,6 +44,7 @@ class ViewProviderFemMesh(ViewProviderGeometryObject):
def setNodeDisplacementByVectors(self) -> Any:
""""""
...
NodeColor: dict
"""Postprocessing color of the nodes. The faces between the nodes get interpolated."""

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
@export(
Twin="ViewProviderFemPostObject",
TwinPointer="ViewProviderFemPostObject",

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
@export(
Include="Mod/Fem/Gui/ViewProviderFemPostPipeline.h",
Namespace="FemGui",

View File

@@ -7,6 +7,7 @@ from typing import Any
from Base.Metadata import export
from Base.PyObjectBase import PyObjectBase
@export(
Include="Mod/Import/App/StepShape.h",
Namespace="Import",

View File

@@ -7,6 +7,7 @@ from Base.BaseClass import BaseClass
from Base.Metadata import constmethod
from typing import Final, List, Any
@export(
Twin="Array2D",
TwinPointer="Array2D",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export, constmethod
from Base.BaseClass import BaseClass
from typing import Any, Final, List
@export(
Twin="Array3D",
TwinPointer="Array3D",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export, no_args, sequence_protocol
from Base.BaseClass import BaseClass
from typing import Final
@export(
Include="Mod/Material/App/Materials.h",
Namespace="Materials",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from Base.BaseClass import BaseClass
from typing import List
@export(
Include="Mod/Material/App/MaterialFilter.h",
Namespace="Materials",

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from Base.Metadata import export
from Base.BaseClass import BaseClass
@export(
Include="Mod/Material/App/MaterialFilter.h",
Namespace="Materials",

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from Base.Metadata import export
from Base.BaseClass import BaseClass
@export(
Include="Mod/Material/App/MaterialLibrary.h",
Namespace="Materials",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from Base.BaseClass import BaseClass
from typing import Final, List, Dict
@export(Include="Mod/Material/App/MaterialManager.h", Namespace="Materials", Constructor=True)
class MaterialManager(BaseClass):
"""

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from ModelProperty import ModelProperty
from typing import Final
@export(
Include="Mod/Material/App/Materials.h",
Namespace="Materials",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from Base.BaseClass import BaseClass
from typing import Final, List, Dict
@export(
Include="Mod/Material/App/Model.h",
Namespace="Materials",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from Base.BaseClass import BaseClass
from typing import Final, List, Dict
@export(Include="Mod/Material/App/ModelManager.h", Namespace="Materials", Constructor=True)
class ModelManager(BaseClass):
"""
@@ -24,13 +25,13 @@ class ModelManager(BaseClass):
Models: Final[Dict] = ...
"""List of model libraries."""
def getModel(self) -> ...:
def getModel(self) ->...:
"""
Get a model object by specifying its UUID
"""
...
def getModelByPath(self) -> ...:
def getModelByPath(self) ->...:
"""
Get a model object by specifying its path
"""

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from Base.BaseClass import BaseClass
from typing import Final
@export(
Include="Mod/Material/App/Model.h",
Namespace="Materials",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from Base.BaseClass import BaseClass
from typing import Final
@export(
PythonName="Material.UUIDs",
Twin="ModelUUIDs",

View File

@@ -7,6 +7,7 @@ from Metadata import (
)
from Base.BaseClass import BaseClass
@export(
Twin="MaterialTreeWidget",
TwinPointer="MaterialTreeWidget",

View File

@@ -6,6 +6,7 @@ from Base.Metadata import export
from App.DocumentObject import DocumentObject
@export(
Include="Mod/Measure/App/MeasureBase.h",
Namespace="Measure",

View File

@@ -7,6 +7,7 @@ from typing import Any
from Base.BaseClass import BaseClass
from Base.Metadata import export
@export(
Include="Mod/Measure/App/Measurement.h",
Namespace="Measure",

View File

@@ -5,6 +5,7 @@ from __future__ import annotations
from Base.Metadata import export
from Base.PyObjectBase import PyObjectBase
@export(
Include="Mod/Measure/Gui/QuickMeasure.h",
Namespace="MeasureGui",

View File

@@ -7,6 +7,7 @@ from typing import Final, Any
from Base.Metadata import export
from Base.PyObjectBase import PyObjectBase
@export(
Include="Mod/Mesh/App/Edge.h",
Namespace="Mesh",
@@ -45,6 +46,7 @@ class Edge(PyObjectBase):
After calling unbound() no topological operation will
work!"""
...
Index: Final[int]
"""The index of this edge of the facet"""

View File

@@ -7,6 +7,7 @@ from typing import Any, Final
from Base.Metadata import export
from Base.PyObjectBase import PyObjectBase
@export(
Include="Mod/Mesh/App/Facet.h",
Namespace="Mesh",
@@ -56,6 +57,7 @@ class Facet(PyObjectBase):
"""getEdge(int) -> Edge
Returns the edge of the facet."""
...
Index: Final[int]
"""The index of this facet in the MeshObject"""

View File

@@ -8,6 +8,7 @@ from Base.Metadata import constmethod, export, class_declarations
from App.ComplexGeoData import ComplexGeoData
@export(
Twin="MeshObject",
TwinPointer="MeshObject",
@@ -509,6 +510,7 @@ class Mesh(ComplexGeoData):
The items in the list contains minimum and maximum curvature with their directions
"""
...
Points: Final[list]
"""A collection of the mesh points
With this attribute it is possible to get access to the points of the mesh

View File

@@ -8,6 +8,7 @@ from Base.Metadata import export
from App.GeoFeature import GeoFeature
@export(
Twin="Feature",
TwinPointer="Feature",

View File

@@ -7,6 +7,7 @@ from typing import Any, Final
from Base.Metadata import export
from Base.PyObjectBase import PyObjectBase
@export(
Include="Mod/Mesh/App/MeshPoint.h",
Namespace="Mesh",
@@ -33,6 +34,7 @@ class MeshPoint(PyObjectBase):
After calling unbound() no topological operation will
work!"""
...
Index: Final[int]
"""The index of this point in the MeshObject"""

View File

@@ -6,6 +6,7 @@ from typing import Any
from Gui.ViewProviderGeometryObject import ViewProviderGeometryObject
from Base.Metadata import export
@export(
Include="Mod/Mesh/Gui/ViewProvider.h",
Namespace="MeshGui",

Some files were not shown because too many files have changed in this diff Show More