Skip to content

refactor: Improve base Modifier class design #190

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

Draft
andeplane wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

refactor: Improve base Modifier class design #190

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7c23377
refactor: Improve base Modifier class design
cursoragent Nov 1, 2025
b21686c
refactor: Update Modifier subclasses to implement abstract run() method
cursoragent Nov 1, 2025
1bdcb29
fix: Remove return statements to match void return type
cursoragent Nov 1, 2025
37194c6
fix: Pass everything parameter to runByType in ColorModifier
cursoragent Nov 1, 2025
8f09583
Merge branch 'main' into cursor/fix-issue-187-and-create-pr-9f41
andeplane Nov 1, 2025
ed1e00a
fix: Address PR review comments for modifier implementations
cursoragent Nov 1, 2025
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
8 changes: 6 additions & 2 deletions src/modifiers/colormodifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,13 +214,17 @@ class ColorModifier extends Modifier {
this.previousColoringMethod = "type";
};

run = (input: ModifierInput, output: ModifierOutput) => {
run(
input: ModifierInput,
output: ModifierOutput,
everything: boolean = false,
): void {
if (this.computeName) {
this.runByProperty(input, output);
} else {
this.runByType(input, output);
}
};
}
}

export default ColorModifier;
8 changes: 4 additions & 4 deletions src/modifiers/modifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ interface ModifierProps {
active: boolean;
}

class Modifier {
abstract class Modifier {
public name: string;
public key: string;
public active: boolean;
Expand All @@ -16,10 +16,10 @@ class Modifier {
this.active = active;
}

run = (
abstract run(
input: ModifierInput,
output: ModifierOutput,
everything: boolean = false,
) => {};
everything?: boolean
): void;
}
export default Modifier;
10 changes: 7 additions & 3 deletions src/modifiers/syncbondsmodifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ class SyncBondsModifier extends Modifier {
super({ name, active });
}

run = (input: ModifierInput, output: ModifierOutput) => {
run(
input: ModifierInput,
output: ModifierOutput,
everything: boolean = false,
): void {
if (!this.active) {
if (output.bonds) {
output.bonds.count = 0;
Expand Down Expand Up @@ -43,7 +47,7 @@ class SyncBondsModifier extends Modifier {
if (newBonds.mesh) {
newBonds.mesh.count = numBonds;
}
return newBonds;
return;
}

const bonds1Ptr = input.lammps.getBondsPosition1Pointer() / 4;
Expand All @@ -64,7 +68,7 @@ class SyncBondsModifier extends Modifier {
newBonds.mesh.count = numBonds;
}
newBonds.markNeedsUpdate();
};
}
}

export default SyncBondsModifier;
6 changes: 3 additions & 3 deletions src/modifiers/synccomputesmodifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ class SyncComputesModifier extends Modifier {
super({ name, active });
}

run = (
run(
input: ModifierInput,
output: ModifierOutput,
everything: boolean = false,
) => {
): void {
if (!this.active || !input.hasSynchronized) {
return;
}
Expand Down Expand Up @@ -121,7 +121,7 @@ class SyncComputesModifier extends Modifier {
}
output.computes[name] = compute;
}
};
}
}

export default SyncComputesModifier;
6 changes: 3 additions & 3 deletions src/modifiers/syncfixesmodifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ class SyncFixesModifier extends Modifier {
super({ name, active });
}

run = (
run(
input: ModifierInput,
output: ModifierOutput,
everything: boolean = false,
) => {
): void {
if (!this.active || !input.hasSynchronized) {
return;
}
Expand Down Expand Up @@ -116,7 +116,7 @@ class SyncFixesModifier extends Modifier {
}
output.fixes[name] = fix;
}
};
}
}

export default SyncFixesModifier;
7 changes: 3 additions & 4 deletions src/modifiers/syncparticlesmodifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ class SyncParticlesModifier extends Modifier {
super({ name, active });
}

run = (
run(
input: ModifierInput,
output: ModifierOutput,
everything: boolean = false,
) => {
): void {
if (!this.active) {
if (output.particles) {
output.particles.count = 0;
Expand Down Expand Up @@ -75,8 +75,7 @@ class SyncParticlesModifier extends Modifier {
}

newParticles.markNeedsUpdate();
return newParticles;
};
}
}

export default SyncParticlesModifier;
6 changes: 3 additions & 3 deletions src/modifiers/syncvariablesmodifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ class SyncVariablesModifier extends Modifier {
super({ name, active });
}

run = (
run(
input: ModifierInput,
output: ModifierOutput,
everything: boolean = false,
) => {
): void {
if (!this.active || !input.hasSynchronized) {
return;
}
Expand Down Expand Up @@ -118,7 +118,7 @@ class SyncVariablesModifier extends Modifier {
}
output.variables[name] = variable;
}
};
}
}

export default SyncVariablesModifier;