diff --git a/doc/Localization_guide.md b/doc/Localization_guide.md new file mode 100644 index 000000000..33fcc1c08 --- /dev/null +++ b/doc/Localization_guide.md @@ -0,0 +1,76 @@ +# Localization and translation guide + +The purpose of this guide is to describe how to contribute to the Slic3rPE translations. We use GNUgettext for extracting string resources from the project and PoEdit for editing translations. + +Those are possible to download here: +- https://sourceforge.net/directory/os:windows/?q=gnu+gettext GNUgettext package contains a set of tools to extract strings from the source code and to create the translation Catalog. +- https://poedit.net PoEdit provides good interface for the translators. + +After GNUgettext is installed it is recommended to add the path to gettext/bin to PATH variable. + +Full manual for GNUgettext you can see here: http://www.gnu.org/software/gettext/manual/gettext.html + + +### Scenario 1. How do I add a translation or fix the existing translation +1. Get PO-file from corresponding folder here: +https://github.com/prusa3d/Slic3r/tree/master/resources/localization +2. Open this file in PoEdit as "Edit a translation" +3. Apply your corrections to translation +4. Push changed Slic3rPE.po and Slic3rPE.mo (will create automatically after saving of Slic3r.po in PoEdit) back to to the enter folder. + +### Scenario 2. How do I add a new language support +1. Get file Slic3rPE.pot here : +https://github.com/prusa3d/Slic3r/tree/master/resources/localization +2. Open it in PoEdit for "Create new translation" +3. Select Translation Language (for example French). +4. As a result you will have fr.po - the file contaning translation to French. +Notice. When the transtation is complete you need to: + - Rename the file to Slic3rPE.po + - Click "Save file" button. Slic3rPE.mo will be created immediatly + - Both Slic3rPE.po and Slic3rPE.mo have to be saved here: +https://github.com/prusa3d/Slic3r/tree/master/resources/localization/fr +( name of folder "fr" means "French" - the translation language). + +### Scenario 3. How do I add a new text resource when implementing a feature to Slic3rPE +Each string resource in Slic3rPE available for translation needs to be explicitly marked using L() macro like this: +```C++ +auto msg = L("This message to be localized") +``` +To get translated text use one of needed macro/function (`_(s)`, `_CHB(s)` or `L_str(s)` ). +If you add new file resourse, add it to list of files contaned macro `L()` + +### Scenario 4. How do I use GNUgettext to localize my own application taking Slic3rPE as an example + +1. For conviniance create list of files with this macro `L(s)`. We have +https://github.com/prusa3d/Slic3r/tree/master/resources/localization/list.txt. + +2. Create template file(*.POT) with GNUgettext command: + ``` + xgettext --keyword=L --from-code=UTF-8 --debug -o Slic3rPE.pot -f list.txt + ``` + + Use flag `--from-code=UTF-8` to specify that the source strings are in UTF-8 encoding + Use flag `--debug` to correctly extract formated strings(used %d, %s etc.) + +3. Create PO- and MO-files for your project as described above. + +4. To merge old PO-file with strings from creaded new POT-file use command: + ``` + msgmerge -N -o new.po old.po new.pot + ``` + Use option `-N` to not using fuzzy matching when an exact match is not found. + +5. To concatenate old PO-file with strings from new PO-file use command: + ``` + msgcat -o new.po old.po + ``` + +6. Create an English translation catalog with command: + ``` + msgen -o new.po old.po + ``` + Notice, in this Catalog it will be totally same strings for initial text and translated. + +When you have Catalog to translation open POT or PO file in PoEdit and start to translation. +It's very important to keep attention to every gaps and punctuation. Especially with +formated strings. (used %d, %s etc.) \ No newline at end of file diff --git a/doc/Localization_manual.txt b/doc/Localization_manual.txt deleted file mode 100644 index f31d2c7f6..000000000 --- a/doc/Localization_manual.txt +++ /dev/null @@ -1,45 +0,0 @@ -From the begining you need to have GNUgettext and PoEdit. -GNUgettext package contains a set of tools to extract strings from the source code and -to create the Catalog to translation. -PoEdit provide good interface for the translators. - -Those are possible to download here: - GNUgettext - https://sourceforge.net/directory/os:windows/?q=gnu+gettext - PoEdit - https://poedit.net/ - -When GNUgettext and poEdit are downloaded and installationed, next step is -to add path to gettext/bin directory to your PATH variable. -You can use gettext from cmdline now. - - -In Slic3rPE we have one macro (L) used to markup strings to localizations. - -So, to create Catalog to translation there are next steps: - 1. create list of files with this macro (list.txt) - - 2. create template file(*.POT) with command: - xgettext --keyword=L --from-code=UTF-8 --debug -o Slic3rPE.pot -f list.txt - Use flag --from-code=UTF-8 to specify that the source strings are in UTF-8 encoding - Use flag --debug to correctly extract formated strings(used %d, %s etc.) - - 3.1 if you start to create PO-file for your projest just open this POT-file in PoEdit. - When you select translation language after first opening of POT-files, - PO-file will be created immediatly. - - 3.2 if you already have PO-file created before, you have to merge old PO-file with - strings from creaded POT-file. You can do that with command: - msgmerge -N -o new.po old.po new.pot - Use option -N to not using fuzzy matching when an exact match is not found. - - 3.3 if you already have PO-file created before and new PO-file created from new sourse files - which is not related with first one, you have to concatenate old PO-file with - strings from new PO-file. You can do that with command: - msgcat -o new.po old.po - - 4. create an English translation catalog with command: - msgen -o new.po old.po - Notice, in this Catalog it will be totally same strings for initial text and translated. - -When you have Catalog to translation open POT or PO file in PoEdit and start to translation. -It's very important to keep attention to every gaps and punctuation. Especially with -formated strings. (used %d, %s etc.) \ No newline at end of file diff --git a/xs/src/libslic3r/Fill/FillGyroid.cpp b/xs/src/libslic3r/Fill/FillGyroid.cpp index 5fb16ba4d..e63ce0bfd 100644 --- a/xs/src/libslic3r/Fill/FillGyroid.cpp +++ b/xs/src/libslic3r/Fill/FillGyroid.cpp @@ -9,149 +9,74 @@ namespace Slic3r { -Polyline FillGyroid::makeLineVert(double xPos, double yPos, double width, double height, double currentXBegin, double segmentSize, coord_t scaleFactor, - double zCs, double zSn, bool flip, double decal){ - double maxSlope = abs(abs(zCs)-abs(zSn)); - Polyline polyline; - polyline.points.push_back(Point(coord_t((std::max(std::min(currentXBegin, xPos+width),xPos) + decal) * scaleFactor), coord_t(yPos * scaleFactor))); - for(double y=yPos;yyPos+height) y = yPos+height; - double ySn = sin(y +(zCs<0?3.14:0) + 3.14); - double yCs = cos(y +(zCs<0?3.14:0) + 3.14+(!flip?0:3.14)); - - double a = ySn; - double b = -zCs; - double res = zSn*yCs; - double r = sqrt(a*a + b*b); - double x = asin(a/r) + asin(res/r) +3.14; - x += currentXBegin; - - double ydeviation = 0.5*(flip?-1:1)*(zSn>0?-1:1)*decal*(1-maxSlope)*(res/r - a/r); - polyline.points.push_back(Point(coord_t((std::max(std::min(x, xPos+width),xPos)+decal-ydeviation/2) * scaleFactor), coord_t((y + ydeviation) * scaleFactor))); - } - - return polyline; -} - -Polyline FillGyroid::makeLineHori(double xPos, double yPos, double width, double height, double currentYBegin, double segmentSize, coord_t scaleFactor, - double zCs, double zSn, bool flip, double decal){ - double maxSlope = abs(abs(zCs)-abs(zSn)); - Polyline polyline; - polyline.points.push_back(Point(coord_t(xPos * scaleFactor), coord_t((std::max(std::min(currentYBegin, yPos+height),yPos)+decal) * scaleFactor))); - for(double x=xPos;xxPos+width) x = xPos+width; - double xSn = sin(x +(zSn<0?3.14:0) +(flip?0:3.14)); - double xCs = cos(x +(zSn<0?3.14:0) ); - - double a = xCs; - double b = -zSn; - double res = zCs*xSn; - double r = sqrt(a*a + b*b); - double y = asin(a/r) + asin(res/r) +3.14/2; - y += currentYBegin; - - double xdeviation = 0.5*(flip?-1:1)*(zCs>0?-1:1)*decal*(1-maxSlope)*(res/r - a/r); - polyline.points.push_back(Point(coord_t((x + xdeviation) * scaleFactor), coord_t((std::max(std::min(y, yPos+height),yPos)+decal-xdeviation/2) * scaleFactor))); - } - - return polyline; -} - -inline void FillGyroid::correctOrderAndAdd(const int num, Polyline poly, Polylines &array){ - if(num%2==0){ - Points temp(poly.points.rbegin(), poly.points.rend()); - poly.points.assign(temp.begin(),temp.end()); - } - array.push_back(poly); -} - -// Generate a set of curves (array of array of 2d points) that describe a -// horizontal slice of a truncated regular octahedron with a specified -// grid square size. -Polylines FillGyroid::makeGrid(coord_t gridZ, double density, double layer_width, size_t gridWidth, size_t gridHeight, size_t curveType) +static inline Polyline make_wave_vertical( + double width, double height, double x0, + double segmentSize, double scaleFactor, + double z_cos, double z_sin, bool flip) { - coord_t scaleFactor = coord_t(scale_(layer_width) / density); - Polylines result; - Polyline *polyline2; - double segmentSize = density/2; - double decal = layer_width*density; - double xPos = 0, yPos=0, width=gridWidth, height=gridHeight; - //scale factor for 5% : 8 712 388 - // 1z = 10^-6 mm ? - double z = gridZ/(1.0 * scaleFactor); - double zSn = sin(z); - double zCs = cos(z); - - - int numLine = 0; - - if(abs(zSn)<=abs(zCs)){ - //vertical - //begin to first one - int iter = 1; - double currentXBegin = xPos - PI/2; - currentXBegin = PI*(int)(currentXBegin/PI -1); - iter = (int)(currentXBegin/PI +1)%2; - bool flip = iter%2==1; - // bool needNewLine =false; - while(currentXBegin(Pointf(x, y) * scaleFactor)); + } + if (flip) + std::reverse(polyline.points.begin(), polyline.points.end()); + return polyline; +} + +static inline Polyline make_wave_horizontal( + double width, double height, double y0, + double segmentSize, double scaleFactor, + double z_cos, double z_sin, bool flip) +{ + Polyline polyline; + polyline.points.emplace_back(Point(0, coord_t(clamp(0., height, y0) * scaleFactor))); + double phase_offset_sin = (z_sin < 0 ? M_PI : 0) + (flip ? 0 : M_PI); + double phase_offset_cos = z_sin < 0 ? M_PI : 0.; + for (double x=0.; x < width + segmentSize; x += segmentSize) { + x = std::min(x, width); + double a = cos(x + phase_offset_cos); + double b = - z_sin; + double res = z_cos * sin(x + phase_offset_sin); + double r = sqrt(sqr(a) + sqr(b)); + double y = clamp(0., height, asin(a/r) + asin(res/r) + 0.5 * M_PI + y0); + polyline.points.emplace_back(convert_to(Pointf(x, y) * scaleFactor)); + } + if (flip) + std::reverse(polyline.points.begin(), polyline.points.end()); + return polyline; +} + +static Polylines make_gyroid_waves(double gridZ, double density, double layer_width, double width, double height) +{ + double scaleFactor = scale_(layer_width) / density; + double segmentSize = 0.5 * density; + //scale factor for 5% : 8 712 388 + // 1z = 10^-6 mm ? + double z = gridZ / scaleFactor; + double z_sin = sin(z); + double z_cos = cos(z); + Polylines result; + if (abs(z_sin) <= abs(z_cos)) { + // Vertical wave + double x0 = M_PI * (int)((- 0.5 * M_PI) / M_PI - 1.); + bool flip = ((int)(x0 / M_PI + 1.) & 1) != 0; + for (; x0 < width - 0.5 * M_PI; x0 += M_PI, flip = ! flip) + result.emplace_back(make_wave_vertical(width, height, x0, segmentSize, scaleFactor, z_cos, z_sin, flip)); + } else { + // Horizontal wave + bool flip = true; + for (double y0 = 0.; y0 < width; y0 += M_PI, flip = !flip) + result.emplace_back(make_wave_horizontal(width, height, y0, segmentSize, scaleFactor, z_cos, z_sin, flip)); } - return result; } @@ -170,18 +95,16 @@ void FillGyroid::_fill_surface_single( bb.merge(_align_to_grid(bb.min, Point(2*M_PI*distance, 2*M_PI*distance))); // generate pattern - Polylines polylines = makeGrid( - (coord_t)scale_(this->z), + Polylines polylines = make_gyroid_waves( + scale_(this->z), params.density*this->scaling, this->spacing, - (size_t)(ceil(bb.size().x / distance) + 1), - (size_t)(ceil(bb.size().y / distance) + 1), - (size_t)(((this->layer_id/thickness_layers) % 2) + 1) ); + ceil(bb.size().x / distance) + 1., + ceil(bb.size().y / distance) + 1.); // move pattern in place - for (Polylines::iterator it = polylines.begin(); it != polylines.end(); ++ it) - it->translate(bb.min.x, bb.min.y); - + for (Polyline &polyline : polylines) + polyline.translate(bb.min.x, bb.min.y); // clip pattern to boundaries polylines = intersection_pl(polylines, (Polygons)expolygon); @@ -198,18 +121,14 @@ void FillGyroid::_fill_surface_single( } } Polylines chained = PolylineCollection::chained_path_from( -#if SLIC3R_CPPVER >= 11 std::move(polylines), -#else - polylines, -#endif PolylineCollection::leftmost_point(polylines), false); // reverse allowed bool first = true; - for (Polylines::iterator it_polyline = chained.begin(); it_polyline != chained.end(); ++ it_polyline) { + for (Polyline &polyline : chained) { if (! first) { // Try to connect the lines. Points &pts_end = polylines_out.back().points; - const Point &first_point = it_polyline->points.front(); + const Point &first_point = polyline.points.front(); const Point &last_point = pts_end.back(); // TODO: we should also check that both points are on a fill_boundary to avoid // connecting paths on the boundaries of internal regions @@ -217,17 +136,12 @@ void FillGyroid::_fill_surface_single( if (first_point.distance_to(last_point) <= 5 * distance && expolygon_off.contains(Line(last_point, first_point))) { // Append the polyline. - pts_end.insert(pts_end.end(), it_polyline->points.begin(), it_polyline->points.end()); + pts_end.insert(pts_end.end(), polyline.points.begin(), polyline.points.end()); continue; } } // The lines cannot be connected. -#if SLIC3R_CPPVER >= 11 - polylines_out.push_back(std::move(*it_polyline)); -#else - polylines_out.push_back(Polyline()); - std::swap(polylines_out.back(), *it_polyline); -#endif + polylines_out.emplace_back(std::move(polyline)); first = false; } } diff --git a/xs/src/libslic3r/Fill/FillGyroid.hpp b/xs/src/libslic3r/Fill/FillGyroid.hpp index 4467a88de..758652a5c 100644 --- a/xs/src/libslic3r/Fill/FillGyroid.hpp +++ b/xs/src/libslic3r/Fill/FillGyroid.hpp @@ -1,8 +1,6 @@ #ifndef slic3r_FillGyroid_hpp_ #define slic3r_FillGyroid_hpp_ -#include - #include "../libslic3r.h" #include "FillBase.hpp" @@ -12,10 +10,8 @@ namespace Slic3r { class FillGyroid : public Fill { public: - - FillGyroid(){ scaling = 1.75; } - virtual Fill* clone() const { return new FillGyroid(*this); }; - virtual ~FillGyroid() {} + FillGyroid() {} + virtual Fill* clone() const { return new FillGyroid(*this); } // require bridge flow since most of this pattern hangs in air virtual bool use_bridge_flow() const { return true; } @@ -23,8 +19,7 @@ public: protected: // mult of density, to have a good %of weight for each density parameter - float scaling; - + float scaling = 1.75; virtual void _fill_surface_single( const FillParams ¶ms, @@ -32,22 +27,6 @@ protected: const std::pair &direction, ExPolygon &expolygon, Polylines &polylines_out); - - // create the gyroid grid to clip. - Polylines makeGrid(coord_t gridZ, double density, double layer_width, size_t gridWidth, size_t gridHeight, size_t curveType); - //add line poly in reverse if needed into array - inline void correctOrderAndAdd(const int num, Polyline poly, Polylines &array); - //create a curved horinzontal line (for each x, compute y) - Polyline makeLineHori(double xPos, double yPos, double width, double height, - double currentYBegin, double segmentSize, coord_t scaleFactor, - double zCs, double zSn, - bool flip, double decal=0); - //create a curved vertival line (for each y, compute x) - Polyline makeLineVert(double xPos, double yPos, double width, double height, - double currentXBegin, double segmentSize, coord_t scaleFactor, - double zCs, double zSn, - bool flip, double decal=0); - }; } // namespace Slic3r