Change the Prefab's parameters and implemention to make it usage clear. #267
Closed
damienmarchal wants to merge 2 commits intosofa-framework:masterfrom
Closed
Change the Prefab's parameters and implemention to make it usage clear. #267damienmarchal wants to merge 2 commits intosofa-framework:masterfrom
damienmarchal wants to merge 2 commits intosofa-framework:masterfrom
Conversation
This was referenced Jun 10, 2022
damienmarchal
added
enhancement
damienmarchal
force-pushed
the
pr-improve-prefab
branch
2 times, most recently
from
2d57c0a to
bee6865
Compare
examples/example-prefab.py
Outdated
Comment on lines
1
to
24
| import Sofa | ||
|
|
||
| class MyPrefab(Sofa.Prefab): | ||
| prefabParameters = [ | ||
| {"name" : "n", | ||
| "type" : "int", | ||
| "help" : "Rien"} | ||
| ] | ||
|
|
||
| prefabData = [ | ||
| {"name" : "angle", "type" : "double", "help" : "The angular velocity of the motor", "default" : 3.14151617} | ||
| ] | ||
|
|
||
| def __init__(self, *args, **kwargs): | ||
| Sofa.Prefab.__init__(self, *args, **kwargs) | ||
|
|
||
| def onParameterChanged(self): | ||
| print("UPDATE...",self.n.value) | ||
| for i in range(self.n.value): | ||
| self.addChild("Child"+str(i)) | ||
|
|
||
| def createScene(root): | ||
| root.addChild("Child1") | ||
| root.addChild(MyPrefab(name="toto", n=5)) No newline at end of file |
Contributor
There was a problem hiding this comment.
I would clean this example a little bit. Like this for instance:
import Sofa
class MyPrefab(Sofa.Prefab):
prefabParameters = [
{"name" : "myParameter", "type" : "int", "help" : "my message to help the user", "default" : 0}
]
# These are special parameters, when any of them are changed the prefab is completely recreated by calling the method onParameterChanged().
# So the scene graph is always kept synchronized with these parameters content.
prefabData = [
{"name" : "myData", "type" : "double", "help" : "my message to help the user", "default" : 0.0}
]
def __init__(self, *args, **kwargs):
Sofa.Prefab.__init__(self, *args, **kwargs)
def onParameterChanged(self):
print("Called when any of the prefabParameters changed: ", self.myParameter.value)
for i in range(self.myParameter.value):
self.addChild("Child"+str(i))
def createScene(root):
root.addChild("MyPrefab1")
root.addChild(MyPrefab(name="MyPrefab2", myParameter=5))
Contributor
Author
There was a problem hiding this comment.
Arg @EulalieCoevoet you rise me a furious envy to continue this work.
So now the onParameterChanged can be either use that way but also to forward to the init()
import Sofa
class MyPrefab(Sofa.Prefab):
prefabParameters = [
{"name" : "myParameter", "type" : "int", "help" : "my message to help the user", "default" : 0}
]
# These are special parameters, when any of them are changed the prefab is completely recreated by calling the method onParameterChanged().
# So the scene graph is always kept synchronized with these parameters content.
prefabData = [
{"name" : "myData", "type" : "double", "help" : "my message to help the user", "default" : 0.0}
]
def __init__(self, *args, **kwargs):
Sofa.Prefab.__init__(self, *args, **kwargs)
def init(self):
print("Build the prefab with: ", self.myParameter.value)
for i in range(self.myParameter.value):
self.addChild("Child"+str(i))
#uncomment this to restrict/disable is update of the prefab on each parameter change
#def onParameterChanged(self):
# if self.myParameter.value > 2:
# self.init()
def createScene(root):
root.addChild("MyPrefab1")
root.addChild(MyPrefab(name="MyPrefab2", myParameter=5))
damienmarchal
force-pushed
the
pr-improve-prefab
branch
3 times, most recently
from
c6ba6c5 to
a6d696e
Compare
damienmarchal
changed the title
| if(!findData(name) && !findLink(name)) | ||
| { | ||
| sofa::core::objectmodel::BaseData* data = sofapython3::addData(py::cast(this), name, py::none(), defaultValue, help, "Prefab's properties", type); | ||
| sofa::core::objectmodel::BaseData* data = sofapython3::addData(py::cast(this), name, py::none(), defaultValue, help, "Prefab's parameters", type); |
Contributor
There was a problem hiding this comment.
ligne 114 should be "Prefab's parameters" too, right?
Contributor
|
I've tried this branch with the Tripod tutorial's update from SofaDefrost/SoftRobots#151. |
damienmarchal
force-pushed
the
pr-improve-prefab
branch
from
4a5c607 to
1c261cf
Compare
damienmarchal
added
pr: status wip
pr: experimental
and removed
enhancement
Contributor
Author
|
This Branch was used to make the #277 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Prefab implementation in SofaPython3 is experimental code that has never been validated, a too complexe API and is not event fully working.
This PR fix all that and includes a basic test and a first example to demonstrate the use of Sofa.Prefab.
The general idea is that a Sofa.Prefab is a Node with extra feature to deal in a systematic way how its content change when some of its parameters changes.