sheet_metal/feature_recognizer/Program.cs

Refer to the Sheet Metal Feature Recognizer Example

feature_group.cs

// ****************************************************************************
// $Id$
//
// Copyright (C) 2008-2014, Roman Lygin. All rights reserved.
// Copyright (C) 2014-2025, CADEX. All rights reserved.
//
// This file is part of the Manufacturing Toolkit software.
//
// You may use this file under the terms of the BSD license as follows:
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// ****************************************************************************
 
using cadex;
using System;
using System.Collections.Generic;
 
using FeatureMapType = System.Collections.Generic.SortedDictionary<cadex.MTKBase_Feature, uint>;
 
namespace feature_group
{
    class FeatureComparer : IComparer<MTKBase_Feature>
    {
        public int Compare(MTKBase_Feature theA, MTKBase_Feature theB)
        {
            MTKBase_FeatureComparator aComparator = new MTKBase_FeatureComparator();
            bool anALessThanB = aComparator.Apply(theA, theB);
            if (anALessThanB)
            {
                return -1;
            }
            bool aBLessThanA = aComparator.Apply(theB, theA);
            if (aBLessThanA)
            {
                return 1;
            }
            return 0;
        }
    }
 
    public struct Pair
    {
        public Pair(double theFirst, double theSecond)
        {
            First = theFirst;
            Second = theSecond;
        }
 
        public double First { get; }
        public double Second { get; }
 
        public override string ToString() => $"{First} x {Second}";
    }
 
    public struct Dimension
    {
        public Dimension(double theL, double theW, double theD)
        {
            L = theL;
            W = theW;
            D = theD;
        }
 
        public double L { get; }
        public double W { get; }
        public double D { get; }
 
        public override string ToString() => $"{L} x {W} x {D}";
    }
 
    public struct Direction
    {
        public Direction(double theX, double theY, double theZ)
        {
            X = theX;
            Y = theY;
            Z = theZ;
        }
 
        public double X { get; }
        public double Y { get; }
        public double Z { get; }
 
        public override string ToString() => $"({FormattedString(X)}, {FormattedString(Y)}, {FormattedString(Z)})";
 
        private string FormattedString(double theValue)
        {
            System.Globalization.CultureInfo aCI = new System.Globalization.CultureInfo("en-US");
            return string.Format(aCI, "{0:0.00}", theValue);
        }
    }
 
    class FeatureGroupManager
    {
        public FeatureGroupManager()
        {
            myGroups = new List<FeatureGroup>();
        }
 
        private class FeatureGroup
        {
            public FeatureGroup(string theName, string theSubgroupName, bool theHasParameters)
            {
                myName = theName;
                mySubgroupName = theSubgroupName;
                myHasParameters = theHasParameters;
                myFeatureSubgroups = new FeatureMapType(new FeatureComparer());
            }
 
            public uint FeatureCount()
            {
                uint aCount = 0;
                foreach (var i in myFeatureSubgroups)
                {
                    aCount += i.Value;
                }
                return aCount;
            }
 
            public string myName;
            public string mySubgroupName;
            public bool myHasParameters;
            public FeatureMapType myFeatureSubgroups;
        }
 
        private class FeatureGroupComparer : IComparer<FeatureGroup>
        {
            public int Compare(FeatureGroup theA, FeatureGroup theB)
            {
                string anAName = theA.myName;
                string aBName = theB.myName;
                if (anAName == aBName)
                {
                    return 0;
                }
 
                FeatureMapType anAFeatureSubgroups = theA.myFeatureSubgroups;
                FeatureMapType aBFeatureSubgroups = theB.myFeatureSubgroups;
                if (anAFeatureSubgroups.Count == 0 || aBFeatureSubgroups.Count == 0)
                {
                    return anAName.CompareTo(aBName);
                }
 
                MTKBase_Feature anAFeature = new MTKBase_Feature();
                MTKBase_Feature aBFeature = new MTKBase_Feature();
                foreach (var i in anAFeatureSubgroups)
                {
                    anAFeature = i.Key;
                    break;
                }
                foreach (var i in aBFeatureSubgroups)
                {
                    aBFeature = i.Key;
                    break;
                }
 
                FeatureComparer aFeatureComparator = new FeatureComparer();
                return aFeatureComparator.Compare(anAFeature, aBFeature);
            }
        }
 
