'use strict'; const { materialTechniquePolyfill } = require('../utils/material'); const { setDisabled, setReadonly, setHidden, loopSetAssetDumpDataReadonly } = require('../utils/prop'); const { join, sep, normalize } = require('path'); exports.style = ` ui-button.location { flex: none; margin-left: 6px; } `; exports.template = /* html */ `
Effect Technique
`; exports.$ = { pass: '.pass', header: '.header', section: '.section', effect: '.effect', location: '.location', technique: '.technique', materialDump: '.material-dump', useInstancing: '.useInstancing', useBatching: '.useBatching', customSection: '.customSection', customPanel: '.customPanel', }; exports.methods = { record() { return JSON.stringify({ material: this.material, cacheData: this.cacheData, }); }, async restore(record) { record = JSON.parse(record); if (!record || typeof record !== 'object' || !record.material) { return false; } this.material = record.material; this.cacheData = record.cacheData; await this.updateInterface({ snapshot: false }); return true; }, async getCustomInspector() { const currentEffectInfo = this._effects.find((effect) => { return effect.name === this.material.effect; }); if (currentEffectInfo && currentEffectInfo.uuid) { const meta = await Editor.Message.request('asset-db', 'query-asset-meta', currentEffectInfo.uuid); return meta && meta.userData && meta.userData.editor && meta.userData.editor.inspector; } return ''; }, /** * Custom Save */ async apply() { this.reset(); await Editor.Message.request('scene', 'apply-material', this.asset.uuid, this.material); }, reset() { this.dirtyData.origin = this.dirtyData.realtime; this.dirtyData.uuid = ''; this.cacheData = {}; }, /** * * @param {string} inspector */ async updateCustomInspector(inspector) { this.$.customPanel.hidden = false; this.$.section.hidden = true; this.$.materialDump.hidden = true; try { if (inspector.startsWith('packages://')) { const relatePath = normalize(inspector.replace('packages://', '')); const name = relatePath.split(sep)[0]; const packagePath = Editor.Package.getPackages({ name, enable: true })[0].path; const path = join(packagePath, relatePath.split(name)[1]); if (this.$.customPanel.getAttribute('src') !== path) { this.$.customPanel.setAttribute('src', path); } this.$.customPanel.update(this.material, this.assetList, this.metaList); } else { throw Editor.I18n.t('ENGINE.assets.material.illegal-inspector-url'); } } catch (error) { console.error(error); console.error(Editor.I18n.t('ENGINE.assets.material.fail-to-load-custom-inspector', { effect: this.material.effect })); this.updatePasses(); } }, /** * Detection of data changes only determines the currently selected technique */ setDirtyData(state) { this.dirtyData.realtime = JSON.stringify({ effect: this.material.effect, technique: this.material.technique, techniqueData: this.material.data[this.material.technique], }); if (!this.dirtyData.origin) { this.dirtyData.origin = this.dirtyData.realtime; this.dispatch('snapshot'); } else { this.dispatch('change', state); } this.canUpdatePreview = true; }, isDirty() { const isDirty = this.dirtyData.origin !== this.dirtyData.realtime; return isDirty; }, async updateInterface(state) { if (this.canUpdatePreview) { await this.updatePreview(); } // effect tag this.$.technique.value = this.material.technique; setDisabled(this.asset.readonly, this.$.technique); this.updateTechniqueOptions(); const inspector = await this.getCustomInspector(); if (inspector) { this.updateCustomInspector(inspector); this.setDirtyData(state); } else { // optimize calculate speed when edit multiple materials in node mode requestIdleCallback(() => { this.updatePasses(); this.setDirtyData(state); }); } }, /** * Update the pass data that is finally displayed in the panel */ updatePasses() { if (this.$.customPanel.hasAttribute('src')) { this.$.customPanel.removeAttribute('src'); } this.$.customPanel.hidden = true; this.$.section.hidden = false; this.$.materialDump.hidden = false; // Automatic rendering of content // The data in passes is not all the values that need to be rendered // So it's sorted here, but that doesn't make sense // The logical way to do it would be to return a normal dump when querying for material const technique = materialTechniquePolyfill(this.material.data[this.material.technique]); this.technique = technique; if (!technique || !technique.passes) { return; } if (this.requestInitCache) { this.initCache(); } else { this.useCache(); } if (technique.passes) { // The interface is not a regular data loop, which needs to be completely cleared and placed, but the UI-prop element is still reusable const $container = this.$.materialDump; $container.innerText = ''; if (!$container.$children) { $container.$children = {}; } for (let i = 0; i < technique.passes.length; i++) { const pass = technique.passes[i]; // if asset is readonly if (this.asset.readonly) { for (const key in pass.value) { loopSetAssetDumpDataReadonly(pass.value[key]); } } $container.$children[i] = document.createElement('ui-prop'); $container.$children[i].setAttribute('type', 'dump'); $container.$children[i].setAttribute('fold', 'false'); $container.appendChild($container.$children[i]); $container.$children[i].render(pass); // Add the checkbox given by the switch attribute if (pass.switch && pass.switch.name) { const $checkbox = document.createElement('ui-checkbox'); $checkbox.innerText = pass.switch.name; $checkbox.setAttribute('slot', 'header'); $checkbox.addEventListener('change', (e) => { pass.switch.value = e.target.value; }); setReadonly(this.asset.readonly, $checkbox); $checkbox.value = pass.switch.value; const $section = $container.$children[i].querySelector('ui-section'); $section.appendChild($checkbox); const $label = $section.querySelector('ui-label'); $label.style.width = 'calc(var(--left-width) - 10px)'; } $container.$children[i].querySelectorAll('ui-prop').forEach(($prop) => { const dump = $prop.dump; if (dump && dump.childMap && dump.children.length) { if (!$prop.$children) { $prop.$children = document.createElement('section'); $prop.$children.setAttribute( 'style', 'border: 1px dashed var(--color-normal-border); padding: 10px; margin: 5px 0;', ); for (const childName in dump.childMap) { if (dump.childMap[childName].value === undefined) { continue; } if (this.asset.readonly) { loopSetAssetDumpDataReadonly(dump.childMap[childName]); } $prop.$children[childName] = document.createElement('ui-prop'); $prop.$children[childName].setAttribute('type', 'dump'); $prop.$children[childName].render(dump.childMap[childName]); $prop.$children.appendChild($prop.$children[childName]); } if (Array.from($prop.$children.children).length) { $prop.after($prop.$children); } } if (dump.value) { $prop.$children.removeAttribute('hidden'); } else { $prop.$children.setAttribute('hidden', ''); } } }); } } }, updateInstancing() { const technique = this.technique; const firstPass = technique.passes[0]; if (firstPass.childMap.USE_INSTANCING) { technique.useInstancing.value = firstPass.childMap.USE_INSTANCING.value; if (firstPass.childMap.USE_BATCHING) { technique.useBatching.value = firstPass.childMap.USE_BATCHING.value; technique.useBatching.visible = !technique.useInstancing.value; } this.changeInstancing(technique.useInstancing.value); } if (technique.useInstancing) { this.$.useInstancing.render(technique.useInstancing); setHidden(technique.useInstancing && !technique.useInstancing.visible, this.$.useInstancing); setReadonly(this.asset.readonly, this.$.useInstancing); } if (technique.useBatching) { this.$.useBatching.render(technique.useBatching); setHidden(technique.useInstancing.value || (technique.useBatching && !technique.useBatching.visible), this.$.useBatching); setReadonly(this.asset.readonly, this.$.useBatching); } }, changeInstancing(checked) { this.technique.passes.forEach((pass) => { if (pass.childMap.USE_INSTANCING) { pass.childMap.USE_INSTANCING.value = checked; } }); // if Instancing show, Batching hidden setHidden(checked, this.$.useBatching); if (checked) { this.changeBatching(false); this.$.useBatching.render(this.technique.useBatching); } }, changeBatching(checked) { this.technique.passes.forEach((pass) => { if (pass.childMap.USE_BATCHING) { pass.childMap.USE_BATCHING.value = checked; } }); }, /** * Update the options data in technique */ updateTechniqueOptions() { let techniqueOption = ''; this.material.data.forEach((technique, index) => { const name = technique.name ? `${index} - ${technique.name}` : index; techniqueOption += ``; }); this.$.technique.innerHTML = techniqueOption; }, hideAllContent(hide) { this.$.header.style = hide ? 'display:none' : ''; this.$.section.style = hide ? 'display:none' : ''; this.$.materialDump.style = hide ? 'display:none' : ''; }, async updatePreview() { await Editor.Message.request('scene', 'preview-material', this.asset.uuid, this.material); Editor.Message.broadcast('material-inspector:change-dump'); }, initCache() { const excludeNames = [ 'children', 'defines', 'extends', 'pipelineStates', ]; const cacheData = this.cacheData; this.technique.passes.forEach((pass, i) => { if (pass.propertyIndex !== undefined && pass.propertyIndex.value !== i) { return; } cacheProperty(pass.value); }); function cacheProperty(prop) { for (const name in prop) { // 这些字段是基础类型或配置性的数据,不需要变动 if (excludeNames.includes(name)) { continue; } if (prop[name] && typeof prop[name] === 'object') { if (!(name in cacheData)) { const { type, value } = prop[name]; if (type) { if (value !== undefined) { cacheData[name] = { type }; if (value && typeof value === 'object') { cacheData[name].value = JSON.parse(JSON.stringify(value)); } else { cacheData[name].value = value; } } } } if (prop[name].childMap && typeof prop[name].childMap === 'object') { cacheProperty(prop[name].childMap); } } } } this.requestInitCache = false; this.updateInstancing(); this.updatePreview(); }, storeCache(dump) { const { name, type, value, default: defaultValue } = dump; if (JSON.stringify(value) === JSON.stringify(defaultValue)) { delete this.cacheData[name]; } else { this.cacheData[name] = JSON.parse(JSON.stringify({ type, value })); } }, useCache() { const cacheData = this.cacheData; this.technique.passes.forEach((pass, i) => { if (pass.propertyIndex !== undefined && pass.propertyIndex.value !== i) { return; } updateProperty(pass.value); }); function updateProperty(prop) { for (const name in prop) { if (prop[name] && typeof prop[name] === 'object') { if (name in cacheData) { const { type, value } = cacheData[name]; if (prop[name].type === type && JSON.stringify(prop[name].value) !== JSON.stringify(value)) { if (value && typeof value === 'object') { prop[name].value = JSON.parse(JSON.stringify(value)); } else { prop[name].value = value; } } } if (prop[name].childMap && typeof prop[name].childMap === 'object') { updateProperty(prop[name].childMap); } } } } // Update the extracted useInstancing and useBatching this.updateInstancing(); this.updatePreview(); }, }; /** * Methods for automatic rendering of components * @param assetList * @param metaList */ exports.update = async function(assetList, metaList) { this.assetList = assetList; this.metaList = metaList; this.asset = assetList[0]; this.meta = metaList[0]; const notOnlyOne = assetList.length !== 1; this.hideAllContent(notOnlyOne); if (notOnlyOne) { return; } if (!this.dirtyData) { return; } if (this.dirtyData.uuid !== this.asset.uuid) { this.dirtyData.uuid = this.asset.uuid; this.dirtyData.origin = ''; this.cacheData = {}; this.requestInitCache = true; } // set this.material.technique this.material = await Editor.Message.request('scene', 'query-material', this.asset.uuid); await this.updateInterface(); }; /** * Method of initializing the panel */ exports.ready = async function() { this.canUpdatePreview = false; // Used to determine whether the material has been modified in isDirty() this.dirtyData = { uuid: '', origin: '', realtime: '', }; // Retain the previously modified data when switching pass this.cacheData = {}; // The event triggered when the content of material is modified this.$.materialDump.addEventListener('change-dump', async (event) => { const dump = event.target.dump; // show its children if (dump && dump.childMap && dump.children.length && event.target.$children) { if (dump.value) { event.target.$children.removeAttribute('hidden'); } else { event.target.$children.setAttribute('hidden', ''); } } this.setDirtyData(); this.storeCache(dump); await this.updatePreview(); }); // The event that is triggered when the effect used is modified this.$.effect.addEventListener('change', async (event) => { this.material.effect = event.target.value; this.material.data = await Editor.Message.request('scene', 'query-effect', this.material.effect); this.updateTechniqueOptions(); if (!this.material.data[this.material.technique]) { this.$.technique.value = this.material.technique = 0; } else { this.$.technique.value = this.material.technique; } const inspector = await this.getCustomInspector(); if (inspector) { this.updateCustomInspector(inspector); } else { this.updatePasses(); } this.setDirtyData(); }); this.$.location.addEventListener('change', () => { const effect = this._effects.find((_effect) => _effect.name === this.material.effect); if (effect) { Editor.Message.send('assets', 'twinkle', effect.uuid); } }); // Event triggered when the technique being used is changed this.$.technique.addEventListener('change', async (event) => { this.material.technique = event.target.value; const inspector = await this.getCustomInspector(); if (inspector) { this.updateCustomInspector(inspector); } else { this.updatePasses(); } this.setDirtyData(); this.updatePreview(); }); // The event is triggered when the useInstancing is modified this.$.useInstancing.addEventListener('change-dump', (event) => { this.changeInstancing(event.target.dump.value); this.storeCache(event.target.dump); this.setDirtyData(); this.updatePreview(); }); // The event is triggered when the useBatching is modified this.$.useBatching.addEventListener('change-dump', (event) => { this.changeBatching(event.target.dump.value); this.storeCache(event.target.dump); this.setDirtyData(); this.updatePreview(); }); // When the page is initialized, all effect lists are queried and then not updated again const effectMap = await Editor.Message.request('scene', 'query-all-effects'); this._effects = Object.keys(effectMap) .sort() .filter((name) => { const effect = effectMap[name]; return !effect.hideInEditor; }) .map((name) => { const effect = effectMap[name]; return { name, uuid: effect.uuid, }; }); let effectOption = ''; for (let effect of this._effects) { effectOption += ``; } this.$.effect.innerHTML = effectOption; this.$.customPanel.addEventListener('change', () => { this.setDirtyData(); this.updatePreview(); }); }; exports.close = function() { // Used to determine whether the material has been modified in isDirty() this.dirtyData = { uuid: '', origin: '', realtime: '', }; this.cacheData = {}; };