Docstrings for PyMaterialXCore. (#1567)

Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
AcademySoftwareFoundation · Oct 31, 2023 · c9a2469 · c9a2469
1 parent 513ef90
commit c9a2469
Show file tree

Hide file tree

Showing 15 changed files with 4,743 additions and 649 deletions.
diff --git a/source/PyMaterialX/PyMaterialXCore/PyDefinition.cpp b/source/PyMaterialX/PyMaterialXCore/PyDefinition.cpp
diff --git a/source/PyMaterialX/PyMaterialXCore/PyDocument.cpp b/source/PyMaterialX/PyMaterialXCore/PyDocument.cpp
diff --git a/source/PyMaterialX/PyMaterialXCore/PyElement.cpp b/source/PyMaterialX/PyMaterialXCore/PyElement.cpp
diff --git a/source/PyMaterialX/PyMaterialXCore/PyGeom.cpp b/source/PyMaterialX/PyMaterialXCore/PyGeom.cpp
diff --git a/source/PyMaterialX/PyMaterialXCore/PyInterface.cpp b/source/PyMaterialX/PyMaterialXCore/PyInterface.cpp
diff --git a/source/PyMaterialX/PyMaterialXCore/PyLook.cpp b/source/PyMaterialX/PyMaterialXCore/PyLook.cpp
diff --git a/source/PyMaterialX/PyMaterialXCore/PyMaterial.cpp b/source/PyMaterialX/PyMaterialXCore/PyMaterial.cpp
@@ -15,7 +15,9 @@ void bindPyMaterial(py::module& mod)
 {
     mod.def("getShaderNodes", &mx::getShaderNodes,
             py::arg("materialNode"),
-            py::arg("nodeType") = mx::SURFACE_SHADER_TYPE_STRING,
+            py::arg_v("nodeType",
+                      mx::SURFACE_SHADER_TYPE_STRING,
+                      "mx.SURFACE_SHADER_TYPE_STRING"),
             py::arg("target") = mx::EMPTY_STRING,
             PYMATERIALX_DOCSTRING(R"docstring(
     Return a list of all shader nodes connected to the given `materialNode`'s inputs,
@@ -26,6 +28,9 @@ void bindPyMaterial(py::module& mod)
     :param materialNode: The node to examine.
     :param nodeType: The shader node type to return.  Defaults to the surface shader type.
     :param target: An optional target name, which will be used to filter the returned nodes.
+    :returns: List of shader nodes.
+    :see: `SURFACE_SHADER_TYPE_STRING`, `DISPLACEMENT_SHADER_TYPE_STRING`,
+        `VOLUME_SHADER_TYPE_STRING`, `LIGHT_SHADER_TYPE_STRING`
 )docstring"));
 
     mod.def("getConnectedOutputs", &mx::getConnectedOutputs,

diff --git a/source/PyMaterialX/PyMaterialXCore/PyModule.cpp b/source/PyMaterialX/PyMaterialXCore/PyModule.cpp
@@ -295,6 +295,147 @@ PYBIND11_MODULE(PyMaterialXCore, mod)
     .. autofunction:: stringStartsWith
     .. autofunction:: geomStringsMatch
     .. autofunction:: targetStringsMatch
+
+    Module Constants
+    ----------------
+
+    .. py:data:: DEFAULT_TYPE_STRING
+        :type: str
+        :value: "color3"
+
+        The name of the default type that is used when no other specific type
+        is given/available.
+
+        :see: `InterfaceElement.addInput()`
+        :see: `InterfaceElement.addOutput()`
+
+    .. py:data:: FILENAME_TYPE_STRING
+        :type: str
+        :value: "filename"
+
+        :see: `StringResolver.resolve()`
+
+    .. py:data:: GEOMNAME_TYPE_STRING
+        :type: str
+        :value: "geomname"
+
+        :see: `StringResolver.resolve()`
+
+    .. py:data:: STRING_TYPE_STRING
+        :type: str
+        :value: "string"
+
+    .. py:data:: BSDF_TYPE_STRING
+        :type: str
+        :value: "BSDF"
+
+    .. py:data:: EDF_TYPE_STRING
+        :type: str
+        :value: "EDF"
+
+    .. py:data:: VDF_TYPE_STRING
+        :type: str
+        :value: "VDF"
+
+    .. py:data:: SURFACE_SHADER_TYPE_STRING
+        :type: str
+        :value: "surfaceshader"
+
+        The node type name used for surface shader nodes.
+
+        :see: `getShaderNodes()`
+
+    .. py:data:: DISPLACEMENT_SHADER_TYPE_STRING
+        :type: str
+        :value: "displacementshader"
+
+        The node type name used for displacement shader nodes.
+
+        :see: `getShaderNodes()`
+
+    .. py:data:: VOLUME_SHADER_TYPE_STRING
+        :type: str
+        :value: "volumeshader"
+
+        The node type name used for volume shader nodes.
+
+        :see: `getShaderNodes()`
+
+    .. py:data:: LIGHT_SHADER_TYPE_STRING
+        :type: str
+        :value: "lightshader"
+
+        The node type name used for light shader nodes.
+
+        :see: `getShaderNodes()`
+
+    .. py:data:: MATERIAL_TYPE_STRING
+        :type: str
+        :value: "material"
+
+    .. py:data:: SURFACE_MATERIAL_NODE_STRING
+        :type: str
+        :value: "surfacematerial"
+
+    .. py:data:: VOLUME_MATERIAL_NODE_STRING
+        :type: str
+        :value: "volumematerial"
+
+    .. py:data:: MULTI_OUTPUT_TYPE_STRING
+        :type: str
+        :value: "multioutput"
+
+    .. py:data:: NONE_TYPE_STRING
+        :type: str
+        :value: "none"
+
+    .. py:data:: VALUE_STRING_TRUE
+        :type: str
+        :value: "true"
+
+    .. py:data:: VALUE_STRING_FALSE
+        :type: str
+        :value: "false"
+
+    .. py:data:: NAME_PREFIX_SEPARATOR
+        :type: str
+        :value: ":"
+
+    .. py:data:: NAME_PATH_SEPARATOR
+        :type: str
+        :value: "/"
+
+    .. py:data:: ARRAY_VALID_SEPARATORS
+        :type: str
+        :value: ", "
+
+    .. py:data:: ARRAY_PREFERRED_SEPARATOR
+        :type: str
+        :value: ", "
+
+    .. py:data:: GEOM_PATH_SEPARATOR
+        :type: str
+        :value: "/"
+
+    .. py:data:: UNIVERSAL_GEOM_NAME
+        :type: str
+        :value: GEOM_PATH_SEPARATOR
+
+        :see: `GEOM_PATH_SEPARATOR`
+        :see: `getGeometryBindings()`
+
+    .. py:data:: UDIM_TOKEN
+        :type: str
+        :value: "<UDIM>"
+
+    .. py:data:: UV_TILE_TOKEN
+        :type: str
+        :value: "<UVTILE>"
+
+    .. py:data:: UDIM_SET_PROPERTY
+        :type: str
+        :value: "udimset"
+
 )docstring");
 
     bindPyElement(mod);