Skip to content

Commit e7901be

Browse files
committed
Updating libslic3r documentation from slic3r repository. Commit: slic3r/Slic3r@4fcbebf.
1 parent c0a1c15 commit e7901be

25 files changed

+453
-485
lines changed

libslic3r-doc/_config_8hpp_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
<div class="ttc" id="class_slic3r_1_1_invalid_option_type_html"><div class="ttname"><a href="class_slic3r_1_1_invalid_option_type.html">Slic3r::InvalidOptionType</a></div><div class="ttdoc">Exception class for type mismatches. </div><div class="ttdef"><b>Definition:</b> Config.hpp:28</div></div>
8686
<div class="ttc" id="class_slic3r_1_1_config_html"><div class="ttname"><a href="class_slic3r_1_1_config.html">Slic3r::Config</a></div><div class="ttdef"><b>Definition:</b> Config.hpp:37</div></div>
8787
<div class="ttc" id="class_slic3r_1_1_config_html_a757a79832bffdb9255f0a35c3a5b3c39"><div class="ttname"><a href="class_slic3r_1_1_config.html#a757a79832bffdb9255f0a35c3a5b3c39">Slic3r::Config::get_ptr</a></div><div class="ttdeci">T * get_ptr(const t_config_option_key &amp;opt_key, bool create=true)</div><div class="ttdoc">Template function to dynamic cast and leave it in pointer form. </div><div class="ttdef"><b>Definition:</b> Config.hpp:83</div></div>
88-
<div class="ttc" id="namespace_slic3r_html_a856a62a1c70a0b6e84d9cd36344ba131"><div class="ttname"><a href="namespace_slic3r.html#a856a62a1c70a0b6e84d9cd36344ba131">Slic3r::print_config_def</a></div><div class="ttdeci">const PrintConfigDef print_config_def</div><div class="ttdef"><b>Definition:</b> PrintConfig.cpp:1764</div></div>
88+
<div class="ttc" id="namespace_slic3r_html_a856a62a1c70a0b6e84d9cd36344ba131"><div class="ttname"><a href="namespace_slic3r.html#a856a62a1c70a0b6e84d9cd36344ba131">Slic3r::print_config_def</a></div><div class="ttdeci">const PrintConfigDef print_config_def</div><div class="ttdef"><b>Definition:</b> PrintConfig.cpp:1757</div></div>
8989
<div class="ttc" id="class_slic3r_1_1_config_html_ac85ad89f37aa4ad1b559f0c53d2a3381"><div class="ttname"><a href="class_slic3r_1_1_config.html#ac85ad89f37aa4ad1b559f0c53d2a3381">Slic3r::Config::write_ini</a></div><div class="ttdeci">void write_ini(const std::string &amp;file) const</div><div class="ttdoc">Write a windows-style opt=value ini file with categories from the configuration store. </div><div class="ttdef"><b>Definition:</b> Config.cpp:314</div></div>
9090
<div class="ttc" id="_config_base_8hpp_html"><div class="ttname"><a href="_config_base_8hpp.html">ConfigBase.hpp</a></div></div>
9191
<div class="ttc" id="class_slic3r_1_1_invalid_config_option_html"><div class="ttname"><a href="class_slic3r_1_1_invalid_config_option.html">Slic3r::InvalidConfigOption</a></div><div class="ttdoc">Exception class to handle config options that don&amp;#39;t exist. </div><div class="ttdef"><b>Definition:</b> Config.hpp:25</div></div>

