Skip to content

d01_draw

d01_draw

Plot (D01) logic.

D01Draw

Bases: CommandToken

4.8.2 Plot (D01).

Performs a plotting operation, creating a draw or an arc segment. The plot state defines which type of segment is created, see 4.7. The syntax depends on the required parameters, and, hence, on the plot state.

D01 creates a linear or circular line segment by plotting from the current point to the coordinate pair in the command. Outside a region statement (see 2.3.2) these segments are converted to draw or arc objects by stroking them with the current aperture (see 2.3.1). Within a region statement these segments form a contour defining a region (see 4.10). The effect of D01, e.g. whether a straight or circular segment is created, depends on the graphics state (see 2.3.2).

Syntax

For linear (G01):

D01 = (['X' x_coordinate] ['Y' y_coordinate] 'D01') '*';

For Circular (G02|G03)

D01 = (['X' x_coordinate] ['Y' y_coordinate] 'I' x_offset 'J' y-offset ) 'D01' '*';
  • x_coordinate - <Coordinate> is coordinate data - see section 0. It defines the X coordinate of the new current point. The default is the X coordinate of the old current point.
Example
X275000Y115000D02*
G01*
X2512000Y115000D01*
G75*
G03*
X5005000Y3506000I3000J0D01*
G01*
X15752000D01*
Y12221000D01*

See section 4.8.2 of The Gerber Layer Format Specification

Source code in src\pygerber\gerberx3\tokenizer\tokens\d01_draw.py 
 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
