Document GCodeWriter class

Contributes to issue CURA-1278.
This commit is contained in:
Ghostkeeper 2016-05-24 02:28:56 +02:00
parent 673f63cf51
commit 8b5c4b0361
No known key found for this signature in database
GPG key ID: 701948C5954A7385

View file

@ -6,7 +6,16 @@ from UM.Logger import Logger
from UM.Application import Application from UM.Application import Application
import re #For escaping characters in the settings. import re #For escaping characters in the settings.
## Writes g-code to a file.
#
# While this poses as a mesh writer, what this really does is take the g-code
# in the entire scene and write it to an output device. Since the g-code of a
# single mesh isn't separable from the rest what with rafts and travel moves
# and all, it doesn't make sense to write just a single mesh.
#
# So this plug-in takes the g-code that is stored in the root of the scene
# node tree, adds a bit of extra information about the profiles and writes
# that to the output device.
class GCodeWriter(MeshWriter): class GCodeWriter(MeshWriter):
## The file format version of the serialised g-code. ## The file format version of the serialised g-code.
# #