Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

Ir 2543 create prefab #10384

Merged
merged 24 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
5beb036
add create prefab panel and export for prefab
JT00y Jun 13, 2024
cb079fb
Merge branch 'dev' of https://github.com/EtherealEngine/etherealengin…
JT00y Jun 13, 2024
2b87c8f
Merge branch 'dev' of https://github.com/EtherealEngine/etherealengin…
JT00y Jun 14, 2024
5b4a6f4
change add component function
JT00y Jun 14, 2024
51558b7
delete changes for modelcomponent
JT00y Jun 15, 2024
0a5c46d
Merge branch 'dev' of https://github.com/EtherealEngine/etherealengin…
JT00y Jun 17, 2024
55ad610
add pass tag to static resource and clean up state
JT00y Jun 17, 2024
23ff84b
clean up
JT00y Jun 17, 2024
59256c7
change state to hookstate and add await to export
JT00y Jun 17, 2024
cce1d1b
fix import
JT00y Jun 17, 2024
f92cca7
Merge branch 'dev' of https://github.com/EtherealEngine/etherealengin…
dinomut1 Jun 17, 2024
059023b
Merge branch 'dev' of https://github.com/EtherealEngine/etherealengin…
JT00y Jun 17, 2024
7322748
fix path for folder
JT00y Jun 17, 2024
4e7729c
Merge branch 'ir-2543-create-prefab' of https://github.com/EtherealEn…
dinomut1 Jun 17, 2024
543f911
fix exporting non-model entities
dinomut1 Jun 18, 2024
7533f55
remove add model component
JT00y Jun 18, 2024
2121655
Merge branch 'dev' of https://github.com/EtherealEngine/etherealengin…
JT00y Jun 18, 2024
def85bf
Merge branch 'dev' of https://github.com/EtherealEngine/etherealengin…
dinomut1 Jun 20, 2024
05bedac
fix upload
dinomut1 Jun 20, 2024
6207bc1
Merge branch 'dev' of https://github.com/EtherealEngine/etherealengin…
dinomut1 Jun 20, 2024
dd7f4cb
create dud prefab entity for export so child is not lost
dinomut1 Jun 20, 2024
0d645db
prefab parenting preserved
dinomut1 Jun 20, 2024
78f7423
update selection on create prefab
dinomut1 Jun 21, 2024
e35209b
Merge branch 'dev' into ir-2543-create-prefab
dinomut1 Jun 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/client-core/i18n/en/editor.json
Original file line number Diff line number Diff line change
Expand Up @@ -1228,6 +1228,7 @@
"lbl-collapseAll": "Collapse All",
"lbl-explode": "Explode Objects",
"lbl-addEntity": "Add Entity",
"lbl-createPrefab": "Create Prefab",
"issues": "Issues",
"copy-paste": {
"no-hierarchy-nodes": "No hierarchy nodes found"
Expand Down
150 changes: 150 additions & 0 deletions packages/editor/src/components/dialogs/CreatePrefabPanelDialog.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
/*
CPAL-1.0 License

The contents of this file are subject to the Common Public Attribution License
Version 1.0. (the "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE.
The License is based on the Mozilla Public License Version 1.1, but Sections 14
and 15 have been added to cover use of software over a computer network and
provide for limited attribution for the Original Developer. In addition,
Exhibit A has been modified to be consistent with Exhibit B.

Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
specific language governing rights and limitations under the License.

The Original Code is Ethereal Engine.

The Original Developer is the Initial Developer. The Initial Developer of the
Original Code is the Ethereal Engine team.

All portions of the code written by the Ethereal Engine team are Copyright © 2021-2023
Ethereal Engine. All Rights Reserved.
*/

import { PopoverState } from '@etherealengine/client-core/src/common/services/PopoverState'
import config from '@etherealengine/common/src/config'
import { staticResourcePath } from '@etherealengine/common/src/schema.type.module'
import { pathJoin } from '@etherealengine/common/src/utils/miscUtils'
import { Engine, Entity, createEntity, getComponent, removeEntity, setComponent } from '@etherealengine/ecs'
import { ModelComponent } from '@etherealengine/engine/src/scene/components/ModelComponent'
import { proxifyParentChildRelationships } from '@etherealengine/engine/src/scene/functions/loadGLTFModel'
import { getMutableState, getState, useHookstate } from '@etherealengine/hyperflux'
import { NameComponent } from '@etherealengine/spatial/src/common/NameComponent'
import { addObjectToGroup } from '@etherealengine/spatial/src/renderer/components/GroupComponent'
import { EntityTreeComponent } from '@etherealengine/spatial/src/transform/components/EntityTree'
import Button from '@etherealengine/ui/src/primitives/tailwind/Button'
import Input from '@etherealengine/ui/src/primitives/tailwind/Input'
import Modal from '@etherealengine/ui/src/primitives/tailwind/Modal'
import React from 'react'
import { useTranslation } from 'react-i18next'
import { Scene } from 'three'
import { EditorControlFunctions } from '../../functions/EditorControlFunctions'
import { exportRelativeGLTF } from '../../functions/exportGLTF'
import { EditorState } from '../../services/EditorServices'
import { SelectionState } from '../../services/SelectionServices'
import { HeirarchyTreeNodeType } from '../hierarchy/HeirarchyTreeWalker'

export default function CreatePrefabPanel({ node }: { node?: HeirarchyTreeNodeType }) {
const entity = node?.entity as Entity
const defaultPrefabFolder = useHookstate<string>('assets/custom-prefabs')
const prefabName = useHookstate<string>('prefab')
const prefabTag = useHookstate<string[]>([])
const { t } = useTranslation()

const onExportPrefab = async () => {
const editorState = getState(EditorState)
const fileName = defaultPrefabFolder.value + '/' + prefabName.value + '.gltf'
const srcProject = editorState.projectName!
const fileURL = pathJoin(config.client.fileServer, 'projects', srcProject, fileName)
try {
const parentEntity = getComponent(entity, EntityTreeComponent).parentEntity
const prefabEntity = createEntity()
const obj = new Scene()
addObjectToGroup(prefabEntity, obj)
proxifyParentChildRelationships(obj)
setComponent(prefabEntity, EntityTreeComponent, { parentEntity })
setComponent(prefabEntity, NameComponent, prefabName.value)
setComponent(entity, EntityTreeComponent, { parentEntity: prefabEntity })

await exportRelativeGLTF(prefabEntity, srcProject, fileName)
//await exportRelativeGLTF(entity, srcProject, fileName)
//pass tags to static resource
const resources = await Engine.instance.api.service(staticResourcePath).find({
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will always fail because the file doesn't exist yet

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should remove this call, and construct a static resource object to pass for upload

query: { key: 'projects/' + srcProject + '/' + fileName }
})
if (resources.data.length === 0) {
throw new Error('User not found')
}
const resource = resources.data[0]
const tags = [...prefabTag.value]
await Engine.instance.api.service(staticResourcePath).patch(resource.id, { tags: tags })
PopoverState.hidePopupover()
defaultPrefabFolder.set('assets/custom-prefabs')
prefabName.set('prefab')
prefabTag.set([])
removeEntity(prefabEntity)
const { entityUUID } = EditorControlFunctions.createObjectFromSceneElement(
[{ name: ModelComponent.jsonID, props: { src: fileURL } }],
parentEntity
)
getMutableState(SelectionState).selectedEntities.set([entityUUID])
} catch (e) {
console.error(e)
}
}
return (
<Modal
title="Create Prefab"
onSubmit={onExportPrefab}
className="w-[50vw] max-w-2xl"
onClose={PopoverState.hidePopupover}
>
<Input
value={defaultPrefabFolder.value}
onChange={(event) => defaultPrefabFolder.set(event.target.value)}
label="Default Save Folder"
/>
<Input value={prefabName.value} onChange={(event) => prefabName.set(event.target.value)} label="Name" />

<Button
size="small"
variant="outline"
className="text-left text-xs"
onClick={() => {
prefabTag.set([...(prefabTag.value ?? []), ''])
}}
>
{t('editor:layout.filebrowser.fileProperties.addTag')}
</Button>
<div>
{(prefabTag.value ?? []).map((tag, index) => (
<div style={{ display: 'flex', flexDirection: 'row', margin: '0, 16px 0 0' }}>
<Input
key={index}
label={t('editor:layout.filebrowser.fileProperties.tag')}
onChange={(event) => {
const tags = [...prefabTag.value]
tags[index] = event.target.value
prefabTag.set(tags)
}}
value={prefabTag.value[index]}
/>
<Button
onClick={() => {
prefabTag.set(prefabTag.value.filter((_, i) => i !== index))
}}
size="small"
variant="outline"
className="text-left text-xs"
>
{' '}
x{' '}
</Button>
</div>
))}
</div>
</Modal>
)
}
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ export default function MaterialLibraryPanel() {
const relativePath = pathJoin('assets', libraryName)
const gltf = (await exportMaterialsGLTF([UUIDComponent.getEntityByUUID(materialUUID)], {
binary: false,
relativePath
relativePath,
projectName
})!) as { [key: string]: any }
const blob = [JSON.stringify(gltf)]
const file = new File(blob, libraryName)
Expand Down
3 changes: 2 additions & 1 deletion packages/editor/src/functions/assetFunctions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ import { modelResourcesPath } from '@etherealengine/engine/src/assets/functions/
import { Heuristic } from '@etherealengine/engine/src/scene/components/VariantComponent'
import { getState } from '@etherealengine/hyperflux'

import { pathJoin } from '@etherealengine/common/src/utils/miscUtils'
import { ImportSettingsState } from '../components/assets/ImportSettingsPanel'
import { createLODVariants } from '../components/assets/ModelCompressionPanel'
import { LODVariantDescriptor } from '../constants/GLTFPresets'
Expand Down Expand Up @@ -135,7 +136,7 @@ export const uploadProjectFiles = (projectName: string, files: File[], paths: st
for (let i = 0; i < files.length; i++) {
const file = files[i]
const fileDirectory = paths[i].replace('projects/' + projectName + '/', '')
const filePath = (fileDirectory.endsWith('/') ? fileDirectory : fileDirectory + '/') + file.name
const filePath = fileDirectory ? pathJoin(fileDirectory, file.name) : file.name
promises.push(
uploadToFeathersService(
fileBrowserUploadPath,
Expand Down
2 changes: 1 addition & 1 deletion packages/editor/src/functions/exportGLTF.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ export async function exportRelativeGLTF(entity: Entity, projectName: string, re
})
const blob = isGLTF ? [JSON.stringify(gltf, null, 2)] : [gltf]
const file = new File(blob, relativePath)
const urls = await Promise.all(uploadProjectFiles(projectName, [file], [`projects/${projectName}`]).promises)
const urls = await Promise.all(uploadProjectFiles(projectName, [file], [``]).promises)
console.log('exported model data to ', ...urls)
}
2 changes: 2 additions & 0 deletions packages/engine/src/assets/exporters/gltf/GLTFExporter.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ export interface GLTFExporterOptions {
*/
includeCustomExtensions?: boolean;

projectName?: string;

relativePath?: string;

resourceURI?: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export default class BasisuExporterExtension extends ExporterExtension implement
if (!_texture?.isCompressedTexture) return
const writer = this.writer
//if we're not embedding images and this image already has a src, just use that
if (!writer.options.embedImages && _texture.userData.src) {
if (!writer.options.embedImages && (_texture.userData.src || _texture.source.data.src)) {
textureDef.extensions[this.name] = { source: textureDef.source }
writer.extensionsUsed[this.name] = true
delete textureDef.source
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,16 @@ export default class ImageRoutingExtension extends ExporterExtension implements
if (!materialEntity) return
const src = getComponent(materialEntity, SourceComponent)
const resolvedPath = pathResolver().exec(src)!
let relativeSrc = resolvedPath[2]
relativeSrc = relativeSrc.replace(/\/[^\/]*$/, '')
const projectDst = this.writer.options.projectName!
let projectSrc = this.writer.options.projectName!
let relativeSrc = './assets/'
if (resolvedPath) {
projectSrc = resolvedPath[1]
relativeSrc = resolvedPath[2]
relativeSrc = relativeSrc.replace(/\/[^\/]*$/, '')
}
const dst = this.writer.options.relativePath!.replace(/\/[^\/]*$/, '')
const relativeBridge = relativePathTo(dst, relativeSrc)
const relativeBridge = relativePathTo(pathJoin(projectDst, dst), pathJoin(projectSrc, relativeSrc))

for (const [field, value] of Object.entries(material)) {
if (field === 'envMap') continue
Expand All @@ -60,8 +66,15 @@ export default class ImageRoutingExtension extends ExporterExtension implements
let oldURI = texture.userData.src
if (!oldURI) {
const resolved = pathResolver().exec(texture.image.src)!
const oldProject = resolved[1]
const relativeOldURL = resolved[2]
oldURI = relativePathTo(relativeSrc, relativeOldURL)
if (oldProject !== projectSrc) {
const srcWithProject = pathJoin(projectSrc, relativeSrc)
const dstWithProject = pathJoin(oldProject, relativeOldURL)
oldURI = relativePathTo(srcWithProject, dstWithProject)
} else {
oldURI = relativePathTo(relativeSrc, relativeOldURL)
}
}
const newURI = pathJoin(relativeBridge, oldURI)
if (!texture.image.src) {
Expand Down
4 changes: 2 additions & 2 deletions packages/engine/src/assets/functions/exportModelGLTF.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ All portions of the code written by the Ethereal Engine team are Copyright © 20
Ethereal Engine. All Rights Reserved.
*/

import { getComponent } from '@etherealengine/ecs/src/ComponentFunctions'
import { getComponent, getOptionalComponent } from '@etherealengine/ecs/src/ComponentFunctions'
import { Entity } from '@etherealengine/ecs/src/Entity'
import { GroupComponent } from '@etherealengine/spatial/src/renderer/components/GroupComponent'

Expand All @@ -41,7 +41,7 @@ export default async function exportModelGLTF(
onlyVisible: false
}
) {
const scene = getComponent(entity, ModelComponent).scene ?? getComponent(entity, GroupComponent)[0]
const scene = getOptionalComponent(entity, ModelComponent)?.scene ?? getComponent(entity, GroupComponent)[0]
const exporter = createGLTFExporter()
const modelName = options.relativePath.split('/').at(-1)!.split('.').at(0)!
const resourceURI = `model-resources/${modelName}`
Expand Down
9 changes: 7 additions & 2 deletions packages/engine/src/scene/functions/loadGLTFModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ import { FrustumCullCameraComponent } from '@etherealengine/spatial/src/transfor
import { EntityTreeComponent } from '@etherealengine/spatial/src/transform/components/EntityTree'
import { computeTransformMatrix } from '@etherealengine/spatial/src/transform/systems/TransformSystem'

import { ColliderComponent } from '@etherealengine/spatial/src/physics/components/ColliderComponent'
import { BoneComponent } from '../../avatar/components/BoneComponent'
import { SkinnedMeshComponent } from '../../avatar/components/SkinnedMeshComponent'
import { GLTFLoadedComponent } from '../components/GLTFLoadedComponent'
Expand Down Expand Up @@ -293,14 +294,18 @@ export const generateEntityJsonFromObject = (rootEntity: Entity, obj: Object3D,

const findColliderData = (obj: Object3D) => {
if (
hasComponent(obj.entity, ColliderComponent) ||
Object.keys(obj.userData).find(
(key) => key.startsWith('xrengine.collider') || key.startsWith('xrengine.EE_collider')
)
) {
return true
} else if (obj.parent) {
return Object.keys(obj.parent.userData).some(
(key) => key.startsWith('xrengine.collider') || key.startsWith('xrengine.EE_collider')
return (
hasComponent(obj.parent.entity, ColliderComponent) ||
Object.keys(obj.parent.userData).some(
(key) => key.startsWith('xrengine.collider') || key.startsWith('xrengine.EE_collider')
)
)
}
return false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ import { NotificationService } from '@etherealengine/client-core/src/common/serv
import { Engine, EntityUUID, UUIDComponent, entityExists, useQuery } from '@etherealengine/ecs'
import { CameraOrbitComponent } from '@etherealengine/spatial/src/camera/components/CameraOrbitComponent'

import { PopoverState } from '@etherealengine/client-core/src/common/services/PopoverState'
import useUpload from '@etherealengine/editor/src/components/assets/useUpload'
import CreatePrefabPanel from '@etherealengine/editor/src/components/dialogs/CreatePrefabPanelDialog'
import {
HeirarchyTreeNodeType,
heirarchyTreeWalker
Expand Down Expand Up @@ -83,6 +85,7 @@ function HierarchyPanelContents(props: { sceneURL: string; rootEntityUUID: Entit
const [anchorEl, setAnchorEl] = React.useState<null | HTMLElement>(null)
const [anchorPosition, setAnchorPosition] = React.useState({ left: 0, top: 0 })
const [anchorPositionPop, setAnchorPositionPop] = React.useState<undefined | PopoverPosition>(undefined)

const [prevClickedNode, setPrevClickedNode] = useState<HeirarchyTreeNodeType | null>(null)
const onUpload = useUpload(uploadOptions)
const [renamingNode, setRenamingNode] = useState<RenameNodeData | null>(null)
Expand All @@ -94,6 +97,9 @@ function HierarchyPanelContents(props: { sceneURL: string; rootEntityUUID: Entit
const sourcedEntities = useQuery([SourceComponent])
const rootEntity = UUIDComponent.useEntityByUUID(rootEntityUUID)
const rootEntityTree = useComponent(rootEntity, EntityTreeComponent)
const panel = document.getElementById('propertiesPanel')
const anchorElButton = useHookstate<HTMLButtonElement | null>(null)
const open = !!anchorElButton.value

const MemoTreeNode = useCallback(
(props: HierarchyTreeNodeProps) => (
Expand Down Expand Up @@ -438,9 +444,7 @@ function HierarchyPanelContents(props: { sceneURL: string; rootEntityUUID: Entit
{MemoTreeNode}
</FixedSizeList>
)
const panel = document.getElementById('propertiesPanel')
const anchorElButton = useHookstate<HTMLButtonElement | null>(null)
const open = !!anchorElButton.value

return (
<>
<PopoverContext.Provider
Expand All @@ -460,6 +464,7 @@ function HierarchyPanelContents(props: { sceneURL: string; rootEntityUUID: Entit
className="m-1 rounded bg-theme-primary text-[#A3A3A3]"
startComponent={<HiMagnifyingGlass className="text-white" />}
/>

<Button
startIcon={<HiOutlinePlusCircle />}
variant="transparent"
Expand Down Expand Up @@ -607,6 +612,18 @@ function HierarchyPanelContents(props: { sceneURL: string; rootEntityUUID: Entit
>
{t('editor:hierarchy.lbl-collapseAll')}
</Button>

<Button
fullWidth
size="small"
variant="transparent"
className="text-left text-xs"
onClick={() => PopoverState.showPopupover(<CreatePrefabPanel node={contextSelectedItem!} />)}
>
{t('editor:hierarchy.lbl-createPrefab')}
</Button>

{/* )} */}
</ContextMenu>
</>
)
Expand Down
Loading