Source code for TXLWizard.Patterns.AbstractPattern

'''
Provides an abstract class for `Pattern` objects
'''

import os.path
import sys

sys.path.append(os.path.abspath(os.path.dirname(__file__) + '/../'))

from Helpers import Tuttifrutti
import copy


[docs]class AbstractPattern(object):
    '''
    Provides an abstract class for `Pattern` objects.


    Parameters
    ----------
    Layer: int, optional
        Specifies the `Layer` attribute of the pattern.\n
        Defaults to None.
    DataType: int, optional
        Specifies the `DataType` attribute of the pattern.\n
        Defaults to None.
    RotationAngle: float, optional
        Specifies the `RotationAngle` attribute of the pattern.\n
        Defaults to None.
    StrokeWidth: float, optional
        Specifies the `StrokeWidth` attribute of the pattern.\n
        Defaults to None.
    ScaleFactor: float, optional
        Specifies the `ScaleFactor` attribute of the pattern.\n
        Defaults to None.
    '''

    def __init__(self, **kwargs):

        #: str: specifies the type of the pattern.
        self.Type = 'AbstractPattern'

        #: list of float, x- and y- coordinates of the origin point of the pattern
        self._OriginPoint = [0, 0]

        #: :class:`TXLWizard.TXLWriter.TXLWriter`: reference to the current `TXLWriter` instance
        self._TXLWriter = None

        #: :class:`TXLWizard.Patterns.Structure.Structure`, reference to the `Structure` instance containing the current pattern
        self.ParentStructure = None

        #: dict: default attributes that are copied to `self.Attributes` upon instantiation. Specifies the allowed attributes
        self.DefaultAttributes = {
            'Layer': None,
            'DataType': None,
            'RotationAngle': None,
            'StrokeWidth': None,
            'ScaleFactor': None,
        }

        #: dict: attribute values of the current pattern. Default values are copied from `self.DefaultAttributes`
        self.Attributes = copy.copy(self.DefaultAttributes)

        for i in self.Attributes:
            if i in kwargs:
                self.Attributes[i] = kwargs[i]

        if 'TXLWriter' in kwargs:
            self._TXLWriter = kwargs['TXLWriter']

        if 'ParentStructure' in kwargs:
            self.ParentStructure = kwargs['ParentStructure']

    def _GetSVGAttributesString(self, OverrideSVGAttributes={}):
        '''
        Generate a string of attributes for an SVG xml element node.
        By default, the `class` attribute is set to ["Pattern"] if the current pattern `self.Type` is not in ['Structure','Array','Reference']

        Parameters
        ----------
        OverrideSVGAttributes: dict, optional
            Dictionary with SVG attributes and values.\n
            The key corresponds to the SVG attribute name, the value can be a str or list of str.\n
            Defaults to {}

        Returns
        -------
        str
           string of attributes for an SVG xml element node

        '''
        SVGAttributes = {
            'style': [],
            'class': [],
            'transform': []
        }
        if not self.Type in ['Structure', 'Array', 'Reference']:
            SVGAttributes['class'].append('Pattern')

        Tuttifrutti.update(SVGAttributes, OverrideSVGAttributes, True)

        SVGAttributesString = ''
        for i in SVGAttributes:
            if len(SVGAttributes[i]):
                SVGAttributesString += i + '="'
                if isinstance(SVGAttributes[i], list):
                    if i == 'style':
                        SVGAttributesString += ';'.join(SVGAttributes[i])
                    else:
                        SVGAttributesString += ' '.join(SVGAttributes[i])
                else:
                    SVGAttributesString += SVGAttributes[i]
                SVGAttributesString += '" '

        return SVGAttributesString

    def _GetFloatFormatString(self, ID=''):
        '''
        Alias of :func:`TXLWizard.TXLWriter.TXLWriter._GetFloatFormatString`.
        Returns a string for formatting a `float`, e.g. `{ID:1.3f}`.
        The number of digits is specified by `self._Precision`

        Parameters
        ----------
        ID: str, optional
            Optional ID for the formatting option.\n
            Defaults to ''

        Returns
        -------
        str:
            string for use with the `str.format()` function

        '''
        return self._TXLWriter._GetFloatFormatString(ID='')

[docs]    def GetTXLOutput(self):
        '''
        Generates the TXL output commands for the current pattern.
        Needs to be implemented for each pattern type separately in the corresponding inheriting class.

        Returns
        -------
        str
            TXL output commands
        '''
        pass

[docs]    def GetSVGOutput(self):
        '''
        Generates the SVG output xml for the current pattern.
        Needs to be implemented for each pattern type separately in the corresponding inheriting class.

        Returns
        -------
        str
            SVG output xml
        '''
        pass