kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Core: Fixes #18717

Browse Source 
Neither in #18332 nor in any of the referenced issues a reason is given why the placement of the coordinate axes must be changed.
Only doing it to make the client code look more consistent is not a valid reason.

This change breaks forward and backward compatibility and with #18717 we already have a hard to solve issue. Furthermore, at this
point of time it's not even clear what other collateral damage the change may cause.

So, this commit hides all the implementation details of the DatumElement and restores the original placement for the axes.
This commit makes the line migration code obsolete
This commit is contained in:
wmayer
2024-12-29 22:01:00 +01:00
parent 90d8c34631
commit ad314fea7e
5 changed files with 60 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
src/App/Datums.cpp
View File

@@ -45,6 +45,7 @@ PROPERTY_SOURCE(App::Point, App::DatumElement)
PROPERTY_SOURCE(App::LocalCoordinateSystem, App::GeoFeature)
DatumElement::DatumElement(bool hideRole)
: baseDir{0.0, 0.0, 1.0}
{
ADD_PROPERTY_TYPE(Role,
(""),
@@ -63,7 +64,7 @@ DatumElement::~DatumElement() = default;
bool DatumElement::getCameraAlignmentDirection(Base::Vector3d& direction, const char* subname) const
{
Q_UNUSED(subname);
Placement.getValue().getRotation().multVec(Base::Vector3d(0., 0., 1.), direction);
Placement.getValue().getRotation().multVec(baseDir, direction);
return true;
}
@@ -95,13 +96,35 @@ Base::Vector3d DatumElement::getBasePoint() const
Base::Vector3d DatumElement::getDirection() const
{
Base::Vector3d dir(0.0, 0.0, 1.0);
Base::Vector3d dir(baseDir);
Base::Placement plc = Placement.getValue();
Base::Rotation rot = plc.getRotation();
rot.multVec(dir, dir);
return dir;
}
Base::Vector3d DatumElement::getBaseDirection() const
{
return baseDir;
}
void DatumElement::setBaseDirection(const Base::Vector3d& dir)
{
baseDir = dir;
}
// ----------------------------------------------------------------------------
Line::Line()
{
setBaseDirection(Base::Vector3d(1, 0, 0));
}
Point::Point()
{
setBaseDirection(Base::Vector3d(0, 0, 0));
}
// ----------------------------------------------------------------------------
LocalCoordinateSystem::LocalCoordinateSystem()
@@ -221,9 +244,9 @@ const std::vector<LocalCoordinateSystem::SetupData>& LocalCoordinateSystem::getS
{
static const std::vector<SetupData> setupData = {
// clang-format off
{App::Line::getClassTypeId(), AxisRoles[0], tr("X-axis"), Base::Rotation(Base::Vector3d(1, 1, 1), M_PI * 2 / 3)},
{App::Line::getClassTypeId(), AxisRoles[1], tr("Y-axis"), Base::Rotation(Base::Vector3d(-1, 1, 1), M_PI * 2 / 3)},
{App::Line::getClassTypeId(), AxisRoles[2], tr("Z-axis"), Base::Rotation()},
{App::Line::getClassTypeId(), AxisRoles[0], tr("X-axis"), Base::Rotation()},
{App::Line::getClassTypeId(), AxisRoles[1], tr("Y-axis"), Base::Rotation(Base::Vector3d(1, 1, 1), M_PI * 2 / 3)},
{App::Line::getClassTypeId(), AxisRoles[2], tr("Z-axis"), Base::Rotation(Base::Vector3d(1,-1, 1), M_PI * 2 / 3)},
{App::Plane::getClassTypeId(), PlaneRoles[0], tr("XY-plane"), Base::Rotation()},
{App::Plane::getClassTypeId(), PlaneRoles[1], tr("XZ-plane"), Base::Rotation(1.0, 0.0, 0.0, 1.0)},
{App::Plane::getClassTypeId(), PlaneRoles[2], tr("YZ-plane"), Base::Rotation(Base::Vector3d(1, 1, 1), M_PI * 2 / 3)},
@@ -233,7 +256,7 @@ const std::vector<LocalCoordinateSystem::SetupData>& LocalCoordinateSystem::getS
return setupData;
}
DatumElement* LocalCoordinateSystem::createDatum(SetupData& data)
DatumElement* LocalCoordinateSystem::createDatum(const SetupData& data)
{
App::Document* doc = getDocument();
std::string objName = doc->getUniqueObjectName(data.role);
@@ -297,10 +320,6 @@ void LocalCoordinateSystem::onDocumentRestored()
// In 0.22 origins did not have point.
migrateOriginPoint();
// In 0.22 the axis placement were wrong. The X axis had identity placement instead of the Z.
// This was fixed but we need to migrate old files.
migrateXAxisPlacement();
}
void LocalCoordinateSystem::migrateOriginPoint()
@@ -314,33 +333,12 @@ void LocalCoordinateSystem::migrateOriginPoint()
if (std::none_of(features.begin(), features.end(), isOrigin)) {
auto data = getData(PointRoles[0]);
auto* origin = createDatum(data);
origin->purgeTouched();
features.push_back(origin);
OriginFeatures.setValues(features);
}
}
void LocalCoordinateSystem::migrateXAxisPlacement()
{
constexpr const double tolerance = 1e-5;
auto features = OriginFeatures.getValues();
const auto& setupData = getSetupData();
for (auto* obj : features) {
auto* feature = dynamic_cast <App::DatumElement*> (obj);
if (!feature) { continue; }
for (auto data : setupData) {
// ensure the rotation is correct for the role
if (std::strcmp(feature->Role.getValue(), data.role) == 0) {
if (!feature->Placement.getValue().getRotation().isSame(data.rot, tolerance)) {
feature->Placement.setValue(Base::Placement(Base::Vector3d(), data.rot));
getDocument()->setStatus(App::Document::MigrateLCS, true);
}
break;
}
}
}
}
// ----------------------------------------------------------------------------
LocalCoordinateSystem::LCSExtension::LCSExtension(LocalCoordinateSystem* obj)

12
src/App/Datums.h
View File

@@ -53,11 +53,18 @@ public:
App::LocalCoordinateSystem* getLCS() const;
Base::Vector3d getBasePoint() const;
Base::Vector3d getDirection() const;
Base::Vector3d getBaseDirection() const;
bool getCameraAlignmentDirection(Base::Vector3d& direction, const char* subname) const override;
/// Returns true if this DatumElement is part of a App::Origin.
bool isOriginFeature() const;
protected:
void setBaseDirection(const Base::Vector3d& dir);
private:
Base::Vector3d baseDir;
};
class AppExport Plane: public App::DatumElement
@@ -76,6 +83,7 @@ class AppExport Line: public App::DatumElement
PROPERTY_HEADER_WITH_OVERRIDE(App::DatumElement);
public:
Line();
const char* getViewProviderName() const override
{
return "Gui::ViewProviderLine";
@@ -87,6 +95,7 @@ class AppExport Point: public App::DatumElement
PROPERTY_HEADER_WITH_OVERRIDE(App::DatumElement);
public:
Point();
const char* getViewProviderName() const override
{
return "Gui::ViewProviderPoint";
@@ -245,11 +254,10 @@ private:
};
static const std::vector<SetupData>& getSetupData();
DatumElement* createDatum(SetupData& data);
DatumElement* createDatum(const SetupData& data);
SetupData getData(const char* role);
void migrateOriginPoint();
void migrateXAxisPlacement();
};
} // namespace App

