symcad.core.Geometry

  1#!/usr/bin/env python3
  2# Copyright (C) 2022, Will Hedgecock
  3#
  4# This program is free software: you can redistribute it and/or modify
  5# it under the terms of the GNU General Public License as published by
  6# the Free Software Foundation, either version 3 of the License, or
  7# (at your option) any later version.
  8#
  9# This program is distributed in the hope that it will be useful,
 10# but WITHOUT ANY WARRANTY; without even the implied warranty of
 11# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 12# GNU General Public License for more details.
 13#
 14# You should have received a copy of the GNU General Public License
 15# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 16
 17from __future__ import annotations
 18from typing import Dict
 19from copy import deepcopy
 20from sympy import Symbol
 21
 22class Geometry(object):
 23   """Represents the shape-specific parametric geometry of a `SymPart`."""
 24
 25   # Public attributes ----------------------------------------------------------------------------
 26
 27   name: str
 28   """Unique, identifying name of the `Geometry` instance."""
 29
 30
 31   # Constructor ----------------------------------------------------------------------------------
 32
 33   def __init__(self, identifier: str) -> None:
 34      """Initializes a `Geometry` instance, where `identifier` uniquely identifies the instance."""
 35      super().__init__()
 36      self.name = identifier
 37
 38
 39   # Built-in method implementations --------------------------------------------------------------
 40
 41   def __repr__(self) -> str:
 42      output = [key+' = '+str(val)+', ' for key, val in self.__dict__.items() if key != 'name']
 43      return ''.join(output).strip(' ,')
 44
 45   def __eq__(self, other: Geometry) -> bool:
 46      for key, val in self.__dict__.items():
 47         if key != 'name' and (key not in other.__dict__ or val != getattr(other, key)):
 48            return False
 49      return True
 50
 51   def __copy__(self) -> Geometry:
 52      copy = self.__class__.__new__(self.__class__)
 53      copy.__dict__.update(self.__dict__)
 54      return copy
 55
 56   def __deepcopy__(self, memo) -> Geometry:
 57      copy = self.__class__.__new__(self.__class__)
 58      memo[id(self)] = copy
 59      for key, val in self.__dict__.items():
 60         setattr(copy, key, deepcopy(val, memo))
 61      return copy
 62
 63   def __imul__(self, value: float) -> Geometry:
 64      for key, val in self.__dict__.items():
 65         if key != 'name':
 66            setattr(self, key, val * value)
 67      return self
 68
 69   def __itruediv__(self, value: float) -> Geometry:
 70      for key, val in self.__dict__.items():
 71         if key != 'name':
 72            setattr(self, key, val / value)
 73      return self
 74
 75
 76   # Public methods -------------------------------------------------------------------------------
 77
 78   def clone(self) -> Geometry:
 79      """Returns an exact clone of this `Geometry` instance."""
 80      return deepcopy(self)
 81
 82
 83   def copy_from(self, other: Geometry) -> Geometry:
 84      """Copies the geometric parameters from another `Geometry` instance into this one.
 85
 86      The name of this instance will not be changed or overwritten.
 87
 88      Parameters
 89      ----------
 90      other : `Geometry`
 91         A Geometry object whose attributes should be copied into this instance.
 92
 93      Returns
 94      -------
 95      self : `Geometry`
 96         The Geometry instance being manipulated.
 97      """
 98      for key, val in other.__dict__.items():
 99         if key != 'name':
100            setattr(self, key, val)
101      return self
102
103
104   def set(self, **kwargs) -> Geometry:
105      """Sets the underlying geometric parameters to the values specified.
106
107      The keys in the `**kwargs` dictionary will be different for each `SymPart`. If a key is
108      missing or its value is `None`, the corresponding geometric property will be treated
109      as a symbol.
110
111      Parameters
112      ----------
113      **kwargs : `Dict`
114         A dictionary containing values or symbols for the geometric properties present in this
115         Geometry instance.
116
117      Returns
118      -------
119      self : `Geometry`
120         The Geometry instance being manipulated.
121      """
122      for key in self.__dict__:
123         if key != 'name':
124            setattr(self, key, kwargs[key] if key in kwargs and kwargs[key] is not None else
125                    Symbol(self.name + '_' + key))
126      return self
127
128
129   def clear(self) -> Geometry:
130      """Clears all geometric properties to `0.0`.
131
132      Returns
133      -------
134      self : `Geometry`
135         The Geometry instance being manipulated.
136      """
137      for key in self.__dict__:
138         if key != 'name':
139            setattr(self, key, 0.0)
140      return self
141
142
143   def as_dict(self) -> Dict[str, float]:
144      """Returns the current geometric properties as a dictionary."""
145      return { key: val for key, val in self.__dict__.items() if key != 'name' }