Feature: Named views (#5532)
* feature: building skeleton for adding a viewpoint in frontend as well as rust with the settings toml * chore: named views loaded into memory * fix: testing code * chore: saving off progress, skeleton for listing and deleting named views * fix: fixed state stale dereferencing issue * feat: initial skeleton for loading view points * fix: pushing bug * fix: saving off progress * fix: trying to update to main? * fix: main fixes, API fixes * fix: what is happening * fix: ope * fix: implemented default values on serde * fix: pushing working dev code... need to clean it up * feature: adding no results found on filteroptions within an options input, not just command input bar level * fix: initial PR cleanup pass of junky code * fix: addressing comments in initial pass * fix: addressing PR comments * fix: moved modeling.namedViews to app.namedViews as per request * fix: _id and _version are now id and version. * fix: python codespell, perspective * fix: cargo fmt * fix: updating description of the named view commands * fix: removing testing code * fix: feature flag this to DEV only * fix: ts ignore for production engine api * fix: deep parital fights arrays and objects within settings, doing a namedview type predicate checking * fix: auto fixes * Remove unnecessary alias * Reword toast messages (more consistency) * fmt * cargo clippy * Fix Set appearance flakes * cargo test * fix: removing pub since the toml_stringify was refactored * fix: adding ignore this on user level * A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores) * chore: Vec<NamedView> to HashMap<uuid::Uuid,NamedView> * fix: removing debugging code * chore: HashMap to IndexMap * fix: remove testing code --------- Co-authored-by: 49lf <ircsurfer33@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Kevin Nadro
GitHub
229
src/lib/commandBarConfigs/namedViewsConfig.ts
Normal file
229
src/lib/commandBarConfigs/namedViewsConfig.ts
Normal file
@ -0,0 +1,229 @@
|
||||
import { NamedView } from 'wasm-lib/kcl/bindings/NamedView'
|
||||
import { Command, CommandArgumentOption } from '../commandTypes'
|
||||
import toast from 'react-hot-toast'
|
||||
import { engineCommandManager } from 'lib/singletons'
|
||||
import { uuidv4 } from 'lib/utils'
|
||||
import { settingsActor } from 'machines/appMachine'
|
||||
import { reportRejection } from 'lib/trap'
|
||||
|
||||
export function createNamedViewsCommand() {
|
||||
// Creates a command to be registered in the command bar.
|
||||
// The createNamedViewsCommand will prompt the user for a name and then
|
||||
// hit the engine for the camera properties and write them back to disk
|
||||
// in project.toml.
|
||||
const createNamedViewCommand: Command = {
|
||||
name: 'Create named view',
|
||||
displayName: `Create named view`,
|
||||
description:
|
||||
'Saves a named view based on your current view to load again later',
|
||||
groupId: 'namedViews',
|
||||
icon: 'settings',
|
||||
needsReview: false,
|
||||
onSubmit: (data) => {
|
||||
const invokeAndForgetCreateNamedView = async () => {
|
||||
if (!data) {
|
||||
return toast.error('Unable to create named view, missing name')
|
||||
}
|
||||
|
||||
// Retrieve camera view state from the engine
|
||||
const cameraGetViewResponse =
|
||||
await engineCommandManager.sendSceneCommand({
|
||||
type: 'modeling_cmd_req',
|
||||
cmd_id: uuidv4(),
|
||||
// @ts-ignore TODO: Not in production yet.
|
||||
cmd: { type: 'default_camera_get_view' },
|
||||
})
|
||||
|
||||
if (!(cameraGetViewResponse && 'resp' in cameraGetViewResponse)) {
|
||||
return toast.error('Unable to create named view, websocket failure')
|
||||
}
|
||||
|
||||
if ('modeling_response' in cameraGetViewResponse.resp.data) {
|
||||
// @ts-ignore TODO: Not in production yet.
|
||||
const view = cameraGetViewResponse.resp.data.modeling_response.data
|
||||
// Create a new named view
|
||||
const requestedView: NamedView = {
|
||||
name: data.name,
|
||||
...view.view,
|
||||
}
|
||||
// Retrieve application state for namedViews
|
||||
const namedViews = {
|
||||
...settingsActor.getSnapshot().context.app.namedViews.current,
|
||||
}
|
||||
|
||||
// Create and set namedViews application state
|
||||
const uniqueUuidV4 = uuidv4()
|
||||
const requestedNamedViews = {
|
||||
...namedViews,
|
||||
[uniqueUuidV4]: requestedView,
|
||||
}
|
||||
settingsActor.send({
|
||||
type: `set.app.namedViews`,
|
||||
data: {
|
||||
level: 'project',
|
||||
value: requestedNamedViews,
|
||||
},
|
||||
})
|
||||
toast.success(`Named view ${requestedView.name} created.`)
|
||||
}
|
||||
}
|
||||
invokeAndForgetCreateNamedView().catch(reportRejection)
|
||||
},
|
||||
args: {
|
||||
name: {
|
||||
required: true,
|
||||
inputType: 'string',
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
// Given a named view selection from the command bar, this will
|
||||
// find it in the setting state, remove it from the array and
|
||||
// rewrite the project.toml settings to disk to delete the named view
|
||||
const deleteNamedViewCommand: Command = {
|
||||
name: 'Delete named view',
|
||||
displayName: `Delete named view`,
|
||||
description: 'Deletes the named view from settings',
|
||||
groupId: 'namedViews',
|
||||
icon: 'settings',
|
||||
needsReview: false,
|
||||
onSubmit: (data) => {
|
||||
if (!data) {
|
||||
return toast.error('Unable to delete named view, missing name')
|
||||
}
|
||||
const idToDelete = data.name
|
||||
|
||||
// Retrieve application state for namedViews
|
||||
|
||||
const namedViews = {
|
||||
...settingsActor.getSnapshot().context.app.namedViews.current,
|
||||
}
|
||||
|
||||
const { [idToDelete]: viewToDelete, ...rest } = namedViews
|
||||
|
||||
// Find the named view in the array
|
||||
if (idToDelete && viewToDelete) {
|
||||
// Update global state with the new computed state
|
||||
settingsActor.send({
|
||||
type: `set.app.namedViews`,
|
||||
data: {
|
||||
level: 'project',
|
||||
value: rest,
|
||||
},
|
||||
})
|
||||
toast.success(`Named view ${viewToDelete.name} removed.`)
|
||||
} else {
|
||||
toast.error(`Unable to delete, could not find the named view`)
|
||||
}
|
||||
},
|
||||
args: {
|
||||
name: {
|
||||
required: true,
|
||||
inputType: 'options',
|
||||
options: () => {
|
||||
const namedViews = {
|
||||
...settingsActor.getSnapshot().context.app.namedViews.current,
|
||||
}
|
||||
const options: CommandArgumentOption<any>[] = []
|
||||
Object.entries(namedViews).forEach(([key, view]) => {
|
||||
if (view) {
|
||||
options.push({
|
||||
name: view.name,
|
||||
isCurrent: false,
|
||||
value: key,
|
||||
})
|
||||
}
|
||||
})
|
||||
return options
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
// Read the named view from settings state and pass that camera information to the engine command to set the view of the engine camera
|
||||
const loadNamedViewCommand: Command = {
|
||||
name: 'Load named view',
|
||||
displayName: `Load named view`,
|
||||
description: 'Loads your camera to the named view',
|
||||
groupId: 'namedViews',
|
||||
icon: 'settings',
|
||||
needsReview: false,
|
||||
onSubmit: (data) => {
|
||||
const invokeAndForgetLoadNamedView = async () => {
|
||||
if (!data) {
|
||||
return toast.error('Unable to load named view')
|
||||
}
|
||||
|
||||
// Retrieve application state for namedViews
|
||||
const namedViews = {
|
||||
...settingsActor.getSnapshot().context.app.namedViews.current,
|
||||
}
|
||||
|
||||
const idToLoad = data.name
|
||||
const viewToLoad = namedViews[idToLoad]
|
||||
if (viewToLoad) {
|
||||
// Split into the name and the engine data
|
||||
const { name, version, ...engineViewData } = viewToLoad
|
||||
|
||||
// Only send the specific camera information, the NamedView itself
|
||||
// is not directly compatible with the engine API
|
||||
await engineCommandManager.sendSceneCommand({
|
||||
type: 'modeling_cmd_req',
|
||||
cmd_id: uuidv4(),
|
||||
cmd: {
|
||||
// @ts-ignore TODO: Not in production yet.
|
||||
type: 'default_camera_set_view',
|
||||
view: {
|
||||
...engineViewData,
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
const isPerpsective = !engineViewData.is_ortho
|
||||
|
||||
// Update the GUI for orthographic and projection
|
||||
settingsActor.send({
|
||||
type: 'set.modeling.cameraProjection',
|
||||
data: {
|
||||
level: 'user',
|
||||
value: isPerpsective ? 'perspective' : 'orthographic',
|
||||
},
|
||||
})
|
||||
|
||||
toast.success(`Named view ${name} loaded.`)
|
||||
} else {
|
||||
toast.error(`Unable to load named view, could not find named view`)
|
||||
}
|
||||
}
|
||||
invokeAndForgetLoadNamedView().catch(reportRejection)
|
||||
},
|
||||
args: {
|
||||
name: {
|
||||
required: true,
|
||||
inputType: 'options',
|
||||
options: () => {
|
||||
const namedViews = {
|
||||
...settingsActor.getSnapshot().context.app.namedViews.current,
|
||||
}
|
||||
const options: CommandArgumentOption<any>[] = []
|
||||
Object.entries(namedViews).forEach(([key, view]) => {
|
||||
if (view) {
|
||||
options.push({
|
||||
name: view.name,
|
||||
isCurrent: false,
|
||||
value: key,
|
||||
})
|
||||
}
|
||||
})
|
||||
return options
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
return {
|
||||
createNamedViewCommand,
|
||||
deleteNamedViewCommand,
|
||||
loadNamedViewCommand,
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user