# Guideline

## Must Override

BaseGuideline._get_angle()

  This is the environment implementation of `BaseGuideline.angle`. This must return an Angle.

  Subclasses must override this method.

BaseGuideline._get_color()

  This is the environment implementation of `BaseGuideline.color`. This must return a Color or `None`. The returned value will be normalized with `normalizers.normalizeColor`.

  Subclasses must override this method.

BaseGuideline._get_identifier()

  This is the environment implementation of `BaseObject.identifier`. This must return an Identifier. If the native object does not have an identifier assigned one should be assigned and returned.

  Subclasses must override this method.

BaseGuideline._get_name()

  This is the environment implementation of `BaseGuideline.name`. This must return a String or `None`. The returned value will be normalized with `normalizers.normalizeGuidelineName`.

  Subclasses must override this method.

BaseGuideline._get_x()

  This is the environment implementation of `BaseGuideline.x`. This must return an Integer/Float.

  Subclasses must override this method.

BaseGuideline._get_y()

  This is the environment implementation of `BaseGuideline.y`. This must return an Integer/Float.

  Subclasses must override this method.

BaseGuideline._set_angle(value)

  This is the environment implementation of `BaseGuideline.angle`. value will be an Angle.

  Subclasses must override this method.

BaseGuideline._set_color(value)

  This is the environment implementation of `BaseGuideline.color`. value will be a Color or `None`. It will have been normalized with `normalizers.normalizeColor`.

  Subclasses must override this method.

BaseGuideline._set_name(value)

  This is the environment implementation of `BaseGuideline.name`. value will be a String or `None`. It will have been normalized with `normalizers.normalizeGuidelineName`.

  Subclasses must override this method.

BaseGuideline._set_x(value)

  This is the environment implementation of `BaseGuideline.x`. value will be an Integer/Float.

  Subclasses must override this method.

BaseGuideline._set_y(value)

  This is the environment implementation of `BaseGuideline.y`. value will be an Integer/Float.

  Subclasses must override this method.

## May Override

BaseGuideline._get_index()

  Get the guideline’s index. This must return an `int`.

  Subclasses may override this method.

BaseGuideline._init(*args, **kwargs)

  Subclasses may override this method.

BaseGuideline._moveBy(value, **kwargs)

  This is the environment implementation of `BaseObject.moveBy`.

  value will be an iterable containing two Integer/Float values defining the x and y values to move the object by. It will have been normalized with `normalizers.normalizeTransformationOffset`.

  Subclasses may override this method.

BaseGuideline._rotateBy(value, origin=None, **kwargs)

  This is the environment implementation of `BaseObject.rotateBy`.

  value will be a Integer/Float value defining the value to rotate the object by. It will have been normalized with `normalizers.normalizeRotationAngle`. origin will be a Coordinate defining the point at which the rotation should orginate.

  Subclasses may override this method.

BaseGuideline._round(**kwargs)

  This is the environment implementation of `BaseGuideline.round`.

  Subclasses may override this method.

BaseGuideline._scaleBy(value, origin=None, **kwargs)

  This is the environment implementation of `BaseObject.scaleBy`.

  value will be an iterable containing two Integer/Float values defining the x and y values to scale the object by. It will have been normalized with `normalizers.normalizeTransformationScale`. origin will be a Coordinate defining the point at which the scale should orginate.

  Subclasses may override this method.

BaseGuideline._skewBy(value, origin=None, **kwargs)

  This is the environment implementation of `BaseObject.skewBy`.

  value will be an iterable containing two Integer/Float values defining the x and y values to skew the object by. It will have been normalized with `normalizers.normalizeTransformationSkewAngle`. origin will be a Coordinate defining the point at which the skew should orginate.

  Subclasses may override this method.

BaseGuideline._transformBy(matrix, **kwargs)

  This is the environment implementation of `BaseGuideline.transformBy`.

  matrix will be a Transformation Matrix. that has been normalized with `normalizers.normalizeTransformationMatrix`.

  Subclasses may override this method.

BaseGuideline.copyData(source)

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

Previous

Anchor

Next

Image