correct file search order to give unofficial files precedence over official ones AND: correct usage of p/8 primitives folder

[MinnieTheMoocher]

Currently, import_ldraw.py reads:

paths = []
paths.append(file_directory)
paths.append(os.path.join(LDrawDir, "models"))
paths.append(os.path.join(LDrawDir, "parts"))
if HighRes:
    paths.append(os.path.join(LDrawDir, "p", "48"))
paths.append(os.path.join(LDrawDir, "p"))
paths.append(os.path.join(LDrawDir, "unofficial", "parts"))
if HighRes:
    paths.append(os.path.join(LDrawDir, "unofficial", "p", "48"))
else:
    paths.append(os.path.join(LDrawDir, "p", "8"))
paths.append(os.path.join(LDrawDir, "unofficial", "p"))

This gives official files precedence over unofficial ones.
This is not what you usually want.
Your usual usecase is that you download corrected or updated parts
from the LDRAW parts tracker to that "unofficial files" folder
and want them to take precedence over the official ones.

Thus, the above lines need to be reordered to:

paths = []
paths.append(file_directory)
paths.append(os.path.join(LDrawDir, "models"))
paths.append(os.path.join(LDrawDir, "unofficial", "parts"))
if HighRes:
    paths.append(os.path.join(LDrawDir, "unofficial", "p", "48"))
else:
    paths.append(os.path.join(LDrawDir, "p", "8"))
paths.append(os.path.join(LDrawDir, "unofficial", "p"))
paths.append(os.path.join(LDrawDir, "parts"))
if HighRes:
    paths.append(os.path.join(LDrawDir, "p", "48"))
paths.append(os.path.join(LDrawDir, "p"))

Additionally, the implementation of the p/8 folder is wrong:
(a) it must be searched both in official and unofficial files and
(b) it needs its own "LowRes" flag instead of depending on HighRes

Applying this correction, the above lines become:

paths = []
paths.append(file_directory)
paths.append(os.path.join(LDrawDir, "models"))
paths.append(os.path.join(LDrawDir, "unofficial", "parts"))
if HighRes:
    paths.append(os.path.join(LDrawDir, "unofficial", "p", "48"))
if LowRes:
    paths.append(os.path.join(LDrawDir, "unofficial", "p", "8"))
paths.append(os.path.join(LDrawDir, "unofficial", "p"))
paths.append(os.path.join(LDrawDir, "parts"))
if HighRes:
    paths.append(os.path.join(LDrawDir, "p", "48"))
if LowRes:
    paths.append(os.path.join(LDrawDir, "p", "8"))
paths.append(os.path.join(LDrawDir, "p"))

Note that in addition to the existing HighRes flag, a new flag LowRes flag needs to be introduced.

[le717]

Fixed in f0037a7. I should have already done this, but I'll add you to the list of authors. Do you want to go by Steffen or MinnieTheMoocher? 😉

[MinnieTheMoocher]

the latter, please. it's my github identity.

[MinnieTheMoocher]

your f0037a7 corrects the unofficial/official files search order, but the error with the p/8 folder is still in it.

it needs to be treated like this

paths = []
paths.append(file_directory)
paths.append(os.path.join(LDrawDir, "models"))
paths.append(os.path.join(LDrawDir, "unofficial", "parts"))
if HighRes:
paths.append(os.path.join(LDrawDir, "unofficial", "p", "48"))
elif LowRes:
paths.append(os.path.join(LDrawDir, "unofficial", "p", "8"))
paths.append(os.path.join(LDrawDir, "unofficial", "p"))
paths.append(os.path.join(LDrawDir, "parts"))
if HighRes:
paths.append(os.path.join(LDrawDir, "p", "48"))
elif LowRes:
paths.append(os.path.join(LDrawDir, "p", "8"))
paths.append(os.path.join(LDrawDir, "p"))

