-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add chamfer tool #1495
base: main
Are you sure you want to change the base?
feat: add chamfer tool #1495
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good at first sight. Again, I would initiate a "Pull tools" example module to host how to use them. We need examples for all these new features.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM @jonahrb! However, we are having some issues with the Docker images as you might have seen. Hope to see this merged soon. I'll leave it approved!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah wait - documentation example is missing. I'll leave the approval for whenever that's done
@RobPasMue yes working on that now :) |
---------- | ||
edges_or_faces : Edge | List[Edge] | Face | List[Face] | ||
Edge(s) or face(s) to act on. | ||
distance : Real | ||
Chamfer distance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jonahrb @RobPasMue . Should we also have a parameter named angle?
As it is, are we assuming that the angle will always be 45deg?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe it add to much complexity and that is why we don't expose such parameters.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll leave it to @jonahrb to decide - implementing the angle operation might imply some math but I agree it would be useful. I would expose it via 2 independent methods chamfer_by_distance
and chamfer_by_angle
.
--- | ||
|
||
# Modeling: Chamfer edges and faces | ||
A chamfer is an angled cut on an edge. Chamfers can be created through the `Modeler.pull_tools` module. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A chamfer is an angled cut on an edge. Chamfers can be created through the `Modeler.pull_tools` module. | |
A chamfer is an angled cut on an edge. Chamfers can be created using the ``Modeler.pull_tools`` module. |
Single backtick formats as italic. We need to use double backticks to format as a code entity.
``` | ||
|
||
## Chamfer faces | ||
The chamfer of a face can also be modified. Create a chamfer on a single edge, then modify the chamfer distance value by providing the newly created face that represents the chamfer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The chamfer of a face can also be modified. Create a chamfer on a single edge, then modify the chamfer distance value by providing the newly created face that represents the chamfer. | |
The chamfer of a face can also be modified. Create a chamfer on a single edge and then modify the chamfer distance value by providing the newly created face that represents the chamfer. |
|
||
|
||
class PullTools: | ||
"""Pull tools for PyAnsys Geometry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"""Pull tools for PyAnsys Geometry. | |
"""Provides pull tools for PyAnsys Geometry. |
Class descriptions should begin with a verb ending in "s" or "es"
|
||
@protect_grpc | ||
def __init__(self, grpc_client: GrpcClient): | ||
"""Initialize pull tools class.""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"""Initialize pull tools class.""" | |
"""Initialize an instance of the ``PullTools`` class.""" |
Parameters | ||
---------- | ||
edges_or_faces : Edge | List[Edge] | Face | List[Face] | ||
Edge(s) or face(s) to act on. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Edge(s) or face(s) to act on. | |
One or more edges or faces to act on. |
Avoid using (s) construction.
Returns | ||
------- | ||
bool | ||
Success of chamfer command. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Success of chamfer command. | |
``True`` when successful, ``False`` when failed. |
This is our standard verbiage for a Boolean return value.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor edits suggested on doc content.
Description
Create chamfer on an edge, or adjust the chamfer of a face. This is available on Linux via the CoreService. Created "pull_tools" to house all the incoming geometry commands that will all be available on windows+linux.
Issue linked
Checklist
feat: extrude circle to cylinder
)