MAYA-106190 - Prim type icons

lib/mayaUsd/CMakeLists.txt

@@ -163,14 +163,14 @@ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/lib/usd/plugInfo.json
 # -----------------------------------------------------------------------------
 # subdirectories
 # -----------------------------------------------------------------------------
-add_subdirectory(ae)
 add_subdirectory(base)
 add_subdirectory(commands)
 add_subdirectory(fileio)
 add_subdirectory(listeners)
 add_subdirectory(nodes)
 add_subdirectory(python)
 add_subdirectory(render)
+add_subdirectory(resources)
 if(UFE_FOUND)
     add_subdirectory(ufe)
 endif()

lib/mayaUsd/resources/CMakeLists.txt

@@ -0,0 +1,2 @@
+add_subdirectory(ae)
+add_subdirectory(icons)

lib/mayaUsd/resources/icons/CMakeLists.txt

@@ -0,0 +1,45 @@
+# ---------------------------------------------------------------------------------------------
+# install
+# ---------------------------------------------------------------------------------------------
+if (CMAKE_UFE_V2_FEATURES_AVAILABLE)
+    # Maya Outliner icons
+    set(OUTLINER_ICONS
+        BlendShape
+        Camera
+        Capsule
+        Cone
+        Cube
+        Cylinder
+        Def
+        GeomSubset
+        LightFilter
+        LightPortal
+        mayaReference
+        Mesh
+        NurbsPatch
+        PointInstancer
+        Points
+        Scope
+        SkelAnimation
+        Skeleton
+        SkelRoot
+        Sphere
+        UsdGeomCurves
+        UsdGeomXformable
+        UsdLuxLight
+        UsdTyped
+        Volume
+    )
+    foreach(ICON_BASE ${OUTLINER_ICONS})
+        # The _100.png files need to be installed without the _100. This is the
+        # base icon name that is used. Maya will automatically choose the _150/_200
+        # image if neeeded.
+        install(FILES "out_USD_${ICON_BASE}_100.png"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/icons"
+            RENAME "out_USD_${ICON_BASE}.png"
+        )
+        install(FILES "out_USD_${ICON_BASE}_150.png" "out_USD_${ICON_BASE}_200.png"
+            DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/icons"
+        )
+    endforeach()
+endif()

lib/mayaUsd/ufe/UsdContextOps.cpp

