Skip to content

ls_load_scaling

ls_load_scaling

Wrapper for load scaling token.

LoadScaling

Bases: Token

Wrapper for load scaling token.

LS Command: Scaling Graphics State Parameter

The LS command is employed to establish the scaling graphics state parameter.

Functionality: - The command dictates the scale factor utilized during object creation. - The aperture undergoes scaling, anchored at its origin. It's crucial to note that this origin might not always align with its geometric center.

Usage and Persistence: - The LS command can be invoked multiple times within a single file. - Once set, the object scaling retains its value unless a subsequent LS command modifies it. - The scaling gets adjusted based on the specific value mentioned in the command and doesn't accumulate with the preceding scale factor.

The LS command was introduced in revision 2016.12.

SPEC: 2023.03 SECTION: 4.9.5

Source code in src/pygerber/gerberx3/tokenizer/tokens/ls_load_scaling.py 
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
class LoadScaling(Token):
    """Wrapper for load scaling token.

    ### LS Command: Scaling Graphics State Parameter

    The `LS` command is employed to establish the scaling graphics state parameter.

    Functionality:
    - The command dictates the scale factor utilized during object creation.
    - The aperture undergoes scaling, anchored at its origin. It's crucial to note that
        this origin might not always align with its geometric center.

    Usage and Persistence:
    - The `LS` command can be invoked multiple times within a single file.
    - Once set, the object scaling retains its value unless a subsequent `LS` command
        modifies it.
    - The scaling gets adjusted based on the specific value mentioned in the command and
        doesn't accumulate with the preceding scale factor.

    The LS command was introduced in revision 2016.12.

    SPEC: `2023.03` SECTION: `4.9.5`
    """

    scaling: Decimal

    @classmethod
    def from_tokens(cls, **tokens: Any) -> Self:
        """Initialize token object."""
        scaling = Decimal(tokens["scaling"])
        return cls(scaling=scaling)

    def update_drawing_state(
        self,
        state: State,
        _backend: Backend,
    ) -> Tuple[State, Iterable[DrawCommand]]:
        """Set drawing polarity."""
        return (
            state.model_copy(
                update={
                    "scaling": self.scaling,
                },
            ),
            (),
        )

    def __str__(self) -> str:
        return f"LS{self.scaling}*"

from_tokens classmethod 

from_tokens(**tokens: Any) -> Self

Initialize token object.

Source code in src/pygerber/gerberx3/tokenizer/tokens/ls_load_scaling.py 
43
44
45
46
47
@classmethod
def from_tokens(cls, **tokens: Any) -> Self:
    """Initialize token object."""
    scaling = Decimal(tokens["scaling"])
    return cls(scaling=scaling)

update_drawing_state 

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

Set drawing polarity.

Source code in src/pygerber/gerberx3/tokenizer/tokens/ls_load_scaling.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def update_drawing_state(
    self,
    state: State,
    _backend: Backend,
) -> Tuple[State, Iterable[DrawCommand]]:
    """Set drawing polarity."""
    return (
        state.model_copy(
            update={
                "scaling": self.scaling,
            },
        ),
        (),
    )