Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EAGLE-1310: Allow users to change node's category, even when the built-in palettes are not loaded #783

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

EAGLE-1310: Allow users to change node's category, even when the built-in palettes are not loaded #783

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1db6d97
Allow users to change node's category, even when the built-in palette…
james-strauss-uwa Nov 21, 2024
332f1e1
Factored out some node updating node to put it in Utils, and leave th…
james-strauss-uwa Nov 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
96 changes: 49 additions & 47 deletions src/Eagle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4543,15 +4543,15 @@ export class Eagle {
}

getEligibleNodeCategories : ko.PureComputed<Category[]> = ko.pureComputed(() => {
// if selectedNode is not set, return the list of all categories, even though it won't be rendered (I guess)
if (this.selectedNode() === null){
return Utils.getCategoriesWithInputsAndOutputs(Category.Type.Unknown, 0, 0);
let categoryType: Category.Type = Category.Type.Unknown;

if (this.selectedNode() !== null){
categoryType = this.selectedNode().getCategoryType();
}

// if selectedNode is not set, return the list of all categories, even though it won't be rendered (I guess)
// if selectedNode is set, return a list of categories within the same category type
const categoryType: Category.Type = this.selectedNode().getCategoryType();

return Utils.getCategoriesWithInputsAndOutputs(categoryType, this.selectedNode().getInputPorts().length, this.selectedNode().getOutputPorts().length);
return Utils.getCategoriesWithInputsAndOutputs(categoryType);
}, this)

inspectorChangeNodeCategoryRequest = (event: Event) : void => {
Expand All @@ -4577,61 +4577,63 @@ export class Eagle {

// get a reference to the builtin palette
james-strauss-uwa marked this conversation as resolved.
Show resolved Hide resolved
const builtinPalette: Palette = this.findPalette(Palette.BUILTIN_PALETTE_NAME, false);

// if no built-in palette can be found, then we can't use an example node from the built-in palette as a basis for the category change
// instead, we just blindly change the category. It is the best we can do
if (builtinPalette === null){
console.warn("Could not find builtin palette", Palette.BUILTIN_PALETTE_NAME);
return;
}
Utils.showNotification(Palette.BUILTIN_PALETTE_NAME + " palette not found", "Unable to transform node according to a template. Instead just changing category.", "warning");
} else {
// find node with new type in builtinPalette
const oldCategoryPrototype: Node = builtinPalette.findNodeByNameAndCategory(oldNode.getCategory());
const newCategoryPrototype: Node = builtinPalette.findNodeByNameAndCategory(newNodeCategory);

// find node with new type in builtinPalette
const oldCategoryPrototype: Node = builtinPalette.findNodeByNameAndCategory(oldNode.getCategory());
const newCategoryPrototype: Node = builtinPalette.findNodeByNameAndCategory(newNodeCategory);
// check that prototypes were found for old category and new category
if (oldCategoryPrototype === null || newCategoryPrototype === null){
console.warn("Prototypes for old and new categories could not be found in palettes", oldCategoryPrototype, newCategoryPrototype);
return;
}

// check that prototypes were found for old category and new category
if (oldCategoryPrototype === null || newCategoryPrototype === null){
console.warn("Prototypes for old and new categories could not be found in palettes", oldCategoryPrototype, newCategoryPrototype);
return;
}
// delete non-ports from the old node (loop backwards since we are deleting from the array as we loop)
for (let i = oldNode.getFields().length - 1 ; i >= 0; i--){
const field: Field = oldNode.getFields()[i];

// delete non-ports from the old node (loop backwards since we are deleting from the array as we loop)
for (let i = oldNode.getFields().length - 1 ; i >= 0; i--){
const field: Field = oldNode.getFields()[i];
if (field.isInputPort() || field.isOutputPort()){
continue;
}

if (field.isInputPort() || field.isOutputPort()){
continue;
oldNode.removeFieldById(field.getId());
}

oldNode.removeFieldById(field.getId());
}

// copy non-ports from new category to old node
for (const field of newCategoryPrototype.getFields()){
if (field.isInputPort() || field.isOutputPort()){
continue;
}
// copy non-ports from new category to old node
for (const field of newCategoryPrototype.getFields()){
if (field.isInputPort() || field.isOutputPort()){
continue;
}

// try to find field in old node that matches by displayText AND parameterType
let destField = oldNode.findFieldByDisplayText(field.getDisplayText(), field.getParameterType());
// try to find field in old node that matches by displayText AND parameterType
let destField = oldNode.findFieldByDisplayText(field.getDisplayText(), field.getParameterType());

// if dest field could not be found, then go ahead and add a NEW field to the dest node
if (destField === null){
destField = field.clone();
oldNode.addField(destField);
// if dest field could not be found, then go ahead and add a NEW field to the dest node
if (destField === null){
destField = field.clone();
oldNode.addField(destField);
}

// copy everything about the field from the src (palette), except maintain the existing id and nodeKey
destField.copyWithIds(field, destField.getNodeId(), destField.getId());
}

// copy everything about the field from the src (palette), except maintain the existing id and nodeKey
destField.copyWithIds(field, destField.getNodeId(), destField.getId());
}

// copy name and description from new category to old node, if old node values are defaults
if (oldNode.getName() === oldCategoryPrototype.getName()){
oldNode.setName(newCategoryPrototype.getName());
}
// copy name and description from new category to old node, if old node values are defaults
if (oldNode.getName() === oldCategoryPrototype.getName()){
oldNode.setName(newCategoryPrototype.getName());
}

if (oldNode.getDescription() === oldCategoryPrototype.getDescription()){
oldNode.setDescription(newCategoryPrototype.getDescription());
if (oldNode.getDescription() === oldCategoryPrototype.getDescription()){
oldNode.setDescription(newCategoryPrototype.getDescription());
}
}

this.selectedNode().setCategory(newNodeCategory);
oldNode.setCategory(newNodeCategory);
james-strauss-uwa marked this conversation as resolved.
Show resolved Hide resolved

this.flagActiveFileModified();
this.checkGraph();
Expand Down
5 changes: 3 additions & 2 deletions src/Utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1084,14 +1084,15 @@ export class Utils {
return result;
}

static getCategoriesWithInputsAndOutputs(categoryType: Category.Type, numRequiredInputs: number, numRequiredOutputs: number) : Category[] {
static getCategoriesWithInputsAndOutputs(categoryType: Category.Type) : Category[] {
const eagle = Eagle.getInstance();

// get a reference to the builtin palette
const builtinPalette: Palette = eagle.findPalette(Palette.BUILTIN_PALETTE_NAME, false);
if (builtinPalette === null){
// if no built-in palette is found, then build a list from the EAGLE categoryData
console.warn("Could not find builtin palette", Palette.BUILTIN_PALETTE_NAME);
return null;
return Utils.buildComponentList((cData: Category.CategoryData) => {return cData.categoryType === categoryType});
}

const matchingNodes = builtinPalette.getNodesByCategoryType(categoryType)
Expand Down