https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L25

This definition of P is not used later on in the code.

https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L6-L15

Two imports are not used: TypedDict and Self. In addition, ParamSpec is not used if P is not used.

https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L24-L28

The nameing: I think it is better to short the class name to: BlenderMeshProtocol or BlenderMeshInterface, since setting up protocols means creating interfaces. Personally, I prefer BlenderMeshProtocol. In addition, is S a good naming? I am not sure what is the convention here... (capitalized single alphabet? Maybe O stands for Object in Blender? or use Obj? M for mesh? or Mesh? or could you explain more on why choose this naming S?)

https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L71-L73

The return type of this class method. Why is it a string "Sphere" not the class Sphere? In addition, why define this class method create, rather than directly use __init__? I am asking this because what happen if the states does not have the keys: position or radius? I thought the use of __init__ forces the user to give these two arguments.

https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L176-L185

I don't understand what TYPE_CHECKING is doing ... Do you have reference to this? Is this a python thing or a mypy thing? I know that the TYPE_CHECKING constant defined by the typing module is False at runtime but True while type checking. But what's the purpose of this if block?

@hanson-hschang

https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L25

This definition of P is not used later on in the code.

Okay, but we need it later.

https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L6-L15

Two imports are not used: TypedDict and Self. In addition, ParamSpec is not used if P is not used.

Again, need them later.

https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L24-L28

The nameing: I think it is better to short the class name to: BlenderMeshProtocol or BlenderMeshInterface, since setting up protocols means creating interfaces. Personally, I prefer BlenderMeshProtocol. In addition, is S a good naming? I am not sure what is the convention here... (capitalized single alphabet? Maybe O stands for Object in Blender? or use Obj? M for mesh? or Mesh? or could you explain more on why choose this naming S?)

We'll add ...Protocol for any protocols to avoid confusion between other namings. Same for ...Type. I think BlenderMesh is misleading because it is not a mesh. BlenderMeshInterfaceProtocol is correct term here. I'm open for discussing if we want to append ...P, such that it is BlenderMeshInterfaceP instead. I've seen some code using this rule, but they doesn't look so clean. Up for discussion.

https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L71-L73

The return type of this class method. Why is it a string "Sphere" not the class Sphere?

Because Sphere is not defined at this line, and python cause error. I think it is resolved in later version of python, but at this moment we just need to use string format.

In addition, why define this class method create, rather than directly use __init__? I am asking this because what happen if the states does not have the keys: position or radius? I thought the use of __init__ forces the user to give these two arguments.

I think these interfaces will have multiple ways of constructing in the future, and I am using factory pattern. For example, we can have multiple way of making spheres in blender, and user might need to choose one or other. In case of rod, I already see that we need cylinder+sphere method for debugging/diagnostics, and bezier/B-spline for visual. We can change it later, but using @classmethod is easier to extend in the future.

https://github.com/GazzolaLab/Blender_Soft_Rod_Visualizer/blob/10fc24205ba28557a513769f2fd726583af0b0b3/src/bsr/geometry.py#L176-L185

I don't understand what TYPE_CHECKING is doing ... Do you have a reference to this? Is this a python thing or a mypy thing? I know that the TYPE_CHECKING constant defined by the typing module is False at runtime but True while type checking. But what's the purpose of this if block?

Idea is that this block is only visible by mypy. I want Sphere and Cylinder object to conform BlenderMeshInterfaceProtocol, but there is no explicit way of testing it. It is a trick introduced here.

@skim0119

I'm open for discussing if we want to append ...P, such that it is BlenderMeshInterfaceP instead. I've seen some code using this rule, but they don't look so clean. Up for discussion.

...P doesn't looks good to me. That's stick to ...Protocol.

In addition, is S a good naming? I am not sure what is the convention here... (capitalized single alphabet? Maybe O stands for Object in Blender? or use Obj? M for mesh? or Mesh? or could you explain more on why choose this naming S?)

How about this part? What is S and P used for?

The letter doesn't have much meaning. Capital single letter is typically used for generic typing in c++ , and that is why people use T or U or some capital letter

Cylinder and Sphere modules complete, passing all test cases. Documentation attached here.





file:///Users/rohitharish/github/Blender-Soft-Arm-Simulation/docs/build/html/api/geometry.html#bsr.geometry.Cylinder