MxNodeEditorPreferences Class Reference

Class to store preferences for the node editor. More...

Public Member Functions
	constructor ()
	getDefaultGeometryFile ()
	Method to return the default geometry file.
	getDefaultMaterialFile ()
	Method to return the default material file.
	getPreferences ()
	Method to return the preferences object.
	getExamples ()
	Return material examples structure.
	getIconMap ()
	Return icon map structure.

Detailed Description

Class to store preferences for the node editor.

• preferences - Object containing preferences for the node editor
• preferences.icon_map - Object containing mapping of file extensions to icons
• preferences.examples - Object containing example materials Note that all material and icon file references are relative to the root of the deployment folder. while geometry is referenced by name only.

Definition at line 10 of file node_editor_preferences.js.

Member Function Documentation

constructor()

MxNodeEditorPreferences::constructor

(

)

Definition at line 12 of file node_editor_preferences.js.

                  {
        this._preferences = {};
 
        this._preferences.default_material_file = "Materials/Examples/Custom/marbley.mtlx";
        this._preferences.default_geometry_file = "sphere";
 
        this._preferences.icon_map = {
            "gltf": "./Icons/gltf_logo.webp",
            "usd": "./Icons/openusd_logo.webp",
            "open_pbr": "./Icons/openpbr_logo.svg", // TODO: Use official logo when available.
            "houdini": "./Icons/houdini_icon.webp",
            "maya": "./Icons/maya_surfaces.webp",
        };
 
        this._preferences.examples = {
            "Default Materials": {
                "Unlit": "Materials/Examples/Custom/default_unlit.mtlx",
                "OpenPBR": "Materials/Examples/OpenPBR/open_pbr_default.mtlx",
                "glTF PBR": "Materials/Examples/GltfPbr/gltf_pbr_default.mtlx",
                "Standard Surface": "Materials/Examples/StandardSurface/standard_surface_default.mtlx",
                "Usd Preview Surface": "Materials/Examples/UsdPreviewSurface/usd_preview_surface_default.mtlx",            
            },
            "Sample Graphs": {
                "Patterns": {
                    "Gooch": "Materials/Examples/Custom/gooch_shade.mtlx",
                    "Simple Checkerboard": "Materials/Examples/Custom/simple_checkerboard_graph.mtlx",
                    "Hatch": "Materials/Examples/Custom/pseudo_hatching_publish.mtlx",
                    "Patterned Shaders": "Materials/Examples/Custom/compound_graph_example.mtlx",
                },
                "Materials": {
                    "glTF Boombox": "Materials/Examples/Custom/gltf_boombox_graph.mtlx",
                    "OpenPBR Pattern": "Materials/Examples/Custom/marbley.mtlx",
                    "Custom Shader Definition": "Materials/Examples/Custom/MayaLambert_embedded_def.mtlx",
                },
                "Images": {
                    "File Lookup": "Materials/Examples/Custom/simple_file_texture.mtlx",
                },
            },
            "Preset Materials": {
                "glTF": {
                    "Car Paint": "Materials/Examples/GltfPbr/gltf_pbr_carpaint.mtlx",
                    "Glass": "Materials/Examples/GltfPbr/gltf_pbr_glass.mtlx",
                    "Gold": "Materials/Examples/GltfPbr/gltf_pbr_gold.mtlx",
                    "Plastic": "Materials/Examples/GltfPbr/gltf_pbr_plastic.mtlx"
                },
                "OpenPBR": {
                    "Aluminum": "Materials/Examples/OpenPBR/open_pbr_aluminum_brushed.mtlx",
                    "Car Paint": "Materials/Examples/OpenPBR/open_pbr_carpaint.mtlx",
                    "Glass": "Materials/Examples/OpenPBR/open_pbr_glass.mtlx",
                    "Honey": "Materials/Examples/OpenPBR/open_pbr_honey.mtlx",
                    "Ketchup": "Materials/Examples/OpenPBR/open_pbr_ketchup.mtlx",
                    "Light Bulb": "Materials/Examples/OpenPBR/open_pbr_lightbulb.mtlx",
                    "Pearl": "Materials/Examples/OpenPBR/open_pbr_pearl.mtlx",
                    "Soap Bubble": "Materials/Examples/OpenPBR/open_pbr_soapbubble.mtlx",
                    "Velvet": "Materials/Examples/OpenPBR/open_pbr_velvet.mtlx"
                },
                "Standard Surface": {
                    "Brass": "Materials/Examples/StandardSurface/standard_surface_brass_tiled.mtlx",
                    "Brick": "Materials/Examples/StandardSurface/standard_surface_brick_procedural.mtlx",
                    "Car Paint": "Materials/Examples/StandardSurface/standard_surface_carpaint.mtlx",
                    "Chess Set": "Materials/Examples/StandardSurface/standard_surface_chess_set.mtlx",
                    "Chrome": "Materials/Examples/standard_surface_chrome.mtlx",
                    "Copper": "Materials/Examples/StandardSurface/standard_surface_copper.mtlx",
                    "Glass": "Materials/Examples/StandardSurface/standard_surface_glass.mtlx",
                    "Tinted Glass": "Materials/Examples/StandardSurface/standard_surface_glass_tinted.mtlx",
                    "Gold": "Materials/Examples/StandardSurface/standard_surface_gold.mtlx",
                    "Grey": "Materials/Examples/StandardSurface/standard_surface_greysphere.mtlx",
                    "Calibration": "Materials/Examples/StandardSurface/standard_surface_greysphere_calibration.mtlx",
                    "Jade": "Materials/Examples/StandardSurface/standard_surface_jade.mtlx",
                    "Marble": "Materials/Examples/StandardSurface/standard_surface_marble_solid.mtlx",
                    "Brushed Metal": "Materials/Examples/StandardSurface/standard_surface_metal_brushed.mtlx",
                    "Plastic": "Materials/Examples/StandardSurface/standard_surface_plastic.mtlx",
                    "Thin Film": "Materials/Examples/StandardSurface/standard_surface_thin_film.mtlx",
                    "Velvet": "Materials/Examples/StandardSurface/standard_surface_velvet.mtlx",
                    "Tiled Wood": "Materials/Examples/StandardSurface/standard_surface_wood_tiled.mtlx",
                },
                "UsdPreviewSurface": {
                    "Brass": "Materials/Examples/UsdPreviewSurface/usd_preview_surface_brass_tiled.mtlx",
                    "Car Paint": "Materials/Examples/UsdPreviewSurface/usd_preview_surface_carpaint.mtlx",
                    "Glass": "Materials/Examples/UsdPreviewSurface/usd_preview_surface_glass.mtlx",
                    "Gold": "Materials/Examples/UsdPreviewSurface/usd_preview_surface_gold.mtlx",
                    "Plastic": "Materials/Examples/UsdPreviewSurface/usd_preview_surface_plastic.mtlx",
                },
                "GPUOpen": {
                    "Motley Patchwork Rug": "Materials/Examples/Custom/AMD/Motley_Patchwork_Rug.mtlx",
                    "Black Upholstery": "Materials/Examples/Custom/AMD/Black_Uphostery.mtlx",
                    "Old Copper": "Materials/Examples/Custom/AMD/Copper_Old.mtlx"
                },
                "PhysicallyBased": {
                    "glTF": "https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PhysicallyBasedMaterialX/PhysicallyBasedMaterialX_GLTF.mtlx",
                    "OpenPBR": "https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PhysicallyBasedMaterialX/PhysicallyBasedMaterialX_OPBR.mtlx",
                    "Standard Surface": "https://kwokcb.github.io/materialxMaterials/src/materialxMaterials/data/PhysicallyBasedMaterialX/PhysicallyBasedMaterialX_SS.mtlx"
                }
            }
        }
    }