14
src/Gui/ViewProviderLine.cpp
View File

@@ -33,6 +33,7 @@
#endif
#include <App/Datums.h>
#include <Gui/Utilities.h>
#include <Gui/ViewParams.h>
#include "ViewProviderLine.h"
@@ -53,7 +54,8 @@ ViewProviderLine::ViewProviderLine()
ViewProviderLine::~ViewProviderLine() = default;
void ViewProviderLine::attach(App::DocumentObject *obj) {
void ViewProviderLine::attach(App::DocumentObject *obj)
{
ViewProviderDatum::attach(obj);
// Setup label text and line colors
@@ -82,14 +84,16 @@ void ViewProviderLine::attach(App::DocumentObject *obj) {
static const float size = App::GetApplication().GetParameterGroupByPath("User parameter:BaseApp/Preferences/View")->GetFloat("DatumLineSize", 70.0);
auto line = getObject<App::Line>();
Base::Vector3d dir = line->getBaseDirection();
SbVec3f verts[2];
if (noRole) {
verts[0] = SbVec3f(0, 0, 2 * size);
verts[0] = Base::convertTo<SbVec3f>(dir * 2 * size);
verts[1] = SbVec3f(0, 0, 0);
}
else {
verts[0] = SbVec3f(0, 0, size);
verts[1] = SbVec3f(0, 0, 0.2 * size);
verts[0] = Base::convertTo<SbVec3f>(dir * size);
verts[1] = Base::convertTo<SbVec3f>(dir * 0.2 * size);
}
// indexes used to create the edges
@@ -108,7 +112,7 @@ void ViewProviderLine::attach(App::DocumentObject *obj) {
sep->addChild ( pLines );
auto textTranslation = new SoTranslation ();
textTranslation->translation.setValue(SbVec3f(0, 0, size * 1.1));
textTranslation->translation.setValue(Base::convertTo<SbVec3f>(dir * 1.1 * size));
sep->addChild ( textTranslation );
auto ps = new SoPickStyle();

11
src/Mod/Part/App/PartFeature.cpp
View File

@@ -69,6 +69,7 @@
#include <Base/Placement.h>
#include <Base/Rotation.h>
#include <Base/Stream.h>
#include <Base/Tools.h>
#include <Mod/Material/App/MaterialManager.h>
#include "Geometry.h"
@@ -76,7 +77,7 @@
#include "PartFeaturePy.h"
#include "PartPyCXX.h"
#include "TopoShapePy.h"
#include "Base/Tools.h"
#include "Tools.h"
using namespace Part;
namespace sp = std::placeholders;
@@ -1026,7 +1027,9 @@ static TopoShape _getTopoShape(const App::DocumentObject* obj,
if (linked->isDerivedFrom(App::Line::getClassTypeId())) {
static TopoDS_Shape _shape;
if (_shape.IsNull()) {
BRepBuilderAPI_MakeEdge builder(gp_Lin(gp_Pnt(0, 0, 0), gp_Dir(0, 0, 1)));
auto line = static_cast<App::Line*>(linked);
Base::Vector3d dir = line->getBaseDirection();
BRepBuilderAPI_MakeEdge builder(gp_Lin(gp_Pnt(0, 0, 0), Base::convertTo<gp_Dir>(dir)));
_shape = builder.Shape();
_shape.Infinite(Standard_True);
}
@@ -1035,7 +1038,9 @@ static TopoShape _getTopoShape(const App::DocumentObject* obj,
else if (linked->isDerivedFrom(App::Plane::getClassTypeId())) {
static TopoDS_Shape _shape;
if (_shape.IsNull()) {
BRepBuilderAPI_MakeFace builder(gp_Pln(gp_Pnt(0, 0, 0), gp_Dir(0, 0, 1)));
auto plane = static_cast<App::Plane*>(linked);
Base::Vector3d dir = plane->getBaseDirection();
BRepBuilderAPI_MakeFace builder(gp_Pln(gp_Pnt(0, 0, 0), Base::convertTo<gp_Dir>(dir)));
_shape = builder.Shape();
_shape.Infinite(Standard_True);
}

6
src/Mod/Test/Document.py
View File

@@ -357,17 +357,17 @@ class DocumentBasicCases(unittest.TestCase):
res = obj.getSubObject("X_Axis", retType=2)
self.assertEqual(
res[1].multVec(FreeCAD.Vector(0, 0, 1)).getAngle(FreeCAD.Vector(1, 0, 0)), 0.0
res[1].multVec(FreeCAD.Vector(1, 0, 0)).getAngle(FreeCAD.Vector(1, 0, 0)), 0.0
)
res = obj.getSubObject("Y_Axis", retType=2)
self.assertEqual(
res[1].multVec(FreeCAD.Vector(0, 0, 1)).getAngle(FreeCAD.Vector(0, 1, 0)), 0.0
res[1].multVec(FreeCAD.Vector(1, 0, 0)).getAngle(FreeCAD.Vector(0, 1, 0)), 0.0
)
res = obj.getSubObject("Z_Axis", retType=2)
self.assertEqual(
res[1].multVec(FreeCAD.Vector(0, 0, 1)).getAngle(FreeCAD.Vector(0, 0, 1)), 0.0
res[1].multVec(FreeCAD.Vector(1, 0, 0)).getAngle(FreeCAD.Vector(0, 0, 1)), 0.0
)
res = obj.getSubObject("XY_Plane", retType=2)