        private List<FeatureGroup> myGroups;
 
        public void AddFeature(string theGroupName, string theSubgroupName, bool theHasParameters, MTKBase_Feature theFeature)
        {
            //find or create
            int aRes = myGroups.FindIndex(theGroup => theGroup.myName == theGroupName);
            if (aRes == -1)
            {
                myGroups.Add(new FeatureGroup(theGroupName, theSubgroupName, theHasParameters));
                aRes = myGroups.Count - 1;
            }
 
            //update
            FeatureGroup aGroup = myGroups[aRes];
            FeatureMapType aSubgroups = aGroup.myFeatureSubgroups;
            if (aSubgroups.ContainsKey(theFeature))
            {
                ++aSubgroups[theFeature];
            }
            else
            {
                aSubgroups[theFeature] = 1;
            }
        }
 
        public void Print(string theFeatureType, Action<MTKBase_Feature> thePrintFeatureParameters)
        {
            myGroups.Sort(new FeatureGroupComparer());
 
            uint aTotalCount = 0;
            foreach (var i in myGroups)
            {
                uint aFeatureCount = i.FeatureCount();
                aTotalCount += aFeatureCount;
 
                Console.WriteLine($"    {i.myName}: {aFeatureCount}");
 
                if (!i.myHasParameters)
                {
                    continue;
                }
 
                string aSubgroupName = i.mySubgroupName;
                foreach (var j in i.myFeatureSubgroups)
                {
                    Console.WriteLine($"        {j.Value} {aSubgroupName} with");
                    thePrintFeatureParameters(j.Key);
                }
            }
 
            Console.WriteLine($"\n    Total {theFeatureType}: {aTotalCount}\n");
        }
 
        public static void PrintFeatureParameter<T>(string theName, T theValue, string theUnits)
        {
            Console.WriteLine($"          {theName}: {theValue} {theUnits}");
        }
    }
}

shape_processor.cs

// ****************************************************************************
// $Id$
//
// Copyright (C) 2008-2014, Roman Lygin. All rights reserved.
// Copyright (C) 2014-2025, CADEX. All rights reserved.
//
// This file is part of the Manufacturing Toolkit software.
//
// You may use this file under the terms of the BSD license as follows:
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// ****************************************************************************
 
using System;
using cadex;
using cadex.ModelData;
 
namespace shape_processor
{
    abstract class ShapeProcessor : ModelElementVoidVisitor
    {
        public override void Apply(Part thePart)
        {
            var aPartName = thePart.Name().IsEmpty() ? new UTF16String("noname") : thePart.Name();
 
            var aBodyVec = thePart.Bodies();
            if (aBodyVec.Count != 0)
            {
                // Looking for a suitable body
                for (int i = 0; i < aBodyVec.Count; ++i)
                {
                    Body aBody = aBodyVec[i];
 
                    var aShapeIt = new ShapeIterator(aBody);
                    while (aShapeIt.HasNext())
                    {
                        var aShape = aShapeIt.Next();
                        if (aShape.Type() == ShapeType.Solid)
                        {
                            Console.Write($"Part #{myPartIndex} [\"{aPartName}\"] - solid #{i} has:\n");
                            ProcessSolid(Solid.Cast(aShape));
                        }
                        else if (aShape.Type() == ShapeType.Shell)
                        {
                            Console.Write($"Part #{myPartIndex} [\"{aPartName}\"] - shell #{i} has:\n");
                            ProcessShell(Shell.Cast(aShape));
                        }
                    }
 
                    ++myPartIndex;
                }
            }
        }
 