I.e.,
"When the HighRes flag is set to true, let the p/48 folder take precedence.
ELSE
When the LowRes flag is set to true, let the p/8 folder take precedence.
ELSE
Fallback to the p/ folder
"

[le717]

There is no LowRes variable (unless you are referring to #44), so it would actually be elif not HighRes.

Is this the proper formatting? Python uses indentation levels for if/elif/else. In this, parts/ and p/ are always searched no matter the value of HighRes. Do I need to move those under elif not HighRes as well? There really is no else in this section.

paths = []
paths.append(file_directory)
paths.append(os.path.join(LDrawDir, "models"))
paths.append(os.path.join(LDrawDir, "unofficial", "parts"))
if HighRes:
    paths.append(os.path.join(LDrawDir, "unofficial", "p", "48"))
elif not HighRes:
    paths.append(os.path.join(LDrawDir, "unofficial", "p", "8"))
    paths.append(os.path.join(LDrawDir, "unofficial", "p"))
paths.append(os.path.join(LDrawDir, "parts"))
if HighRes:
    paths.append(os.path.join(LDrawDir, "p", "48"))
elif not HighRes:
    paths.append(os.path.join(LDrawDir, "p", "8"))
paths.append(os.path.join(LDrawDir, "p"))

[MinnieTheMoocher]

no, "elif not HighRes" would be equal to "else" which is wrong here!:

the p/8 folder must ONLY be used if the user explicitly requests so.

the current implementation is wrong, because it always uses that folder if HighRes is NOT enabled,
which is wrong.

the fix is very simple!
just introduce a flag "LogRes" completely analogous to "HighRes", i.e., change

highResPrims = BoolProperty(
    name="Use High-Res Primitives",
    description="Replace all Primitives by Hi-Res (48ed) Primitives",
    default=False
)

to

highResPrims = BoolProperty(
    name="Use High-Res Primitives",
    description="Replace all Primitives by Hi-Res (48ed) Primitives",
    default=False
)

lowResPrims = BoolProperty(
    name="Use Low-Res Primitives",
    description="Replace all Primitives by Lo-Res (8ed) Primitives",
    default=False
)

and

    box.prop(self, "highResPrims", icon="MOD_BUILD")

to

    box.prop(self, "highResPrims", icon="MOD_BUILD")
    box.prop(self, "lowResPrims", icon="MOD_BUILD")

and

    global LDrawDir, CleanUp, GameFix, HighRes, CleanUpOpt
    LDrawDir = str(self.ldrawPath)
    HighRes = bool(self.highResPrims)

to

    global LDrawDir, CleanUp, GameFix, HighRes, LowRes, CleanUpOpt
    LDrawDir = str(self.ldrawPath)
    HighRes = bool(self.highResPrims)
    LowRes = bool(self.lowResPrims)

and

    if HighRes:
        debugPrint("High resolution bricks option selected")

to

    if HighRes:
        debugPrint("High resolution bricks option selected")
    if LowRes:
        debugPrint("Low resolution bricks option selected")

[MinnieTheMoocher]

in a future refacturing, you can merge these 2 boolean flags to a simple multiple choice:

• do no primtives replacement (default)
• always use High-Res primitives (this currently is the flag "HighRes")
• always use Low-Res primitives (this currently is the flag "LowRes")

[MinnieTheMoocher]

to make is simple, here is the corrected file (untested):
https://gist.github.com/MinnieTheMoocher/d337bb86864befd094b8

[le717]

Yikes the formatting. You might want to paste that in a Gist and edit your comment with the link.

[MinnieTheMoocher]

here it is :)

[le717]

I tested the patch and it works. However, I did edit it to make the options exclusive so both are not used (and clean up the options a bit) and to work better with your last patch. The layout looks like this now.

You can review the changes (and the descriptions) on the highres-or-lowres branch.

[rioforce]

What about "normal-res" primitives? All you have is low and high.

[le717]

I didn't show that option in the screenshots. ;)

[le717]

Fixed by #54, issue solved!