1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
|
/*
* GNU AFFERO GENERAL PUBLIC LICENSE
* Version 3, 19 November 2007
* Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
* Everyone is permitted to copy and distribute verbatim copies
* of this license document, but changing it is not allowed.
*/
using System;
using System.Drawing;
using System.Text;
using Emgu.CV;
using UVtools.Core.Operations;
namespace UVtools.Core.FileFormats
{
/// <summary>
/// Slicer file format representation interface
/// </summary>
public interface IFileFormat
{
#region Properties
/// <summary>
/// Gets the file format type
/// </summary>
FileFormat.FileFormatType FileType { get; }
/// <summary>
/// Gets the valid file extensions for this <see cref="FileFormat"/>
/// </summary>
FileExtension[] FileExtensions { get; }
/// <summary>
/// Gets the implemented file formats able to convert to
/// </summary>
Type[] ConvertToFormats { get; }
/// <summary>
/// Gets the available <see cref="FileFormat.PrintParameterModifier"/>
/// </summary>
FileFormat.PrintParameterModifier[] PrintParameterModifiers { get; }
/// <summary>
/// Gets the available <see cref="FileFormat.PrintParameterModifier"/> per layer
/// </summary>
FileFormat.PrintParameterModifier[] PrintParameterPerLayerModifiers { get; }
/// <summary>
/// Gets the file filter for open and save dialogs
/// </summary>
string FileFilter { get; }
/// <summary>
/// Gets all valid file extensions in "*.extension1;*.extension2" format
/// </summary>
string FileFilterExtensionsOnly { get; }
/// <summary>
/// Gets the input file path loaded into this <see cref="FileFormat"/>
/// </summary>
string FileFullPath { get; set; }
/// <summary>
/// Gets the thumbnails count present in this file format
/// </summary>
byte ThumbnailsCount { get; }
/// <summary>
/// Gets the number of created thumbnails
/// </summary>
byte CreatedThumbnailsCount { get; }
/// <summary>
/// Gets the original thumbnail sizes
/// </summary>
System.Drawing.Size[] ThumbnailsOriginalSize { get; }
/// <summary>
/// Gets the thumbnails for this <see cref="FileFormat"/>
/// </summary>
Mat[] Thumbnails { get; set; }
/// <summary>
/// Gets the cached layers into compressed bytes
/// </summary>
LayerManager LayerManager { get; set; }
Size Resolution { get; }
/// <summary>
/// Gets the image width resolution
/// </summary>
uint ResolutionX { get; set; }
/// <summary>
/// Gets the image height resolution
/// </summary>
uint ResolutionY { get; set; }
/// <summary>
/// Gets the size of display in millimeters
/// </summary>
SizeF Display { get; set; }
/// <summary>
/// Gets or sets the display width in millimeters
/// </summary>
float DisplayWidth { get; set; }
/// <summary>
/// Gets or sets the display height in millimeters
/// </summary>
float DisplayHeight { get; set; }
bool HaveAntiAliasing { get; }
/// <summary>
/// Gets the AntiAliasing level
/// </summary>
byte AntiAliasing { get; }
/// <summary>
/// Gets Layer Height in mm
/// </summary>
float LayerHeight { get; set; }
/// <summary>
/// Gets Total Height in mm
/// </summary>
float TotalHeight { get; }
/// <summary>
/// Gets the last layer index
/// </summary>
uint LastLayerIndex { get; }
#region Universal Properties
/// <summary>
/// Gets if this format support per layer override settings
/// </summary>
bool SupportPerLayerSettings { get; }
/// <summary>
/// Gets the number of layers present in this file
/// </summary>
uint LayerCount { get; set; }
/// <summary>
/// Gets or sets the number of initial layer count
/// </summary>
ushort BottomLayerCount { get; set; }
/// <summary>
/// Gets the number of normal layer count
/// </summary>
uint NormalLayerCount { get; }
/// <summary>
/// Gets or sets the initial exposure time for <see cref="BottomLayerCount"/> in seconds
/// </summary>
float BottomExposureTime { get; set; }
/// <summary>
/// Gets or sets the normal layer exposure time in seconds
/// </summary>
float ExposureTime { get; set; }
/// <summary>
/// Gets or sets the bottom layer off time in seconds
/// </summary>
float BottomLayerOffTime { get; set; }
/// <summary>
/// Gets or sets the layer off time in seconds
/// </summary>
float LayerOffTime { get; set; }
/// <summary>
/// Gets or sets the bottom lift height in mm
/// </summary>
float BottomLiftHeight { get; set; }
/// <summary>
/// Gets or sets the lift height in mm
/// </summary>
float LiftHeight { get; set; }
/// <summary>
/// Gets or sets the bottom lift speed in mm/min
/// </summary>
float BottomLiftSpeed { get; set; }
/// <summary>
/// Gets or sets the speed in mm/min
/// </summary>
float LiftSpeed { get; set; }
/// <summary>
/// Gets the speed in mm/min for the retracts
/// </summary>
float RetractSpeed { get; set; }
/// <summary>
/// Gets or sets the bottom pwm value from 0 to 255
/// </summary>
byte BottomLightPWM { get; set; }
/// <summary>
/// Gets or sets the pwm value from 0 to 255
/// </summary>
byte LightPWM { get; set; }
#endregion
/// <summary>
/// Gets the estimate print time in seconds
/// </summary>
float PrintTime { get; }
/// <summary>
/// Gets the estimate print time in seconds, if print doesn't support it it will be calculated
/// </summary>
float PrintTimeOrComputed { get; }
/// <summary>
/// Gets the estimate print time in hours
/// </summary>
float PrintTimeHours { get; }
/// <summary>
/// Gets the estimate used material in ml
/// </summary>
float UsedMaterial { get; }
/// <summary>
/// Gets the estimate material cost
/// </summary>
float MaterialCost { get; }
/// <summary>
/// Gets the material name
/// </summary>
string MaterialName { get; }
/// <summary>
/// Gets the machine name
/// </summary>
string MachineName { get; }
/// <summary>
/// Gets the GCode, returns null if not supported
/// </summary>
StringBuilder GCode { get; set; }
string GCodeStr { get; }
/// <summary>
/// Gets if this file have available gcode
/// </summary>
bool HaveGCode { get; }
/// <summary>
/// Get all configuration objects with properties and values
/// </summary>
object[] Configs { get; }
/// <summary>
/// Gets if this file is valid to read
/// </summary>
bool IsValid { get; }
#endregion
#region Methods
/// <summary>
/// Clears all definitions and properties, it also dispose valid candidates
/// </summary>
void Clear();
/// <summary>
/// Validate if a file is a valid <see cref="FileFormat"/>
/// </summary>
/// <param name="fileFullPath">Full file path</param>
void FileValidation(string fileFullPath);
/// <summary>
/// Checks if a extension is valid under the <see cref="FileFormat"/>
/// </summary>
/// <param name="extension">Extension to check</param>
/// <param name="isFilePath">True if <see cref="extension"/> is a full file path, otherwise false for extension only</param>
/// <returns>True if valid, otherwise false</returns>
bool IsExtensionValid(string extension, bool isFilePath = false);
/// <summary>
/// Gets all valid file extensions in a specified format
/// </summary>
string GetFileExtensions(string prepend = ".", string separator = ", ");
/// <summary>
/// Gets a thumbnail by it height or lower
/// </summary>
/// <param name="maxHeight">Max height allowed</param>
/// <returns></returns>
Mat GetThumbnail(uint maxHeight = 400);
/// <summary>
/// Gets a thumbnail by the largest or smallest
/// </summary>
/// <param name="largest">True to get the largest, otherwise false</param>
/// <returns></returns>
Mat GetThumbnail(bool largest);
/// <summary>
/// Sets thumbnails from a list of thumbnails and clone them
/// </summary>
/// <param name="images"></param>
void SetThumbnails(Mat[] images);
/// <summary>
/// Sets all thumbnails the same image
/// </summary>
/// <param name="images">Image to set</param>
void SetThumbnails(Mat images);
/// <summary>
/// Sets a thumbnail from a disk file
/// </summary>
/// <param name="index">Thumbnail index</param>
/// <param name="filePath"></param>
void SetThumbnail(int index, string filePath);
/// <summary>
/// Encode to an output file
/// </summary>
/// <param name="fileFullPath">Output file</param>
/// <param name="progress"></param>
void Encode(string fileFullPath, OperationProgress progress = null);
void AfterEncode();
/*
/// <summary>
/// Begin encode to an output file
/// </summary>
/// <param name="fileFullPath">Output file</param>
//void BeginEncode(string fileFullPath);
/// <summary>
/// Insert a layer image to be encoded
/// </summary>
/// <param name="image"></param>
/// <param name="layerIndex"></param>
//void InsertLayerImageEncode(Image<L8> image, uint layerIndex);
/// <summary>
/// Finish the encoding procedure
/// </summary>
//void EndEncode();*/
/// <summary>
/// Decode a slicer file
/// </summary>
/// <param name="fileFullPath"></param>
/// <param name="progress"></param>
void Decode(string fileFullPath, OperationProgress progress = null);
/// <summary>
/// Extract contents to a folder
/// </summary>
/// <param name="path">Path to folder where content will be extracted</param>
/// <param name="genericConfigExtract"></param>
/// <param name="genericLayersExtract"></param>
/// <param name="progress"></param>
void Extract(string path, bool genericConfigExtract = true, bool genericLayersExtract = true,
OperationProgress progress = null);
/// <summary>
/// Get height in mm from layer height
/// </summary>
/// <param name="layerIndex"></param>
/// <param name="realHeight"></param>
/// <returns>The height in mm</returns>
float GetHeightFromLayer(uint layerIndex, bool realHeight = true);
/// <summary>
/// Gets the value for initial layer or normal layers based on layer index
/// </summary>
/// <typeparam name="T">Type of value</typeparam>
/// <param name="layerIndex">Layer index</param>
/// <param name="initialLayerValue">Initial value</param>
/// <param name="normalLayerValue">Normal value</param>
/// <returns></returns>
T GetInitialLayerValueOrNormal<T>(uint layerIndex, T initialLayerValue, T normalLayerValue);
void RefreshPrintParametersModifiersValues();
void RefreshPrintParametersPerLayerModifiersValues(uint layerIndex);
/// <summary>
/// Gets the value attributed to <see cref="FileFormat.PrintParameterModifier"/>
/// </summary>
/// <param name="modifier">Modifier to use</param>
/// <returns>A value</returns>
object GetValueFromPrintParameterModifier(FileFormat.PrintParameterModifier modifier);
/// <summary>
/// Sets a property value attributed to <see cref="modifier"/>
/// </summary>
/// <param name="modifier">Modifier to use</param>
/// <param name="value">Value to set</param>
/// <returns>True if set, otherwise false = <see cref="modifier"/> not found</returns>
bool SetValueFromPrintParameterModifier(FileFormat.PrintParameterModifier modifier, decimal value);
byte SetValuesFromPrintParametersModifiers();
void EditPrintParameters(OperationEditParameters operation);
/// <summary>
/// Rebuilds GCode based on current settings
/// </summary>
void RebuildGCode();
/// <summary>
/// Saves current configuration on input file
/// </summary>
/// <param name="progress"></param>
void Save(OperationProgress progress = null);
/// <summary>
/// Saves current configuration on a copy
/// </summary>
/// <param name="filePath">File path to save copy as, use null to overwrite active file (Same as <see cref="Save"/>)</param>
/// <param name="progress"></param>
void SaveAs(string filePath = null, OperationProgress progress = null);
/// <summary>
/// Converts this file type to another file type
/// </summary>
/// <param name="to">Target file format</param>
/// <param name="fileFullPath">Output path file</param>
/// <param name="progress"></param>
/// <returns>True if convert succeed, otherwise false</returns>
bool Convert(Type to, string fileFullPath, OperationProgress progress = null);
/// <summary>
/// Converts this file type to another file type
/// </summary>
/// <param name="to">Target file format</param>
/// <param name="fileFullPath">Output path file</param>
/// <param name="progress"></param>
/// <returns>True if convert succeed, otherwise false</returns>
bool Convert(FileFormat to, string fileFullPath, OperationProgress progress = null);
/// <summary>
/// Validate AntiAlias Level
/// </summary>
byte ValidateAntiAliasingLevel();
#endregion
}
}
|