Add relative paths to nodes as variables #2629
Open
Conversation
This file contains 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
cbentejac
force-pushed
the
dev/relativePaths
branch
2 times, most recently
from
53206f9 to
34e1495
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #2629 +/- ##
===========================================
+ Coverage 69.93% 70.47% +0.53%
===========================================
Files 121 123 +2
Lines 7088 7231 +143
===========================================
+ Hits 4957 5096 +139
- Misses 2131 2135 +4 ☔ View full report in Codecov by Sentry. |
cbentejac
force-pushed
the
dev/relativePaths
branch
8 times, most recently
from
8c37fd0 to
3042f94
Compare
fabiencastan
requested changes
Jan 6, 2025
| @@ -124,6 +124,6 @@ class CameraCalibration(desc.AVCommandLineNode): | |||
| name="output", | |||
| label="Output", | |||
| description="Output filename for intrinsic [and extrinsic] parameters.", | |||
| value=desc.Node.internalFolder + "/cameraCalibration.cal", | |||
| value="${NODE_CACHE_FOLDER}" + "cameraCalibration.cal", | |||
There was a problem hiding this comment.
Should be a single string:
value="${NODE_CACHE_FOLDER}/cameraCalibration.cal",
This property stores the location of the source code for a given node and is not exposed to the QML side.
`dynamicEnvVars` is a dictionary currently mapping a name to a folder to use as the root when writing relative paths. Keys correspond to the variable names that are to be replaced with their values during the evaluation of attributes. Although it currently only contains folder paths, any type of variable may be written in this dictionary to resolve attribute values with.
When the value of an attribute is evaluated, we should look for any
substitution that can be made from the `dynamicEnvVars` dictionary. The
values to substitute from are thus not part of the command line and can
just be identified with "${varname}", as we do for environment variables.
For all nodes, use the new syntax for relative paths.
…ER}` This prevents having an absolute path for the script, which led to errors when opening, for example, a project in another environment.
cbentejac
force-pushed
the
dev/relativePaths
branch
from
3042f94 to
11d9b40
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR adds new variables that can be used in the description of nodes to write relative paths. For each
Nodeobject, there are currently two variables that are available by default:${NODE_CACHE_FOLDER}, which points towards the cache folder for this node (and is effectively the same asdesc.Node.internalFolder);${NODE_SOURCECODE_FOLDER}, which points towards the folder containing the node's description.These variables are stored in a dictionary named
rootFolderwhich is part of theNodeclass.rootFoldercan be edited to add or remove variables, with the key of each entry being the name of variable and its value the path it corresponds to. Those variables will be resolved at the same time as environment variables during the evaluation of the attribute's value.All the nodes are modified to use
${NODE_CACHE_FOLDER}instead ofdesc.Node.internalFolder, andScenePreviewis updated to use${NODE_SOURCECODE_FOLDER}when providing the path to the Blender script.Unit tests are added.
Features
rootFolderdictionary to theBaseNodeclassrootFolderImplementation remarks
Nodeobjects have a new propertysourceCodeFolderwhich contains the path to their directory, and which is used to resolve${NODE_SOURCECODE_FOLDER}.