2072 lines
78 KiB
Python
2072 lines
78 KiB
Python
# SPDX-License-Identifier: LGPL-2.1-or-later
|
|
|
|
# ***************************************************************************
|
|
# * *
|
|
# * Copyright (c) 2011 Yorik van Havre <yorik@uncreated.net> *
|
|
# * *
|
|
# * This file is part of FreeCAD. *
|
|
# * *
|
|
# * FreeCAD is free software: you can redistribute it and/or modify it *
|
|
# * under the terms of the GNU Lesser General Public License as *
|
|
# * published by the Free Software Foundation, either version 2.1 of the *
|
|
# * License, or (at your option) any later version. *
|
|
# * *
|
|
# * FreeCAD 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 *
|
|
# * Lesser General Public License for more details. *
|
|
# * *
|
|
# * You should have received a copy of the GNU Lesser General Public *
|
|
# * License along with FreeCAD. If not, see *
|
|
# * <https://www.gnu.org/licenses/>. *
|
|
# * *
|
|
# ***************************************************************************
|
|
|
|
__title__ = "FreeCAD Site"
|
|
__author__ = "Yorik van Havre"
|
|
__url__ = "https://www.freecad.org"
|
|
|
|
## @package ArchSite
|
|
# \ingroup ARCH
|
|
# \brief The Site object and tools
|
|
#
|
|
# This module provides tools to build Site objects.
|
|
# Sites are containers for Arch objects, and also define a
|
|
# terrain surface
|
|
|
|
"""This module provides tools to build Site objects. Sites are
|
|
containers for Arch objects, and also define a terrain surface.
|
|
"""
|
|
|
|
import datetime
|
|
import math
|
|
import re
|
|
|
|
import FreeCAD
|
|
import ArchCommands
|
|
import ArchComponent
|
|
import ArchIFC
|
|
import Draft
|
|
|
|
from draftutils import params
|
|
|
|
if FreeCAD.GuiUp:
|
|
from PySide import QtGui, QtCore
|
|
from PySide.QtCore import QT_TRANSLATE_NOOP
|
|
import FreeCADGui
|
|
from draftutils.translate import translate
|
|
else:
|
|
# \cond
|
|
def translate(ctxt, txt):
|
|
return txt
|
|
|
|
def QT_TRANSLATE_NOOP(ctxt, txt):
|
|
return txt
|
|
|
|
# \endcond
|
|
|
|
import logging
|
|
from contextlib import contextmanager
|
|
|
|
|
|
@contextmanager
|
|
def temp_logger_level(level):
|
|
"""A context manager to temporarily set the root logger's level."""
|
|
root_logger = logging.getLogger()
|
|
original_level = root_logger.level
|
|
root_logger.setLevel(level)
|
|
try:
|
|
yield
|
|
finally:
|
|
root_logger.setLevel(original_level)
|
|
|
|
|
|
def toNode(shape):
|
|
"""builds a linear pivy node from a shape"""
|
|
|
|
from pivy import coin
|
|
|
|
buf = shape.writeInventor(2, 0.01).replace("\n", "")
|
|
buf = re.findall(r"point \[(.*?)\]", buf)
|
|
pts = []
|
|
for c in buf:
|
|
pts.extend(zip(*[iter(c.split())] * 3))
|
|
pc = []
|
|
for v in pts:
|
|
v = [float(v[0]), float(v[1]), float(v[2])]
|
|
if (not pc) or (pc[-1] != v):
|
|
pc.append(v)
|
|
coords = coin.SoCoordinate3()
|
|
coords.point.setValues(0, len(pc), pc)
|
|
line = coin.SoLineSet()
|
|
line.numVertices.setValue(-1)
|
|
item = coin.SoSeparator()
|
|
item.addChild(coords)
|
|
item.addChild(line)
|
|
return item
|
|
|
|
|
|
def makeSolarDiagram(longitude, latitude, scale=1, complete=False, tz=None):
|
|
"""makeSolarDiagram(longitude,latitude,[scale,complete,tz]):
|
|
returns a solar diagram as a pivy node. If complete is
|
|
True, the 12 months are drawn. Tz is the timezone related to
|
|
UTC (ex: -3 = UTC-3)"""
|
|
|
|
oldversion = False
|
|
ladybug = False
|
|
with temp_logger_level(logging.WARNING):
|
|
try:
|
|
import ladybug
|
|
|
|
logging.getLogger("ladybug").propagate = False
|
|
from ladybug import location
|
|
from ladybug import sunpath
|
|
except ImportError:
|
|
# TODO - remove pysolar dependency
|
|
# FreeCAD.Console.PrintWarning("Ladybug module not found, using pysolar instead. Warning, this will be deprecated in the future\n")
|
|
ladybug = False
|
|
try:
|
|
import pysolar
|
|
except ImportError:
|
|
try:
|
|
import Pysolar as pysolar
|
|
except ImportError:
|
|
FreeCAD.Console.PrintError(
|
|
"The pysolar module was not found. Unable to generate solar diagrams\n"
|
|
)
|
|
return None
|
|
else:
|
|
oldversion = True
|
|
if tz:
|
|
tz = datetime.timezone(datetime.timedelta(hours=tz))
|
|
else:
|
|
tz = datetime.timezone.utc
|
|
else:
|
|
loc = ladybug.location.Location(latitude=latitude, longitude=longitude, time_zone=tz)
|
|
sunpath = ladybug.sunpath.Sunpath.from_location(loc)
|
|
|
|
from pivy import coin
|
|
|
|
if not scale:
|
|
return None
|
|
|
|
circles = []
|
|
sunpaths = []
|
|
hourpaths = []
|
|
circlepos = []
|
|
hourpos = []
|
|
|
|
# build the base circle + number positions
|
|
import Part
|
|
|
|
for i in range(1, 9):
|
|
circles.append(Part.makeCircle(scale * (i / 8.0)))
|
|
for ad in range(0, 360, 15):
|
|
a = math.radians(ad)
|
|
p1 = FreeCAD.Vector(math.cos(a) * scale, math.sin(a) * scale, 0)
|
|
p2 = FreeCAD.Vector(math.cos(a) * scale * 0.125, math.sin(a) * scale * 0.125, 0)
|
|
p3 = FreeCAD.Vector(math.cos(a) * scale * 1.08, math.sin(a) * scale * 1.08, 0)
|
|
circles.append(Part.LineSegment(p1, p2).toShape())
|
|
circlepos.append((ad, p3))
|
|
|
|
# build the sun curves at solstices and equinoxe
|
|
year = datetime.datetime.now().year
|
|
hpts = [[] for i in range(24)]
|
|
m = [(6, 21), (7, 21), (8, 21), (9, 21), (10, 21), (11, 21), (12, 21)]
|
|
if complete:
|
|
m.extend([(1, 21), (2, 21), (3, 21), (4, 21), (5, 21)])
|
|
for i, d in enumerate(m):
|
|
pts = []
|
|
for h in range(24):
|
|
if ladybug:
|
|
sun = sunpath.calculate_sun(month=d[0], day=d[1], hour=h)
|
|
alt = math.radians(sun.altitude)
|
|
az = 90 + sun.azimuth
|
|
elif oldversion:
|
|
dt = datetime.datetime(year, d[0], d[1], h)
|
|
alt = math.radians(pysolar.solar.GetAltitudeFast(latitude, longitude, dt))
|
|
az = pysolar.solar.GetAzimuth(latitude, longitude, dt)
|
|
az = -90 + az # pysolar's zero is south, ours is X direction
|
|
else:
|
|
dt = datetime.datetime(year, d[0], d[1], h, tzinfo=tz)
|
|
alt = math.radians(pysolar.solar.get_altitude_fast(latitude, longitude, dt))
|
|
az = pysolar.solar.get_azimuth(latitude, longitude, dt)
|
|
az = 90 + az # pysolar's zero is north, ours is X direction
|
|
if az < 0:
|
|
az = 360 + az
|
|
az = math.radians(az)
|
|
zc = math.sin(alt) * scale
|
|
ic = math.cos(alt) * scale
|
|
xc = math.cos(az) * ic
|
|
yc = math.sin(az) * ic
|
|
p = FreeCAD.Vector(xc, yc, zc)
|
|
pts.append(p)
|
|
hpts[h].append(p)
|
|
if i in [0, 6]:
|
|
ep = FreeCAD.Vector(p)
|
|
ep.multiply(1.08)
|
|
if ep.z >= 0:
|
|
if not oldversion:
|
|
h = 24 - h # not sure why this is needed now... But it is.
|
|
if h == 12:
|
|
if i == 0:
|
|
h = "SUMMER"
|
|
else:
|
|
h = "WINTER"
|
|
if latitude < 0:
|
|
if h == "SUMMER":
|
|
h = "WINTER"
|
|
else:
|
|
h = "SUMMER"
|
|
hourpos.append((h, ep))
|
|
if i < 7:
|
|
if len(pts) > 1:
|
|
b_spline = Part.BSplineCurve()
|
|
b_spline.buildFromPoles(pts)
|
|
sunpaths.append(b_spline.toShape())
|
|
|
|
for h in hpts:
|
|
if complete:
|
|
h.append(h[0])
|
|
if len(h) > 1:
|
|
b_spline = Part.BSplineCurve()
|
|
b_spline.buildFromPoles(h)
|
|
hourpaths.append(b_spline.toShape())
|
|
|
|
# cut underground lines
|
|
sz = 2.1 * scale
|
|
cube = Part.makeBox(sz, sz, sz)
|
|
cube.translate(FreeCAD.Vector(-sz / 2, -sz / 2, -sz))
|
|
sunpaths = [sp.cut(cube) for sp in sunpaths]
|
|
hourpaths = [hp.cut(cube) for hp in hourpaths]
|
|
|
|
# build nodes
|
|
ts = 0.005 * scale # text scale
|
|
mastersep = coin.SoSeparator()
|
|
circlesep = coin.SoSeparator()
|
|
numsep = coin.SoSeparator()
|
|
pathsep = coin.SoSeparator()
|
|
hoursep = coin.SoSeparator()
|
|
# hournumsep = coin.SoSeparator()
|
|
mastersep.addChild(circlesep)
|
|
mastersep.addChild(numsep)
|
|
mastersep.addChild(pathsep)
|
|
mastersep.addChild(hoursep)
|
|
for item in circles:
|
|
circlesep.addChild(toNode(item))
|
|
for item in sunpaths:
|
|
for w in item.Edges:
|
|
pathsep.addChild(toNode(w))
|
|
for item in hourpaths:
|
|
for w in item.Edges:
|
|
hoursep.addChild(toNode(w))
|
|
for p in circlepos:
|
|
text = coin.SoText2()
|
|
s = p[0] - 90
|
|
s = -s
|
|
if s > 360:
|
|
s = s - 360
|
|
if s < 0:
|
|
s = 360 + s
|
|
if s == 0:
|
|
s = "N"
|
|
elif s == 90:
|
|
s = "E"
|
|
elif s == 180:
|
|
s = "S"
|
|
elif s == 270:
|
|
s = "W"
|
|
else:
|
|
s = str(s)
|
|
text.string = s
|
|
text.justification = coin.SoText2.CENTER
|
|
coords = coin.SoTransform()
|
|
coords.translation.setValue([p[1].x, p[1].y, p[1].z])
|
|
coords.scaleFactor.setValue([ts, ts, ts])
|
|
item = coin.SoSeparator()
|
|
item.addChild(coords)
|
|
item.addChild(text)
|
|
numsep.addChild(item)
|
|
for p in hourpos:
|
|
text = coin.SoText2()
|
|
s = str(p[0])
|
|
text.string = s
|
|
text.justification = coin.SoText2.CENTER
|
|
coords = coin.SoTransform()
|
|
coords.translation.setValue([p[1].x, p[1].y, p[1].z])
|
|
coords.scaleFactor.setValue([ts, ts, ts])
|
|
item = coin.SoSeparator()
|
|
item.addChild(coords)
|
|
item.addChild(text)
|
|
numsep.addChild(item)
|
|
return mastersep
|
|
|
|
|
|
def makeWindRose(epwfile, scale=1, sectors=24):
|
|
"""makeWindRose(site,sectors):
|
|
returns a wind rose diagram as a pivy node"""
|
|
|
|
with temp_logger_level(logging.WARNING):
|
|
try:
|
|
import ladybug
|
|
|
|
logging.getLogger("ladybug").propagate = False
|
|
from ladybug import epw
|
|
except ImportError:
|
|
FreeCAD.Console.PrintError(
|
|
"The ladybug module was not found. Unable to generate solar diagrams\n"
|
|
)
|
|
return None
|
|
|
|
if not epwfile:
|
|
FreeCAD.Console.PrintWarning("No EPW file, unable to generate wind rose.\n")
|
|
return None
|
|
epw_data = ladybug.epw.EPW(epwfile)
|
|
baseangle = 360 / sectors
|
|
sectorangles = [i * baseangle for i in range(sectors)] # the divider angles between each sector
|
|
basebissect = baseangle / 2
|
|
angles = [basebissect] # build a list of central direction for each sector
|
|
for i in range(1, sectors):
|
|
angles.append(angles[-1] + baseangle)
|
|
windsbysector = [0 for i in range(sectors)] # prepare a holder for values for each sector
|
|
for hour in epw_data.wind_direction:
|
|
sector = min(angles, key=lambda x: abs(x - hour)) # find the closest sector angle
|
|
sectorindex = angles.index(sector)
|
|
windsbysector[sectorindex] = windsbysector[sectorindex] + 1
|
|
maxwind = max(windsbysector)
|
|
windsbysector = [wind / maxwind for wind in windsbysector] # normalize
|
|
vectors = [] # create 3D vectors
|
|
dividers = []
|
|
for i in range(sectors):
|
|
angle = math.radians(90 + angles[i])
|
|
x = math.cos(angle) * windsbysector[i] * scale
|
|
y = math.sin(angle) * windsbysector[i] * scale
|
|
vectors.append(FreeCAD.Vector(x, y, 0))
|
|
secangle = math.radians(90 + sectorangles[i])
|
|
x = math.cos(secangle) * scale
|
|
y = math.sin(secangle) * scale
|
|
dividers.append(FreeCAD.Vector(x, y, 0))
|
|
vectors.append(vectors[0])
|
|
|
|
# build coin node
|
|
import Part
|
|
from pivy import coin
|
|
|
|
masternode = coin.SoSeparator()
|
|
for r in (0.25, 0.5, 0.75, 1.0):
|
|
c = Part.makeCircle(r * scale)
|
|
masternode.addChild(toNode(c))
|
|
for divider in dividers:
|
|
l = Part.makeLine(FreeCAD.Vector(), divider)
|
|
masternode.addChild(toNode(l))
|
|
ds = coin.SoDrawStyle()
|
|
ds.lineWidth = 2.0
|
|
masternode.addChild(ds)
|
|
d = Part.makePolygon(vectors)
|
|
masternode.addChild(toNode(d))
|
|
return masternode
|
|
|
|
|
|
# Values in mm
|
|
COMPASS_POINTER_LENGTH = 1000
|
|
COMPASS_POINTER_WIDTH = 100
|
|
|
|
|
|
class Compass(object):
|
|
def __init__(self):
|
|
self.rootNode = self.setupCoin()
|
|
|
|
def show(self):
|
|
from pivy import coin
|
|
|
|
self.compassswitch.whichChild = coin.SO_SWITCH_ALL
|
|
|
|
def hide(self):
|
|
from pivy import coin
|
|
|
|
self.compassswitch.whichChild = coin.SO_SWITCH_NONE
|
|
|
|
def rotate(self, angleInDegrees):
|
|
from pivy import coin
|
|
|
|
self.transform.rotation.setValue(coin.SbVec3f(0, 0, 1), math.radians(angleInDegrees))
|
|
|
|
def locate(self, x, y, z):
|
|
from pivy import coin
|
|
|
|
self.transform.translation.setValue(x, y, z)
|
|
|
|
def scale(self, area):
|
|
from pivy import coin
|
|
|
|
scale = round(max(math.sqrt(area.getValueAs("m^2").Value) / 10, 1))
|
|
|
|
self.transform.scaleFactor.setValue(coin.SbVec3f(scale, scale, 1))
|
|
|
|
def setupCoin(self):
|
|
from pivy import coin
|
|
|
|
compasssep = coin.SoSeparator()
|
|
|
|
self.transform = coin.SoTransform()
|
|
|
|
darkNorthMaterial = coin.SoMaterial()
|
|
darkNorthMaterial.diffuseColor.set1Value(0, 0.5, 0, 0) # north dark color
|
|
|
|
lightNorthMaterial = coin.SoMaterial()
|
|
lightNorthMaterial.diffuseColor.set1Value(0, 0.9, 0, 0) # north light color
|
|
|
|
darkGreyMaterial = coin.SoMaterial()
|
|
darkGreyMaterial.diffuseColor.set1Value(0, 0.9, 0.9, 0.9) # dark color
|
|
|
|
lightGreyMaterial = coin.SoMaterial()
|
|
lightGreyMaterial.diffuseColor.set1Value(0, 0.5, 0.5, 0.5) # light color
|
|
|
|
coords = self.buildCoordinates()
|
|
|
|
# coordIndex = [0, 1, 2, -1, 2, 3, 0, -1]
|
|
|
|
lightColorFaceset = coin.SoIndexedFaceSet()
|
|
lightColorCoordinateIndex = [4, 5, 6, -1, 8, 9, 10, -1, 12, 13, 14, -1]
|
|
lightColorFaceset.coordIndex.setValues(
|
|
0, len(lightColorCoordinateIndex), lightColorCoordinateIndex
|
|
)
|
|
|
|
darkColorFaceset = coin.SoIndexedFaceSet()
|
|
darkColorCoordinateIndex = [6, 7, 4, -1, 10, 11, 8, -1, 14, 15, 12, -1]
|
|
darkColorFaceset.coordIndex.setValues(
|
|
0, len(darkColorCoordinateIndex), darkColorCoordinateIndex
|
|
)
|
|
|
|
lightNorthFaceset = coin.SoIndexedFaceSet()
|
|
lightNorthCoordinateIndex = [2, 3, 0, -1]
|
|
lightNorthFaceset.coordIndex.setValues(
|
|
0, len(lightNorthCoordinateIndex), lightNorthCoordinateIndex
|
|
)
|
|
|
|
darkNorthFaceset = coin.SoIndexedFaceSet()
|
|
darkNorthCoordinateIndex = [0, 1, 2, -1]
|
|
darkNorthFaceset.coordIndex.setValues(
|
|
0, len(darkNorthCoordinateIndex), darkNorthCoordinateIndex
|
|
)
|
|
|
|
self.compassswitch = coin.SoSwitch()
|
|
self.compassswitch.whichChild = coin.SO_SWITCH_NONE
|
|
self.compassswitch.addChild(compasssep)
|
|
|
|
lightGreySeparator = coin.SoSeparator()
|
|
lightGreySeparator.addChild(lightGreyMaterial)
|
|
lightGreySeparator.addChild(lightColorFaceset)
|
|
|
|
darkGreySeparator = coin.SoSeparator()
|
|
darkGreySeparator.addChild(darkGreyMaterial)
|
|
darkGreySeparator.addChild(darkColorFaceset)
|
|
|
|
lightNorthSeparator = coin.SoSeparator()
|
|
lightNorthSeparator.addChild(lightNorthMaterial)
|
|
lightNorthSeparator.addChild(lightNorthFaceset)
|
|
|
|
darkNorthSeparator = coin.SoSeparator()
|
|
darkNorthSeparator.addChild(darkNorthMaterial)
|
|
darkNorthSeparator.addChild(darkNorthFaceset)
|
|
|
|
compasssep.addChild(coords)
|
|
compasssep.addChild(self.transform)
|
|
compasssep.addChild(lightGreySeparator)
|
|
compasssep.addChild(darkGreySeparator)
|
|
compasssep.addChild(lightNorthSeparator)
|
|
compasssep.addChild(darkNorthSeparator)
|
|
|
|
return self.compassswitch
|
|
|
|
def buildCoordinates(self):
|
|
from pivy import coin
|
|
|
|
coords = coin.SoCoordinate3()
|
|
|
|
# North Arrow
|
|
coords.point.set1Value(0, 0, 0, 0)
|
|
coords.point.set1Value(1, COMPASS_POINTER_WIDTH, COMPASS_POINTER_WIDTH, 0)
|
|
coords.point.set1Value(2, 0, COMPASS_POINTER_LENGTH, 0)
|
|
coords.point.set1Value(3, -COMPASS_POINTER_WIDTH, COMPASS_POINTER_WIDTH, 0)
|
|
|
|
# East Arrow
|
|
coords.point.set1Value(4, 0, 0, 0)
|
|
coords.point.set1Value(5, COMPASS_POINTER_WIDTH, -COMPASS_POINTER_WIDTH, 0)
|
|
coords.point.set1Value(6, COMPASS_POINTER_LENGTH, 0, 0)
|
|
coords.point.set1Value(7, COMPASS_POINTER_WIDTH, COMPASS_POINTER_WIDTH, 0)
|
|
|
|
# South Arrow
|
|
coords.point.set1Value(8, 0, 0, 0)
|
|
coords.point.set1Value(9, -COMPASS_POINTER_WIDTH, -COMPASS_POINTER_WIDTH, 0)
|
|
coords.point.set1Value(10, 0, -COMPASS_POINTER_LENGTH, 0)
|
|
coords.point.set1Value(11, COMPASS_POINTER_WIDTH, -COMPASS_POINTER_WIDTH, 0)
|
|
|
|
# West Arrow
|
|
coords.point.set1Value(12, 0, 0, 0)
|
|
coords.point.set1Value(13, -COMPASS_POINTER_WIDTH, COMPASS_POINTER_WIDTH, 0)
|
|
coords.point.set1Value(14, -COMPASS_POINTER_LENGTH, 0, 0)
|
|
coords.point.set1Value(15, -COMPASS_POINTER_WIDTH, -COMPASS_POINTER_WIDTH, 0)
|
|
|
|
return coords
|
|
|
|
|
|
class _Site(ArchIFC.IfcProduct):
|
|
"""The Site object.
|
|
|
|
Turns a <Part::FeaturePython> into a site object.
|
|
|
|
If an object is assigned to the Terrain property, gains a shape, and deals
|
|
with additions and subtractions as earthmoving, calculating volumes of
|
|
terrain that have been moved by the additions and subtractions. Unlike most
|
|
Arch objects, the Terrain object works well as a mesh.
|
|
|
|
The site must be based off a <Part::FeaturePython> object.
|
|
|
|
Parameters
|
|
----------
|
|
obj: <Part::FeaturePython>
|
|
The object to turn into a site.
|
|
"""
|
|
|
|
def __init__(self, obj):
|
|
obj.Proxy = self
|
|
self.Type = "Site"
|
|
self.setProperties(obj)
|
|
obj.IfcType = "Site"
|
|
obj.CompositionType = "ELEMENT"
|
|
|
|
def setProperties(self, obj):
|
|
"""Gives the object properties unique to sites.
|
|
|
|
Adds the IFC product properties, and sites' unique properties like
|
|
Terrain.
|
|
|
|
You can learn more about properties here:
|
|
https://wiki.freecad.org/property
|
|
"""
|
|
|
|
ArchIFC.IfcProduct.setProperties(self, obj)
|
|
|
|
pl = obj.PropertiesList
|
|
if not "Terrain" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyLink",
|
|
"Terrain",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The base terrain of this site"),
|
|
locked=True,
|
|
)
|
|
if not "Address" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyString",
|
|
"Address",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"The street and house number of this site, with postal box or apartment number if needed",
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "PostalCode" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyString",
|
|
"PostalCode",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The postal or zip code of this site"),
|
|
locked=True,
|
|
)
|
|
if not "City" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyString",
|
|
"City",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The city of this site"),
|
|
locked=True,
|
|
)
|
|
if not "Region" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyString",
|
|
"Region",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The region, province or county of this site"),
|
|
locked=True,
|
|
)
|
|
if not "Country" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyString",
|
|
"Country",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The country of this site"),
|
|
locked=True,
|
|
)
|
|
if not "Latitude" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyFloat",
|
|
"Latitude",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The latitude of this site"),
|
|
locked=True,
|
|
)
|
|
if not "Longitude" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyFloat",
|
|
"Longitude",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The latitude of this site"),
|
|
locked=True,
|
|
)
|
|
if not "Declination" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyAngle",
|
|
"Declination",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"Angle between the true North and the North direction in this document",
|
|
),
|
|
locked=True,
|
|
)
|
|
if "NorthDeviation" in pl:
|
|
obj.Declination = obj.NorthDeviation.Value
|
|
obj.removeProperty("NorthDeviation")
|
|
if not "Elevation" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyLength",
|
|
"Elevation",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The elevation of level 0 of this site"),
|
|
locked=True,
|
|
)
|
|
if not "Url" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyString",
|
|
"Url",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "A URL that shows this site in a mapping website"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "Additions" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyLinkList",
|
|
"Additions",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "Other shapes that are appended to this object"),
|
|
locked=True,
|
|
)
|
|
if not "Subtractions" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyLinkList",
|
|
"Subtractions",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "Other shapes that are subtracted from this object"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "ProjectedArea" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyArea",
|
|
"ProjectedArea",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "The area of the projection of this object onto the XY plane"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "Perimeter" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyLength",
|
|
"Perimeter",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The perimeter length of the projected area"),
|
|
locked=True,
|
|
)
|
|
if not "AdditionVolume" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyVolume",
|
|
"AdditionVolume",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "The volume of earth to be added to this terrain"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "SubtractionVolume" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyVolume",
|
|
"SubtractionVolume",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "The volume of earth to be removed from this terrain"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "ExtrusionVector" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyVector",
|
|
"ExtrusionVector",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "An extrusion vector to use when performing boolean operations"
|
|
),
|
|
locked=True,
|
|
)
|
|
obj.ExtrusionVector = FreeCAD.Vector(0, 0, -100000)
|
|
if not "RemoveSplitter" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyBool",
|
|
"RemoveSplitter",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "Remove splitters from the resulting shape"),
|
|
locked=True,
|
|
)
|
|
if not "OriginOffset" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyVector",
|
|
"OriginOffset",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"An optional offset between the model (0,0,0) origin and the point indicated by the geocoordinates",
|
|
),
|
|
locked=True,
|
|
)
|
|
if not hasattr(obj, "Group"):
|
|
obj.addExtension("App::GroupExtensionPython")
|
|
if not "IfcType" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyEnumeration",
|
|
"IfcType",
|
|
"IFC",
|
|
QT_TRANSLATE_NOOP("App::Property", "The type of this object"),
|
|
locked=True,
|
|
)
|
|
obj.IfcType = ArchIFC.IfcTypes
|
|
obj.IcfType = "Site"
|
|
if not "TimeZone" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyInteger",
|
|
"TimeZone",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The time zone where this site is located"),
|
|
locked=True,
|
|
)
|
|
if not "EPWFile" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyFileIncluded",
|
|
"EPWFile",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"An optional EPW File for the location of this site. Refer to the Site documentation to know how to obtain one",
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "SunRay" in pl:
|
|
obj.addProperty(
|
|
"App::PropertyLink",
|
|
"SunRay",
|
|
"Sun",
|
|
QT_TRANSLATE_NOOP("App::Property", "The generated sun ray object"),
|
|
locked=True,
|
|
)
|
|
obj.setEditorMode("SunRay", ["ReadOnly", "Hidden"])
|
|
|
|
def onDocumentRestored(self, obj):
|
|
"""FreeCAD hook run after the object is restored from a file.
|
|
|
|
This method serves a dual purpose due to FreeCAD framework limitations:
|
|
|
|
1. **Standard Role:** Restore properties on the data object (`_Site` proxy) itself by
|
|
calling `self.setProperties(obj)`. This ensures backward compatibility by adding any new
|
|
properties defined in the current FreeCAD version to an object loaded from an older
|
|
file.
|
|
|
|
2. **Workaround Role:** Trigger the initialization for the associated view provider object
|
|
(`_ViewProviderSite`). This is necessary because: a) The view provider has no equivalent
|
|
`onDocumentRestored` callback. b) This hook provides a reliable point in the document
|
|
lifecycle where the `ViewObject` is guaranteed to be attached to the data object
|
|
(`obj`), which is a prerequisite for any GUI-related setup.
|
|
|
|
The core issue is that the App::FeaturePython object has a convenient onDocumentRestored
|
|
hook, but its Gui::ViewProviderPython counterpart does not. This forces us to use the data
|
|
object's hook as a trigger for initializing the view object, which is architecturally
|
|
unclean but necessary.
|
|
"""
|
|
|
|
# 1. Restore properties on the data object.
|
|
self.setProperties(obj)
|
|
|
|
# 2. Trigger the restoration sequence for the associated view provider.
|
|
# This block only runs in GUI mode.
|
|
if FreeCAD.GuiUp and hasattr(obj, "ViewObject"):
|
|
# Manually ensure the view provider's properties are up-to-date.
|
|
#
|
|
# When loading a document, FreeCAD's C++ document loading mechanism restores Python
|
|
# proxy objects by allocating an empty instance and then calling its `loads()` method.
|
|
# The `__init__()` constructor is intentionally bypassed in this restoration path.
|
|
#
|
|
# As a result, any setup logic in the view provider's `__init__` (like the call to
|
|
# `self.setProperties()`) is never executed during a file load.
|
|
#
|
|
# The solution is to call `setProperties()` again here to ensure the view object is
|
|
# correctly initialized, especially for backward compatibility when a newer version of
|
|
# FreeCAD adds new properties.
|
|
try:
|
|
proxy = getattr(obj.ViewObject, "Proxy", None)
|
|
if proxy is not None and hasattr(proxy, "setProperties"):
|
|
proxy.setProperties(obj.ViewObject)
|
|
except Exception as e:
|
|
# Do not break document restore if view-side initialization fails.
|
|
FreeCAD.Console.PrintError(f"ArchSite: proxy.setProperties failed: {e}\n")
|
|
|
|
# The Site's view provider has property constraints defined (e.g., min/max values for
|
|
# dates). This requires a special handling sequence during document restoration due to
|
|
# the way FreeCAD's GUI and data layers interact.
|
|
#
|
|
# 1. Constraints are not saved in the .FCStd file, so they must be programmatically
|
|
# reapplied every time a document is loaded.
|
|
# 2. The Property Editor GUI builds its widgets (like spin boxes) as soon as it is
|
|
# notified that a property has been added. If constraints are applied in the same
|
|
# function call, a race condition occurs: the GUI may build its widget *before* the
|
|
# constraints are set, resulting in an unconstrained input field.
|
|
#
|
|
# To solve this, we defer the constraint restoration. We use QTimer.singleShot(0, ...)
|
|
# to push the `restoreConstraints` call to the end of the Qt event queue. This
|
|
# guarantees that the Property Editor has fully processed the property-add signals in
|
|
# one event loop cycle *before* we apply the constraints in a subsequent cycle.
|
|
from PySide import QtCore
|
|
|
|
QtCore.QTimer.singleShot(
|
|
0, lambda: obj.ViewObject.Proxy.restoreConstraints(obj.ViewObject)
|
|
)
|
|
|
|
def execute(self, obj):
|
|
"""Method run when the object is recomputed.
|
|
|
|
Perform additions and subtractions on terrain, and assign to the site's
|
|
Shape.
|
|
"""
|
|
|
|
if not hasattr(obj, "Shape"): # old-style Site
|
|
return
|
|
|
|
import Part
|
|
|
|
pl = FreeCAD.Placement(obj.Placement)
|
|
shape = None
|
|
if (
|
|
obj.Terrain is not None
|
|
and hasattr(obj.Terrain, "Shape")
|
|
and not obj.Terrain.Shape.isNull()
|
|
and obj.Terrain.Shape.isValid()
|
|
):
|
|
shape = Part.Shape(obj.Terrain.Shape)
|
|
# Fuse and cut operations return a shape with a default placement.
|
|
# We need to transform our shape accordingly to get a consistent
|
|
# result with or without fuse or cut operations:
|
|
shape = shape.transformGeometry((shape.Placement * pl).Matrix)
|
|
shape.Placement = FreeCAD.Placement()
|
|
|
|
if shape.Solids:
|
|
for sub in obj.Additions:
|
|
if hasattr(sub, "Shape") and sub.Shape and sub.Shape.Solids:
|
|
for sol in sub.Shape.Solids:
|
|
shape = shape.fuse(sol)
|
|
for sub in obj.Subtractions:
|
|
if hasattr(sub, "Shape") and sub.Shape and sub.Shape.Solids:
|
|
for sol in sub.Shape.Solids:
|
|
shape = shape.cut(sol)
|
|
elif shape.Faces:
|
|
shells = []
|
|
for sub in obj.Additions:
|
|
if hasattr(sub, "Shape") and sub.Shape and sub.Shape.Solids:
|
|
for sol in sub.Shape.Solids:
|
|
rest = shape.cut(sol)
|
|
shells.append(sol.Shells[0].cut(shape.extrude(obj.ExtrusionVector)))
|
|
shape = rest
|
|
for sub in obj.Subtractions:
|
|
if hasattr(sub, "Shape") and sub.Shape and sub.Shape.Solids:
|
|
for sol in sub.Shape.Solids:
|
|
rest = shape.cut(sol)
|
|
shells.append(sol.Shells[0].common(shape.extrude(obj.ExtrusionVector)))
|
|
shape = rest
|
|
for shell in shells:
|
|
shape = shape.fuse(shell)
|
|
|
|
if not shape.isNull() and shape.isValid():
|
|
if obj.RemoveSplitter:
|
|
shape = shape.removeSplitter()
|
|
# Transform the shape to counteract the effect of placement pl
|
|
# and then apply that placement:
|
|
obj.Shape = shape.transformGeometry(pl.inverse().Matrix)
|
|
obj.Placement = pl
|
|
else:
|
|
shape = None
|
|
|
|
if shape is None:
|
|
obj.Shape = Part.Shape()
|
|
obj.Placement = pl
|
|
|
|
self.computeAreas(obj)
|
|
|
|
if FreeCAD.GuiUp:
|
|
vobj = obj.ViewObject
|
|
if vobj.Proxy is not None:
|
|
vobj.Proxy.updateDisplaymodeTerrainSwitches(vobj)
|
|
|
|
def onBeforeChange(self, obj, prop):
|
|
ArchComponent.Component.onBeforeChange(self, obj, prop)
|
|
|
|
def onChanged(self, obj, prop):
|
|
ArchComponent.Component.onChanged(self, obj, prop)
|
|
if prop == "Terrain" and obj.Terrain:
|
|
if obj.Terrain in getattr(obj, "Group", []):
|
|
grp = obj.Group
|
|
grp.remove(obj.Terrain)
|
|
obj.Group = grp
|
|
if FreeCAD.GuiUp:
|
|
obj.Terrain.ViewObject.hide()
|
|
if prop == "Group" and getattr(obj, "Terrain", None) in obj.Group:
|
|
obj.Terrain = None
|
|
|
|
def getMovableChildren(self, obj):
|
|
return obj.Additions + obj.Subtractions
|
|
|
|
def computeAreas(self, obj):
|
|
"""Compute the area, perimeter length, and volume of the terrain shape.
|
|
|
|
Compute the area of the terrain projected onto an XY plane, IE:
|
|
the area of the terrain if viewed from a birds eye view.
|
|
|
|
Compute the length of the perimeter of this birds eye view area.
|
|
|
|
Compute the volume of the terrain that needs to be added and subtracted
|
|
on account of the Additions and Subtractions of the site.
|
|
|
|
Assign these values to their respective site properties.
|
|
"""
|
|
|
|
if not hasattr(obj, "Perimeter"): # check we have a latest version site
|
|
return
|
|
|
|
if not obj.Shape.Faces:
|
|
if obj.ProjectedArea.Value != 0:
|
|
obj.ProjectedArea = 0
|
|
if obj.Perimeter.Value != 0:
|
|
obj.Perimeter = 0
|
|
if obj.AdditionVolume.Value != 0:
|
|
obj.AdditionVolume = 0
|
|
if obj.SubtractionVolume.Value != 0:
|
|
obj.SubtractionVolume = 0
|
|
return
|
|
|
|
import TechDraw
|
|
import Part
|
|
|
|
area = 0
|
|
perim = 0
|
|
addvol = 0
|
|
subvol = 0
|
|
edges = []
|
|
|
|
for face in obj.Shape.Faces:
|
|
if face.normalAt(0, 0).getAngle(FreeCAD.Vector(0, 0, 1)) < 1.5707:
|
|
edges.extend(TechDraw.project(face, FreeCAD.Vector(0, 0, 1))[0].Edges)
|
|
outer = TechDraw.findOuterWire(edges)
|
|
|
|
# compute area
|
|
try:
|
|
area = Part.Face(outer).Area # outer.Area does not always work.
|
|
except Part.OCCError:
|
|
print("Error computing areas for", obj.Label)
|
|
area = 0
|
|
|
|
# compute perimeter
|
|
perim = outer.Length
|
|
|
|
# compute volumes
|
|
shape = Part.Shape(obj.Terrain.Shape)
|
|
shape.Placement = obj.Placement * shape.Placement
|
|
if not obj.Terrain.Shape.Solids:
|
|
shape = shape.extrude(obj.ExtrusionVector)
|
|
for sub in obj.Additions:
|
|
addvol += sub.Shape.cut(shape).Volume
|
|
for sub in obj.Subtractions:
|
|
subvol += sub.Shape.common(shape).Volume
|
|
|
|
# update properties
|
|
if obj.ProjectedArea.Value != area:
|
|
obj.ProjectedArea = area
|
|
if obj.Perimeter.Value != perim:
|
|
obj.Perimeter = perim
|
|
if obj.AdditionVolume.Value != addvol:
|
|
obj.AdditionVolume = addvol
|
|
if obj.SubtractionVolume.Value != subvol:
|
|
obj.SubtractionVolume = subvol
|
|
|
|
def addObject(self, obj, child):
|
|
"Adds an object to the group of this BuildingPart"
|
|
|
|
if not child in obj.Group:
|
|
g = obj.Group
|
|
g.append(child)
|
|
obj.Group = g
|
|
|
|
def dumps(self):
|
|
|
|
return None
|
|
|
|
def loads(self, state):
|
|
|
|
self.Type = "Site"
|
|
|
|
|
|
class _ViewProviderSite:
|
|
"""A View Provider for the Site object.
|
|
|
|
Parameters
|
|
----------
|
|
vobj: <Gui.ViewProviderDocumentObject>
|
|
The view provider to turn into a site view provider.
|
|
"""
|
|
|
|
def __init__(self, vobj):
|
|
vobj.Proxy = self
|
|
vobj.addExtension("Gui::ViewProviderGroupExtensionPython")
|
|
self.setProperties(vobj)
|
|
# Defer the constraint and default value setup until after the GUI is fully initialized.
|
|
from PySide import QtCore
|
|
|
|
QtCore.QTimer.singleShot(0, lambda: self.restoreConstraints(vobj))
|
|
|
|
def setProperties(self, vobj):
|
|
"""Give the site view provider its site view provider specific properties.
|
|
|
|
These include solar diagram and compass data, dealing the orientation
|
|
of the site, and its orientation to the sun.
|
|
|
|
You can learn more about properties here: https://wiki.freecad.org/property
|
|
"""
|
|
|
|
pl = vobj.PropertiesList
|
|
if not "WindRose" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyBool",
|
|
"WindRose",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"Show wind rose diagram or not. Uses solar diagram scale. Needs Ladybug module",
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "SolarDiagram" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyBool",
|
|
"SolarDiagram",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "Show solar diagram or not"),
|
|
locked=True,
|
|
)
|
|
if not "SolarDiagramScale" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyFloat",
|
|
"SolarDiagramScale",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The scale of the solar diagram"),
|
|
locked=True,
|
|
)
|
|
vobj.SolarDiagramScale = 20000.0 # Default diagram of 20 m radius
|
|
if not "SolarDiagramPosition" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyVector",
|
|
"SolarDiagramPosition",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The position of the solar diagram"),
|
|
locked=True,
|
|
)
|
|
if not "SolarDiagramColor" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyColor",
|
|
"SolarDiagramColor",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP("App::Property", "The color of the solar diagram"),
|
|
locked=True,
|
|
)
|
|
vobj.SolarDiagramColor = (0.16, 0.16, 0.25)
|
|
if not "Orientation" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyEnumeration",
|
|
"Orientation",
|
|
"Site",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property",
|
|
"When set to 'True North' the whole geometry will be rotated to match the true north of this site",
|
|
),
|
|
locked=True,
|
|
)
|
|
vobj.Orientation = ["Project North", "True North"]
|
|
vobj.Orientation = "Project North"
|
|
if not "Compass" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyBool",
|
|
"Compass",
|
|
"Compass",
|
|
QT_TRANSLATE_NOOP("App::Property", "Show compass or not"),
|
|
locked=True,
|
|
)
|
|
if not "CompassRotation" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyAngle",
|
|
"CompassRotation",
|
|
"Compass",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "The rotation of the Compass relative to the Site"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "CompassPosition" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyVector",
|
|
"CompassPosition",
|
|
"Compass",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "The position of the Compass relative to the Site placement"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "UpdateDeclination" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyBool",
|
|
"UpdateDeclination",
|
|
"Compass",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "Update the Declination value based on the compass rotation"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "ShowSunPosition" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyBool",
|
|
"ShowSunPosition",
|
|
"Sun",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "Show the sun position for a specific date and time"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "SunDateMonth" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyIntegerConstraint",
|
|
"SunDateMonth",
|
|
"Sun",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "The month of the year to show the sun position"
|
|
),
|
|
locked=True,
|
|
)
|
|
if not "SunDateDay" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyIntegerConstraint",
|
|
"SunDateDay",
|
|
"Sun",
|
|
QT_TRANSLATE_NOOP("App::Property", "The day of the month to show the sun position"),
|
|
locked=True,
|
|
)
|
|
if not "SunTimeHour" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyFloatConstraint",
|
|
"SunTimeHour",
|
|
"Sun",
|
|
QT_TRANSLATE_NOOP("App::Property", "The hour of the day to show the sun position"),
|
|
locked=True,
|
|
)
|
|
if not "ShowHourLabels" in pl:
|
|
vobj.addProperty(
|
|
"App::PropertyBool",
|
|
"ShowHourLabels",
|
|
"Sun",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "Show text labels for key hours on the sun path"
|
|
),
|
|
locked=True,
|
|
)
|
|
vobj.ShowHourLabels = True # Show hour labels by default
|
|
|
|
def restoreConstraints(self, vobj):
|
|
"""Re-apply non-persistent property constraints after a file load.
|
|
|
|
It also handles new objects, where their value is 0.
|
|
"""
|
|
try:
|
|
pl = vobj.PropertiesList
|
|
except ReferenceError:
|
|
# vobj no longer exists
|
|
# see https://github.com/FreeCAD/FreeCAD/issues/24543
|
|
return
|
|
|
|
if "SunDateMonth" in pl:
|
|
saved_month = vobj.SunDateMonth if vobj.SunDateMonth != 0 else 6
|
|
vobj.SunDateMonth = (saved_month, 1, 12, 1)
|
|
else:
|
|
vobj.SunDateMonth = (6, 1, 12, 1) # Default to June
|
|
|
|
if "SunDateDay" in pl:
|
|
saved_day = vobj.SunDateDay if vobj.SunDateDay != 0 else 21
|
|
vobj.SunDateDay = (saved_day, 1, 31, 1)
|
|
else:
|
|
# 31 is a safe maximum; the datetime object will handle invalid dates like Feb 31.
|
|
vobj.SunDateDay = (21, 1, 31, 1) # Default to the 21st (solstice)
|
|
|
|
if "SunTimeHour" in pl:
|
|
saved_hour = vobj.SunTimeHour if abs(vobj.SunTimeHour) > 1e-9 else 12.0
|
|
vobj.SunTimeHour = (saved_hour, 0.0, 23.5, 0.5)
|
|
else:
|
|
# Use 23.5 to avoid issues with hour 24
|
|
vobj.SunTimeHour = (12.0, 0.0, 23.5, 0.5) # Default to noon
|
|
|
|
def getIcon(self):
|
|
"""Return the path to the appropriate icon.
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
Path to the appropriate icon .svg file.
|
|
"""
|
|
|
|
import Arch_rc
|
|
|
|
return ":/icons/Arch_Site_Tree.svg"
|
|
|
|
def claimChildren(self):
|
|
"""Define which objects will appear as children in the tree view.
|
|
|
|
Set objects within the site group, and the terrain object as children.
|
|
|
|
If the Arch preference swallowSubtractions is true, set the additions
|
|
and subtractions to the terrain as children.
|
|
|
|
Returns
|
|
-------
|
|
list of <App::DocumentObject>s:
|
|
The objects claimed as children.
|
|
"""
|
|
|
|
objs = []
|
|
if hasattr(self, "Object"):
|
|
objs = self.Object.Group + [self.Object.Terrain]
|
|
if hasattr(self.Object, "Additions") and params.get_param_arch("swallowAdditions"):
|
|
objs.extend(self.Object.Additions)
|
|
if hasattr(self.Object, "Subtractions") and params.get_param_arch(
|
|
"swallowSubtractions"
|
|
):
|
|
objs.extend(self.Object.Subtractions)
|
|
return objs
|
|
|
|
def setEdit(self, vobj, mode):
|
|
if mode == 1 or mode == 2:
|
|
return None
|
|
|
|
import ArchComponent
|
|
|
|
taskd = ArchComponent.ComponentTaskPanel()
|
|
taskd.obj = self.Object
|
|
taskd.update()
|
|
FreeCADGui.Control.showDialog(taskd)
|
|
return True
|
|
|
|
def unsetEdit(self, vobj, mode):
|
|
if mode == 1 or mode == 2:
|
|
return None
|
|
|
|
FreeCADGui.Control.closeDialog()
|
|
return True
|
|
|
|
def setupContextMenu(self, vobj, menu):
|
|
|
|
if FreeCADGui.activeWorkbench().name() != "BIMWorkbench":
|
|
return
|
|
|
|
actionEdit = QtGui.QAction(translate("Arch", "Edit"), menu)
|
|
QtCore.QObject.connect(actionEdit, QtCore.SIGNAL("triggered()"), self.edit)
|
|
menu.addAction(actionEdit)
|
|
|
|
actionToggleSubcomponents = QtGui.QAction(
|
|
QtGui.QIcon(":/icons/Arch_ToggleSubs.svg"),
|
|
translate("Arch", "Toggle Subcomponents"),
|
|
menu,
|
|
)
|
|
QtCore.QObject.connect(
|
|
actionToggleSubcomponents, QtCore.SIGNAL("triggered()"), self.toggleSubcomponents
|
|
)
|
|
menu.addAction(actionToggleSubcomponents)
|
|
|
|
# The default Part::FeaturePython context menu contains a `Set colors`
|
|
# option. This option does not work well for Site objects. We therefore
|
|
# override this menu and have to add our own `Transform` item.
|
|
# To override the default menu this function must return `True`.
|
|
actionTransform = QtGui.QAction(
|
|
FreeCADGui.getIcon("Std_TransformManip.svg"),
|
|
translate("Command", "Transform"), # Context `Command` instead of `Arch`.
|
|
menu,
|
|
)
|
|
QtCore.QObject.connect(actionTransform, QtCore.SIGNAL("triggered()"), self.transform)
|
|
menu.addAction(actionTransform)
|
|
|
|
return True
|
|
|
|
def edit(self):
|
|
FreeCADGui.ActiveDocument.setEdit(self.Object, 0)
|
|
|
|
def toggleSubcomponents(self):
|
|
FreeCADGui.runCommand("Arch_ToggleSubs")
|
|
|
|
def transform(self):
|
|
FreeCADGui.ActiveDocument.setEdit(self.Object, 1)
|
|
|
|
def attach(self, vobj):
|
|
"""Adds the solar diagram and compass to the coin scenegraph, but does
|
|
not add display modes.
|
|
"""
|
|
|
|
self.Object = vobj.Object
|
|
from pivy import coin
|
|
|
|
basesep = coin.SoSeparator()
|
|
vobj.Annotation.addChild(basesep)
|
|
self.color = coin.SoBaseColor()
|
|
self.coords = coin.SoTransform()
|
|
basesep.addChild(self.coords)
|
|
basesep.addChild(self.color)
|
|
self.diagramsep = coin.SoSeparator()
|
|
self.diagramswitch = coin.SoSwitch()
|
|
self.diagramswitch.whichChild = -1
|
|
self.diagramswitch.addChild(self.diagramsep)
|
|
basesep.addChild(self.diagramswitch)
|
|
self.windrosesep = coin.SoSeparator()
|
|
self.windroseswitch = coin.SoSwitch()
|
|
self.windroseswitch.whichChild = -1
|
|
self.windroseswitch.addChild(self.windrosesep)
|
|
basesep.addChild(self.windroseswitch)
|
|
self.compass = Compass()
|
|
self.updateCompassVisibility(vobj)
|
|
self.updateCompassScale(vobj)
|
|
self.rotateCompass(vobj)
|
|
vobj.Annotation.addChild(self.compass.rootNode)
|
|
|
|
self.sunSwitch = coin.SoSwitch() # Toggle the sun sphere on and off
|
|
self.sunSwitch.whichChild = -1 # -1 means hidden
|
|
|
|
self.sunSep = coin.SoSeparator() # A separator to group all sun elements
|
|
self.sunTransform = coin.SoTransform() # Position the sphere
|
|
self.sunMaterial = coin.SoMaterial()
|
|
self.sunMaterial.diffuseColor.setValue(1, 1, 0) # Yellow color
|
|
self.sunSphere = coin.SoSphere()
|
|
|
|
# Assemble the scene graph for the sphere
|
|
self.sunSep.addChild(self.sunTransform)
|
|
self.sunSep.addChild(self.sunMaterial)
|
|
self.sunSep.addChild(self.sunSphere)
|
|
self.sunSwitch.addChild(self.sunSep)
|
|
|
|
# Add the entire sun assembly to the object's annotation node
|
|
vobj.Annotation.addChild(self.sunSwitch)
|
|
|
|
def setup_path_segment(color_tuple):
|
|
separator = coin.SoSeparator()
|
|
material = coin.SoMaterial()
|
|
material.diffuseColor.setValue(color_tuple)
|
|
node = coin.SoSeparator() # This will hold the geometry
|
|
separator.addChild(material)
|
|
separator.addChild(node)
|
|
self.sunSwitch.addChild(separator)
|
|
return node
|
|
|
|
# Create nodes for different segments of the sun path representing
|
|
# morning, midday, and afternoon with distinct colors.
|
|
self.sunPathMorningNode = setup_path_segment((0.2, 0.8, 1.0)) # Sky Blue
|
|
self.sunPathMiddayNode = setup_path_segment((1.0, 0.75, 0.0)) # Golden Yellow / Amber
|
|
self.sunPathAfternoonNode = setup_path_segment((1.0, 0.35, 0.0)) # Orange-Red
|
|
|
|
# Create nodes for the hour marker points.
|
|
self.hourMarkerSep = coin.SoSeparator()
|
|
self.hourMarkerMaterial = coin.SoMaterial()
|
|
self.hourMarkerMaterial.diffuseColor.setValue(0.8, 0.8, 0.8) # Grey
|
|
|
|
self.hourMarkerDrawStyle = coin.SoDrawStyle()
|
|
self.hourMarkerDrawStyle.pointSize.setValue(5) # Set a visible point size (e.g., 5 pixels)
|
|
self.hourMarkerDrawStyle.style.setValue(coin.SoDrawStyle.POINTS)
|
|
|
|
self.hourMarkerCoords = coin.SoCoordinate3()
|
|
self.hourMarkerSet = coin.SoPointSet()
|
|
|
|
self.hourMarkerSep.addChild(self.hourMarkerMaterial)
|
|
self.hourMarkerSep.addChild(self.hourMarkerDrawStyle)
|
|
self.hourMarkerSep.addChild(self.hourMarkerCoords)
|
|
self.hourMarkerSep.addChild(self.hourMarkerSet)
|
|
self.sunSwitch.addChild(self.hourMarkerSep)
|
|
|
|
# Create nodes for the hour labels.
|
|
self.hourLabelSep = coin.SoSeparator()
|
|
self.hourLabelMaterial = coin.SoMaterial()
|
|
self.hourLabelMaterial.diffuseColor.setValue(0.8, 0.8, 0.8) # Same grey as markers
|
|
self.hourLabelFont = coin.SoFont()
|
|
self.hourLabelSep.addChild(self.hourLabelMaterial)
|
|
self.hourLabelSep.addChild(self.hourLabelFont)
|
|
self.sunSwitch.addChild(self.hourLabelSep)
|
|
|
|
def updateData(self, obj, prop):
|
|
"""Method called when the host object has a property changed.
|
|
|
|
If the Longitude or Latitude has changed, set the SolarDiagram to
|
|
update.
|
|
|
|
If Terrain or Placement has changed, move the compass to follow it.
|
|
|
|
Parameters
|
|
----------
|
|
obj: <App::FeaturePython>
|
|
The host object that has changed.
|
|
prop: string
|
|
The name of the property that has changed.
|
|
"""
|
|
|
|
if prop in ["Longitude", "Latitude", "TimeZone"]:
|
|
self.onChanged(obj.ViewObject, "SolarDiagram")
|
|
elif prop == "Declination":
|
|
self.onChanged(obj.ViewObject, "SolarDiagramPosition")
|
|
self.updateTrueNorthRotation()
|
|
elif prop == "Terrain":
|
|
self.updateCompassLocation(obj.ViewObject)
|
|
elif prop == "Placement":
|
|
self.updateCompassLocation(obj.ViewObject)
|
|
self.updateDeclination(obj.ViewObject)
|
|
elif prop == "ProjectedArea":
|
|
self.updateCompassScale(obj.ViewObject)
|
|
|
|
def addDisplaymodeTerrainSwitches(self, vobj):
|
|
"""Adds 'terrain' switches to the 4 default display modes.
|
|
|
|
If the Terrain property of the site is None, the 'normal' display can
|
|
be switched off with these switches. This avoids 'ghosts' of the objects
|
|
in the Group property.
|
|
See:
|
|
https://forum.freecad.org/viewtopic.php?f=10&t=74731
|
|
https://forum.freecad.org/viewtopic.php?t=75658
|
|
https://forum.freecad.org/viewtopic.php?t=75883
|
|
"""
|
|
|
|
from pivy import coin
|
|
from draftutils import gui_utils
|
|
|
|
if not hasattr(self, "terrain_switches"):
|
|
if vobj.RootNode.getNumChildren():
|
|
main_switch = gui_utils.find_coin_node(
|
|
vobj.RootNode, coin.SoSwitch
|
|
) # The display mode switch.
|
|
if (
|
|
main_switch is not None and main_switch.getNumChildren() == 4
|
|
): # Check if all display modes are available.
|
|
self.terrain_switches = []
|
|
for node in tuple(main_switch.getChildren()):
|
|
new_switch = coin.SoSwitch()
|
|
sep1 = coin.SoSeparator()
|
|
sep1.setName("NoTerrain")
|
|
sep2 = coin.SoSeparator()
|
|
sep2.setName("Terrain")
|
|
child_list = list(node.getChildren())
|
|
for child in child_list:
|
|
sep2.addChild(child)
|
|
new_switch.addChild(sep1)
|
|
new_switch.addChild(sep2)
|
|
new_switch.whichChild = 0
|
|
node.addChild(new_switch)
|
|
for i in range(len(child_list)):
|
|
node.removeChild(0) # Remove the original children.
|
|
self.terrain_switches.append(new_switch)
|
|
|
|
def updateDisplaymodeTerrainSwitches(self, vobj):
|
|
"""Updates the 'terrain' switches."""
|
|
|
|
if not hasattr(self, "terrain_switches"):
|
|
return
|
|
|
|
idx = 0 if self.Object.Terrain is None else 1
|
|
for switch in self.terrain_switches:
|
|
switch.whichChild = idx
|
|
|
|
def onChanged(self, vobj, prop):
|
|
from pivy import coin
|
|
|
|
if prop == "Visibility":
|
|
if vobj.Visibility:
|
|
# When the site becomes visible, check if the sun elements should also be shown.
|
|
if hasattr(vobj, "ShowSunPosition") and vobj.ShowSunPosition:
|
|
self.sunSwitch.whichChild = coin.SO_SWITCH_ALL
|
|
else:
|
|
# When the site is hidden, always hide the sun elements.
|
|
self.sunSwitch.whichChild = coin.SO_SWITCH_NONE
|
|
|
|
# onChanged is called multiple times when a document is opened.
|
|
# Some display mode nodes can be missing during initial calls.
|
|
# The two methods called below must take that into account.
|
|
self.addDisplaymodeTerrainSwitches(vobj)
|
|
self.updateDisplaymodeTerrainSwitches(vobj)
|
|
|
|
if prop == "SolarDiagramPosition":
|
|
if hasattr(vobj, "SolarDiagramPosition"):
|
|
p = vobj.SolarDiagramPosition
|
|
self.coords.translation.setValue([p.x, p.y, p.z])
|
|
if hasattr(vobj.Object, "Declination"):
|
|
from pivy import coin
|
|
|
|
self.coords.rotation.setValue(
|
|
coin.SbVec3f((0, 0, 1)), math.radians(vobj.Object.Declination.Value)
|
|
)
|
|
elif prop == "SolarDiagramColor":
|
|
if hasattr(vobj, "SolarDiagramColor"):
|
|
l = vobj.SolarDiagramColor
|
|
self.color.rgb.setValue([l[0], l[1], l[2]])
|
|
elif "SolarDiagram" in prop:
|
|
if hasattr(self, "diagramnode"):
|
|
self.diagramsep.removeChild(self.diagramnode)
|
|
del self.diagramnode
|
|
if hasattr(vobj, "SolarDiagram") and hasattr(vobj, "SolarDiagramScale"):
|
|
if vobj.SolarDiagram:
|
|
tz = 0
|
|
if hasattr(vobj.Object, "TimeZone"):
|
|
tz = vobj.Object.TimeZone
|
|
self.diagramnode = makeSolarDiagram(
|
|
vobj.Object.Longitude, vobj.Object.Latitude, vobj.SolarDiagramScale, tz=tz
|
|
)
|
|
if self.diagramnode:
|
|
self.diagramsep.addChild(self.diagramnode)
|
|
self.diagramswitch.whichChild = 0
|
|
else:
|
|
del self.diagramnode
|
|
else:
|
|
self.diagramswitch.whichChild = -1
|
|
elif prop in [
|
|
"ShowSunPosition",
|
|
"SunDateMonth",
|
|
"SunDateDay",
|
|
"SunTimeHour",
|
|
"SolarDiagramScale",
|
|
"SolarDiagramPosition",
|
|
"ShowHourLabels",
|
|
]:
|
|
# During file load or property creation, this method can be triggered
|
|
# before all necessary properties are available. This guard ensures
|
|
# that the sun position is only updated when the object is in a consistent state.
|
|
if all(
|
|
hasattr(vobj, p)
|
|
for p in ["ShowSunPosition", "SunDateMonth", "SunDateDay", "SunTimeHour"]
|
|
):
|
|
self.updateSunPosition(vobj)
|
|
elif prop == "WindRose":
|
|
if hasattr(self, "windrosenode"):
|
|
del self.windrosenode
|
|
if hasattr(vobj, "WindRose"):
|
|
if vobj.WindRose:
|
|
if hasattr(vobj.Object, "EPWFile") and vobj.Object.EPWFile:
|
|
with temp_logger_level(logging.WARNING):
|
|
try:
|
|
import ladybug
|
|
|
|
logging.getLogger("ladybug").propagate = False
|
|
except ImportError:
|
|
pass
|
|
else:
|
|
self.windrosenode = makeWindRose(
|
|
vobj.Object.EPWFile, vobj.SolarDiagramScale
|
|
)
|
|
if self.windrosenode:
|
|
self.windrosesep.addChild(self.windrosenode)
|
|
self.windroseswitch.whichChild = 0
|
|
else:
|
|
del self.windrosenode
|
|
else:
|
|
self.windroseswitch.whichChild = -1
|
|
elif prop == "Visibility":
|
|
if vobj.Visibility:
|
|
self.updateCompassVisibility(vobj)
|
|
else:
|
|
self.compass.hide()
|
|
elif prop == "Orientation":
|
|
if vobj.Orientation == "True North":
|
|
self.addTrueNorthRotation()
|
|
else:
|
|
self.removeTrueNorthRotation()
|
|
elif prop == "UpdateDeclination":
|
|
self.updateDeclination(vobj)
|
|
elif prop == "Compass":
|
|
self.updateCompassVisibility(vobj)
|
|
elif prop == "CompassRotation":
|
|
self.updateDeclination(vobj)
|
|
self.rotateCompass(vobj)
|
|
elif prop == "CompassPosition":
|
|
self.updateCompassLocation(vobj)
|
|
|
|
def updateDeclination(self, vobj):
|
|
"""Update the declination of the compass
|
|
|
|
Update the declination by adding together how the site has been rotated
|
|
within the document, and the rotation of the site compass.
|
|
"""
|
|
|
|
if not hasattr(vobj, "UpdateDeclination") or not vobj.UpdateDeclination:
|
|
return
|
|
compassRotation = vobj.CompassRotation.Value
|
|
siteRotation = math.degrees(
|
|
vobj.Object.Placement.Rotation.Angle
|
|
) # This assumes Rotation.axis = (0,0,1)
|
|
vobj.Object.Declination = compassRotation + siteRotation
|
|
|
|
def addTrueNorthRotation(self):
|
|
|
|
if hasattr(self, "trueNorthRotation") and self.trueNorthRotation is not None:
|
|
return
|
|
if not FreeCADGui.ActiveDocument.ActiveView:
|
|
return
|
|
if not hasattr(FreeCADGui.ActiveDocument.ActiveView, "getSceneGraph"):
|
|
return
|
|
|
|
from pivy import coin
|
|
|
|
self.trueNorthRotation = coin.SoTransform()
|
|
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
|
|
sg.insertChild(self.trueNorthRotation, 0)
|
|
self.updateTrueNorthRotation()
|
|
|
|
def removeTrueNorthRotation(self):
|
|
|
|
if not hasattr(self, "trueNorthRotation"):
|
|
return
|
|
if self.trueNorthRotation is None:
|
|
return
|
|
if not FreeCADGui.ActiveDocument.ActiveView:
|
|
return
|
|
if not hasattr(FreeCADGui.ActiveDocument.ActiveView, "getSceneGraph"):
|
|
return
|
|
|
|
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
|
|
sg.removeChild(self.trueNorthRotation)
|
|
self.trueNorthRotation = None
|
|
|
|
def updateTrueNorthRotation(self):
|
|
|
|
if hasattr(self, "trueNorthRotation") and self.trueNorthRotation is not None:
|
|
from pivy import coin
|
|
|
|
angle = self.Object.Declination.Value
|
|
self.trueNorthRotation.rotation.setValue(coin.SbVec3f(0, 0, 1), math.radians(-angle))
|
|
|
|
def updateCompassVisibility(self, vobj):
|
|
|
|
if not hasattr(self, "compass"):
|
|
return
|
|
show = hasattr(vobj, "Compass") and vobj.Compass
|
|
if show:
|
|
self.compass.show()
|
|
else:
|
|
self.compass.hide()
|
|
|
|
def rotateCompass(self, vobj):
|
|
|
|
if not hasattr(self, "compass"):
|
|
return
|
|
if hasattr(vobj, "CompassRotation"):
|
|
self.compass.rotate(vobj.CompassRotation.Value)
|
|
|
|
def updateCompassLocation(self, vobj):
|
|
|
|
if not hasattr(self, "compass"):
|
|
return
|
|
if not vobj.Object.Shape:
|
|
return
|
|
boundBox = vobj.Object.Shape.BoundBox
|
|
pos = vobj.Object.Placement.Base
|
|
x = 0
|
|
y = 0
|
|
if hasattr(vobj, "CompassPosition"):
|
|
x = vobj.CompassPosition.x
|
|
y = vobj.CompassPosition.y
|
|
z = boundBox.ZMax = pos.z
|
|
self.compass.locate(x, y, z + 1000)
|
|
|
|
def updateCompassScale(self, vobj):
|
|
|
|
if not hasattr(self, "compass"):
|
|
return
|
|
self.compass.scale(vobj.Object.ProjectedArea)
|
|
|
|
def dumps(self):
|
|
|
|
return None
|
|
|
|
def loads(self, state):
|
|
"""Restore hook for view provider instances created by the loader.
|
|
|
|
During document deserialization the Python instance may be
|
|
allocated without calling __init__, so runtime initialization
|
|
(adding view properties) must be performed here. We defer the
|
|
actual reinitialization to the event loop to ensure the
|
|
ViewObject binding and the Property Editor are available.
|
|
"""
|
|
# Try to obtain the `ViewObject` immediately; if not ready, the
|
|
# helper method `_wait_for_viewobject` will schedule retries
|
|
# via the event loop. This ensures view-specific properties and
|
|
# constraints are applied once the view object exists.
|
|
self._wait_for_viewobject(self._on_viewobject_ready)
|
|
|
|
return None
|
|
|
|
def _migrate_legacy_solar_diagram_scale(self, vobj):
|
|
"""Migration for legacy SolarDiagramScale values.
|
|
|
|
Historically older FreeCAD files (1.0.0 and prior) sometimes stored
|
|
an impractically small SolarDiagramScale (for example `1.0`) which
|
|
results in invisible or confusing solar diagrams in the UI. This
|
|
helper intentionally performs a small, best-effort normalization:
|
|
|
|
- If the `SolarDiagramScale` property exists and its saved value is
|
|
numeric and <= 1.0 (or effectively zero) it will be replaced with
|
|
the modern default of 20000.0 (20 m radius).
|
|
- The operation is non-destructive and best-effort: failures are
|
|
quietly ignored so loading does not fail.
|
|
|
|
Keep this helper small and idempotent so it can be called safely
|
|
during view-provider restore.
|
|
"""
|
|
# Keep the migration compact and non-fatal
|
|
if not FreeCAD.GuiUp:
|
|
return
|
|
try:
|
|
if "SolarDiagramScale" in vobj.PropertiesList:
|
|
scale_value = getattr(vobj, "SolarDiagramScale", None)
|
|
if scale_value is None:
|
|
return
|
|
try:
|
|
scale_value = float(scale_value)
|
|
except (ValueError, TypeError):
|
|
return
|
|
# Treat 0 or 1 as legacy values and replace them with the modern default
|
|
if scale_value <= 1.0 or abs(scale_value) < 1e-9:
|
|
vobj.SolarDiagramScale = 20000.0
|
|
FreeCAD.Console.PrintMessage(
|
|
"ArchSite: migrated SolarDiagramScale property value to 20 m.\n"
|
|
)
|
|
except Exception as e:
|
|
# Non-fatal: never let migration break document restore.
|
|
FreeCAD.Console.PrintError(f"ArchSite: Failed during legacy migration: {e}\n")
|
|
|
|
def _wait_for_viewobject(self, callback):
|
|
"""Polls until the ViewObject is available, then executes the callback."""
|
|
from PySide import QtCore
|
|
|
|
# Try common ways to obtain the ViewObject
|
|
vobj = getattr(self, "__vobject__", None)
|
|
if vobj is None:
|
|
appobj = getattr(self, "Object", None)
|
|
if appobj is not None:
|
|
vobj = getattr(appobj, "ViewObject", None)
|
|
|
|
if vobj is None:
|
|
# ViewObject binding not ready yet: schedule a retry
|
|
QtCore.QTimer.singleShot(50, lambda: self._wait_for_viewobject(callback))
|
|
return
|
|
|
|
# ViewObject is ready, execute the callback
|
|
callback(vobj)
|
|
|
|
def _on_viewobject_ready(self, vobj):
|
|
"""Callback executed once the ViewObject is guaranteed to be available."""
|
|
from PySide import QtCore
|
|
|
|
# Ensure properties exist (idempotent)
|
|
try:
|
|
self.setProperties(vobj)
|
|
except Exception as e:
|
|
FreeCAD.Console.PrintError(f"ArchSite: Failed to set properties during restore: {e}\n")
|
|
|
|
# Perform any small migrations
|
|
try:
|
|
self._migrate_legacy_solar_diagram_scale(vobj)
|
|
except Exception as e:
|
|
FreeCAD.Console.PrintError(f"ArchSite: Failed during legacy migration: {e}\n")
|
|
|
|
# Give the UI one more event cycle to pick up the new properties,
|
|
# then restore constraints and defaults.
|
|
QtCore.QTimer.singleShot(0, lambda: self.restoreConstraints(vobj))
|
|
|
|
def updateSunPosition(self, vobj):
|
|
"""Calculates sun position and updates the sphere, path arc, and ray object."""
|
|
import math
|
|
import Part
|
|
import datetime
|
|
from pivy import coin
|
|
|
|
obj = vobj.Object
|
|
|
|
# During document restore the view provider may be allocated without full runtime
|
|
# initialization (attach()/node creation). If the scenegraph nodes we need are not yet
|
|
# present, schedule a retry in the next event loop iteration and return. This avoids
|
|
# AttributeError and is harmless because updateSunPosition will be called again when the
|
|
# object becomes consistent, or the scheduled retry will run after attach() finishes.
|
|
required_attrs = [
|
|
"sunPathMorningNode",
|
|
"sunPathMiddayNode",
|
|
"sunPathAfternoonNode",
|
|
"hourMarkerCoords",
|
|
"hourLabelSep",
|
|
"sunTransform",
|
|
"sunSphere",
|
|
]
|
|
for a in required_attrs:
|
|
if not hasattr(self, a):
|
|
try:
|
|
from PySide import QtCore
|
|
|
|
QtCore.QTimer.singleShot(0, lambda: self.updateSunPosition(vobj))
|
|
except Exception:
|
|
# If Qt is unavailable or scheduling fails, just return silently.
|
|
pass
|
|
return
|
|
|
|
# Handle the visibility toggle for all elements
|
|
self.sunPathMorningNode.removeAllChildren()
|
|
self.sunPathMiddayNode.removeAllChildren()
|
|
self.sunPathAfternoonNode.removeAllChildren()
|
|
self.hourLabelSep.removeAllChildren()
|
|
self.hourMarkerCoords.point.deleteValues(0)
|
|
|
|
if not vobj.ShowSunPosition:
|
|
self.sunSwitch.whichChild = -1 # Hide the Pivy sphere and path
|
|
ray_object = getattr(obj, "SunRay", None)
|
|
if ray_object and hasattr(ray_object, "ViewObject"):
|
|
obj.SunRay.ViewObject.Visibility = False
|
|
return
|
|
|
|
self.sunSwitch.whichChild = coin.SO_SWITCH_ALL # Show sphere and path
|
|
|
|
dt_object_for_label = None
|
|
|
|
with temp_logger_level(logging.WARNING):
|
|
try:
|
|
from ladybug import location, sunpath
|
|
|
|
logging.getLogger("ladybug").propagate = False
|
|
loc = location.Location(
|
|
latitude=obj.Latitude, longitude=obj.Longitude, time_zone=obj.TimeZone
|
|
)
|
|
sp = sunpath.Sunpath.from_location(loc)
|
|
is_ladybug = True
|
|
except ImportError:
|
|
try:
|
|
import pysolar.solar as solar
|
|
|
|
is_ladybug = False
|
|
except ImportError:
|
|
FreeCAD.Console.PrintError(
|
|
"Ladybug or Pysolar module not found. Cannot calculate sun position.\n"
|
|
)
|
|
return
|
|
|
|
morning_points, midday_points, afternoon_points = [], [], []
|
|
self.hourMarkerCoords.point.deleteValues(0) # Clear previous marker coordinates
|
|
marker_coords = []
|
|
|
|
for hour_float in [h / 2.0 for h in range(48)]: # Loop from 0.0 to 23.5
|
|
if is_ladybug:
|
|
sun = sp.calculate_sun(
|
|
month=vobj.SunDateMonth, day=vobj.SunDateDay, hour=hour_float
|
|
)
|
|
alt = sun.altitude
|
|
az = sun.azimuth
|
|
else:
|
|
tz = datetime.timezone(datetime.timedelta(hours=obj.TimeZone))
|
|
dt = datetime.datetime(
|
|
2023,
|
|
vobj.SunDateMonth,
|
|
vobj.SunDateDay,
|
|
int(hour_float),
|
|
int((hour_float % 1) * 60),
|
|
tzinfo=tz,
|
|
)
|
|
alt = solar.get_altitude(obj.Latitude, obj.Longitude, dt)
|
|
az = solar.get_azimuth(obj.Latitude, obj.Longitude, dt)
|
|
|
|
if alt > 0:
|
|
alt_rad = math.radians(alt)
|
|
az_rad = math.radians(90 - az)
|
|
xy_proj = math.cos(alt_rad) * vobj.SolarDiagramScale
|
|
x = math.cos(az_rad) * xy_proj
|
|
y = math.sin(az_rad) * xy_proj
|
|
z = math.sin(alt_rad) * vobj.SolarDiagramScale
|
|
point = FreeCAD.Vector(x, y, z)
|
|
if hour_float < 10:
|
|
morning_points.append(point)
|
|
elif hour_float <= 14:
|
|
midday_points.append(point)
|
|
else:
|
|
afternoon_points.append(point)
|
|
# Check if the current time is a full hour
|
|
if hour_float % 1 == 0:
|
|
marker_coords.append(FreeCAD.Vector(x, y, z))
|
|
|
|
if hasattr(vobj, "ShowHourLabels") and vobj.ShowHourLabels:
|
|
if vobj.ShowHourLabels and (hour_float in [9.0, 12.0, 15.0]):
|
|
# Create a text node for the label
|
|
text_node = coin.SoText2()
|
|
text_node.string = f"{int(hour_float)}h"
|
|
|
|
# Create a transform to position the text slightly offset from the marker
|
|
text_transform = coin.SoTransform()
|
|
offset_vec = FreeCAD.Vector(x, y, z).normalize() * (
|
|
vobj.SolarDiagramScale * 0.03
|
|
)
|
|
text_pos = FreeCAD.Vector(x, y, z).add(offset_vec)
|
|
text_transform.translation.setValue(text_pos.x, text_pos.y, text_pos.z)
|
|
|
|
# Add a separator for this specific label
|
|
label_sep = coin.SoSeparator()
|
|
label_sep.addChild(text_transform)
|
|
label_sep.addChild(text_node)
|
|
self.hourLabelSep.addChild(label_sep)
|
|
|
|
if marker_coords:
|
|
self.hourMarkerCoords.point.setValues(marker_coords)
|
|
|
|
if len(morning_points) > 1:
|
|
path_b_spline = Part.BSplineCurve()
|
|
path_b_spline.buildFromPoles(morning_points)
|
|
self.sunPathMorningNode.addChild(toNode(path_b_spline.toShape()))
|
|
|
|
if len(midday_points) > 1:
|
|
# To connect midday to morning, we need the last point from the morning list
|
|
if morning_points:
|
|
midday_points.insert(0, morning_points[-1])
|
|
path_b_spline = Part.BSplineCurve()
|
|
path_b_spline.buildFromPoles(midday_points)
|
|
self.sunPathMiddayNode.addChild(toNode(path_b_spline.toShape()))
|
|
|
|
if len(afternoon_points) > 1:
|
|
# To connect afternoon to midday, we need the last point from the midday list
|
|
if midday_points:
|
|
afternoon_points.insert(0, midday_points[-1])
|
|
path_b_spline = Part.BSplineCurve()
|
|
path_b_spline.buildFromPoles(afternoon_points)
|
|
self.sunPathAfternoonNode.addChild(toNode(path_b_spline.toShape()))
|
|
|
|
self.hourLabelFont.size = vobj.SolarDiagramScale * 0.015
|
|
|
|
# Sun sphere and sun ray logic
|
|
if is_ladybug:
|
|
sun = sp.calculate_sun(
|
|
month=vobj.SunDateMonth, day=vobj.SunDateDay, hour=vobj.SunTimeHour
|
|
)
|
|
altitude_deg, azimuth_deg = sun.altitude, sun.azimuth
|
|
dt_object_for_label = datetime.datetime(
|
|
2023,
|
|
vobj.SunDateMonth,
|
|
vobj.SunDateDay,
|
|
int(vobj.SunTimeHour),
|
|
int((vobj.SunTimeHour % 1) * 60),
|
|
)
|
|
else:
|
|
tz = datetime.timezone(datetime.timedelta(hours=obj.TimeZone))
|
|
dt_object_for_label = datetime.datetime(
|
|
2023,
|
|
vobj.SunDateMonth,
|
|
vobj.SunDateDay,
|
|
int(vobj.SunTimeHour),
|
|
int((vobj.SunTimeHour % 1) * 60),
|
|
tzinfo=tz,
|
|
)
|
|
altitude_deg = solar.get_altitude(obj.Latitude, obj.Longitude, dt_object_for_label)
|
|
azimuth_deg = solar.get_azimuth(obj.Latitude, obj.Longitude, dt_object_for_label)
|
|
|
|
altitude_rad = math.radians(altitude_deg)
|
|
azimuth_rad = math.radians(90 - azimuth_deg)
|
|
xy_proj = math.cos(altitude_rad) * vobj.SolarDiagramScale
|
|
x = math.cos(azimuth_rad) * xy_proj
|
|
y = math.sin(azimuth_rad) * xy_proj
|
|
z = math.sin(altitude_rad) * vobj.SolarDiagramScale
|
|
sun_pos_3d = vobj.SolarDiagramPosition.add(
|
|
FreeCAD.Vector(x, y, z)
|
|
) # Final absolute position
|
|
|
|
self.sunTransform.translation.setValue(sun_pos_3d.x, sun_pos_3d.y, sun_pos_3d.z)
|
|
self.sunSphere.radius = vobj.SolarDiagramScale * 0.02
|
|
|
|
# Safely obtain existing SunRay if present, and update it; otherwise create one
|
|
ray_object = getattr(obj, "SunRay", None)
|
|
if ray_object and hasattr(ray_object, "ViewObject"):
|
|
try:
|
|
ray_object.Start = sun_pos_3d
|
|
ray_object.End = vobj.SolarDiagramPosition
|
|
ray_object.ViewObject.Visibility = True
|
|
except Exception:
|
|
# If updating fails, fall back to creating a new ray
|
|
ray_object = None
|
|
if not ray_object:
|
|
ray_object = Draft.make_line(sun_pos_3d, vobj.SolarDiagramPosition)
|
|
vo = ray_object.ViewObject
|
|
vo.LineColor = (1.0, 1.0, 0.0)
|
|
vo.DrawStyle = "Dashed"
|
|
vo.ArrowTypeEnd = "Arrow"
|
|
vo.LineWidth = 2
|
|
vo.ArrowSizeEnd = vobj.SolarDiagramScale * 0.015
|
|
|
|
if hasattr(obj, "addObject"):
|
|
obj.addObject(ray_object)
|
|
# Store new ray on the Site object
|
|
try:
|
|
obj.SunRay = ray_object
|
|
except Exception as e:
|
|
# Ignore failures to set property on legacy objects, but log them
|
|
FreeCAD.Console.PrintWarning(
|
|
f"ArchSite: could not assign SunRay on object {obj.Label}: {e}\n"
|
|
)
|
|
|
|
ray_object.recompute()
|
|
|
|
# Add and update custom data properties
|
|
if not hasattr(ray_object, "Altitude"):
|
|
ray_object.addProperty(
|
|
"App::PropertyAngle",
|
|
"Altitude",
|
|
"Sun Data",
|
|
QT_TRANSLATE_NOOP("App::Property", "The altitude of the sun above the horizon"),
|
|
locked=True,
|
|
)
|
|
ray_object.setEditorMode("Altitude", ["ReadOnly", "Hidden"])
|
|
ray_object.addProperty(
|
|
"App::PropertyAngle",
|
|
"Azimuth",
|
|
"Sun Data",
|
|
QT_TRANSLATE_NOOP(
|
|
"App::Property", "The compass direction of the sun (0° is North)"
|
|
),
|
|
locked=True,
|
|
)
|
|
ray_object.setEditorMode("Azimuth", ["ReadOnly", "Hidden"])
|
|
ray_object.addProperty(
|
|
"App::PropertyString",
|
|
"Time",
|
|
"Sun Data",
|
|
QT_TRANSLATE_NOOP("App::Property", "The date and time for this sun position"),
|
|
locked=True,
|
|
)
|
|
ray_object.setEditorMode("Time", ["ReadOnly", "Hidden"])
|
|
|
|
ray_object.Altitude = math.radians(altitude_deg)
|
|
ray_object.Azimuth = math.radians(azimuth_deg)
|
|
time_string = dt_object_for_label.strftime("%B %d, %H:%M")
|
|
ray_object.Time = time_string
|
|
ray_object.Label = f"Sun Ray ({time_string})"
|