class D01Draw(CommandToken):
    """## 4.8.2 Plot (D01).

    Performs a plotting operation, creating a draw or an arc segment. The plot state defines which
    type of segment is created, see 4.7. The syntax depends on the required parameters, and,
    hence, on the plot state.

    D01 creates a linear or circular line segment by plotting from the current point to the
    coordinate pair in the command. Outside a region statement (see 2.3.2) these segments
    are converted to draw or arc objects by stroking them with the current aperture (see 2.3.1).
    Within a region statement these segments form a contour defining a region (see 4.10). The
    effect of D01, e.g. whether a straight or circular segment is created, depends on the
    graphics state (see 2.3.2).

    ### Syntax

    For linear (G01):

    ```ebnf
    D01 = (['X' x_coordinate] ['Y' y_coordinate] 'D01') '*';
    ```

    For Circular (G02|G03)

    ```ebnf
    D01 = (['X' x_coordinate] ['Y' y_coordinate] 'I' x_offset 'J' y-offset ) 'D01' '*';
    ```

    - x_coordinate - `<Coordinate>` is coordinate data - see section 0. It defines the X coordinate of the
        new current point. The default is the X coordinate of the old current point.

    ---

    ## Example

    ```gerber
    X275000Y115000D02*
    G01*
    X2512000Y115000D01*
    G75*
    G03*
    X5005000Y3506000I3000J0D01*
    G01*
    X15752000D01*
    Y12221000D01*
    ```

    ---

    See section 4.8.2 of [The Gerber Layer Format Specification](https://www.ucamco.com/files/downloads/file_en/456/gerber-layer-format-specification-revision-2023-08_en.pdf#page=83)

    """  # noqa: E501

    def __init__(
        self,
        string: str,
        location: int,
        x: Coordinate,
        y: Coordinate,
        i: Coordinate,
        j: Coordinate,
    ) -> None:
        super().__init__(string, location)
        self.x = x
        self.y = y
        self.i = i
        self.j = j

    @classmethod
    def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
        """Create instance of this class.

        Created to be used as callback in `ParserElement.set_parse_action()`.
        """
        x = tokens.get("x")
        x = Coordinate.new(
            coordinate_type=CoordinateType.X,
            offset=str(x) if x is not None else None,
        )
        y = tokens.get("y")
        y = Coordinate.new(
            coordinate_type=CoordinateType.Y,
            offset=str(y) if y is not None else None,
        )
        i = tokens.get("i")
        i = Coordinate.new(
            coordinate_type=CoordinateType.I,
            offset=str(i) if i is not None else None,
        )
        j = tokens.get("j")
        j = Coordinate.new(
            coordinate_type=CoordinateType.J,
            offset=str(j) if j is not None else None,
        )

        return cls(
            string=string,
            location=location,
            x=x,
            y=y,
            i=i,
            j=j,
        )

    def update_drawing_state(
        self,
        state: State,
        backend: Backend,
    ) -> Tuple[State, Iterable[DrawCommand]]:
        """Set coordinate parser."""
        x = state.parse_coordinate(self.x)
        y = state.parse_coordinate(self.y)

        end_position = Vector2D(x=x, y=y)
        start_position = state.current_position

        draw_commands: list[DrawCommand] = []

        if state.is_region:
            polarity = state.polarity.to_region_variant()
        else:
            polarity = state.polarity

        if not state.is_region or backend.options.draw_region_outlines:
            draw_commands.extend(
                self._create_draw_commands(
                    state,
                    backend,
                    end_position,
                    start_position,
                    polarity,
                ),
            )

        if state.is_region:
            self._create_region_points(
                state,
                backend,
                end_position,
                start_position,
                polarity,
            )

        return (
            state.model_copy(
                update={
                    "current_position": end_position,
                },
            ),
            draw_commands,
        )

    def _create_region_points(
        self,
        state: State,
        backend: Backend,
        end_position: Vector2D,
        start_position: Vector2D,
        polarity: Polarity,
    ) -> None:
        if state.draw_mode == DrawMode.Linear:
            state.region_boundary_points.append(start_position)
            state.region_boundary_points.append(end_position)

        elif state.draw_mode in (
            DrawMode.ClockwiseCircular,
            DrawMode.CounterclockwiseCircular,
        ):
            i = state.parse_coordinate(self.i)
            j = state.parse_coordinate(self.j)

            center_offset = Vector2D(x=i, y=j)

            state.region_boundary_points.extend(
                backend.get_draw_arc_cls()(
                    backend=backend,
                    polarity=polarity,
                    start_position=start_position,
                    dx_dy_center=center_offset,
                    end_position=end_position,
                    width=Offset.NULL,
                    is_clockwise=(state.draw_mode == DrawMode.ClockwiseCircular),
                    # Will require tweaking if support for single quadrant mode
                    # will be desired.
                    is_multi_quadrant=True,
                ).calculate_arc_points(),
            )

        else:
            raise NotImplementedError(state.draw_mode)

    def _create_draw_commands(
        self,
        state: State,
        backend: Backend,
        end_position: Vector2D,
        start_position: Vector2D,
        polarity: Polarity,
    ) -> Generator[DrawCommand, None, None]:
        current_aperture = backend.get_private_aperture_handle(
            state.get_current_aperture(),
        )
        yield backend.get_draw_paste_cls()(
            backend=backend,
            polarity=polarity,
            center_position=start_position,
            other=current_aperture.drawing_target,
        )

        if state.draw_mode == DrawMode.Linear:
            if not state.is_region or backend.options.draw_region_outlines:
                yield backend.get_draw_vector_line_cls()(
                    backend=backend,
                    polarity=polarity,
                    start_position=start_position,
                    end_position=end_position,
                    width=current_aperture.get_line_width(),
                )

        elif state.draw_mode in (
            DrawMode.ClockwiseCircular,
            DrawMode.CounterclockwiseCircular,
        ):
            i = state.parse_coordinate(self.i)
            j = state.parse_coordinate(self.j)

            center_offset = Vector2D(x=i, y=j)
            if not state.is_region or backend.options.draw_region_outlines:
                yield backend.get_draw_arc_cls()(
                    backend=backend,
                    polarity=polarity,
                    start_position=start_position,
                    dx_dy_center=center_offset,
                    end_position=end_position,
                    width=current_aperture.get_line_width(),
                    is_clockwise=(state.draw_mode == DrawMode.ClockwiseCircular),
                    # Will require tweaking if support for single quadrant mode
                    # will be desired.
                    is_multi_quadrant=True,
                )

        else:
            raise NotImplementedError(state.draw_mode)

        yield backend.get_draw_paste_cls()(
            backend=backend,
            polarity=polarity,
            center_position=end_position,
            other=current_aperture.drawing_target,
        )

    def parser2_visit_token(self, context: Parser2Context) -> None:
        """Perform actions on the context implicated by this token."""
        context.get_hooks().command_draw.pre_parser_visit_token(self, context)
        context.get_hooks().command_draw.on_parser_visit_token(self, context)
        context.get_hooks().command_draw.post_parser_visit_token(self, context)

    def get_gerber_code(
        self,
        indent: str = "",
        endline: str = "\n",
    ) -> str:
        """Get gerber code represented by this token."""
        return (
            f"{indent}"
            f"{self.x.get_gerber_code(indent, endline)}"
            f"{self.y.get_gerber_code(indent, endline)}"
            f"{self.i.get_gerber_code(indent, endline)}"
            f"{self.j.get_gerber_code(indent, endline)}"
            "D01"
        )

    def get_state_based_hover_message(
        self,
        state: State,
    ) -> str:
        """Return operation specific extra information about token."""
        units = state.get_units()

        x0 = state.current_position.x.as_unit(units)
        y0 = state.current_position.x.as_unit(units)

        x1 = state.parse_coordinate(self.x).as_unit(units)
        y1 = state.parse_coordinate(self.y).as_unit(units)

        draw_mode = state.draw_mode.to_human_readable()

        aperture = state.get_current_aperture().aperture_id

        u = units.value.lower()
        d = state.draw_mode.value

        return (
            f"Draw {draw_mode} (`{d}`) from (`{x0}`{u}, `{y0}`{u}) to "
            f"(`{x1}`{u}, `{y1}`{u}) with aperture `{aperture}`"
        )