        public abstract void ProcessSolid(Solid theSolid);
 
        public abstract void ProcessShell(Shell theShell);
 
        private uint myPartIndex = 0;
    }
 
    abstract class SolidProcessor : ModelElementVoidVisitor
    {
        public override void Apply(Part thePart)
        {
            var aPartName = thePart.Name().IsEmpty() ? new UTF16String ("noname") : thePart.Name();
 
            var aBodyVec = thePart.Bodies();
            if (aBodyVec.Count != 0)
            {
                // Looking for a suitable body
                for (int i = 0; i < aBodyVec.Count; ++i)
                {
                    Body aBody = aBodyVec[i];
 
                    var aShapeIt = new ShapeIterator(aBody);
                    while (aShapeIt.HasNext())
                    {
                        var aShape = aShapeIt.Next();
                        if (aShape.Type() == ShapeType.Solid)
                        {
                            Console.Write ($"Part #{myPartIndex} [\"{aPartName}\"] - solid #{i} has:\n");
                            ProcessSolid(Solid.Cast(aShape));
                        }
                    }
 
                    ++myPartIndex;
                }
            }
        }
 
        public abstract void ProcessSolid(Solid theSolid);
 
        private uint myPartIndex = 0;
    }
}

Program.cs

// ****************************************************************************
// $Id$
//
// Copyright (C) 2008-2014, Roman Lygin. All rights reserved.
// Copyright (C) 2014-2025, CADEX. All rights reserved.
//
// This file is part of the Manufacturing Toolkit software.
//
// You may use this file under the terms of the BSD license as follows:
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// ****************************************************************************
 
using cadex;
using cadex.ModelData;
using feature_group;
using shape_processor;
using System;
 
namespace feature_recognizer
{
    class Program
    {
        static int Main(string[] args)
        {
            string aKey = MTKLicenseKey.Value();
 
            // Activate the license (the key should be defined in mtk_license.cs)
            if (!LicenseManager.Activate(aKey))
            {
                Console.WriteLine("Failed to activate Manufacturing Toolkit license.");
                return 1;
            }
 
            if (args.Length != 1)
            {
                Console.WriteLine("Usage: " +
                    $"{System.Reflection.Assembly.GetExecutingAssembly().Location} <input_file>, where:");
                Console.WriteLine($"    <input_file> is a name of the file to be read");
                return 1;
            }
 
            string aSource = args[0];
 
            var aModel = new Model();
            var aReader = new ModelReader();
 
            // Reading the file
            if (!aReader.Read(new UTF16String(aSource), aModel))
            {
                Console.WriteLine($"Failed to read the file {aSource}");
                return 1;
            }
            Console.WriteLine($"Model: {aModel.Name()}\n");
 
            var aPartProcessor = new PartProcessor();
            var aVisitor = new ModelElementUniqueVisitor(aPartProcessor);
            aModel.Accept(aVisitor);
 
            return 0;
        }
 
        class PartProcessor : ShapeProcessor
        {
            public PartProcessor()
            {
                myRecognizer = new SheetMetal_FeatureRecognizer();
            }
 
            public override void ProcessSolid(Solid theSolid)
            {
                var aFeatureList = myRecognizer.Perform(theSolid);
                PrintFeatures(aFeatureList);
            }
 
            public override void ProcessShell(Shell theShell)
            {
                var aFeatureList = myRecognizer.Perform(theShell);
                PrintFeatures(aFeatureList);
            }
 
            private SheetMetal_FeatureRecognizer myRecognizer;
        }
 
