{"id":3109,"date":"2021-01-02T14:00:06","date_gmt":"2021-01-02T06:00:06","guid":{"rendered":"http:\/\/blog.coolcoding.cn\/?p=3109"},"modified":"2021-01-02T19:43:19","modified_gmt":"2021-01-02T11:43:19","slug":"inspecting-types-with-custom-details-panels","status":"publish","type":"post","link":"https:\/\/blog.coolcoding.cn\/?p=3109","title":{"rendered":"Inspecting types with custom Details panels"},"content":{"rendered":"\n

By default, UObject-derived UAssets open in the generic property editor. It looks as follows:<\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n

However, at times, you may wish for custom widgets so that you can edit the properties on your class. To facilitate this, Unreal supports\u00a0Details Customization<\/strong>, which is the focus of this recipe.<\/p>\n\n\n\n

How to do it…<\/h1>\n\n\n\n
  1. From the Chapter_10Editor folder, create two new files called MyCustomAssetDetailsCustomization.h and MyCustomAssetDetailsCustomization.cpp.<\/li>
  2. Return to your project file and update your Visual Studio project. Once finished, open up the project in Visual Studio.<\/li>
  3. Add the following #pragma and #includes to the header (MyCustomAssetDetailsCustomization.h):<\/li><\/ol>\n\n\n\n
    #pragma once

    #include \"MyCustomAsset.h\" \n#include \"DetailLayoutBuilder.h\" \n#include \"IDetailCustomization.h\" \n#include \"IPropertyTypeCustomization.h\" <\/pre>\n\n\n\n
    1. Define our customization class, as follows:<\/li><\/ol>\n\n\n\n
      class FMyCustomAssetDetailsCustomization : public IDetailCustomization
      {

      public:
          virtual void CustomizeDetails(IDetailLayoutBuilder& DetailBuilder) override;

          void ColorPicked(FLinearColor SelectedColor);
          
          static TSharedRef<IDetailCustomization> MakeInstance()
          {
              return MakeShareable(new FMyCustomAssetDetailsCustomization);
          }
          
          TWeakObjectPtr<class UMyCustomAsset> MyAsset;
      };<\/pre>\n\n\n\n
      1. Below that, define the following additional class:<\/li><\/ol>\n\n\n\n
        class FMyCustomAssetPropertyDetails : public IPropertyTypeCustomization
        {
        public:
          void ColorPicked(FLinearColor SelectedColor);
          static TSharedRef<IPropertyTypeCustomization> MakeInstance()
          {
            return MakeShareable(new FMyCustomAssetPropertyDetails);
          }

          UMyCustomAsset* MyAsset;
          virtual void CustomizeChildren(TSharedRef<IPropertyHandle> PropertyHandle, IDetailChildrenBuilder& ChildBuilder, IPropertyTypeCustomizationUtils& CustomizationUtils) override;

          virtual void CustomizeHeader(TSharedRef<IPropertyHandle> PropertyHandle, FDetailWidgetRow& HeaderRow, IPropertyTypeCustomizationUtils& CustomizationUtils) override;

        };<\/pre>\n\n\n\n
        1. In the implementation file, add the following includes at the top of the file:<\/li><\/ol>\n\n\n\n
          #include \"MyCustomAssetDetailsCustomization.h\" 
          #include \"Chapter_10Editor.h\" 
          #include \"IDetailsView.h\" 
          #include \"DetailLayoutBuilder.h\" 
          #include \"DetailCategoryBuilder.h\" 
          #include \"SColorPicker.h\" 
          #include \"SBoxPanel.h\" 
          #include \"DetailWidgetRow.h\" <\/pre>\n\n\n\n
          1. Afterwards, create an implementation for CustomizeDetails:<\/li><\/ol>\n\n\n\n
            void FMyCustomAssetDetailsCustomization::CustomizeDetails(IDetailLayoutBuilder& DetailBuilder)
            {
                const TArray< TWeakObjectPtr<UObject> >& SelectedObjects = DetailBuilder.GetDetailsView()->GetSelectedObjects();

                for (int32 ObjectIndex = 0; !MyAsset.IsValid() && ObjectIndex < SelectedObjects.Num(); ++ObjectIndex)
                {
                    const TWeakObjectPtr<UObject>& CurrentObject = SelectedObjects[ObjectIndex];
                    if (CurrentObject.IsValid())
                    {
                        MyAsset = Cast<UMyCustomAsset>(CurrentObject.Get());
                    }
                }

                DetailBuilder.EditCategory(\"CustomCategory\", FText::GetEmpty(), ECategoryPriority::Important)
            .AddCustomRow(FText::GetEmpty())
                [
                SNew(SVerticalBox)
                + SVerticalBox::Slot()
                .VAlign(VAlign_Center)
                    [
                        SNew(SColorPicker)
                        .OnColorCommitted(this, &FMyCustomAssetDetailsCustomization::ColorPicked)
                    ]
                ];
            }<\/pre>\n\n\n\n
            1. Also, create a definition for ColorPicked:<\/li><\/ol>\n\n\n\n
              void FMyCustomAssetDetailsCustomization::ColorPicked(FLinearColor SelectedColor)
              {
                  if (MyAsset.IsValid())
                  {
                      MyAsset.Get()->ColorName = SelectedColor.ToFColor(false).ToHex();
                  }
              }<\/pre>\n\n\n\n
              1. Beneath all of the scripts in MyCustomAssetDetailsCustomization.cpp, add the following code: <\/li><\/ol>\n\n\n\n
                void FMyCustomAssetPropertyDetails::CustomizeChildren(TSharedRef<IPropertyHandle> PropertyHandle, IDetailChildrenBuilder& ChildBuilder, IPropertyTypeCustomizationUtils& CustomizationUtils)
                {
                }

                void FMyCustomAssetPropertyDetails::CustomizeHeader(TSharedRef<IPropertyHandle> PropertyHandle, FDetailWidgetRow& HeaderRow, IPropertyTypeCustomizationUtils& CustomizationUtils)
                {
                    UObject* PropertyValue = nullptr;
                    auto GetValueResult = PropertyHandle->GetValue(PropertyValue);

                    HeaderRow.NameContent()
                        [
                            PropertyHandle->CreatePropertyNameWidget()
                        ];
                    HeaderRow.ValueContent()
                        [
                            SNew(SVerticalBox)
                            + SVerticalBox::Slot()
                        .VAlign(VAlign_Center)
                        [
                            SNew(SColorPicker)
                            .OnColorCommitted(this, &FMyCustomAssetPropertyDetails::ColorPicked)
                        ]
                        ];
                }

                void FMyCustomAssetPropertyDetails::ColorPicked(FLinearColor SelectedColor)
                {
                    if (MyAsset)
                    {
                        MyAsset->ColorName = SelectedColor.ToFColor(false).ToHex();
                    }
                }<\/pre>\n\n\n\n
                1. In our editor module source file (Chapter_10Editor.cpp), add the following to your #includes in the Chapter_10Editor.cpp file:<\/li><\/ol>\n\n\n\n
                  #include \"PropertyEditorModule.h\" 
                  #include \"MyCustomAssetDetailsCustomization.h\"
                  #include \"MyCustomAssetPinFactory.h\"<\/pre>\n\n\n\n
                  1. Add the following to the implementation of StartupModule:<\/li><\/ol>\n\n\n\n
                    FPropertyEditorModule& PropertyModule = FModuleManager::LoadModuleChecked<FPropertyEditorModule>(\"PropertyEditor\");
                    PropertyModule.RegisterCustomClassLayout(UMyCustomAsset::StaticClass()->GetFName(), FOnGetDetailCustomizationInstance::CreateStatic(&FMyCustomAssetDetailsCustomization::MakeInstance));
                    PropertyModule.RegisterCustomPropertyTypeLayout(UMyCustomAsset::StaticClass()->GetFName(), FOnGetPropertyTypeCustomizationInstance::CreateStatic(&FMyCustomAssetPropertyDetails::MakeInstance));<\/pre>\n\n\n\n
                    1. Add the following to ShutdownModule:<\/li><\/ol>\n\n\n\n
                      FPropertyEditorModule& PropertyModule = FModuleManager::LoadModuleChecked<FPropertyEditorModule>(\"PropertyEditor\");
                      PropertyModule.UnregisterCustomClassLayout(UMyCustomAsset::StaticClass()->GetFName());<\/pre>\n\n\n\n
                      1. Compile your code and launch the editor. Create a new instance of MyCustomAsset via the Content Browser.<\/li>
                      2. Double-click on it to verify that the default editor that comes up now shows your custom layout:<\/li><\/ol>\n\n\n\n
                        \"\"\/<\/figure>\n\n\n\n
                        How it works…<\/h1>\n\n\n\n
                        Details Customization is performed through the IDetailCustomization interface, which developers can inherit when defining a class that customizes the way assets of a certain class are displayed.<\/p>\n\n\n\n
                        The main function that IDetailCustomization uses to allow for this process to occur is as follows:<\/p>\n\n\n\n
                        virtual void CustomizeDetails(IDetailLayoutBuilder& DetailBuilder) override;<\/pre>\n\n\n\n
                        Within our implementation of this function, we use methods on DetailBuilder that are passed in as parameters to get an array of all selected objects. The loop then scans those to ensure that at least one selected object is of the correct type.<\/p>\n\n\n\n
                        Customizing the representation of a class is done by calling methods on the DetailBuilder object. We create a new category for our details view by using the EditCategory function.<\/p>\n\n\n\n
                        The first parameter of the EditCategory function is the name of the category we are going to manipulate.<\/p>\n\n\n\n
                        The second parameter is optional, and contains a potentially localized display name for the category.<\/p>\n\n\n\n
                        The third parameter is the priority of the category. A higher priority means it is displayed further up the list.<\/p>\n\n\n\n
                        EditCategory returns a reference to the category itself as CategoryBuilder, allowing us to chain additional method calls onto an invocation of EditCategory.<\/p>\n\n\n\n
                        As a result, we call AddCustomRow() on CategoryBuilder, which adds a new key-value pair to be displayed in the category.<\/p>\n\n\n\n
                        Using the Slate syntax, we then specify that the row will contain a Vertical Box with a single center-aligned slot.<\/p>\n\n\n\n
                        Inside the slot, we create a color picker control and bind its OnColorCommitted delegate to our local ColorPicked event handler.<\/p>\n\n\n\n
                        Of course, this requires us to define and implement ColourPicked. It has the following signature:<\/p>\n\n\n\n
                        void FMyCustomAssetDetailsCustomization::ColorPicked(FLinearColor SelectedColor)<\/pre>\n\n\n\n
                        Inside the implementation of ColorPicked, we check to see if one of our selected assets was of the correct type, because, if at least one selected asset was correct, then MyAsset will be populated with a valid value.<\/p>\n\n\n\n
                        Assuming we have a valid asset, we set the ColorName property to the hex string value corresponding to the color that was selected by the user.<\/p>\n\n\n\n
                        <\/p>\n","protected":false},"excerpt":{"rendered":"
                        By default, UObject-derived UAssets open in the ge […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[27,1],"tags":[26],"_links":{"self":[{"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=\/wp\/v2\/posts\/3109"}],"collection":[{"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3109"}],"version-history":[{"count":1,"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=\/wp\/v2\/posts\/3109\/revisions"}],"predecessor-version":[{"id":3122,"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=\/wp\/v2\/posts\/3109\/revisions\/3122"}],"wp:attachment":[{"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3109"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=3109"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.coolcoding.cn\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=3109"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}