Adsk Contrib - Include color spaces with no categories in menuHelper results by default

.github/workflows/gpu_workflow.yml

@@ -43,3 +43,4 @@ jobs:
         with:
           project-name: OpenColorIO
           buildspec-override: buildspec.yml
+          image-override: aswf/ci-ocio:2025

include/OpenColorIO/OpenColorAppHelpers.h

@@ -56,6 +56,11 @@ namespace OCIO_NAMESPACE
  *        - UserCategories: A list of strings specified by the end-user of the application.  OCIO
  *          will check for these strings in an environment variable, or they may be passed in from
  *          the application.
+ *        - TreatNoCategoryAsAny: By default, color spaces (or named transforms) that have no
+ *          categories are handled as if they had any of the categories.  Config authors that want to
+ *          hide color spaces without categories should either put them in the inactiveColorSpaces
+ *          list or add a category that will never be searched for (e.g., "invisible" or "hidden").
+ *          App developers may set this option to false to hide items without any categories.
  *
  * Basically the intent is for the filtering to return the intersection of the app categories,
  * encoding, and user categories.  However, some fall-backs are in place to ensure that the
@@ -130,6 +135,13 @@ class OCIOEXPORT ColorSpaceMenuParameters
     virtual void setIncludeNamedTransforms(bool include) noexcept = 0;
     virtual bool getIncludeNamedTransforms() const noexcept = 0;
 
