From e82d98d34517787e81c631ab7cebbd5206b15feb Mon Sep 17 00:00:00 2001 From: anv Date: Wed, 28 Aug 2024 04:23:16 +0100 Subject: [PATCH] 0033816: Data Exchange - Implementing common logic for scaling during Write procedure (part 1) Implementation for Gltf and STEP formats. --- src/DE/DE_ConfigurationNode.hxx | 3 +- src/DE/DE_Wrapper.cxx | 5 +- src/RWGltf/RWGltf_Provider.cxx | 15 +++- .../STEPCAFControl_Provider.cxx | 36 +++++++--- tests/de_wrapper/configuration/A3 | 1 + tests/de_wrapper/configuration/A4 | 1 + tests/de_wrapper/gltf/A6 | 68 +++++++++---------- tests/de_wrapper/step/A6 | 12 ++-- 8 files changed, 89 insertions(+), 52 deletions(-) diff --git a/src/DE/DE_ConfigurationNode.hxx b/src/DE/DE_ConfigurationNode.hxx index 45b653338f..d424dc92fa 100644 --- a/src/DE/DE_ConfigurationNode.hxx +++ b/src/DE/DE_ConfigurationNode.hxx @@ -154,7 +154,8 @@ public: //!< Internal parameters for transfer process struct DE_SectionGlobal { - Standard_Real LengthUnit = 1.0; //!< Scale length unit value from MM, default 1.0 (MM) + Standard_Real LengthUnit = 1.0; //!< Target Unit (scaling based on MM) for the transfer process, default 1.0 (MM) + Standard_Real SystemUnit = 1.0; //!< System Unit (scaling based on MM) to be used when initial unit is unknown, default 1.0 (MM) } GlobalParameters; private: diff --git a/src/DE/DE_Wrapper.cxx b/src/DE/DE_Wrapper.cxx index 7a9531d490..54ced338db 100644 --- a/src/DE/DE_Wrapper.cxx +++ b/src/DE/DE_Wrapper.cxx @@ -290,6 +290,7 @@ Standard_Boolean DE_Wrapper::Load(const Handle(DE_ConfigurationContext)& theReso const Standard_Boolean theIsRecursive) { GlobalParameters.LengthUnit = theResource->RealVal("general.length.unit", GlobalParameters.LengthUnit, THE_CONFIGURATION_SCOPE()); + GlobalParameters.SystemUnit = theResource->RealVal("general.system.unit", GlobalParameters.SystemUnit, THE_CONFIGURATION_SCOPE()); if (theIsRecursive) { for (DE_ConfigurationFormatMap::Iterator aFormatIter(myConfiguration); @@ -372,8 +373,10 @@ TCollection_AsciiString DE_Wrapper::Save(const Standard_Boolean theIsRecursive, aResult += "\n"; } aResult += "!Global parameters. Used for all providers\n"; - aResult += "!Length scale unit value. Should be more the 0. Default value: 1.0(MM)\n"; + aResult += "!Length scale unit value. Should be more than 0. Default value: 1.0(MM)\n"; aResult += THE_CONFIGURATION_SCOPE() + ".general.length.unit :\t " + GlobalParameters.LengthUnit + "\n"; + aResult += "!System unit value. Should be more than 0. Default value: 1.0(MM)\n"; + aResult += THE_CONFIGURATION_SCOPE() + ".general.system.unit :\t " + GlobalParameters.SystemUnit + "\n"; if (theIsRecursive) { for (DE_ConfigurationFormatMap::Iterator aFormatIter(myConfiguration); diff --git a/src/RWGltf/RWGltf_Provider.cxx b/src/RWGltf/RWGltf_Provider.cxx index 1331011aeb..eeadfba355 100644 --- a/src/RWGltf/RWGltf_Provider.cxx +++ b/src/RWGltf/RWGltf_Provider.cxx @@ -140,9 +140,20 @@ bool RWGltf_Provider::Write(const TCollection_AsciiString& thePath, Handle(RWGltf_ConfigurationNode) aNode = Handle(RWGltf_ConfigurationNode)::DownCast(GetNode()); RWMesh_CoordinateSystemConverter aConverter; - aConverter.SetInputLengthUnit(aNode->GlobalParameters.LengthUnit / 1000); + Standard_Real aScaleFactorM = 1.; + if (!XCAFDoc_DocumentTool::GetLengthUnit(theDocument, aScaleFactorM)) + { + aConverter.SetInputLengthUnit(aNode->GlobalParameters.SystemUnit / 1000.); + Message::SendWarning() << "Warning in the RWGltf_Provider during writing the file " << + thePath << "\t: The document has no information on Units. Using global parameter as initial Unit."; + } aConverter.SetInputCoordinateSystem(aNode->InternalParameters.SystemCS); - aConverter.SetOutputLengthUnit(aNode->InternalParameters.FileLengthUnit); + if (aNode->GlobalParameters.LengthUnit != 1000.) + { + Message::SendWarning() << "Warning in the RWGltf_Provider during writing the file " << + thePath << "\t: Target format doesn't support custom units. Model will be scaled to Meters"; + } + aConverter.SetOutputLengthUnit(1.); // gltf units always Meters aConverter.SetOutputCoordinateSystem(aNode->InternalParameters.FileCS); TColStd_IndexedDataMapOfStringString aFileInfo; diff --git a/src/STEPCAFControl/STEPCAFControl_Provider.cxx b/src/STEPCAFControl/STEPCAFControl_Provider.cxx index 969c54d220..354212e60c 100644 --- a/src/STEPCAFControl/STEPCAFControl_Provider.cxx +++ b/src/STEPCAFControl/STEPCAFControl_Provider.cxx @@ -110,10 +110,6 @@ bool STEPCAFControl_Provider::Write(const TCollection_AsciiString& thePath, return false; } Handle(STEPCAFControl_ConfigurationNode) aNode = Handle(STEPCAFControl_ConfigurationNode)::DownCast(GetNode()); - - XCAFDoc_DocumentTool::SetLengthUnit(theDocument, - UnitsMethods::GetLengthUnitScale(aNode->InternalParameters.WriteUnit, - UnitsMethods_LengthUnit_Millimeter), UnitsMethods_LengthUnit_Millimeter); personizeWS(theWS); STEPCAFControl_Writer aWriter; aWriter.Init(theWS); @@ -124,9 +120,22 @@ bool STEPCAFControl_Provider::Write(const TCollection_AsciiString& thePath, aWriter.SetNameMode(aNode->InternalParameters.WriteName); aWriter.SetLayerMode(aNode->InternalParameters.WriteLayer); aWriter.SetPropsMode(aNode->InternalParameters.WriteProps); - - TDF_Label aLabel; StepData_ConfParameters aParams; + Standard_Real aScaleFactorMM = 1.; + if (XCAFDoc_DocumentTool::GetLengthUnit(theDocument, aScaleFactorMM, UnitsMethods_LengthUnit_Millimeter)) + { + aModel->SetLocalLengthUnit(aScaleFactorMM); + } + else + { + aModel->SetLocalLengthUnit(aNode->GlobalParameters.SystemUnit); + Message::SendWarning() << "Warning in the STEPCAFControl_Provider during writing the file " << + thePath << "\t: The document has no information on Units. Using global parameter as initial Unit."; + } + UnitsMethods_LengthUnit aTargetUnit = UnitsMethods::GetLengthUnitByFactorValue(aNode->GlobalParameters.LengthUnit, UnitsMethods_LengthUnit_Millimeter); + aParams.WriteUnit = aTargetUnit; + aModel->SetWriteLengthUnit(aNode->GlobalParameters.LengthUnit); + TDF_Label aLabel; if (!aWriter.Transfer(theDocument, aParams, aMode, 0, theProgress)) { Message::SendFail() << "Error in the STEPCAFControl_Provider during writing the file " << @@ -242,9 +251,20 @@ bool STEPCAFControl_Provider::Write(const TCollection_AsciiString& thePath, STEPControl_Writer aWriter; aWriter.SetWS(theWS); IFSelect_ReturnStatus aWritestat = IFSelect_RetVoid; - Handle(StepData_StepModel) aModel = aWriter.Model(); - aModel->SetWriteLengthUnit(UnitsMethods::GetLengthUnitScale(aNode->InternalParameters.WriteUnit, UnitsMethods_LengthUnit_Millimeter)); + Handle(StepData_StepModel) aModel = aWriter.Model();; StepData_ConfParameters aParams; + aModel->SetLocalLengthUnit(aNode->GlobalParameters.SystemUnit); + UnitsMethods_LengthUnit aTargetUnit = UnitsMethods::GetLengthUnitByFactorValue(aNode->GlobalParameters.LengthUnit, UnitsMethods_LengthUnit_Millimeter); + aParams.WriteUnit = aTargetUnit; + if (aTargetUnit == UnitsMethods_LengthUnit_Undefined) + { + aModel->SetWriteLengthUnit(1.0); + Message::SendWarning() << "Custom units are not supported by STEP format, but LengthUnit global parameter doesn't fit any predefined unit. Units will be scaled to Millimeters"; + } + else + { + aModel->SetWriteLengthUnit(aNode->GlobalParameters.LengthUnit); + } aWritestat = aWriter.Transfer(theShape, aNode->InternalParameters.WriteModelType, aParams, true, theProgress); if (aWritestat != IFSelect_RetDone) { diff --git a/tests/de_wrapper/configuration/A3 b/tests/de_wrapper/configuration/A3 index 61f2db99ce..babb2a3cfa 100644 --- a/tests/de_wrapper/configuration/A3 +++ b/tests/de_wrapper/configuration/A3 @@ -15,6 +15,7 @@ global.priority.XCAF : OCC global.priority.IGES : OCC global.priority.PLY : OCC global.general.length.unit : 1 +global.general.system.unit : 1 provider.STEP.OCC.read.iges.bspline.continuity : 1 provider.STEP.OCC.read.precision.mode : 0 provider.STEP.OCC.read.precision.val : 0.0001 diff --git a/tests/de_wrapper/configuration/A4 b/tests/de_wrapper/configuration/A4 index e760e2d546..3fb307dd90 100644 --- a/tests/de_wrapper/configuration/A4 +++ b/tests/de_wrapper/configuration/A4 @@ -15,6 +15,7 @@ global.priority.XCAF : OCC global.priority.IGES : OCC global.priority.PLY : OCC global.general.length.unit : 1 +global.general.system.unit : 1 provider.STEP.OCC.read.iges.bspline.continuity : 1 provider.STEP.OCC.read.precision.mode : 0 provider.STEP.OCC.read.precision.val : 0.0001 diff --git a/tests/de_wrapper/gltf/A6 b/tests/de_wrapper/gltf/A6 index ea78ba1bf1..7ea6cfcdab 100644 --- a/tests/de_wrapper/gltf/A6 +++ b/tests/de_wrapper/gltf/A6 @@ -20,15 +20,7 @@ if [catch {ReadGltf D0 $filename} catch_result] { } XGetOneShape S0 D0 -param xstep.cascade.unit M -if [catch {ReadGltf D1 $filename} catch_result] { - puts "Error : Problem with reading file" -} else { - puts "OK : Reading is correct" -} -XGetOneShape S1 D1 - -if [catch {WriteFile D0 $write_path -conf "provider.GLTF.OCC.file.length.unit : 0.001 "} catch_result] { +if [catch {WriteFile D0 $write_path -conf "global.general.length.unit : 1 "} catch_result] { puts "Error : Problem with writing file" } else { puts "OK : Writing is correct" @@ -50,29 +42,7 @@ if [catch {readfile S3 $write_path} catch_result] { puts "OK : Reading is correct" } -if [catch {WriteFile D1 $write_path -conf "provider.GLTF.OCC.file.length.unit : 1 "} catch_result] { - puts "Error : Problem with writing file" -} else { - puts "OK : Writing is correct" -} -if [catch {readfile S4 $write_path -conf "global.general.length.unit : 1000 "} catch_result] { - puts "Error : Problem with reading file" -} else { - puts "OK : Reading is correct" -} - -if [catch {writefile S1 $write_path} catch_result] { - puts "Error : Problem with writing file" -} else { - puts "OK : Writing is correct" -} -if [catch {readfile S5 $write_path} catch_result] { - puts "Error : Problem with reading file" -} else { - puts "OK : Reading is correct" -} - -if [catch {WriteFile D0 $write_path -conf "provider.GLTF.OCC.file.length.unit : 0.001 "} catch_result] { +if [catch {WriteFile D0 $write_path -conf "global.general.length.unit : 1 "} catch_result] { puts "Error : Problem with writing file" } else { puts "OK : Writing is correct" @@ -84,7 +54,37 @@ if [catch {ReadFile D6 $write_path -conf "global.general.length.unit : 1 "} catc } XGetOneShape S6 D6 -if [catch {writefile S1 $write_path -conf "provider.GLTF.OCC.file.length.unit : 1 "} catch_result] { +param xstep.cascade.unit M +if [catch {ReadGltf D1 $filename} catch_result] { + puts "Error : Problem with reading file" +} else { + puts "OK : Reading is correct" +} +XGetOneShape S1 D1 + +if [catch {WriteFile D1 $write_path -conf "global.general.length.unit : 1000 "} catch_result] { + puts "Error : Problem with writing file" +} else { + puts "OK : Writing is correct" +} +if [catch {readfile S4 $write_path -conf "global.general.length.unit : 1000 "} catch_result] { + puts "Error : Problem with reading file" +} else { + puts "OK : Reading is correct" +} + +if [catch {writefile S1 $write_path -conf "global.general.system.unit : 1000 "} catch_result] { + puts "Error : Problem with writing file" +} else { + puts "OK : Writing is correct" +} +if [catch {readfile S5 $write_path} catch_result] { + puts "Error : Problem with reading file" +} else { + puts "OK : Reading is correct" +} + +if [catch {writefile S1 $write_path -conf "global.general.length.unit : 1000 \n global.general.system.unit : 1000 "} catch_result] { puts "Error : Problem with writing file" } else { puts "OK : Writing is correct" @@ -96,7 +96,7 @@ if [catch {ReadFile D7 $write_path -conf "global.general.length.unit : 1000 "} c } XGetOneShape S7 D7 -array set areas {0 3.18785e+06 1 3.18785 2 3.18785e+06 3 3.18785e+06 4 3.18785 5 3.18785 6 3.18785e+06 7 3.18785e-06} +array set areas {0 3.18785e+06 1 3.18785 2 3.18785e+06 3 3.18785e+06 4 3.18785 5 3.18785e+06 6 3.18785e+06 7 3.18785} array set results {0 S0 1 S1 2 S2 3 S3 4 S4 5 S5 6 S6 7 S7} for { set anind 0} { $anind < 8 } { incr anind } { checkprops $results($anind) -s $areas($anind) -eps 1e-2 diff --git a/tests/de_wrapper/step/A6 b/tests/de_wrapper/step/A6 index e7943453a5..d74af7fef7 100644 --- a/tests/de_wrapper/step/A6 +++ b/tests/de_wrapper/step/A6 @@ -30,7 +30,7 @@ XGetOneShape S1 D1 param xstep.cascade.unit MM -if [catch {WriteFile D0 $write_path -conf "provider.STEP.write.step.unit : 1 "} catch_result] { +if [catch {WriteFile D0 $write_path -conf "global.general.length.unit : 25.4 "} catch_result] { puts "Error : Problem with writing file" } else { puts "OK : Writing is correct" @@ -41,7 +41,7 @@ if [catch {readfile S2 $write_path } catch_result] { puts "OK : Reading is correct" } -if [catch {writefile S0 $write_path } catch_result] { +if [catch {writefile S0 $write_path -conf "global.general.system.unit : 1 "} catch_result] { puts "Error : Problem with writing file" } else { puts "OK : Writing is correct" @@ -52,7 +52,7 @@ if [catch {readfile S3 $write_path} catch_result] { puts "OK : Reading is correct" } -if [catch {WriteFile D1 $write_path -conf "provider.STEP.write.step.unit : 6 "} catch_result] { +if [catch {WriteFile D1 $write_path -conf "global.general.length.unit : 1000 "} catch_result] { puts "Error : Problem with writing file" } else { puts "OK : Writing is correct" @@ -74,7 +74,7 @@ if [catch {readfile S5 $write_path} catch_result] { puts "OK : Reading is correct" } -if [catch {WriteFile D0 $write_path -conf "provider.STEP.write.step.unit : 2 "} catch_result] { +if [catch {WriteFile D0 $write_path -conf "global.general.length.unit : 1 "} catch_result] { puts "Error : Problem with writing file" } else { puts "OK : Writing is correct" @@ -86,7 +86,7 @@ if [catch {ReadFile D6 $write_path -conf "global.general.length.unit : 1 "} catc } XGetOneShape S6 D6 -if [catch {writefile S1 $write_path -conf "provider.STEP.write.step.unit : 1 "} catch_result] { +if [catch {writefile S1 $write_path -conf "global.general.length.unit : 25.4 "} catch_result] { puts "Error : Problem with writing file" } else { puts "OK : Writing is correct" @@ -98,7 +98,7 @@ if [catch {ReadFile D7 $write_path -conf "global.general.length.unit : 0.0254"} } XGetOneShape S7 D7 -array set areas {0 2.52381e+06 1 2.52381 2 2.52381e+06 3 2.52381e+06 4 2.52381 5 2.52381 6 2.52381e+06 7 3911.92} +array set areas {0 2.52381e+06 1 2.52381 2 2.52381e+06 3 2.52381e+06 4 2.52381e+06 5 2.52381 6 2.52381e+06 7 3911.92} array set results {0 S0 1 S1 2 S2 3 S3 4 S4 5 S5 6 S6 7 S7} for { set anind 0} { $anind < 8 } { incr anind } { checkprops $results($anind) -s $areas($anind) -eps 1e-2