Runtime token support #1157

bernardkwok · 2021-04-01T02:41:02Z

Add in support for <token> as a runtime "input" which is marked as a token.

Example nodegraph with token called mytoken which is marked as non-visible.

<?xml version="1.0"?>
<materialx version="1.38">
  <nodegraph name="Tokenized_graph" xpos="1044.25" ypos="852.077" >
    <token name="mytoken" type="color3" value="1, 1, 1" uivisible="false" uiname="My Token"/>
    <input name="value" type="color3" value="0, 0, 0" uivisible="false"/>
    <constant name="constant" type="color3" xpos="-136.498" ypos="-120.44">
      <input name="value" type="color3" interfacename="value" value="0, 0, 0" uivisible="true" />
    </constant>
    <output name="out" type="color3" nodename="constant" />
  </nodegraph>
  <collection name="defaultCollection" includecollection="" includegeom="/*" xpos="315" ypos="229" />
</materialx>

Would look like this graphically:

With the contents looking like this (token in "neon pink").

Based on the current specification <token> elements are not connectable.

Unit test will produce this file:

<?xml version="1.0"?>
<materialx version="1.38">
  <nodegraph name="nodegraph1">
    <input name="in" type="float" value="0" />
    <token name="token1" type="float" uniform="true" value="0" />
    <add name="add" type="float">
      <input name="in1" type="float" interfacename="in" value="0" />
    </add>
    <add name="add1" type="float">
      <input name="in1" type="float" nodename="add" />
    </add>
    <add name="add2" type="float" />
    <output name="out" type="float" nodename="add1" />
  </nodegraph>
  <add name="add" type="float">
    <input name="in1" type="float" nodegraph="nodegraph1" />
  </add>
</materialx>

… on inputs. Remove hard-coded logic to always make tokens invisible.

… UI.

bernardkwok · 2021-04-01T18:54:47Z

source/MaterialXRuntime/Private/PvtPort.cpp

@@ -39,6 +39,11 @@ PvtInput::PvtInput(const RtIdentifier& name, const RtIdentifier& type, uint32_t

 bool PvtInput::isConnectable(const PvtOutput* output) const
 {
+    if (isToken() || output->isToken())


Disallow connections.

bernardkwok · 2021-04-01T18:55:16Z

source/MaterialXRuntime/Private/PvtPort.h

@@ -148,6 +166,24 @@ class PvtInput : public PvtPort
        }
    }

+    bool isUIVisible() const


Wrote some wrappers for reuse.

bernardkwok · 2021-04-01T18:58:32Z

source/MaterialXRuntime/RtFileIo.cpp

@@ -901,7 +917,16 @@ namespace
        for (PvtObject* obj : src->getInputs())
        {
            const PvtInput* input = obj->asA<PvtInput>();
-            ValueElementPtr destPort = destNodeDef->addInput(input->getName().str(), input->getType().str());
+            ValueElementPtr destPort = nullptr;
+            if (input->isToken())


bernardkwok · 2021-04-01T18:59:53Z

source/MaterialXRuntime/RtFileIo.cpp

@@ -200,6 +200,12 @@ namespace
                const uint32_t flags = elem->asA<Input>()->getIsUniform() ? RtPortFlag::UNIFORM : 0;
                port = schema.createInput(portName, portType, flags);
            }
+            else if (elem->isA<Token>())


bernardkwok · 2021-04-01T19:00:19Z

source/MaterialXTest/MaterialXRuntime/Runtime.cpp

@@ -1299,20 +1300,35 @@ TEST_CASE("Runtime: FileIo NodeGraph", "[runtime]")
    // Create a nodegraph.
    mx::RtNodeGraph graph = stage->createPrim(mx::RtNodeGraph::typeName());
    graph.createInput(IN, mx::RtType::FLOAT);
+    graph.createInput(TOKEN1, mx::RtType::FLOAT, mx::RtPortFlag::UNIFORM | mx::RtPortFlag::TOKEN);