new classmethod 

new(
    string: str, location: int, tokens: ParseResults
) -> Self

Create instance of this class.

Created to be used as callback in ParserElement.set_parse_action().

Source code in src\pygerber\gerberx3\tokenizer\tokens\d01_draw.py 
 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
@classmethod
def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
    """Create instance of this class.

    Created to be used as callback in `ParserElement.set_parse_action()`.
    """
    x = tokens.get("x")
    x = Coordinate.new(
        coordinate_type=CoordinateType.X,
        offset=str(x) if x is not None else None,
    )
    y = tokens.get("y")
    y = Coordinate.new(
        coordinate_type=CoordinateType.Y,
        offset=str(y) if y is not None else None,
    )
    i = tokens.get("i")
    i = Coordinate.new(
        coordinate_type=CoordinateType.I,
        offset=str(i) if i is not None else None,
    )
    j = tokens.get("j")
    j = Coordinate.new(
        coordinate_type=CoordinateType.J,
        offset=str(j) if j is not None else None,
    )

    return cls(
        string=string,
        location=location,
        x=x,
        y=y,
        i=i,
        j=j,
    )

update_drawing_state 

update_drawing_state(
    state: State, backend: Backend
) -> Tuple[State, Iterable[DrawCommand]]

Set coordinate parser.

Source code in src\pygerber\gerberx3\tokenizer\tokens\d01_draw.py 
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
def update_drawing_state(
    self,
    state: State,
    backend: Backend,
) -> Tuple[State, Iterable[DrawCommand]]:
    """Set coordinate parser."""
    x = state.parse_coordinate(self.x)
    y = state.parse_coordinate(self.y)

    end_position = Vector2D(x=x, y=y)
    start_position = state.current_position

    draw_commands: list[DrawCommand] = []

    if state.is_region:
        polarity = state.polarity.to_region_variant()
    else:
        polarity = state.polarity

    if not state.is_region or backend.options.draw_region_outlines:
        draw_commands.extend(
            self._create_draw_commands(
                state,
                backend,
                end_position,
                start_position,
                polarity,
            ),
        )

    if state.is_region:
        self._create_region_points(
            state,
            backend,
            end_position,
            start_position,
            polarity,
        )

    return (
        state.model_copy(
            update={
                "current_position": end_position,
            },
        ),
        draw_commands,
    )

parser2_visit_token 

parser2_visit_token(context: Parser2Context) -> None

Perform actions on the context implicated by this token.

Source code in src\pygerber\gerberx3\tokenizer\tokens\d01_draw.py 
274
275
276
277
278
def parser2_visit_token(self, context: Parser2Context) -> None:
    """Perform actions on the context implicated by this token."""
    context.get_hooks().command_draw.pre_parser_visit_token(self, context)
    context.get_hooks().command_draw.on_parser_visit_token(self, context)
    context.get_hooks().command_draw.post_parser_visit_token(self, context)

get_gerber_code 

get_gerber_code(
    indent: str = "", endline: str = "\n"
) -> str

Get gerber code represented by this token.

Source code in src\pygerber\gerberx3\tokenizer\tokens\d01_draw.py 
280
281
282
283
284
285
286
287
288
289
290
291
292
293
def get_gerber_code(
    self,
    indent: str = "",
    endline: str = "\n",
) -> str:
    """Get gerber code represented by this token."""
    return (
        f"{indent}"
        f"{self.x.get_gerber_code(indent, endline)}"
        f"{self.y.get_gerber_code(indent, endline)}"
        f"{self.i.get_gerber_code(indent, endline)}"
        f"{self.j.get_gerber_code(indent, endline)}"
        "D01"
    )

get_state_based_hover_message 

get_state_based_hover_message(state: State) -> str

Return operation specific extra information about token.

Source code in src\pygerber\gerberx3\tokenizer\tokens\d01_draw.py 
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
def get_state_based_hover_message(
    self,
    state: State,
) -> str:
    """Return operation specific extra information about token."""
    units = state.get_units()

    x0 = state.current_position.x.as_unit(units)
    y0 = state.current_position.x.as_unit(units)

    x1 = state.parse_coordinate(self.x).as_unit(units)
    y1 = state.parse_coordinate(self.y).as_unit(units)

    draw_mode = state.draw_mode.to_human_readable()

    aperture = state.get_current_aperture().aperture_id

    u = units.value.lower()
    d = state.draw_mode.value

    return (
        f"Draw {draw_mode} (`{d}`) from (`{x0}`{u}, `{y0}`{u}) to "
        f"(`{x1}`{u}, `{y1}`{u}) with aperture `{aperture}`"
    )