Skip to content

GuidelineSafeArea class

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

A GuidelineSafeArea is an area used as guideline for artists.

Source code in pytvpaint/guideline.py 
713
714
715
716
717
718
719
720
def __init__(
    self,
    position: int,
    project: Project,
    data: george.TVPGuidelineSafeArea | None = None,
) -> None:
    super().__init__(position, project)
    self._data: george.TVPGuidelineSafeArea = data or george.tv_guideline_modify_safe_area_get(self._position)

TYPE = george.GuidelineType.SAFE_AREA 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 
722
723
724
725
726
727
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_safe_area_get(self._position)

sf_out(value: float) -> None

Source code in pytvpaint/guideline.py 
734
735
736
@sf_out.setter
def sf_out(self, value: float) -> None:
    george.tv_guideline_modify_safe_area_set(self.position, sf_out=value)

sf_in(value: float) -> None

Source code in pytvpaint/guideline.py 
743
744
745
@sf_in.setter
def sf_in(self, value: float) -> None:
    george.tv_guideline_modify_safe_area_set(self.position, sf_in=value)

new(project: Project, sf_out: int | None = None, sf_in: int | None = None) -> GuidelineSafeArea classmethod

Create a new guideline in the project.

Source code in pytvpaint/guideline.py 
747
748
749
750
751
752
753
754
755
756
757
758
@classmethod
def new(
    cls,
    project: Project,
    sf_out: int | None = None,
    sf_in: int | None = None,
) -> GuidelineSafeArea:
    """Create a new guideline in the project."""
    project.make_current()

    position = george.tv_guideline_add_safe_area(sf_out, sf_in)
    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)