Base: Standardize on Py::Long type for Python bindings.

This commit is contained in:
tritao
2025-02-07 22:46:35 +00:00
parent 5117c82d33
commit 2145b742eb
44 changed files with 285 additions and 285 deletions

View File

@@ -15,274 +15,274 @@
</Documentation>
<Methode Name="addProperty">
<Documentation>
<UserDocu>addProperty(type, name, group, doc, attr=0, ro=False, hd=False) -> ViewProvider
<UserDocu>addProperty(type, name, group, doc, attr=0, ro=False, hd=False) -> ViewProvider
Add a generic property.
Add a generic property.
type : str
type : str
Property type.
name : str
name : str
Property name. Optional.
group : str
group : str
Property group. Optional.
attr : int
attr : int
Property attributes.
ro : bool
ro : bool
Read only property.
hd : bool
hd : bool
Hidden property.</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeProperty">
<Documentation>
<UserDocu>removeProperty(name) -> bool
<UserDocu>removeProperty(name) -> bool
Remove a generic property.
Only user-defined properties can be removed, not built-in ones.
Only user-defined properties can be removed, not built-in ones.
name : str
name : str
Property name.</UserDocu>
</Documentation>
</Methode>
<Methode Name="supportedProperties">
<Documentation>
<UserDocu>supportedProperties() -> list
<UserDocu>supportedProperties() -> list
A list of supported property types.</UserDocu>
</Documentation>
</Methode>
<Methode Name="show">
<Documentation>
<UserDocu>show() -> None
<UserDocu>show() -> None
Show the object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="hide">
<Documentation>
<UserDocu>show() -> None
<UserDocu>show() -> None
Hide the object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="isVisible">
<Documentation>
<UserDocu>isVisible() -> bool
<UserDocu>isVisible() -> bool
Check if the object is visible.</UserDocu>
</Documentation>
</Methode>
<Methode Name="canDragObject">
<Documentation>
<UserDocu>canDragObject(obj=None) -> bool
<UserDocu>canDragObject(obj=None) -> bool
Check whether the child object can be removed by dragging.
If 'obj' is not given, check without filter by any particular object.
If 'obj' is not given, check without filter by any particular object.
obj : App.DocumentObject
obj : App.DocumentObject
Object to be dragged.</UserDocu>
</Documentation>
</Methode>
<Methode Name="dragObject">
<Documentation>
<UserDocu>dragObject(obj) -> None
<UserDocu>dragObject(obj) -> None
Remove a child object by dropping.
Remove a child object by dropping.
obj : App.DocumentObject
obj : App.DocumentObject
Object to be dragged.</UserDocu>
</Documentation>
</Methode>
<Methode Name="canDropObject" Keyword="true">
<Documentation>
<UserDocu>canDropObject(obj=None, owner=None, subname, elem=None) -> bool
<UserDocu>canDropObject(obj=None, owner=None, subname, elem=None) -> bool
Check whether the child object can be added by dropping.
If 'obj' is not given, check without filter by any particular object.
If 'obj' is not given, check without filter by any particular object.
obj : App.DocumentObject
obj : App.DocumentObject
Object to be dropped.
owner : App.DocumentObject
owner : App.DocumentObject
Parent object of the dropping object.
subname : str
subname : str
Subname reference to the dropping object. Optional.
elem : sequence of str
elem : sequence of str
Non-objects subelements selected when the object is
being dropped.</UserDocu>
</Documentation>
</Methode>
<Methode Name="dropObject" Keyword="true">
<Documentation>
<UserDocu>dropObject(obj, owner=None, subname, elem=None) -> str
<UserDocu>dropObject(obj, owner=None, subname, elem=None) -> str
Add a child object by dropping.
Add a child object by dropping.
obj : App.DocumentObject
obj : App.DocumentObject
Object to be dropped.
owner : App.DocumentObject
owner : App.DocumentObject
Parent object of the dropping object.
subname : str
subname : str
Subname reference to the dropping object. Optional.
elem : sequence of str
elem : sequence of str
Non-objects subelements selected when the object is
being dropped.</UserDocu>
</Documentation>
</Methode>
<Methode Name="canDragAndDropObject">
<Documentation>
<UserDocu>canDragAndDropObject(obj) -> bool
<UserDocu>canDragAndDropObject(obj) -> bool
Check whether the child object can be removed from
other parent and added here by drag and drop.
other parent and added here by drag and drop.
obj : App.DocumentObject
obj : App.DocumentObject
Object to be dragged and dropped.</UserDocu>
</Documentation>
</Methode>
<Methode Name="replaceObject">
<Documentation>
<UserDocu>replaceObject(oldObj, newObj) -> int
<UserDocu>replaceObject(oldObj, newObj) -> int
Replace a child object.
Returns 1 if succeeded, 0 if not found, -1 if not supported.
Returns 1 if succeeded, 0 if not found, -1 if not supported.
oldObj : App.DocumentObject
oldObj : App.DocumentObject
Old object.
newObj : App.DocumentObject
newObj : App.DocumentObject
New object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="doubleClicked">
<Documentation>
<UserDocu>doubleClicked() -> bool
<UserDocu>doubleClicked() -> bool
Trigger double clicking the corresponding tree item of this view object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="addDisplayMode">
<Documentation>
<UserDocu>addDisplayMode(obj, mode) -> None
<UserDocu>addDisplayMode(obj, mode) -> None
Add a new display mode to the view provider.
Add a new display mode to the view provider.
obj : coin.SoNode
obj : coin.SoNode
Display mode.
mode : str
mode : str
Name of the display mode.</UserDocu>
</Documentation>
</Methode>
<Methode Name="listDisplayModes">
<Documentation>
<UserDocu>listDisplayModes() -> list
<UserDocu>listDisplayModes() -> list
Show a list of all display modes.</UserDocu>
</Documentation>
</Methode>
<Methode Name="toString">
<Documentation>
<UserDocu>toString() -> str
<UserDocu>toString() -> str
Return a string representation of the Inventor node.</UserDocu>
</Documentation>
</Methode>
<Methode Name="setTransformation">
<Documentation>
<UserDocu>setTransformation(trans) -> None
<UserDocu>setTransformation(trans) -> None
Set a transformation on the Inventor node.
Set a transformation on the Inventor node.
trans : Base.Placement, Base.Matrix</UserDocu>
</Documentation>
</Methode>
<Methode Name="claimChildren" Const="true">
<Documentation>
<UserDocu>claimChildren() -> list
<UserDocu>claimChildren() -> list
Returns list of objects that are to be grouped in tree under this object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="claimChildrenRecursive" Const="true">
<Documentation>
<UserDocu>claimChildrenRecursive() -> list
<UserDocu>claimChildrenRecursive() -> list
Returns list of objects that are to be grouped in tree under this object recursively.</UserDocu>
</Documentation>
</Methode>
<Methode Name="partialRender">
<Documentation>
<UserDocu>partialRender(sub=None, clear=False) -> int
<UserDocu>partialRender(sub=None, clear=False) -> int
Render only part of the object.
Render only part of the object.
sub: None, str, sequence of str
sub: None, str, sequence of str
Refer to the subelement. If it is None then reset the partial rendering.
clear: bool
clear: bool
True to add, or False to remove the subelement(s) for rendering.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getElementColors">
<Documentation>
<UserDocu>getElementColors(elementName) -> dict
<UserDocu>getElementColors(elementName) -> dict
Get a dictionary of the form {elementName : (r,g,b,a)}.
If no element name is given a dictionary with all the elements is returned.
If no element name is given a dictionary with all the elements is returned.
elementName : str
elementName : str
Name of the element. Optional.</UserDocu>
</Documentation>
</Methode>
<Methode Name="setElementColors">
<Documentation>
<UserDocu>setElementColors(colors) -> None
<UserDocu>setElementColors(colors) -> None
Set element colors.
Set element colors.
colors: dict
colors: dict
Color dictionary of the form {elementName:(r,g,b,a)}.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getElementPicked" Const="true">
<Documentation>
<UserDocu>getElementPicked(pickPoint) -> str
<UserDocu>getElementPicked(pickPoint) -> str
Return the picked subelement.
Return the picked subelement.
pickPoint : coin.SoPickedPoint</UserDocu>
</Documentation>
</Methode>
<Methode Name="getDetailPath" Const="true">
<Documentation>
<UserDocu>getDetailPath(subelement, path, append=True) -> coin.SoDetail or None
<UserDocu>getDetailPath(subelement, path, append=True) -> coin.SoDetail or None
Return Coin detail and path of an subelement.
Return Coin detail and path of an subelement.
subname: str
subname: str
Dot separated string reference to the sub element.
pPath: coin.SoPath
pPath: coin.SoPath
Output coin path leading to the returned element detail.
append: bool
append: bool
If True, path will be first appended with the root node and the mode
switch node of this view provider.</UserDocu>
</Documentation>
</Methode>
<Methode Name="signalChangeIcon" Const="true">
<Documentation>
<UserDocu>signalChangeIcon() -> None
<UserDocu>signalChangeIcon() -> None
Trigger icon changed signal.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getBoundingBox">
<Documentation>
<UserDocu>getBoundingBox(subName, transform=True, view) -> Base.BoundBox
<UserDocu>getBoundingBox(subName, transform=True, view) -> Base.BoundBox
Obtain the bounding box of this view object.
Obtain the bounding box of this view object.
subName : str
subName : str
Name referring a sub-object. Optional.
transform: bool
transform: bool
Whether to apply the transformation matrix of this view provider.
view: View3DInventorPy
view: View3DInventorPy
Default to active view. Optional.</UserDocu>
</Documentation>
</Methode>
@@ -314,7 +314,7 @@ view: View3DInventorPy
<Documentation>
<UserDocu>Get/Set the default display mode in turns of coin node index.</UserDocu>
</Documentation>
<Parameter Name="DefaultNode" Type="Int" />
<Parameter Name="DefaultNode" Type="Long" />
</Attribute>
<Attribute Name="IV" ReadOnly="true">
<Documentation>