diff options
Diffstat (limited to 'xs/src/libslic3r/Print.hpp')
| -rw-r--r-- | xs/src/libslic3r/Print.hpp | 346 |
1 files changed, 230 insertions, 116 deletions
diff --git a/xs/src/libslic3r/Print.hpp b/xs/src/libslic3r/Print.hpp index 1162c9b0f..71711b31e 100644 --- a/xs/src/libslic3r/Print.hpp +++ b/xs/src/libslic3r/Print.hpp @@ -51,7 +51,7 @@ template <class StepType, size_t COUNT> class PrintState { public: - PrintState() { for (size_t i = 0; i < COUNT; ++ i) m_state[i] = INVALID; } + PrintState() { for (size_t i = 0; i < COUNT; ++ i) m_state[i].store(INVALID, std::memory_order_relaxed); } enum State { INVALID, @@ -59,24 +59,58 @@ public: DONE, }; + // With full memory barrier. bool is_done(StepType step) const { return m_state[step] == DONE; } - // set_started() will lock the provided mutex before setting the state. + + // Set the step as started. Block on mutex while the Print / PrintObject / PrintRegion objects are being + // modified by the UI thread. // This is necessary to block until the Print::apply_config() updates its state, which may // influence the processing step being entered. - void set_started(StepType step, tbb::mutex &mtx) { mtx.lock(); m_state[step] = STARTED; mtx.unlock(); } - void set_done(StepType step) { m_state[step] = DONE; } - bool invalidate(StepType step) { - bool invalidated = m_state[step] != INVALID; - m_state[step] = INVALID; + void set_started(StepType step, tbb::mutex &mtx) { + mtx.lock(); + m_state[step].store(STARTED, std::memory_order_relaxed); + mtx.unlock(); + } + + // Set the step as done. Block on mutex while the Print / PrintObject / PrintRegion objects are being + // modified by the UI thread. + void set_done(StepType step, tbb::mutex &mtx) { + mtx.lock(); + m_state[step].store(DONE, std::memory_order_relaxed); + mtx.unlock(); + } + + // Make the step invalid. + // The provided mutex should be locked at this point, guarding access to m_state. + // In case the step has already been entered or finished, cancel the background + // processing by calling the cancel callback. + template<typename CancelationCallback> + bool invalidate(StepType step, tbb::mutex &mtx, CancelationCallback &cancel) { + bool invalidated = m_state[step].load(std::memory_order_relaxed) != INVALID; + if (invalidated) { + mtx.unlock(); + cancel(); + mtx.lock(); + } return invalidated; } - bool invalidate_all() { + + // Make all steps invalid. + // The provided mutex should be locked at this point, guarding access to m_state. + // In case any step has already been entered or finished, cancel the background + // processing by calling the cancel callback. + template<typename CancelationCallback> + bool invalidate_all(tbb::mutex &mtx, CancelationCallback &cancel) { bool invalidated = false; for (size_t i = 0; i < COUNT; ++ i) - if (m_state[i] != INVALID) { - invalidated = true; - m_state[i] = INVALID; - break; + if (m_state[i].load(std::memory_order_relaxed) != INVALID) { + if (! invalidated) { + mtx.unlock(); + cancel(); + mtx.lock(); + invalidated = true; + } + m_state[i].store(INVALID, std::memory_order_relaxed); } return invalidated; } @@ -91,17 +125,24 @@ class PrintRegion { friend class Print; +// Methods NOT modifying the PrintRegion's state: public: - PrintRegionConfig config; + const Print* print() const { return m_print; } + const PrintRegionConfig& config() const { return m_config; } + Flow flow(FlowRole role, double layer_height, bool bridge, bool first_layer, double width, const PrintObject &object) const; + coordf_t nozzle_dmr_avg(const PrintConfig &print_config) const; - Print* print() { return this->_print; } - Flow flow(FlowRole role, double layer_height, bool bridge, bool first_layer, double width, const PrintObject &object) const; - coordf_t nozzle_dmr_avg(const PrintConfig &print_config) const; +// Methods modifying the PrintRegion's state: +public: + Print* print() { return m_print; } + void config_apply_only(const ConfigBase &other, const t_config_option_keys &keys, bool ignore_nonexistent = false) { this->m_config.apply_only(other, keys, ignore_nonexistent); } private: - Print* _print; + Print *m_print; + PrintRegionConfig m_config; - PrintRegion(Print* print) : _print(print) {} + PrintRegion(Print* print) : m_print(print) {} + PrintRegion(Print* print, const PrintRegionConfig &config) : m_print(print), m_config(config) {} ~PrintRegion() {} }; @@ -117,7 +158,6 @@ class PrintObject public: // vector of (vectors of volume ids), indexed by region_id std::vector<std::vector<int>> region_volumes; - PrintObjectConfig config; t_layer_height_ranges layer_height_ranges; // Profile of increasing z to a layer height, to be linearly interpolated when calculating the layers. @@ -144,15 +184,17 @@ public: // Slic3r::Point objects in scaled G-code coordinates in our coordinates Points _shifted_copies; - LayerPtrs layers; - SupportLayerPtrs support_layers; - - Print* print() { return this->_print; } - const Print* print() const { return this->_print; } - ModelObject* model_object() { return this->_model_object; } - const ModelObject* model_object() const { return this->_model_object; } - - const Points& copies() const { return this->_copies; } + Print* print() { return m_print; } + const Print* print() const { return m_print; } + ModelObject* model_object() { return m_model_object; } + const ModelObject* model_object() const { return m_model_object; } + const PrintObjectConfig& config() const { return m_config; } + void config_apply(const ConfigBase &other, bool ignore_nonexistent = false) { this->m_config.apply(other, ignore_nonexistent); } + void config_apply_only(const ConfigBase &other, const t_config_option_keys &keys, bool ignore_nonexistent = false) { this->m_config.apply_only(other, keys, ignore_nonexistent); } + const LayerPtrs& layers() const { return m_layers; } + const SupportLayerPtrs& support_layers() const { return m_support_layers; } + + const Points& copies() const { return m_copies; } bool add_copy(const Pointf &point); bool delete_last_copy(); bool delete_all_copies() { return this->set_copies(Points()); } @@ -171,24 +213,25 @@ public: // this value is not supposed to be compared with Layer::id // since they have different semantics. size_t total_layer_count() const { return this->layer_count() + this->support_layer_count(); } - size_t layer_count() const { return this->layers.size(); } + size_t layer_count() const { return m_layers.size(); } void clear_layers(); - Layer* get_layer(int idx) { return this->layers.at(idx); } - const Layer* get_layer(int idx) const { return this->layers.at(idx); } + Layer* get_layer(int idx) { return m_layers[idx]; } + const Layer* get_layer(int idx) const { return m_layers[idx]; } // print_z: top of the layer; slice_z: center of the layer. Layer* add_layer(int id, coordf_t height, coordf_t print_z, coordf_t slice_z); - size_t support_layer_count() const { return this->support_layers.size(); } + size_t support_layer_count() const { return m_support_layers.size(); } void clear_support_layers(); - SupportLayer* get_support_layer(int idx) { return this->support_layers.at(idx); } + SupportLayer* get_support_layer(int idx) { return m_support_layers[idx]; } SupportLayer* add_support_layer(int id, coordf_t height, coordf_t print_z); + SupportLayerPtrs::const_iterator insert_support_layer(SupportLayerPtrs::const_iterator pos, int id, coordf_t height, coordf_t print_z, coordf_t slice_z); void delete_support_layer(int idx); // methods for handling state bool invalidate_state_by_config_options(const std::vector<t_config_option_key> &opt_keys); bool invalidate_step(PrintObjectStep step); - bool invalidate_all_steps() { return m_state.invalidate_all(); } + bool invalidate_all_steps(); bool is_step_done(PrintObjectStep step) const { return m_state.is_done(step); } // To be used over the layer_height_profile of both the PrintObject and ModelObject @@ -229,9 +272,14 @@ private: void combine_infill(); void _generate_support_material(); - Print* _print; - ModelObject* _model_object; - Points _copies; // Slic3r::Point objects in scaled G-code coordinates + Print *m_print; + ModelObject *m_model_object; + PrintObjectConfig m_config; + // Slic3r::Point objects in scaled G-code coordinates + Points m_copies; + + LayerPtrs m_layers; + SupportLayerPtrs m_support_layers; PrintState<PrintObjectStep, posCount> m_state; // Mutex used for synchronization of the worker thread with the UI thread: @@ -245,9 +293,49 @@ private: ~PrintObject() {} void set_started(PrintObjectStep step) { m_state.set_started(step, m_mutex); } + void set_done(PrintObjectStep step) { m_state.set_done(step, m_mutex); } std::vector<ExPolygons> _slice_region(size_t region_id, const std::vector<float> &z, bool modifier); }; +struct WipeTowerData +{ + // Following section will be consumed by the GCodeGenerator. + // Tool ordering of a non-sequential print has to be known to calculate the wipe tower. + // Cache it here, so it does not need to be recalculated during the G-code generation. + ToolOrdering tool_ordering; + // Cache of tool changes per print layer. + std::unique_ptr<WipeTower::ToolChangeResult> priming; + std::vector<std::vector<WipeTower::ToolChangeResult>> tool_changes; + std::unique_ptr<WipeTower::ToolChangeResult> final_purge; + + void clear() { + tool_ordering.clear(); + priming.reset(nullptr); + tool_changes.clear(); + final_purge.reset(nullptr); + } +}; + +struct PrintStatistics +{ + PrintStatistics() { clear(); } + std::string estimated_print_time; + double total_used_filament; + double total_extruded_volume; + double total_cost; + double total_weight; + std::map<size_t, float> filament_stats; + + void clear() { + estimated_print_time.clear(); + total_used_filament = 0.; + total_extruded_volume = 0.; + total_weight = 0.; + total_cost = 0.; + filament_stats.clear(); + } +}; + typedef std::vector<PrintObject*> PrintObjectPtrs; typedef std::vector<PrintRegion*> PrintRegionPtrs; @@ -255,110 +343,115 @@ typedef std::vector<PrintRegion*> PrintRegionPtrs; class Print { public: - PrintConfig config; - PrintObjectConfig default_object_config; - PrintRegionConfig default_region_config; - PrintObjectPtrs objects; - PrintRegionPtrs regions; - PlaceholderParser placeholder_parser; - std::string estimated_print_time; - double total_used_filament, total_extruded_volume, total_cost, total_weight; - std::map<size_t, float> filament_stats; - - // ordered collections of extrusion paths to build skirt loops and brim - ExtrusionEntityCollection skirt, brim; - - Print() : total_used_filament(0), total_extruded_volume(0) { restart(); } + Print() { restart(); } ~Print() { clear_objects(); } - // methods for handling objects - void clear_objects(); - PrintObject* get_object(size_t idx) { return objects.at(idx); } - const PrintObject* get_object(size_t idx) const { return objects.at(idx); } - - void delete_object(size_t idx); - void reload_object(size_t idx); - bool reload_model_instances(); + // Methods, which change the state of Print / PrintObject / PrintRegion. + // The following methods are synchronized with process() and export_gcode(), + // so that process() and export_gcode() may be called from a background thread. + // In case the following methods need to modify data processed by process() or export_gcode(), + // a cancellation callback is executed to stop the background processing before the operation. + void clear_objects(); + void delete_object(size_t idx); + void reload_object(size_t idx); + bool reload_model_instances(); + void add_model_object(ModelObject* model_object, int idx = -1); + bool apply_config(DynamicPrintConfig config); + void process(); + void export_gcode(const std::string &path_template, GCodePreviewData *preview_data); - // methods for handling regions - PrintRegion* get_region(size_t idx) { return regions.at(idx); } - const PrintRegion* get_region(size_t idx) const { return regions.at(idx); } - PrintRegion* add_region(); - // methods for handling state - bool invalidate_step(PrintStep step); - bool invalidate_all_steps() { return m_state.invalidate_all(); } - bool is_step_done(PrintStep step) const { return m_state.is_done(step); } - bool is_step_done(PrintObjectStep step) const; - - void add_model_object(ModelObject* model_object, int idx = -1); - bool apply_config(DynamicPrintConfig config); - bool has_infinite_skirt() const; - bool has_skirt() const; + bool is_step_done(PrintStep step) const { return m_state.is_done(step); } + bool is_step_done(PrintObjectStep step) const; + + bool has_infinite_skirt() const; + bool has_skirt() const; // Returns an empty string if valid, otherwise returns an error message. - std::string validate() const; - BoundingBox bounding_box() const; - BoundingBox total_bounding_box() const; - double skirt_first_layer_height() const; - Flow brim_flow() const; - Flow skirt_flow() const; + std::string validate() const; + BoundingBox bounding_box() const; + BoundingBox total_bounding_box() const; + double skirt_first_layer_height() const; + Flow brim_flow() const; + Flow skirt_flow() const; std::vector<unsigned int> object_extruders() const; std::vector<unsigned int> support_material_extruders() const; std::vector<unsigned int> extruders() const; - void _simplify_slices(double distance); - double max_allowed_layer_height() const; - bool has_support_material() const; - void auto_assign_extruders(ModelObject* model_object) const; + double max_allowed_layer_height() const; + bool has_support_material() const; + // Make sure the background processing has no access to this model_object during this call! + void auto_assign_extruders(ModelObject* model_object) const; + + const PrintConfig& config() const { return m_config; } + const PrintObjectConfig& default_object_config() const { return m_default_object_config; } + const PrintRegionConfig& default_region_config() const { return m_default_region_config; } + const PrintObjectPtrs& objects() const { return m_objects; } + const PrintRegionPtrs& regions() const { return m_regions; } + const PlaceholderParser& placeholder_parser() const { return m_placeholder_parser; } + + const ExtrusionEntityCollection& skirt() const { return m_skirt; } + const ExtrusionEntityCollection& brim() const { return m_brim; } - void process(); - void export_gcode(const std::string &path_template, GCodePreviewData *preview_data); + const PrintStatistics& print_statistics() const { return m_print_statistics; } // Wipe tower support. - bool has_wipe_tower() const; - // Tool ordering of a non-sequential print has to be known to calculate the wipe tower. - // Cache it here, so it does not need to be recalculated during the G-code generation. - ToolOrdering m_tool_ordering; - // Cache of tool changes per print layer. - std::unique_ptr<WipeTower::ToolChangeResult> m_wipe_tower_priming; - std::vector<std::vector<WipeTower::ToolChangeResult>> m_wipe_tower_tool_changes; - std::unique_ptr<WipeTower::ToolChangeResult> m_wipe_tower_final_purge; + bool has_wipe_tower() const; + const WipeTowerData& wipe_tower_data() const { return m_wipe_tower_data; } - std::string output_filename(); - std::string output_filepath(const std::string &path); + std::string output_filename() const; + std::string output_filepath(const std::string &path) const; typedef std::function<void(int, const std::string&)> status_callback_type; // Default status console print out in the form of percent => message. - void set_status_default() { m_status_callback = nullptr; } + void set_status_default() { m_status_callback = nullptr; } // No status output or callback whatsoever, useful mostly for automatic tests. - void set_status_silent() { m_status_callback = [](int, const std::string&){}; } + void set_status_silent() { m_status_callback = [](int, const std::string&){}; } // Register a custom status callback. - void set_status_callback(status_callback_type cb) { m_status_callback = cb; } + void set_status_callback(status_callback_type cb) { m_status_callback = cb; } // Calls a registered callback to update the status, or print out the default message. - void set_status(int percent, const std::string &message) { + void set_status(int percent, const std::string &message) { if (m_status_callback) m_status_callback(percent, message); else printf("%d => %s\n", percent, message.c_str()); } + + typedef std::function<void()> cancel_callback_type; + // Various methods will call this callback to stop the background processing (the Print::process() call) + // in case a successive change of the Print / PrintObject / PrintRegion instances changed + // the state of the finished or running calculations. + void set_cancel_callback(cancel_callback_type cancel_callback) { m_cancel_callback = cancel_callback; } + // Has the calculation been canceled? + bool canceled() const { return m_canceled; } // Cancel the running computation. Stop execution of all the background threads. - void cancel() { m_canceled = true; } + void cancel() { m_canceled = true; } // Cancel the running computation. Stop execution of all the background threads. - void restart() { m_canceled = false; } - // Has the calculation been canceled? - bool canceled() { return m_canceled; } - void throw_if_canceled() { if (m_canceled) throw CanceledException(); } + void restart() { m_canceled = false; } + + // Accessed by SupportMaterial + const PrintRegion* get_region(size_t idx) const { return m_regions[idx]; } protected: - void set_started(PrintStep step) { m_state.set_started(step, m_mutex); } - void set_done(PrintStep step) { m_state.set_done(step); } + void set_started(PrintStep step) { m_state.set_started(step, m_mutex); } + void set_done(PrintStep step) { m_state.set_done(step, m_mutex); } + bool invalidate_step(PrintStep step); + bool invalidate_all_steps() { return m_state.invalidate_all(m_mutex, m_cancel_callback); } + + // methods for handling regions + PrintRegion* get_region(size_t idx) { return m_regions[idx]; } + PrintRegion* add_region(); + PrintRegion* add_region(const PrintRegionConfig &config); private: - bool invalidate_state_by_config_options(const std::vector<t_config_option_key> &opt_keys); - PrintRegionConfig _region_config_from_model_volume(const ModelVolume &volume); + bool invalidate_state_by_config_options(const std::vector<t_config_option_key> &opt_keys); + PrintRegionConfig _region_config_from_model_volume(const ModelVolume &volume); - void _make_skirt(); - void _make_brim(); - void _clear_wipe_tower(); - void _make_wipe_tower(); + // If the background processing stop was requested, throw CanceledException. + // To be called by the worker thread and its sub-threads (mostly launched on the TBB thread pool) regularly. + void throw_if_canceled() { if (m_canceled) throw CanceledException(); } + + void _make_skirt(); + void _make_brim(); + void _make_wipe_tower(); + void _simplify_slices(double distance); PrintState<PrintStep, psCount> m_state; // Mutex used for synchronization of the worker thread with the UI thread: @@ -370,15 +463,36 @@ private: // Callback to be evoked regularly to update state of the UI thread. status_callback_type m_status_callback; + // Callback to be evoked to stop the background processing before a state is updated. + cancel_callback_type m_cancel_callback = [](){}; + + PrintConfig m_config; + PrintObjectConfig m_default_object_config; + PrintRegionConfig m_default_region_config; + PrintObjectPtrs m_objects; + PrintRegionPtrs m_regions; + PlaceholderParser m_placeholder_parser; + + // Ordered collections of extrusion paths to build skirt loops and brim. + ExtrusionEntityCollection m_skirt; + ExtrusionEntityCollection m_brim; + + // Following section will be consumed by the GCodeGenerator. + WipeTowerData m_wipe_tower_data; + + // Estimated print time, filament consumed. + PrintStatistics m_print_statistics; + // To allow GCode to set the Print's GCodeExport step status. friend class GCode; + // Allow PrintObject to access m_mutex and m_cancel_callback. + friend class PrintObject; }; #define FOREACH_BASE(type, container, iterator) for (type::const_iterator iterator = (container).begin(); iterator != (container).end(); ++iterator) -#define FOREACH_REGION(print, region) FOREACH_BASE(PrintRegionPtrs, (print)->regions, region) -#define FOREACH_OBJECT(print, object) FOREACH_BASE(PrintObjectPtrs, (print)->objects, object) -#define FOREACH_LAYER(object, layer) FOREACH_BASE(LayerPtrs, (object)->layers, layer) -#define FOREACH_LAYERREGION(layer, layerm) FOREACH_BASE(LayerRegionPtrs, (layer)->regions, layerm) +#define FOREACH_OBJECT(print, object) FOREACH_BASE(PrintObjectPtrs, (print)->m_objects, object) +#define FOREACH_LAYER(object, layer) FOREACH_BASE(LayerPtrs, (object)->m_layers, layer) +#define FOREACH_LAYERREGION(layer, layerm) FOREACH_BASE(LayerRegionPtrs, (layer)->m_regions, layerm) } |