Skip to content
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

Pin visibility #32

Open
mhusinsky opened this issue Jul 12, 2023 · 3 comments
Open

Pin visibility #32

mhusinsky opened this issue Jul 12, 2023 · 3 comments

Comments

@mhusinsky
Copy link
Contributor

The info about optional pins is not very helpful. Possible values in the configure inspector are optional and hidden (apart from visible)

grafik

I cannot read the difference between those two and the explanation hardly makes it clearer.
Also: when is it a good idea to use a hidden pin, which is not visible and cannot be activated in the inspector?

@joreg
Copy link
Member

joreg commented Jul 12, 2023

looks like you stumbled on the "wrong" documentation there. the docs for the definition side of pin visibility are here: https://thegraybook.vvvv.org/reference/language/operations.html#visibility-for-inputs-and-outputs hope this explains better.

what you found is the docs for the application side, where there are indeed only two options: show or not
obviously screenshots would add to the clarity in both cases.

re hidden: @azeno @gregsn do we have an example of hidden inputs in the real world?

@mhusinsky
Copy link
Contributor Author

ah, I did not see that (the page I linked was the first meaningful search result).
I added a link to the paragraph so it is easier to find.

@azeno
Copy link
Member

azeno commented Jul 14, 2023

Hidden pins are currently used for the "Node Context" pins. They are treated in a special way by the system, as it injects the ID of the node itself. There are cases where you want to get access to your own "Node Context", so one needs to create that pin manually. However you probably still wanna hide it from the user -> use the Hidden flag.

Upcoming developments in the inspector branch will enable another scenario for them: the ability to store a model on application side, but not showing it to the user. As an example think of Kairos. It's Timeline node currently shows a white Model input where it stores its timeline. That pin shouldn't be visible at all. It currently only is visible because we didn't create pins on application side if the definition said it's hidden. So we couldn't store anything there. With the inspector branch this restriction will be lifted, all pins will have a counter part on application side and therefor storing values will be possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants