Skip to content

GuidelineMarks class

Bases: pytvpaint.guideline.Guideline[pytvpaint.george.TVPGuidelineMarks, pytvpaint.george.GuidelineType]

A GuidelineCircle is a set of marks used as guidelines for artists.

Source code in pytvpaint\guideline.py 
606
607
608
609
610
611
612
613
def __init__(
    self,
    position: int,
    project: Project,
    data: george.TVPGuidelineMarks | None = None,
) -> None:
    super().__init__(position, project)
    self._data: george.TVPGuidelineMarks = data or george.tv_guideline_modify_marks_get(self._position)

TYPE = george.GuidelineType.MARKS class-attribute instance-attribute

refresh_on_call = True instance-attribute

is_removed: bool property

Checks if the object is removed by trying to refresh its data.

Returns:

Name Type Description
bool bool

whether if it was removed or not

position: int property

The position of the guideline.

data: GuidelineDT | None property

Returns the raw data of the guideline.

project: Project property

The project instance the guideline belongs to.

name: str property writable

The name of the guideline.

is_visible: bool property writable

The guideline visibility.

margin: int property writable

The guideline margin.

color: george.RGBAColor property writable

The guideline color.

snap: bool property writable

The guideline snap state.

collapse: bool property writable

The guideline collapse state.

refresh() -> None

Refreshes the guideline data.

Source code in pytvpaint\guideline.py 
615
616
617
618
619
620
def refresh(self) -> None:
    """Refreshes the guideline data."""
    super().refresh()
    if not self.refresh_on_call and self._data:
        return
    self._data = george.tv_guideline_modify_marks_get(self._position)

count_x(value: int) -> None

The number of vertical marks.

Warning

function GuidelineMarks.x doesn't seem to work in tvpaint, values are never changed.

Source code in pytvpaint\guideline.py 
627
628
629
630
631
632
633
634
@count_x.setter
def count_x(self, value: int) -> None:
    """The number of vertical marks.

    Warning:
        function GuidelineMarks.x doesn't seem to work in tvpaint, values are never changed.
    """
    george.tv_guideline_modify_marks_set(self.position, count_x=value)

count_y(value: int) -> None

The number of vertical marks.

Warning

function GuidelineMarks.y doesn't seem to work in tvpaint, values are never changed.

Source code in pytvpaint\guideline.py 
641
642
643
644
645
646
647
648
@count_y.setter
def count_y(self, value: int) -> None:
    """The number of vertical marks.

    Warning:
        function GuidelineMarks.y doesn't seem to work in tvpaint, values are never changed.
    """
    george.tv_guideline_modify_marks_set(self.position, count_y=value)

new(project: Project, count_x: int | None = None, count_y: int | None = None) -> GuidelineMarks classmethod

Create a new guideline in the project.

Source code in pytvpaint\guideline.py 
650
651
652
653
654
655
656
657
658
659
660
661
@classmethod
def new(
    cls,
    project: Project,
    count_x: int | None = None,
    count_y: int | None = None,
) -> GuidelineMarks:
    """Create a new guideline in the project."""
    project.make_current()

    position = george.tv_guideline_add_marks(count_x, count_y)
    return cls(position, project)

remove() -> None

Remove the guideline.

Warning

the guideline instance won't be usable after removal

Source code in pytvpaint\guideline.py 
151
152
153
154
155
156
157
158
159
def remove(self) -> None:
    """Remove the guideline.

    Warning:
        the guideline instance won't be usable after removal
    """
    if self.TYPE:
        george.tv_guideline_remove(self.position, self.TYPE)
    self.mark_removed()

mark_removed() -> None

Marks the object as removed and is therefor not usable.

Source code in pytvpaint\utils.py 
 98
 99
100
def mark_removed(self) -> None:
    """Marks the object as removed and is therefor not usable."""
    self._is_removed = True

set_all_visible(value: bool) -> None classmethod

Set visibility state on all guidelines.

Source code in pytvpaint\guideline.py 
121
122
123
124
@classmethod
def set_all_visible(cls, value: bool) -> None:
    """Set visibility state on all guidelines."""
    george.tv_guideline_visibility_set_all(cls.TYPE, value)

set_all_margin(value: int) -> None classmethod

Set the margin on all guidelines.

Source code in pytvpaint\guideline.py 
126
127
128
129
@classmethod
def set_all_margin(cls, value: int) -> None:
    """Set the margin on all guidelines."""
    george.tv_guideline_margin_set_all(cls.TYPE, value)

set_all_color(value: george.RGBAColor) -> None classmethod

Set the color on all guidelines.

Source code in pytvpaint\guideline.py 
131
132
133
134
@classmethod
def set_all_color(cls, value: george.RGBAColor) -> None:
    """Set the color on all guidelines."""
    george.tv_guideline_color_set_all(cls.TYPE, value)

set_all_snap(value: bool) -> None classmethod

Set the snap state on all guidelines.

Source code in pytvpaint\guideline.py 
136
137
138
139
@classmethod
def set_all_snap(cls, value: bool) -> None:
    """Set the snap state on all guidelines."""
    george.tv_guideline_snap_set_all(cls.TYPE, value)

set_global_visible(value: bool) -> None staticmethod

Set the visibility on the global guideline.

Source code in pytvpaint\guideline.py 
141
142
143
144
@staticmethod
def set_global_visible(value: bool) -> None:
    """Set the visibility on the global guideline."""
    george.tv_guideline_visibility_set(0, value, on_global=True)

set_global_snap(value: bool) -> None staticmethod

Set snap state on the global guideline.

Source code in pytvpaint\guideline.py 
146
147
148
149
@staticmethod
def set_global_snap(value: bool) -> None:
    """Set snap state on the global guideline."""
    george.tv_guideline_snap_set(0, value, on_global=True)