Protocol on update_states

[hanson-hschang]

@skim0119

Is the current protocol on update_states good?

Blender-Soft-Rod/src/bsr/geometry/protocol.py

Lines 51 to 52 in 96190a1

	def update_states(self, *args: Any) -> None:
	"""Updates the mesh object with the given states."""

Will it be better to change *args to **kwargs? Since the states might be different for different objects?

I have the following protocol on update_material:

Blender-Soft-Rod/src/bsr/geometry/protocol.py

Lines 55 to 56 in 051ddbe

	def update_material(self, **kwargs: dict[str, Any]) -> None:
	"""Updates the material of the mesh object."""

[skim0119]

Will it be better to change *args to **kwargs? Since the states might be different for different objects?

Both args and kwargs can support all kinds of state. The difference is whether we want to be called with explicit parameter name or just an order.

I'll probably need to see what kind of parameters are suited for update_material to make the decision. For update_states, I would prefer using args.

[hanson-hschang]

If args is used, then the order of arguments matters, right?

For update_material, I think kwargs might be better.

[hanson-hschang]

In the following case, if the radii does not need to be updated, it still needs to be provided, right?

Blender-Soft-Rod/src/bsr/geometry/composite/rod.py

Lines 77 to 87 in e6a0a89

	def update_states(self, positions: NDArray, radii: NDArray) -> None:
	"""
	Update the states of the rod object
	Parameters
	----------
	positions : NDArray
	The positions of the sphere objects. Expected shape is (n_nodes, 3).
	radii : NDArray
	The radii of the sphere objects. Expected shape is (n_nodes-1,).
	"""