        static void PrintFeatures(MTKBase_FeatureList theFeatureList)
        {
            FeatureGroupManager aManager = new FeatureGroupManager();
 
            //group by parameters to provide more compact information about features
            Action<MTKBase_FeatureList> GroupByParameters = null;
            GroupByParameters = new Action<MTKBase_FeatureList>((theFeatures) =>
            {
                for (uint i = 0; i < theFeatures.Size(); ++i)
                {
                    MTKBase_Feature aFeature = theFeatures.Feature(i);
                    if (SheetMetal_Bead.CompareType(aFeature))
                    {
                        aManager.AddFeature("Bead(s)", "Bead(s)", true, aFeature);
                    }
                    else if (SheetMetal_Cutout.CompareType(aFeature))
                    {
                        aManager.AddFeature("Cutout(s)", "Cutout(s)", true, aFeature);
                    }
                    else if (SheetMetal_Louver.CompareType(aFeature))
                    {
                        aManager.AddFeature("Louver(s)", "", true, aFeature);
                    }
                    else if (SheetMetal_Bridge.CompareType(aFeature))
                    {
                        aManager.AddFeature("Bridge(s)", "Bridge(s)", true, aFeature);
                    }
                    else if (SheetMetal_Hole.CompareType(aFeature))
                    {
                        SheetMetal_Hole aHole = SheetMetal_Hole.Cast(aFeature);
                        aManager.AddFeature(HoleName(aHole), "Hole(s)", true, aFeature);
                    }
                    else if (SheetMetal_Bend.CompareType(aFeature))
                    {
                        SheetMetal_Bend aBend = SheetMetal_Bend.Cast(aFeature);
                        aManager.AddFeature(BendName(aBend), "Bend(s)", true, aFeature);
                    }
                    else if (SheetMetal_Notch.CompareType(aFeature))
                    {
                        SheetMetal_Notch aNotch = SheetMetal_Notch.Cast(aFeature);
                        aManager.AddFeature(NotchName (aNotch), "Notch(es)", true, aFeature);
                    }
                    else if (SheetMetal_Tab.CompareType(aFeature))
                    {
                        aManager.AddFeature("Tab(s)", "Tab(s)", true, aFeature);
                    }
                    else if (SheetMetal_CompoundBend.CompareType(aFeature))
                    {
                        SheetMetal_CompoundBend aCompoundBend = SheetMetal_CompoundBend.Cast(aFeature);
                        GroupByParameters(aCompoundBend.FeatureList());
                    }
                }
            });
            GroupByParameters(theFeatureList);
 
            //print
            Action<MTKBase_Feature> PrintFeatureParameters = theFeature =>
            {
                if (SheetMetal_Bead.CompareType(theFeature))
                {
                    SheetMetal_Bead aBead = SheetMetal_Bead.Cast(theFeature);
                    FeatureGroupManager.PrintFeatureParameter("depth", aBead.Depth(), "mm");
                }
                else if (SheetMetal_Cutout.CompareType(theFeature))
                {
                    SheetMetal_Cutout aCutout = SheetMetal_Cutout.Cast(theFeature);
                    FeatureGroupManager.PrintFeatureParameter("perimeter", aCutout.Perimeter(), "mm");
                }
                else if (SheetMetal_Louver.CompareType(theFeature))
                {
                    SheetMetal_Louver aLouver = SheetMetal_Louver.Cast(theFeature);
                    FeatureGroupManager.PrintFeatureParameter("depth", aLouver.Depth(), "mm");
                }
                else if (SheetMetal_Bridge.CompareType(theFeature))
                {
                    SheetMetal_Bridge aBridge = SheetMetal_Bridge.Cast(theFeature);
                    FeatureGroupManager.PrintFeatureParameter("length", aBridge.Length(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("depth", aBridge.Depth(), "mm");
                }
                else if (SheetMetal_Hole.CompareType(theFeature))
                {
                    SheetMetal_Hole aHole = SheetMetal_Hole.Cast(theFeature);
                    cadex.Geom.Direction anAxis = aHole.Axis().Axis();
                    feature_group.Direction aDir = new feature_group.Direction(anAxis.X(), anAxis.Y(), anAxis.Z());
                    FeatureGroupManager.PrintFeatureParameter("radius", aHole.Radius(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("depth",  aHole.Depth(),  "mm");
                    FeatureGroupManager.PrintFeatureParameter("axis", aDir, "");
                }
                else if (SheetMetal_Bend.CompareType(theFeature))
                {
                    SheetMetal_Bend aBend = SheetMetal_Bend.Cast(theFeature);
                    FeatureGroupManager.PrintFeatureParameter("radius", aBend.Radius(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("angle", ToDegrees(aBend.Angle()), "deg");
                    FeatureGroupManager.PrintFeatureParameter("length", aBend.Length(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("width", aBend.Width(), "mm");
                }
                else if (SheetMetal_Notch.CompareType(theFeature))
                {
                    SheetMetal_Notch aNotch = SheetMetal_Notch.Cast(theFeature);
                    FeatureGroupManager.PrintFeatureParameter("length", aNotch.Length(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("width", aNotch.Width(), "mm");
                    if (SheetMetal_StraightNotch.CompareType(aNotch))
                    {
                        SheetMetal_StraightNotch aStraightNotch = SheetMetal_StraightNotch.Cast(aNotch);
                        FeatureGroupManager.PrintFeatureParameter ("corner fillet radius", aStraightNotch.CornerFilletRadius(), "mm");
                    }
                    else if (SheetMetal_VNotch.CompareType(aNotch))
                    {
                        SheetMetal_VNotch aVNotch = SheetMetal_VNotch.Cast(aNotch);
                        FeatureGroupManager.PrintFeatureParameter ("angle", ToDegrees(aVNotch.Angle()), "deg");
                    }
                }
                else if (SheetMetal_Tab.CompareType(theFeature))
                {
                    SheetMetal_Tab aTab = SheetMetal_Tab.Cast(theFeature);
                    FeatureGroupManager.PrintFeatureParameter("length", aTab.Length(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("width", aTab.Width(), "mm");
                }
            };
            aManager.Print("features", PrintFeatureParameters);
        }
 
        static string HemTypeToString (SheetMetal_HemBendType theType)
        {
            switch (theType) {
            case SheetMetal_HemBendType.SheetMetal_HBT_Flattened: return "Flattened Hem Bend(s)";
            case SheetMetal_HemBendType.SheetMetal_HBT_Open: return "Open Hem Bend(s)";
            case SheetMetal_HemBendType.SheetMetal_HBT_Teardrop: return "Teardrop Hem Bend(s)";
            case SheetMetal_HemBendType.SheetMetal_HBT_Rope: return "Rope Hem Bend(s)";
            case SheetMetal_HemBendType.SheetMetal_HBT_Rolled: return "Rolled Hem Bend(s)";
            default:
                break;
            }
            return "Hem Bend(s)";
        } 
 
        static string BendName(SheetMetal_Bend theBend)
        {
            if (SheetMetal_HemBend.CompareType(theBend))
            {
                SheetMetal_HemBend aHemBend = SheetMetal_HemBend.Cast(theBend);
                return HemTypeToString(aHemBend.Type());
            }
            else if (SheetMetal_CurvedBend.CompareType(theBend))
            {
                return "Curved Bend(s)";
            }
            return "Bend(s)";
        }
 
        static string HoleName(SheetMetal_Hole theHole)
        {
            if (SheetMetal_ComplexHole.CompareType(theHole))
            {
                return "Complex Hole(s)";
            }
            return "Hole(s)";
        }
 
        static string NotchName(SheetMetal_Notch theNotch)
        {
            if (SheetMetal_StraightNotch.CompareType(theNotch))
            {
                return "Straight Notch(es)";
            }
            else if (SheetMetal_VNotch.CompareType(theNotch))
            {
                return "V Notch(es)";
            }
            return "Notch(es)";
        }
 
        static double ToDegrees(double theAngleRad)
        {
            return theAngleRad * 180 / Math.PI;
        }
    }
}