@@ -42,8 +42,12 @@ namespace {
 // Ufe::ContextItem strings
 // - the "Item" describe the operation to be performed.
 // - the "Label" is used in the context menu (can be localized).
+// - the "Image" is used for icon in the context menu. Directly used std::string
+//   for these so the emplace_back() will choose the right constructor. With char[]
+//   it would convert that param to a bool and choose the wrong constructor.
 static constexpr char kUSDLayerEditorItem[] = "USD Layer Editor";
 static constexpr char kUSDLayerEditorLabel[] = "USD Layer Editor...";
+static const std::string kUSDLayerEditorImage{"USD_generic.png"};
 static constexpr char kUSDVariantSetsItem[] = "Variant Sets";
 static constexpr char kUSDVariantSetsLabel[] = "Variant Sets";
 static constexpr char kUSDToggleVisibilityItem[] = "Toggle Visibility";
@@ -56,20 +60,28 @@ static constexpr char kUSDAddNewPrimItem[] = "Add New Prim";
 static constexpr char kUSDAddNewPrimLabel[] = "Add New Prim";
 static constexpr char kUSDDefPrimItem[] = "Def";
 static constexpr char kUSDDefPrimLabel[] = "Def";
+static const std::string kUSDDefPrimImage{"out_USD_Def.png"};
 static constexpr char kUSDScopePrimItem[] = "Scope";
 static constexpr char kUSDScopePrimLabel[] = "Scope";
+static const std::string kUSDScopePrimImage{"out_USD_Scope.png"};
 static constexpr char kUSDXformPrimItem[] = "Xform";
 static constexpr char kUSDXformPrimLabel[] = "Xform";
+static const std::string kUSDXformPrimImage{"out_USD_UsdGeomXformable.png"};
 static constexpr char kUSDCapsulePrimItem[] = "Capsule";
 static constexpr char kUSDCapsulePrimLabel[] = "Capsule";
+static const std::string kUSDCapsulePrimImage{"out_USD_Capsule.png"};
 static constexpr char kUSDConePrimItem[] = "Cone";
 static constexpr char kUSDConePrimLabel[] = "Cone";
+static const std::string kUSDConePrimImage{"out_USD_Cone.png"};
 static constexpr char kUSDCubePrimItem[] = "Cube";
 static constexpr char kUSDCubePrimLabel[] = "Cube";
+static const std::string kUSDCubePrimImage{"out_USD_Cube.png"};
 static constexpr char kUSDCylinderPrimItem[] = "Cylinder";
 static constexpr char kUSDCylinderPrimLabel[] = "Cylinder";
+static const std::string kUSDCylinderPrimImage{"out_USD_Cylinder.png"};
 static constexpr char kUSDSpherePrimItem[] = "Sphere";
 static constexpr char kUSDSpherePrimLabel[] = "Sphere";
+static const std::string kUSDSpherePrimImage{"out_USD_Sphere.png"};
 
 //! \brief Undoable command for variant selection change
 class SetVariantSelectionUndoableCommand : public Ufe::UndoableCommand
@@ -275,7 +287,11 @@ Ufe::ContextOps::Items UsdContextOps::getItems(
         int hasLayerEditorCmd{0};
         MGlobal::executeCommand("runTimeCommand -exists UsdLayerEditor", hasLayerEditorCmd);
         if (hasLayerEditorCmd) {
+#if UFE_PREVIEW_VERSION_NUM >= 2023
+            items.emplace_back(kUSDLayerEditorItem, kUSDLayerEditorLabel, kUSDLayerEditorImage);
+#else
             items.emplace_back(kUSDLayerEditorItem, kUSDLayerEditorLabel);
+#endif
             items.emplace_back(Ufe::ContextItem::kSeparator);
         }
 
@@ -346,6 +362,17 @@ Ufe::ContextOps::Items UsdContextOps::getItems(
             } // Variants of a variant set
         } // Variant sets
         else if (itemPath[0] == kUSDAddNewPrimItem) {
+#if UFE_PREVIEW_VERSION_NUM >= 2023
+            items.emplace_back(kUSDDefPrimItem, kUSDDefPrimLabel, kUSDDefPrimImage);  // typeless prim
+            items.emplace_back(kUSDScopePrimItem, kUSDScopePrimLabel, kUSDScopePrimImage);
+            items.emplace_back(kUSDXformPrimItem, kUSDXformPrimLabel, kUSDXformPrimImage);
+            items.emplace_back(Ufe::ContextItem::kSeparator);
+            items.emplace_back(kUSDCapsulePrimItem, kUSDCapsulePrimLabel, kUSDCapsulePrimImage);
+            items.emplace_back(kUSDConePrimItem, kUSDConePrimLabel, kUSDConePrimImage);
+            items.emplace_back(kUSDCubePrimItem, kUSDCubePrimLabel, kUSDCubePrimImage);
+            items.emplace_back(kUSDCylinderPrimItem, kUSDCylinderPrimLabel, kUSDCylinderPrimImage);
+            items.emplace_back(kUSDSpherePrimItem, kUSDSpherePrimLabel, kUSDSpherePrimImage);
+#else
             items.emplace_back(kUSDDefPrimItem, kUSDDefPrimLabel);  // typeless prim
             items.emplace_back(kUSDScopePrimItem, kUSDScopePrimLabel);
             items.emplace_back(kUSDXformPrimItem, kUSDXformPrimLabel);
@@ -355,6 +382,7 @@ Ufe::ContextOps::Items UsdContextOps::getItems(
             items.emplace_back(kUSDCubePrimItem, kUSDCubePrimLabel);
             items.emplace_back(kUSDCylinderPrimItem, kUSDCylinderPrimLabel);
             items.emplace_back(kUSDSpherePrimItem, kUSDSpherePrimLabel);
+#endif
         }
     } // Top-level items
 

lib/mayaUsd/ufe/UsdSceneItem.cpp

@@ -62,8 +62,7 @@ std::vector<std::string> UsdSceneItem::ancestorNodeTypes() const
 	const TfType& schemaType = fPrim.GetPrimTypeInfo().GetSchemaType();
 #endif
 	if (!schemaType) {
-		TF_CODING_ERROR("Could not find prim type '%s' for prim %s",
-			fPrim.GetTypeName().GetText(), UsdDescribe(fPrim).c_str());
+		// No schema type, return empty ancestor types.
 		return strAncestorTypes;
 	}
 

lib/mayaUsd/ufe/UsdUIInfoHandler.cpp

@@ -19,6 +19,8 @@
 #include <maya/MDoubleArray.h>
 #include <maya/MGlobal.h>
 
+#include <map>
+
 MAYAUSD_NS_DEF {
 namespace ufe {
 
@@ -71,6 +73,48 @@ bool UsdUIInfoHandler::treeViewCellInfo(const Ufe::SceneItem::Ptr& item, Ufe::Ce
 	return changed;
 }
 
+std::string UsdUIInfoHandler::treeViewIcon(const Ufe::SceneItem::Ptr& item) const
+{
+	// Special case for nullptr input.
+	if (!item) {
+		return "out_USD_UsdTyped.png";	// Default USD icon
+	}
+
+	// We support these node types directly.
+	static const std::map<std::string, std::string> supportedTypes{
+		{"",					"out_USD_Def.png"},					// No node type
+		{"BlendShape",			"out_USD_BlendShape.png"},
+		{"Camera",				"out_USD_Camera.png"},
+		{"Capsule",				"out_USD_Capsule.png"},
+		{"Cone",				"out_USD_Cone.png"},
+		{"Cube",				"out_USD_Cube.png"},
+		{"Cylinder",			"out_USD_Cylinder.png"},
+		{"GeomSubset",			"out_USD_GeomSubset.png"},
+		{"LightFilter",			"out_USD_LightFilter.png"},
+		{"LightPortal",			"out_USD_LightPortal.png"},
+		{"mayaReference",		"out_USD_mayaReference.png"},
+		{"AL_MayaReference",	"out_USD_mayaReference.png"},		// Same as mayaRef
+		{"Mesh",				"out_USD_Mesh.png"},
+		{"NurbsPatch",			"out_USD_NurbsPatch.png"},
+		{"PointInstancer",		"out_USD_PointInstancer.png"},
+		{"Points",				"out_USD_Points.png"},
+		{"Scope",				"out_USD_Scope.png"},
+		{"SkelAnimation",		"out_USD_SkelAnimation.png"},
+		{"Skeleton",			"out_USD_Skeleton.png"},
+		{"SkelRoot",			"out_USD_SkelRoot.png"},
+		{"Sphere",				"out_USD_Sphere.png"},
+		{"Volume",				"out_USD_Volume.png"}
+	};
+
+	const auto search = supportedTypes.find(item->nodeType());
+	if (search != supportedTypes.cend()) {
+		return search->second;
+	}
+
+	// No specific node type icon was found.
+	return "";
+}
+
 std::string UsdUIInfoHandler::getLongRunTimeLabel() const
 {
 	return "Universal Scene Description";

lib/mayaUsd/ufe/UsdUIInfoHandler.h

@@ -45,6 +45,7 @@ class MAYAUSD_CORE_PUBLIC UsdUIInfoHandler : public Ufe::UIInfoHandler
 
 	// Ufe::UIInfoHandler overrides
 	bool treeViewCellInfo(const Ufe::SceneItem::Ptr& item, Ufe::CellInfo& info) const override;
+	std::string treeViewIcon(const Ufe::SceneItem::Ptr& item) const override;
 	std::string getLongRunTimeLabel() const override;
 }; // UsdUIInfoHandler
 

modules/mayaUSD.mod.template

@@ -8,7 +8,7 @@ PYTHONPATH+:=lib/python
 USD_LOCATION:=
 
 + MayaUSD_LIB ${MAYAUSD_VERSION} ${CMAKE_INSTALL_PREFIX}
-icons: 
+icons: lib/icons
 plug-ins: 
 presets: 
 scripts: 

modules/mayaUSD_Win.mod.template

@@ -10,7 +10,7 @@ PATH+:=lib
 USD_LOCATION:=
 
 + MayaUSD_LIB ${MAYAUSD_VERSION} ${CMAKE_INSTALL_PREFIX}
-icons: 
+icons: lib/icons
 plug-ins: 
 presets: 
 scripts: 

plugin/adsk/CMakeLists.txt

@@ -2,5 +2,6 @@ message("========== ADSK USD Plugin ==========")
 
 set(INSTALL_DIR_SUFFIX plugin/adsk)
 
+add_subdirectory(icons)
 add_subdirectory(plugin)
 add_subdirectory(scripts)

plugin/adsk/icons/CMakeLists.txt

@@ -0,0 +1,21 @@
+# ---------------------------------------------------------------------------------------------
+# install
+# ---------------------------------------------------------------------------------------------
+
+set(PLUGIN_ICONS
+    out_mayaUsdProxyShape
+    USD_generic
+    USD_stage
+)
+foreach(ICON_BASE ${PLUGIN_ICONS})
+    # The _100.png files need to be installed without the _100. This is the
+    # base icon name that is used. Maya will automatically choose the _150/_200
+    # image if neeeded.
+    install(FILES "${ICON_BASE}_100.png"
+        DESTINATION "${INSTALL_DIR_SUFFIX}/icons"
+        RENAME "${ICON_BASE}.png"
+    )
+    install(FILES "${ICON_BASE}_150.png" "${ICON_BASE}_200.png"
+        DESTINATION "${INSTALL_DIR_SUFFIX}/icons"
+    )
+endforeach()

plugin/adsk/scripts/mayaUsdMenu.mel

@@ -64,6 +64,7 @@ proc initRuntimeCommands() {
             -annotation "Create a new, empty USD Stage"
             -category "Menu items.Maya USD"
             -command "python(\"import mayaUsd_createStageWithNewLayer; mayaUsd_createStageWithNewLayer.createStageWithNewLayer()\")"
+            -image "USD_stage.png"
             mayaUsdCreateStageWithNewLayer;
     }
 
@@ -73,6 +74,7 @@ proc initRuntimeCommands() {
             -annotation "Create a USD Stage from an existing USD file"
             -category   "Menu items.Maya USD"
             -command    "mayaUsd_createStageFromFile"
+            -image      "USD_stage.png"
             mayaUsdCreateStageFromFile;
     }
 
@@ -111,6 +113,7 @@ global proc mayaUsdMenu_createMenuCallback() {
             $gMayaUsdCreateSubMenu = `menuItem -subMenu true -insertAfter $sceneManagementDivider -tearOff true
                 -label "Universal Scene Description (USD)" 
                 -annotation "Create a USD stage" 
+                -image "USD_generic.png"
                 -version $mayaVersion`;
             menuItem -runTimeCommand mayaUsdCreateStageWithNewLayer;
             menuItem -runTimeCommand mayaUsdCreateStageFromFile;

plugin/adsk/scripts/mayaUsd_createStageFromFile.mel

@@ -81,9 +81,7 @@ global proc stageFromFile_UICommit(string $parent) {
 proc doCreateStage(string $fileName) {
     // actually load the file
     string $baseName = capitalizeString(`basenameEx $fileName`);
-    if( isValidObjectName($baseName) )
-        $baseName += "_usd";
-    else
+    if( ! isValidObjectName($baseName) )
         $baseName = "UsdStage";
 
     string $ppath = `optionVar -q stageFromFile_primPath`;