svgen.cartesian
index
/home/vkottler/src/vkottler/workspace/svgen/svgen/cartesian/__init__.py

svgen - A module for Cartesian-coordinate interfaces.

 
Package Contents
       
circle
mutate
plane
point
rectangle (package)

 
Classes
       
builtins.tuple(builtins.object)
DimensionAttrs
Dimensions

 
class DimensionAttrs(builtins.tuple)
    DimensionAttrs(width: svgen.attribute.SimpleAttribute, height: svgen.attribute.SimpleAttribute)
 
A grouping for 'width' and 'height' attributes.
 
 
Method resolution order:
DimensionAttrs
builtins.tuple
builtins.object

Methods defined here:
__getnewargs__(self)
Return self as a plain tuple.  Used by copy and pickle.
__repr__(self)
Return a nicely formatted representation string
_asdict(self)
Return a new dict which maps field names to their values.
_replace(self, /, **kwds)
Return a new DimensionAttrs object replacing specified fields with new values

Class methods defined here:
_make(iterable) from builtins.type
Make a new DimensionAttrs object from a sequence or iterable

Static methods defined here:
__new__(_cls, width: svgen.attribute.SimpleAttribute, height: svgen.attribute.SimpleAttribute)
Create new instance of DimensionAttrs(width, height)

Readonly properties defined here:
height_val
Get the 'height' value for these dimensions.
width_val
Get this 'width' value for these dimensions.

Data descriptors defined here:
width
Alias for field number 0
height
Alias for field number 1

Data and other attributes defined here:
__annotations__ = {'height': <class 'svgen.attribute.SimpleAttribute'>, 'width': <class 'svgen.attribute.SimpleAttribute'>}
__match_args__ = ('width', 'height')
__orig_bases__ = (<function NamedTuple>,)
_field_defaults = {}
_fields = ('width', 'height')

Methods inherited from builtins.tuple:
__add__(self, value, /)
Return self+value.
__contains__(self, key, /)
Return bool(key in self).
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getitem__(self, key, /)
Return self[key].
__gt__(self, value, /)
Return self>value.
__hash__(self, /)
Return hash(self).
__iter__(self, /)
Implement iter(self).
__le__(self, value, /)
Return self<=value.
__len__(self, /)
Return len(self).
__lt__(self, value, /)
Return self<value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__rmul__(self, value, /)
Return value*self.
count(self, value, /)
Return number of occurrences of value.
index(self, value, start=0, stop=9223372036854775807, /)
Return first index of value.
 
Raises ValueError if the value is not present.

Class methods inherited from builtins.tuple:
__class_getitem__(...) from builtins.type
See PEP 585

 
class Dimensions(builtins.tuple)
    Dimensions(width: float, height: float)
 
A set of dimensions describing a rectangular entity.
 
 
Method resolution order:
Dimensions
builtins.tuple
builtins.object

Methods defined here:
__eq__(self, other: object) -> bool
Determine if these dimensions are equivalent to another set.
__getnewargs__(self)
Return self as a plain tuple.  Used by copy and pickle.
__hash__(self) -> int
Get a suitable hash value for this instance.
__repr__(self)
Return a nicely formatted representation string
__str__(self) -> str
Get this instance as a string.
_asdict(self)
Return a new dict which maps field names to their values.
_replace(self, /, **kwds)
Return a new Dimensions object replacing specified fields with new values
scale(self, width_scale: float = 1.0, height_scale: float = 1.0) -> 'Dimensions'
Scale these dimensions.
to_centered_square(self, scale: float = 1.0) -> Tuple[ForwardRef('Dimensions'), svgen.cartesian.mutate.Translation]
Make dimensions square and determine the resulting translation that
would be needed to logically center the new object.
to_square(self, scale: float = 1.0) -> 'Dimensions'
Convert these dimensions to a scaled square.

Class methods defined here:
_make(iterable) from builtins.type
Make a new Dimensions object from a sequence or iterable

Static methods defined here:
__new__(_cls, width: float, height: float)
Create new instance of Dimensions(width, height)

Readonly properties defined here:
attrs
Get the 'width' and 'height' attributes for these dimensions.
dx
An alias for width.
dy
An alias for height.
height_attr
Get the 'height' attribute for these dimensions.
square
Determine if these dimensions are square.
width_attr
Get the 'width' attribute for these dimensions.

Data descriptors defined here:
width
Alias for field number 0
height
Alias for field number 1

Data and other attributes defined here:
__annotations__ = {'height': <class 'float'>, 'width': <class 'float'>}
__match_args__ = ('width', 'height')
__orig_bases__ = (<function NamedTuple>,)
_field_defaults = {}
_fields = ('width', 'height')

Methods inherited from builtins.tuple:
__add__(self, value, /)
Return self+value.
__contains__(self, key, /)
Return bool(key in self).
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getitem__(self, key, /)
Return self[key].
__gt__(self, value, /)
Return self>value.
__iter__(self, /)
Implement iter(self).
__le__(self, value, /)
Return self<=value.
__len__(self, /)
Return len(self).
__lt__(self, value, /)
Return self<value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__rmul__(self, value, /)
Return value*self.
count(self, value, /)
Return number of occurrences of value.
index(self, value, start=0, stop=9223372036854775807, /)
Return first index of value.
 
Raises ValueError if the value is not present.

Class methods inherited from builtins.tuple:
__class_getitem__(...) from builtins.type
See PEP 585

 
Functions
       
distance(point_a: svgen.cartesian.point.Point, point_b: svgen.cartesian.point.Point = Point(x=0.0, y=0.0, center=False, idx=-1)) -> float
Compute the distance between two points.
isclose(a, b, *, rel_tol=1e-09, abs_tol=0.0)
Determine whether two floating point numbers are close in value.
 
  rel_tol
    maximum difference for being considered "close", relative to the
    magnitude of the input values
  abs_tol
    maximum difference for being considered "close", regardless of the
    magnitude of the input values
 
Return True if a is close in value to b, and False otherwise.
 
For the values to be considered close, the difference between them
must be smaller than at least one of the tolerances.
 
-inf, inf and NaN behave similarly to the IEEE 754 Standard.  That
is, NaN is not close to anything, even itself.  inf and -inf are
only close to themselves.

 
Data
        DEFAULT = Point(x=0.0, y=0.0, center=False, idx=-1)
Tuple = typing.Tuple
UNITY = 1.0
__annotations__ = {'UNITY': <class 'float'>}