Basic test for create and connectivity.

… connected is visible.

feldstj · 2021-04-07T13:12:09Z

source/MaterialXRuntime/RtFileIo.cpp

@@ -487,7 +492,17 @@ namespace
                        if (!socket)
                        {
                            const RtIdentifier inputType(elem->getType());
-                            RtInput input = nodegraph.createInput(socketName, inputType);
+


Just a suggestion, but you could convert this into one or two lines if you wanted to:

const uint32_t flags = elem->isA() ? RtPortFlag::UNIFORM | RtPortFlag::TOKEN : 0;
RtInput input = nodegraph.createInput(socketName, inputType, flags);

or even:
RtInput input = nodegraph.createInput(socketName, inputType, elem->isA() ? RtPortFlag::UNIFORM | RtPortFlag::TOKEN : 0);

I can do the first. Bit too hard to read the second :).

feldstj · 2021-04-07T15:06:43Z

source/MaterialXRuntime/RtFileIo.cpp

-                    v = destNodeGraph->addInput(nodegraphInput.getName().str(), nodegraphInput.getType().str());
+                    if (nodegraphInput.isToken())
+                    {
+                        v = destNodeGraph->addToken(nodegraphInput.getName().str());


Question out of curiousity. If addInput takes a type as a second parameter, shouldn't addToken as well so you don't need two lines to accomplish what could be done on one line?

This PR adds a tangent input to the glTF PBR, similar to how it's done in the standard surface.

bernardkwok added 7 commits March 30, 2021 16:52

Experitment on token file I/O.

10ec57a

Make tokens not visible in UI.

ec7183b

uivisible try 2.

d1a5891

uivis 3

0631811

Add logic for tokens in RtStage nodedef creation + fix attribute copy…

48aac55

… on inputs. Remove hard-coded logic to always make tokens invisible.

Add in uivisible interface on RtInput.

f5493c2

If port is connected then force it to return that it's visible in the…

a8d4acb

… UI.

bernardkwok added this to the 1.39 milestone Apr 1, 2021

bernardkwok added the Do Not Merge This PR should not be merged label Apr 1, 2021

bernardkwok added 6 commits March 31, 2021 22:57

Make tokens unconnectable for now.

0fd6a92

Move to port.

c5f6a6e

connectable check.

cf0e537

Cleanup + testing.

729cd54

Fix issue.

f14690a

Cleanup.

2f1ed65

bernardkwok commented Apr 1, 2021

View reviewed changes

bernardkwok removed the Do Not Merge This PR should not be merged label Apr 1, 2021

bernardkwok self-assigned this Apr 1, 2021

bernardkwok requested a review from feldstj April 1, 2021 19:03

Fix up uivisible logic : if no attribute is visible (default), and if…

099aafd

… connected is visible.

feldstj reviewed Apr 7, 2021

View reviewed changes

feldstj approved these changes Apr 7, 2021

View reviewed changes

Review fixes.

9f9daa4

bernardkwok merged commit 43885e2 into adsk_contrib/dev Apr 7, 2021

bernardkwok deleted the adsk_contrib/token_runtime branch April 7, 2021 17:11

ashwinbhat pushed a commit that referenced this pull request Jan 4, 2023

Add tangent input to glTF PBR (#1157)

6a91401

This PR adds a tangent input to the glTF PBR, similar to how it's done in the standard surface.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Runtime token support #1157

Runtime token support #1157

bernardkwok commented Apr 1, 2021 •

edited

Loading

bernardkwok Apr 1, 2021

bernardkwok Apr 1, 2021

bernardkwok Apr 1, 2021

bernardkwok Apr 1, 2021

bernardkwok Apr 1, 2021

feldstj Apr 7, 2021

bernardkwok Apr 7, 2021

feldstj Apr 7, 2021

Runtime token support #1157

Runtime token support #1157

Conversation

bernardkwok commented Apr 1, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bernardkwok commented Apr 1, 2021 •

edited

Loading