File size: 7,925 Bytes
985c397 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | # SPDX-License-Identifier: LGPL-2.1-or-later
# ***************************************************************************
# * Copyright (c) 2020 sliptonic <shopinthewoods@gmail.com> *
# * *
# * This program is free software; you can redistribute it and/or modify *
# * it under the terms of the GNU Lesser General Public License (LGPL) *
# * as published by the Free Software Foundation; either version 2 of *
# * the License, or (at your option) any later version. *
# * for detail see the LICENCE text file. *
# * *
# * This program is distributed in the hope that it will be useful, *
# * but WITHOUT ANY WARRANTY; without even the implied warranty of *
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
# * GNU Library General Public License for more details. *
# * *
# * You should have received a copy of the GNU Library General Public *
# * License along with this program; if not, write to the Free Software *
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
# * USA *
# * *
# ***************************************************************************
from PySide.QtCore import QT_TRANSLATE_NOOP
import FreeCAD
import Path
import re
__title__ = "Generic property container to store some values."
__author__ = "sliptonic (Brad Collette)"
__url__ = "https://www.freecad.org"
__doc__ = "A generic container for typed properties in arbitrary categories."
if False:
Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule())
Path.Log.trackModule(Path.Log.thisModule())
else:
Path.Log.setLevel(Path.Log.Level.INFO, Path.Log.thisModule())
translate = FreeCAD.Qt.translate
SupportedPropertyType = {
"Angle": "App::PropertyAngle",
"Bool": "App::PropertyBool",
"Distance": "App::PropertyDistance",
"Enumeration": "App::PropertyEnumeration",
"File": "App::PropertyFile",
"Float": "App::PropertyFloat",
"Integer": "App::PropertyInteger",
"Length": "App::PropertyLength",
"Percent": "App::PropertyPercent",
"String": "App::PropertyString",
}
def getPropertyTypeName(o):
for typ in SupportedPropertyType:
if SupportedPropertyType[typ] == o:
return typ
raise IndexError()
class PropertyBag(object):
"""Property container object."""
CustomPropertyGroups = "CustomPropertyGroups"
CustomPropertyGroupDefault = "User"
def __init__(self, obj):
# Always add as enumeration
if not hasattr(obj, self.CustomPropertyGroups):
obj.addProperty(
"App::PropertyEnumeration",
self.CustomPropertyGroups,
"Base",
QT_TRANSLATE_NOOP("App::Property", "List of custom property groups"),
)
self.onDocumentRestored(obj)
def dumps(self):
return None
def loads(self, state):
return None
def __sanitizePropertyName(self, name):
if len(name) == 0:
return
clean = name[0]
for i in range(1, len(name)):
if name[i] == " ":
clean += name[i + 1].upper()
i += 1
elif name[i - 1] != " ":
clean += name[i]
return clean
def onDocumentRestored(self, obj):
self.obj = obj
cpg = getattr(obj, self.CustomPropertyGroups, None)
# If it's a string list, convert to enum
if isinstance(cpg, list):
vals = cpg
try:
obj.removeProperty(self.CustomPropertyGroups)
except Exception:
# Removing the property may fail if it does not exist; safe to ignore in this context.
pass
obj.addProperty(
"App::PropertyEnumeration",
self.CustomPropertyGroups,
"Base",
QT_TRANSLATE_NOOP("App::Property", "List of custom property groups"),
)
if hasattr(obj, "setEnumerationsOfProperty"):
obj.setEnumerationsOfProperty(self.CustomPropertyGroups, vals)
else:
# Fallback: set the property value directly (may not work in all FreeCAD versions)
setattr(obj, self.CustomPropertyGroups, vals)
if hasattr(obj, "setEditorMode"):
obj.setEditorMode(self.CustomPropertyGroups, 2) # hide
elif hasattr(obj, "getEnumerationsOfProperty"):
if hasattr(obj, "setEditorMode"):
obj.setEditorMode(self.CustomPropertyGroups, 2) # hide
def getCustomProperties(self):
"""Return a list of all custom properties created in this container."""
groups = []
if hasattr(self.obj, "getEnumerationsOfProperty"):
groups = list(self.obj.getEnumerationsOfProperty(self.CustomPropertyGroups))
else:
groups = list(getattr(self.obj, self.CustomPropertyGroups, []))
return [p for p in self.obj.PropertiesList if self.obj.getGroupOfProperty(p) in groups]
def addCustomProperty(self, propertyType, name, group=None, desc=None):
"""addCustomProperty(propertyType, name, group=None, desc=None) ... adds a custom property and tracks its group."""
if desc is None:
desc = ""
if group is None:
group = self.CustomPropertyGroupDefault
# Always use enum for groups
if hasattr(self.obj, "getEnumerationsOfProperty"):
groups = list(self.obj.getEnumerationsOfProperty(self.CustomPropertyGroups))
else:
groups = list(getattr(self.obj, self.CustomPropertyGroups, []))
name = self.__sanitizePropertyName(name)
if not re.match("^[A-Za-z0-9_]*$", name):
raise ValueError("Property Name can only contain letters and numbers")
if group not in groups:
groups.append(group)
if hasattr(self.obj, "setEnumerationsOfProperty"):
self.obj.setEnumerationsOfProperty(self.CustomPropertyGroups, groups)
else:
setattr(self.obj, self.CustomPropertyGroups, groups)
self.obj.addProperty(propertyType, name, group, desc)
return name
def refreshCustomPropertyGroups(self):
"""refreshCustomPropertyGroups() ... removes empty property groups, should be called after deleting properties."""
customGroups = []
for p in self.obj.PropertiesList:
group = self.obj.getGroupOfProperty(p)
if hasattr(self.obj, "getEnumerationsOfProperty"):
groups = list(self.obj.getEnumerationsOfProperty(self.CustomPropertyGroups))
else:
groups = list(getattr(self.obj, self.CustomPropertyGroups, []))
if group in groups and group not in customGroups:
customGroups.append(group)
if hasattr(self.obj, "setEnumerationsOfProperty"):
self.obj.setEnumerationsOfProperty(self.CustomPropertyGroups, customGroups)
else:
setattr(self.obj, self.CustomPropertyGroups, customGroups)
def Create(name="PropertyBag"):
obj = FreeCAD.ActiveDocument.addObject("App::FeaturePython", name)
obj.Proxy = PropertyBag(obj)
return obj
def IsPropertyBag(obj):
"""Returns True if the supplied object is a property container (or its Proxy)."""
if type(obj) == PropertyBag:
return True
if hasattr(obj, "Proxy"):
return IsPropertyBag(obj.Proxy)
return False
|