document

This node holds all information included in a smile2 document.

This page provides a rather short reference of the plugs of a document. To learn more on what smile2 documents are, consult the Documents chapter in the smile2 manual.

An illustration of how the document attributes are organized in the Attribute Editor can be found in the Document settings.

Attribute Reference

Write field

Write Field Size

writeFieldSize dist10 (⇨ square) dist50 plug_in plug_out , f_default Size: 200 Center: 0 0

Square that defines the write filed (soft size). More information about write fields in smile2 can be found in the Write Field chapter.

Behavior

Snapping

Settings related to snapping.

Point snapping

snapToPoints dist10 (⇨ bool) dist50 plug_in plug_out , f_default False

If on, point snapping is enabled.

Grid snapping

snapToGrid dist10 (⇨ bool) dist50 plug_in plug_out , f_default False

If on, grid snapping is enabled.

Grid snapping distance

snapToGridDist dist10 (⇨ double) dist50 plug_in plug_out , f_default 0.2

Distance for the point snapping grid.

Default snapping angle

angleSnappingAngle dist10 (⇨ double) dist50 plug_in plug_out , f_default 10

Value in DEG (°) for the rough polar snapping angle.

Fine snapping angle

fineAngleSnappingAngle dist10 (⇨ double) dist50 plug_in plug_out , f_default 1

Value in DEG (°) for the fine polar snapping angle.

Selection

Drag-selection mode

dragSelectionMode dist10 (⇨ BoxSelectionMode) dist50 plug_in plug_out , f_default Enclosed

Sets the behavior of the “drag selection”. If set to Fully Inside (Enclosed), only objects that are fully inside the selection rectangle are selected (Powerpoint like).

If set to Partially Inside, objects that are only “touched” by the selection rectangle are also selected (most CAD-Editors use this mode).

Display

Display style

displayStyle dist10 (⇨ DisplayStyle) dist50 plug_in plug_out , f_default FilledAndLines

“Style” used to draw the structure (in the Document View).

Show selection group membership
drawGroupIndicators dist10 (⇨ bool) dist50 plug_in plug_out , f_default True
Show guide lines
guidesEnabled dist10 (⇨ bool) dist50 plug_in plug_out , f_default True
Display objects per Layer
perLayerDisplay dist10 (⇨ bool) dist50 plug_in plug_out , f_default False

Appearance

Setting, related to the appearance of the document view.

Background color
bgColor dist10 (⇨ color) dist50 plug_in plug_out , f_default rgb(80,80,80)
Show main grid
showMainGrid dist10 (⇨ bool) dist50 plug_in plug_out , f_default True
Main grid color
mainGridColor dist10 (⇨ color) dist50 plug_in plug_out , f_default rgb(160,160,160)
Show sub grid
showSubGrid dist10 (⇨ bool) dist50 plug_in plug_out , f_default True
Sub grid color
subGridColor dist10 (⇨ color) dist50 plug_in plug_out , f_default rgb(170,170,170)
Show writable area
showSoftSize dist10 (⇨ bool) dist50 plug_in plug_out , f_default True
Writable area background color
softSizeBgColor dist10 (⇨ color) dist50 plug_in plug_out , f_default rgb(200,200,200)
Show hardware limit
showHardSize dist10 (⇨ bool) dist50 plug_in plug_out , f_default True
Hardware limit background color
hardSizeBgColor dist10 (⇨ color) dist50 plug_in plug_out , f_default rgb(180,180,180)
Draw center
drawOrigin dist10 (⇨ bool) dist50 plug_in plug_out , f_default True
Origin indicator color
originColor dist10 (⇨ color) dist50 plug_in plug_out , f_default rgb(90,120,90)

Save options

Options, that control how documents are saved, and what kind of information is saved.

Save scan images

saveScans dist10 (⇨ bool) dist50 plug_in plug_out , f_default False

If on, scans are saved, it off, scans are omitted.
Save align matrix

saveAlignMatrix dist10 (⇨ bool) dist50 plug_in plug_out , f_default False

If on, the alignment matrix (if any), is stored in the document file, it off, it is omitted.
Optimize file size

optimizeFileSize dist10 (⇨ bool) dist50 plug_in plug_out , f_default False

If on, the values of all plugs that have an input connection are not saved, leading to a smaller file size. However, if the input comes from a node that is implemented in a plug-in that is not available during loading of the document file, the plug value cannot be restored.

Use compression

compress dist10 (⇨ bool) dist50 plug_in plug_out , f_default True

If on the resulting lbf-file is compressed, leading to a smaller file size.

Note

Compressed files are smaller, but slower to save and load (at least on SSD hard drives).

Other Attributes (Hidden)

Edit mode selection filter
alignSelectionFilter dist10 (⇨ int) dist50 plug_in plug_out , f_default 192
Display space
displaySpace dist10 (⇨ DisplaySpace) dist50 plug_in plug_out , f_default NativeSpace
Edit mode selection filter
editSelectionFilter dist10 (⇨ int) dist50 plug_in plug_out , f_default 510
File
filePath dist10 (⇨ wstring) dist50 plug_in plug_out , f_default Unspecified
Hardware Limit
hardwareLimitSize dist10 (⇨ square) dist50 plug_out , f_default Size: 0 Center: 0 0
Selection mode
selectionMode dist10 (⇨ SelectionMode) dist50 plug_in plug_out , f_default Groups
Object Name

name dist10 (⇨ string) dist50 plug_in plug_out , f_default Unnamed

The object name can be used to address objects from PYTHON scripts or from an expression (eg. in the Attribute Editor). More information about object names can be found Object Names

PYTHON Reference

This class can be instantiated (directly). It is derived from NodeManager.