+    /**
+     * When searching for color spaces using app or user categories, treat color spaces or
+     * named transforms that have no categories as if they had any of the categories.
+     * Default is true.
+     */
+    virtual void setTreatNoCategoryAsAny(bool value) noexcept = 0;
+    virtual bool getTreatNoCategoryAsAny() const noexcept = 0;
 
     /**
      * App categories is a comma separated list of categories. If appCategories is not NULL and

src/OpenColorIO/apphelpers/CategoryHelpers.cpp

@@ -49,6 +49,7 @@ bool HasEncoding(const T & elt, const std::string & encoding)
 
 ColorSpaceVec GetColorSpaces(ConstConfigRcPtr config,
                              bool includeColorSpaces,
+                             bool treatNoCategoryAsAny,
                              SearchReferenceSpaceType colorSpaceType,
                              const Categories & categories,
                              const Encodings & encodings)
@@ -62,11 +63,13 @@ ColorSpaceVec GetColorSpaces(ConstConfigRcPtr config,
             auto cs = config->getColorSpace(config->getColorSpaceNameByIndex(colorSpaceType,
                                                                              COLORSPACE_ACTIVE,
                                                                              idx));
+
+            const bool ignoreCategory = treatNoCategoryAsAny && cs->getNumCategories() == 0;
             for (const auto & cat : categories)
             {
                 for (const auto & enc : encodings)
                 {
-                    if (HasCategory(cs, cat) && HasEncoding(cs, enc))
+                    if ((ignoreCategory || HasCategory(cs, cat)) && HasEncoding(cs, enc))
                     {
                         AddElement(css, cs.get());
                     }
@@ -79,6 +82,7 @@ ColorSpaceVec GetColorSpaces(ConstConfigRcPtr config,
 
 ColorSpaceVec GetColorSpaces(ConstConfigRcPtr config,
                              bool includeColorSpaces,
+                             bool treatNoCategoryAsAny,
                              SearchReferenceSpaceType colorSpaceType,
                              const Categories & categories)
 {
@@ -91,9 +95,11 @@ ColorSpaceVec GetColorSpaces(ConstConfigRcPtr config,
             auto cs = config->getColorSpace(config->getColorSpaceNameByIndex(colorSpaceType,
                                                                              COLORSPACE_ACTIVE,
                                                                              idx));
+
+            const bool ignoreCategory = treatNoCategoryAsAny && cs->getNumCategories() == 0;
             for (const auto & cat : categories)
             {
-                if (HasCategory(cs, cat))
+                if (ignoreCategory || HasCategory(cs, cat))
                 {
                     AddElement(css, cs.get());
                 }
@@ -133,6 +139,7 @@ typedef std::vector<const NamedTransform *> NamedTransformVec;
 
 NamedTransformVec GetNamedTransforms(ConstConfigRcPtr config,
                                      bool includeNamedTransforms,
+                                     bool treatNoCategoryAsAny,
                                      const Categories & categories,
                                      const Encodings & encodings)
 {
@@ -142,11 +149,13 @@ NamedTransformVec GetNamedTransforms(ConstConfigRcPtr config,
         for (int idx = 0; idx < config->getNumNamedTransforms(); ++idx)
         {
             auto nt = config->getNamedTransform(config->getNamedTransformNameByIndex(idx));
+
+            const bool ignoreCategory = treatNoCategoryAsAny && nt->getNumCategories() == 0;
             for (const auto & cat : categories)
             {
                 for (const auto & enc : encodings)
                 {
-                    if (HasCategory(nt, cat) && HasEncoding(nt, enc))
+                    if ((ignoreCategory || HasCategory(nt, cat)) && HasEncoding(nt, enc))
                     {
                         AddElement(nts, nt.get());
                     }
@@ -159,6 +168,7 @@ NamedTransformVec GetNamedTransforms(ConstConfigRcPtr config,
 
 NamedTransformVec GetNamedTransforms(ConstConfigRcPtr config,
                                      bool includeNamedTransforms,
+                                     bool treatNoCategoryAsAny,
                                      const Categories & categories)
 {
     NamedTransformVec nts;
@@ -167,9 +177,11 @@ NamedTransformVec GetNamedTransforms(ConstConfigRcPtr config,
         for (int idx = 0; idx < config->getNumNamedTransforms(); ++idx)
         {
             auto nt = config->getNamedTransform(config->getNamedTransformNameByIndex(idx));
+
+            const bool ignoreCategory = treatNoCategoryAsAny && nt->getNumCategories() == 0;
             for (const auto & cat : categories)
             {
-                if (HasCategory(nt, cat))
+                if (ignoreCategory || HasCategory(nt, cat))
                 {
                     AddElement(nts, nt.get());
                 }
@@ -267,7 +279,7 @@ StringUtils::StringVec ExtractItems(const char * strings)
 
 ColorSpaceNames FindColorSpaceNames(ConstConfigRcPtr config, const Categories & categories)
 {
-    ColorSpaceVec allCS = GetColorSpaces(config, true, SEARCH_REFERENCE_SPACE_ALL, categories);
+    ColorSpaceVec allCS = GetColorSpaces(config, true, false, SEARCH_REFERENCE_SPACE_ALL, categories);
     return GetNames(allCS);
 }
 
@@ -338,6 +350,7 @@ Infos FindColorSpaceInfos(ConstConfigRcPtr config,
                           const Categories & userCategories,
                           bool includeColorSpaces,
                           bool includeNamedTransforms,
+                          bool treatNoCategoryAsAny,
                           const Encodings & encodings,
                           SearchReferenceSpaceType colorSpaceType)
 {
@@ -369,10 +382,10 @@ Infos FindColorSpaceInfos(ConstConfigRcPtr config,
 
             if (!encsIgnored)
             {
-                appCS = GetColorSpaces(config, includeColorSpaces, colorSpaceType,
+                appCS = GetColorSpaces(config, includeColorSpaces, treatNoCategoryAsAny, colorSpaceType,
                                        appCategories, encodings);
-                appNT = GetNamedTransforms(config, includeNamedTransforms, appCategories,
-                                           encodings);
+                appNT = GetNamedTransforms(config, includeNamedTransforms, treatNoCategoryAsAny,
+                                           appCategories, encodings);
                 appSize = appCS.size() + appNT.size();
             }
 
@@ -381,8 +394,11 @@ Infos FindColorSpaceInfos(ConstConfigRcPtr config,
             {
                 encsIgnored = true;
                 log.m_ignoreEncodings = !encodings.empty();
-                appCS = GetColorSpaces(config, includeColorSpaces, colorSpaceType, appCategories);
-                appNT = GetNamedTransforms(config, includeNamedTransforms, appCategories);
+                appCS = GetColorSpaces(config, includeColorSpaces, treatNoCategoryAsAny, colorSpaceType, 
+                                       appCategories);
+
+                appNT = GetNamedTransforms(config, includeNamedTransforms, treatNoCategoryAsAny,
+                                           appCategories);
                 appSize = appCS.size() + appNT.size();
 
                 // Keep these results in case we need them later.
@@ -424,8 +440,10 @@ Infos FindColorSpaceInfos(ConstConfigRcPtr config,
         {
             // 3b) Items using user categories.
 
-            userCS = GetColorSpaces(config, includeColorSpaces, colorSpaceType, userCategories);
-            userNT = GetNamedTransforms(config, includeNamedTransforms, userCategories);
+            userCS = GetColorSpaces(config, includeColorSpaces, treatNoCategoryAsAny, colorSpaceType, 
+                                    userCategories);
+            userNT = GetNamedTransforms(config, includeNamedTransforms, treatNoCategoryAsAny,
+                                        userCategories);
             userSize = userCS.size() + userNT.size();
             if (userSize == 0)
             {
@@ -464,10 +482,10 @@ Infos FindColorSpaceInfos(ConstConfigRcPtr config,
                     {
                         // If not already computed, compute list with app categories and no
                         // encodings.
-                        appCSNoEncodings = GetColorSpaces(config, includeColorSpaces,
+                        appCSNoEncodings = GetColorSpaces(config, includeColorSpaces, treatNoCategoryAsAny,
                                                           colorSpaceType, appCategories);
                         appNTNoEncodings = GetNamedTransforms(config, includeNamedTransforms,
-                                                              appCategories);
+                                                              treatNoCategoryAsAny, appCategories);
                     }
                     appCSTest = &appCSNoEncodings;
                     appNTTest = &appNTNoEncodings;

src/OpenColorIO/apphelpers/CategoryHelpers.h

@@ -37,6 +37,7 @@ Infos FindColorSpaceInfos(ConstConfigRcPtr config,
                           const Categories & userCategories,
                           bool includeColorSpaces,
                           bool includeNamedTransforms,
+                          bool treatNoCategoryAsAny,
                           const Encodings & encodings,
                           SearchReferenceSpaceType colorSpaceType);
 

src/OpenColorIO/apphelpers/ColorSpaceHelpers.cpp

@@ -184,6 +184,7 @@ void ColorSpaceMenuParametersImpl::setParameters(ConstColorSpaceMenuParametersRc
     m_includeColorSpaces     = impl.m_includeColorSpaces;
     m_includeRoles           = impl.m_includeRoles;
     m_includeNamedTransforms = impl.m_includeNamedTransforms;
+    m_treatNoCategoryAsAny   = impl.m_treatNoCategoryAsAny;
     m_colorSpaceType         = impl.m_colorSpaceType;
     m_additionalColorSpaces  = impl.m_additionalColorSpaces;
 }
@@ -268,6 +269,16 @@ bool ColorSpaceMenuParametersImpl::getIncludeNamedTransforms() const noexcept
     return m_includeNamedTransforms;
 }
 
+void ColorSpaceMenuParametersImpl::setTreatNoCategoryAsAny(bool value) noexcept
+{
+    m_treatNoCategoryAsAny = value;
+}
+
+bool ColorSpaceMenuParametersImpl::getTreatNoCategoryAsAny() const noexcept
+{
+    return m_treatNoCategoryAsAny;
+}
+
 void ColorSpaceMenuParametersImpl::addColorSpace(const char * name) noexcept
 {
     if (name && *name && !StringUtils::Contain(m_additionalColorSpaces, name))
@@ -334,6 +345,7 @@ std::ostream & operator<<(std::ostream & os, const ColorSpaceMenuParameters & p)
     os << ", includeColorSpaces: " << (p.getIncludeColorSpaces() ? "true" : "false");
     os << ", includeRoles: " << (p.getIncludeRoles() ? "true" : "false");
     os << ", includeNamedTransforms: " << (p.getIncludeNamedTransforms() ? "true" : "false");
+    os << ", treatNoCategoryAsAny: " << (p.getTreatNoCategoryAsAny() ? "true" : "false");
     if (impl.m_colorSpaceType == SEARCH_REFERENCE_SPACE_SCENE)
     {
         os << ", colorSpaceType: scene";
@@ -481,6 +493,7 @@ void ColorSpaceMenuHelperImpl::refresh()
                                         allAppCategories, allUserCategories,
                                         m_parameters.m_includeColorSpaces,
                                         m_parameters.m_includeNamedTransforms,
+                                        m_parameters.m_treatNoCategoryAsAny,
                                         allEncodings, m_parameters.m_colorSpaceType);
     }
 

src/OpenColorIO/apphelpers/ColorSpaceHelpers.h

@@ -105,6 +105,9 @@ class ColorSpaceMenuParametersImpl : public ColorSpaceMenuParameters
     bool getIncludeRoles() const noexcept override;
     void setIncludeNamedTransforms(bool include) noexcept override;
     bool getIncludeNamedTransforms() const noexcept override;
+    void setTreatNoCategoryAsAny(bool value) noexcept override;
+    bool getTreatNoCategoryAsAny() const noexcept override;
+
     SearchReferenceSpaceType getSearchReferenceSpaceType() const noexcept override;
     void setSearchReferenceSpaceType(SearchReferenceSpaceType colorspaceType) noexcept override;
 
@@ -127,6 +130,7 @@ class ColorSpaceMenuParametersImpl : public ColorSpaceMenuParameters
     bool m_includeColorSpaces = true;
     bool m_includeRoles = false;
     bool m_includeNamedTransforms = false;
+    bool m_treatNoCategoryAsAny = true;
     SearchReferenceSpaceType m_colorSpaceType = SEARCH_REFERENCE_SPACE_ALL;
 
     StringUtils::StringVec m_additionalColorSpaces;

src/bindings/python/apphelpers/PyColorSpaceHelpers.cpp

@@ -64,6 +64,7 @@ void bindPyColorSpaceMenuHelpers(py::module & m)
                          bool includeColorSpaces,
                          SearchReferenceSpaceType searchReferenceSpaceType,
                          bool includeNamedTransforms,
+                         bool treatNoCategoryAsAny,
                          const std::string & appCategories,
                          const std::string & encodings,
                          const std::string & userCategories,
@@ -90,13 +91,15 @@ void bindPyColorSpaceMenuHelpers(py::module & m)
                  p->setIncludeColorSpaces(includeColorSpaces);
                  p->setIncludeRoles(includeRoles);
                  p->setIncludeNamedTransforms(includeNamedTransforms);
+                 p->setTreatNoCategoryAsAny(treatNoCategoryAsAny);
                  return p;
             }),
              "config"_a.none(false),
              "role"_a.none(false) = "",
              "includeColorSpaces"_a = true,
              "searchReferenceSpaceType"_a = SEARCH_REFERENCE_SPACE_ALL,
              "includeNamedTransforms"_a = false,
+             "treatNoCategoryAsAny"_a = true,
              "appCategories"_a.none(false) = "",
              "encodings"_a.none(false) = "",
              "userCategories"_a.none(false) = "",
@@ -126,6 +129,11 @@ void bindPyColorSpaceMenuHelpers(py::module & m)
         .def("setIncludeNamedTransforms", &ColorSpaceMenuParameters::setIncludeNamedTransforms,
              "includeNamedTransforms"_a = true,
              DOC(ColorSpaceMenuParameters, setIncludeNamedTransforms))
+        .def("getTreatNoCategoryAsAny", &ColorSpaceMenuParameters::getTreatNoCategoryAsAny,
+             DOC(ColorSpaceMenuParameters, getTreatNoCategoryAsAny))
+        .def("setTreatNoCategoryAsAny", &ColorSpaceMenuParameters::setTreatNoCategoryAsAny,
+             "treatNoCategoryAsAny"_a = true,
+             DOC(ColorSpaceMenuParameters, setTreatNoCategoryAsAny))
         .def("getEncodings", &ColorSpaceMenuParameters::getEncodings,
              DOC(ColorSpaceMenuParameters, getEncodings))
         .def("setEncodings", &ColorSpaceMenuParameters::setEncodings, "encodings"_a.none(false),