libslic3r-doc/_cooling_buffer_8hpp_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
<div class="title">CoolingBuffer.hpp</div> </div>
6969
</div><!--header-->
7070
<div class="contents">
71-
<a href="_cooling_buffer_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef slic3r_CoolingBuffer_hpp_</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define slic3r_CoolingBuffer_hpp_</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="libslic3r_8h.html">libslic3r.h</a>&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_g_code_8hpp.html">GCode.hpp</a>&quot;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_slic3r.html">Slic3r</a> {</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">A standalone G-code filter, to control cooling of the print.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">The G-code is processed per layer. Once a layer is collected, fan start / stop commands are edited</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">and the print is modified to stretch over a minimum layer time.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_slic3r_1_1_cooling_buffer.html"> 17</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_slic3r_1_1_cooling_buffer.html">CoolingBuffer</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="class_slic3r_1_1_cooling_buffer.html#af79601fb79aecb7f2d657a2921545242"> 19</a></span>&#160; <a class="code" href="class_slic3r_1_1_cooling_buffer.html#af79601fb79aecb7f2d657a2921545242">CoolingBuffer</a>(<a class="code" href="class_slic3r_1_1_g_code.html">GCode</a> &amp;<a class="code" href="class_slic3r_1_1_cooling_buffer.html#a5458f6144926782ae839d60abdf7b7ca">gcodegen</a>)</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; : _gcodegen(&amp;gcodegen), _elapsed_time(0.), _elapsed_time_bridges(0.),</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; _elapsed_time_external(0.), _layer_id(0)</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; this-&gt;_min_print_speed = this-&gt;_gcodegen-&gt;<a class="code" href="class_slic3r_1_1_g_code.html#ac1925c875268f63d09539522597f40df">config</a>.<a class="code" href="class_slic3r_1_1_print_config.html#ae66fd0191c1fa41f404116548be4dcc2">min_print_speed</a> * 60;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; };</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; std::string <a class="code" href="class_slic3r_1_1_cooling_buffer.html#a6524d86c7eeb6f4f340bdf0cec8755df">append</a>(<span class="keyword">const</span> std::string &amp;gcode, std::string obj_id, <span class="keywordtype">size_t</span> layer_id, <span class="keywordtype">float</span> print_z);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; std::string <a class="code" href="class_slic3r_1_1_cooling_buffer.html#a29006f78c1170e5c94e7e3645be94f61">flush</a>();</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="class_slic3r_1_1_cooling_buffer.html#a5458f6144926782ae839d60abdf7b7ca"> 27</a></span>&#160; <a class="code" href="class_slic3r_1_1_g_code.html">GCode</a>* <a class="code" href="class_slic3r_1_1_cooling_buffer.html#a5458f6144926782ae839d60abdf7b7ca">gcodegen</a>() { <span class="keywordflow">return</span> this-&gt;_gcodegen; };</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="class_slic3r_1_1_g_code.html">GCode</a>* _gcodegen;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; std::string _gcode;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">float</span> _elapsed_time;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">float</span> _elapsed_time_bridges;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">float</span> _elapsed_time_external;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">size_t</span> _layer_id;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; std::map&lt;std::string,float&gt; _last_z;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">float</span> _min_print_speed;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;};</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="class_slic3r_1_1_print_config_html_ae66fd0191c1fa41f404116548be4dcc2"><div class="ttname"><a href="class_slic3r_1_1_print_config.html#ae66fd0191c1fa41f404116548be4dcc2">Slic3r::PrintConfig::min_print_speed</a></div><div class="ttdeci">ConfigOptionFloat min_print_speed</div><div class="ttdef"><b>Definition:</b> PrintConfig.hpp:463</div></div>
71+
<a href="_cooling_buffer_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef slic3r_CoolingBuffer_hpp_</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define slic3r_CoolingBuffer_hpp_</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="libslic3r_8h.html">libslic3r.h</a>&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_g_code_8hpp.html">GCode.hpp</a>&quot;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_slic3r.html">Slic3r</a> {</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">A standalone G-code filter, to control cooling of the print.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">The G-code is processed per layer. Once a layer is collected, fan start / stop commands are edited</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">and the print is modified to stretch over a minimum layer time.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_slic3r_1_1_cooling_buffer.html"> 17</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_slic3r_1_1_cooling_buffer.html">CoolingBuffer</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="class_slic3r_1_1_cooling_buffer.html#af79601fb79aecb7f2d657a2921545242"> 19</a></span>&#160; <a class="code" href="class_slic3r_1_1_cooling_buffer.html#af79601fb79aecb7f2d657a2921545242">CoolingBuffer</a>(<a class="code" href="class_slic3r_1_1_g_code.html">GCode</a> &amp;<a class="code" href="class_slic3r_1_1_cooling_buffer.html#a5458f6144926782ae839d60abdf7b7ca">gcodegen</a>)</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; : _gcodegen(&amp;gcodegen), _elapsed_time(0.), _elapsed_time_bridges(0.),</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; _elapsed_time_external(0.), _layer_id(0)</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; this-&gt;_min_print_speed = this-&gt;_gcodegen-&gt;<a class="code" href="class_slic3r_1_1_g_code.html#ac1925c875268f63d09539522597f40df">config</a>.<a class="code" href="class_slic3r_1_1_print_config.html#ae66fd0191c1fa41f404116548be4dcc2">min_print_speed</a> * 60;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; };</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; std::string <a class="code" href="class_slic3r_1_1_cooling_buffer.html#a6524d86c7eeb6f4f340bdf0cec8755df">append</a>(<span class="keyword">const</span> std::string &amp;gcode, std::string obj_id, <span class="keywordtype">size_t</span> layer_id, <span class="keywordtype">float</span> print_z);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; std::string <a class="code" href="class_slic3r_1_1_cooling_buffer.html#a29006f78c1170e5c94e7e3645be94f61">flush</a>();</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="class_slic3r_1_1_cooling_buffer.html#a5458f6144926782ae839d60abdf7b7ca"> 27</a></span>&#160; <a class="code" href="class_slic3r_1_1_g_code.html">GCode</a>* <a class="code" href="class_slic3r_1_1_cooling_buffer.html#a5458f6144926782ae839d60abdf7b7ca">gcodegen</a>() { <span class="keywordflow">return</span> this-&gt;_gcodegen; };</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="class_slic3r_1_1_g_code.html">GCode</a>* _gcodegen;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; std::string _gcode;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">float</span> _elapsed_time;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">float</span> _elapsed_time_bridges;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">float</span> _elapsed_time_external;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">size_t</span> _layer_id;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; std::map&lt;std::string,float&gt; _last_z;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">float</span> _min_print_speed;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;};</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="class_slic3r_1_1_print_config_html_ae66fd0191c1fa41f404116548be4dcc2"><div class="ttname"><a href="class_slic3r_1_1_print_config.html#ae66fd0191c1fa41f404116548be4dcc2">Slic3r::PrintConfig::min_print_speed</a></div><div class="ttdeci">ConfigOptionFloat min_print_speed</div><div class="ttdef"><b>Definition:</b> PrintConfig.hpp:461</div></div>
7272
<div class="ttc" id="libslic3r_8h_html"><div class="ttname"><a href="libslic3r_8h.html">libslic3r.h</a></div></div>
7373
<div class="ttc" id="class_slic3r_1_1_cooling_buffer_html_a6524d86c7eeb6f4f340bdf0cec8755df"><div class="ttname"><a href="class_slic3r_1_1_cooling_buffer.html#a6524d86c7eeb6f4f340bdf0cec8755df">Slic3r::CoolingBuffer::append</a></div><div class="ttdeci">std::string append(const std::string &amp;gcode, std::string obj_id, size_t layer_id, float print_z)</div><div class="ttdef"><b>Definition:</b> CoolingBuffer.cpp:9</div></div>
7474
<div class="ttc" id="class_slic3r_1_1_cooling_buffer_html_a5458f6144926782ae839d60abdf7b7ca"><div class="ttname"><a href="class_slic3r_1_1_cooling_buffer.html#a5458f6144926782ae839d60abdf7b7ca">Slic3r::CoolingBuffer::gcodegen</a></div><div class="ttdeci">GCode * gcodegen()</div><div class="ttdef"><b>Definition:</b> CoolingBuffer.hpp:27</div></div>

0 commit comments

Comments
 (0)