getDefaultGeometryFile()

MxNodeEditorPreferences::getDefaultGeometryFile

(

)

Method to return the default geometry file.

Returns

{String} - Default geometry file path

Definition at line 114 of file node_editor_preferences.js.

                             {
        return this._preferences.default_geometry_file;
    }

getDefaultMaterialFile()

MxNodeEditorPreferences::getDefaultMaterialFile

(

)

Method to return the default material file.

Returns

{String} - Default material file path

Definition at line 122 of file node_editor_preferences.js.

                             {
        return this._preferences.default_material_file;
    }

getExamples()

MxNodeEditorPreferences::getExamples

(

)

Return material examples structure.

Returns

{Object} - Object containing example materials

Definition at line 138 of file node_editor_preferences.js.

                  {
        // Add PhysicallyBased Materials dynamically here        
        return this._preferences.examples;        
    }

getIconMap()

MxNodeEditorPreferences::getIconMap

(

)

Return icon map structure.

Returns

{Object} - Object containing mapping of semantic categories to icons

Definition at line 147 of file node_editor_preferences.js.

                 {
        return this._preferences.icon_map;
    }

getPreferences()

MxNodeEditorPreferences::getPreferences

(

)

Method to return the preferences object.

Returns

{Object} - Object containing preferences for the node editor

Definition at line 130 of file node_editor_preferences.js.

                     {
        return this._preferences;
    }

---

The documentation for this class was generated from the following file:

• node_editor_preferences.js