Guideline

Must Override

BaseGuideline._get_angle() → int | float | None

Get the native guideline’s angle.

This is the environment implementation of the BaseGuideline.angle property getter.

Returns:

An int or a float representing the angle of the guideline, or None. The value will be normalized with normalizers.normalizeRotationAngle.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._get_color() → tuple[float, float, float, float] | None

Get the native guideline’s color.

This is the environment implementation of the BaseGuideline.color property getter.

Returns:

A Color representing the color of the guideline, or None. The value will be normalized with normalizers.normalizeColor.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._get_identifier() → str | None

Get the native object’s unique identifier.

This is the environment implementation of IdentifierMixin.identifier.

If the native object does not have an identifier assigned, one may be assigned with IdentifierMixin.getIdentifier

Returns:

The unique identifier assigned to the object as a str, or None indicating the object has no identifier.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._get_name() → str | None

Get the native guideline’s name.

This is the environment implementation of the BaseGuideline.name property getter.

Returns:

A str representing the name of the guideline, or None. The value will have been normalized with normalizers.normalizeGuidelineName.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._get_x() → int | float

Get the native guideline’s x-coordinate.

This is the environment implementation of the BaseGuideline.x property getter.

Returns:

An int or a flat representing the x-coordinate of the guideline. The value will be normalized with normalizers.normalizeX.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._get_y() → int | float

Get the native guideline’s y-coordinate.

This is the environment implementation of the BaseGuideline.y property getter.

Returns:

An int or a flat representing the y-coordinate of the guideline. The value will be normalized with normalizers.normalizeY.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._set_angle(value: float | None) → None

Set the native guideline’s angle.

This is the environment implementation of the BaseGuideline.angle property setter.

Parameters:

value – The angle to set as an int or a float, or None. The value will have been normalized with normalizers.normalizeRotationAngle.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._set_color(value: list[int | float] | tuple[float, float, float, float] | None) → None

Set the native guideline’s color.

This is the environment implementation of the BaseGuideline.color property setter.

Parameters:

value – The Color to set for the guideline or None. The value will have been normalized with normalizers.normalizeColor.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._set_name(value: str | None) → None

Set the native guideline’s name.

This is the environment implementation of the BaseGuideline.name property setter.

Parameters:

value – The name to set as a str or None. The value will have been normalized with normalizers.normalizeGuidelineName.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._set_x(value: int | float) → None

Set the native guideline’s x-coordinate.

This is the environment implementation of the BaseGuideline.x property setter.

Parameters:

value – The x-coordinate to set as an int or a float. The value will have been normalized with normalizers.normalizeX.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

BaseGuideline._set_y(value: int | float) → None

Set the native guideline’s y-coordinate.

This is the environment implementation of the BaseGuideline.y property setter.

Parameters:

value – The y-coordinate to set as an int or a float. The value will have been normalized with normalizers.normalizeY.

Raises:

NotImplementedError – If the method has not been overridden by a subclass.

Important

Subclasses must override this method.

May Override

BaseGuideline._get_index() → int | None

Get the native guideline’s index.

This is the environment implementation of the BaseGuideline.index property getter.

Returns:

An int representing the index of the guideline within the ordered list of the parent glyph’s guidelines. The value will be normalized with normalizers.normalizeIndex.

Note

Subclasses may override this method.

BaseGuideline._init(*args: Any, **kwargs: Any) → None

Initialize the native object.

This is the environment implementation of BaseObject.__init__.

Parameters:

• *args – Any positional arguments.

• **kwargs – Any keyword arguments.

Note

Subclasses may override this method.

BaseGuideline._moveBy(value: list[int | float] | tuple[int | float, int | float], **kwargs: Any) → None

Move the native object according to the given coordinates.

This is the environment implementation of BaseObject.moveBy.

Parameters:

• value – The x and y values to move the object by as a Coordinate. The value will have been normalized with normalizers.normalizeTransformationOffset.

• **kwargs – Additional keyword arguments.

Note

Subclasses may override this method.

BaseGuideline._rotateBy(value: float, origin: list[int | float] | tuple[int | float, int | float], **kwargs: Any) → None

Rotate the native object by the specified value.

This is the environment implementation of TransformationMixin.rotateBy.

Parameters:

• value – The angle at which to rotate the object as an int or a float. The value will have been normalized with normalizers.normalizeRotationAngle.

• origin – The point at which the rotation should originate as a Coordinate or None. The value will have been normalized with normalizers.normalizeCoordinateTuple.

• **kwargs – Additional keyword arguments.

Note

Subclasses may override this method.

BaseGuideline._round(**kwargs: Any) → None

Round the native guideline’s coordinate.

This is the environment implementation of BaseGuideline.round.

Parameters:

**kwargs – Additional keyword arguments.

Note

Subclasses may override this method.

BaseGuideline._scaleBy(value: list[int | float] | tuple[float, float], origin: list[int | float] | tuple[int | float, int | float], **kwargs: Any) → None

Scale the native object according to the given values.

This is the environment implementation of BaseObject.scaleBy.

Parameters:

• value – The value to scale the glyph by as a single int or float, or a tuple or list of two int or float values representing the values (x, y). The value will have been normalized with normalizeTransformationScale.

• origin – The point at which the scale should originate as a Coordinate or None. The value will have been normalized with normalizers.normalizeCoordinateTuple.

• **kwargs – Additional keyword arguments.

Note

Subclasses may override this method.

BaseGuideline._skewBy(value: list[int | float] | tuple[float, float], origin: list[int | float] | tuple[int | float, int | float], **kwargs: Any) → None

Skew the native object by the given value.

This is the environment implementation of TransformationMixin.skewBy.

Parameters:

• value – The value by which to skew the object as either a single int or float corresponding to the x direction, or a tuple of two int or float values corresponding to the x and y directions. The value will have been normalized with normalizers.normalizeTransformationSkewAngle.

• origin – The point at which the rotation should originate as a Coordinate or None. The value will have been normalized with normalizers.normalizeCoordinateTuple.

• **kwargs – Additional keyword arguments.

Note

Subclasses may override this method.

BaseGuideline._transformBy(matrix: list[int | float] | tuple[float, float, float, float, float, float], **kwargs: Any) → None

Transform the native guideline according to the given matrix.

This is the environment implementation of BaseGuideline.transformBy.

Parameters:

• matrix – The Transformation Matrix to apply. The value will be normalized with normalizers.normalizeTransformationMatrix.

• **kwargs – Additional keyword arguments.

Note

Subclasses may override this method.

BaseGuideline.copyData(source: BaseObjectType) → None

Copy data from source into the current object.

Note

Subclasses may override this method. If so, they should call the super.

Previous

Anchor

Next

Image