machining/feature_recognizer/Program.cs

Refer to the CNC Machining Feature Recognizer Example

feature_group.cs

// ****************************************************************************
// $Id$
//
// Copyright (C) 2008-2014, Roman Lygin. All rights reserved.
// Copyright (C) 2014-2023, CADEX. All rights reserved.
//
// This file is part of the CAD Exchanger 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-2023, CADEX. All rights reserved.
//
// This file is part of the CAD Exchanger 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;
 
namespace shape_processor
{
    abstract class ShapeProcessor : ModelData_Model.VoidElementVisitor
    {
        public override void Apply(ModelData_Part thePart)
        {
            var aPartName = thePart.Name().IsEmpty() ? new Base_UTF16String("noname") : thePart.Name();
 
            var aBRep = thePart.BRepRepresentation();
            if (aBRep != null)
            {
                // Looking for a suitable body
                ModelData_BodyList aBodyList = aBRep.Get();
                for (uint i = 0; i < aBodyList.Size(); ++i)
                {
                    ModelData_Body aBody = aBodyList.Element(i);
 
                    var aShapeIt = new ModelData_Shape.Iterator(aBody);
                    while (aShapeIt.HasNext())
                    {
                        var aShape = aShapeIt.Next();
                        if (aShape.Type() == ModelData_ShapeType.ModelData_ST_Solid)
                        {
                            Console.Write($"Part #{myPartIndex} [\"{aPartName}\"] - solid #{i} has:\n");
                            ProcessSolid(ModelData_Solid.Cast(aShape));
                        }
                        else if (aShape.Type() == ModelData_ShapeType.ModelData_ST_Shell)
                        {
                            Console.Write($"Part #{myPartIndex} [\"{aPartName}\"] - shell #{i} has:\n");
                            ProcessShell(ModelData_Shell.Cast(aShape));
                        }
                    }
 
                    ++myPartIndex;
                }
            }
        }
 
        public abstract void ProcessSolid(ModelData_Solid theSolid);
 
        public abstract void ProcessShell(ModelData_Shell theShell);
 
        private uint myPartIndex = 0;
    }
 
    abstract class SolidProcessor : ModelData_Model.VoidElementVisitor
    {
        public override void Apply(ModelData_Part thePart)
        {
            var aPartName = thePart.Name().IsEmpty() ? new Base_UTF16String ("noname") : thePart.Name();
 
            var aBRep = thePart.BRepRepresentation();
            if (aBRep != null)
            {
                // Looking for a suitable body
                ModelData_BodyList aBodyList = aBRep.Get();
                for (uint i = 0; i < aBodyList.Size(); ++i)
                {
                    ModelData_Body aBody = aBodyList.Element(i);
 
                    var aShapeIt = new ModelData_Shape.Iterator(aBody);
                    while (aShapeIt.HasNext())
                    {
                        var aShape = aShapeIt.Next();
                        if (aShape.Type() == ModelData_ShapeType.ModelData_ST_Solid)
                        {
                            Console.Write ($"Part #{myPartIndex} [\"{aPartName}\"] - solid #{i} has:\n");
                            ProcessSolid(ModelData_Solid.Cast(aShape));
                        }
                    }
 
                    ++myPartIndex;
                }
            }
        }
 
        public abstract void ProcessSolid(ModelData_Solid theSolid);
 
        private uint myPartIndex = 0;
    }
}

Program.cs

// ****************************************************************************
// $Id$
//
// Copyright (C) 2008-2014, Roman Lygin. All rights reserved.
// Copyright (C) 2014-2023, CADEX. All rights reserved.
//
// This file is part of the CAD Exchanger 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 feature_group;
using shape_processor;
using System;
using System.Collections.Generic;
 
namespace feature_recognizer
{
    class Program
    {
        static int Main(string[] args)
        {
            // Add runtime path to CAD Exchanger libraries
            cadex.helpers.LoadLibrarySearchDirectory.SetupDllDirectory();
 
            string aKey = LicenseKey.Value();
            string anMTKKey = MTKLicenseKey.Value();
 
            // Activate the license (aKey must be defined in cadex_license.cs
            // and anMTKKey should be defined in mtk_license.cs)
            if (!LicenseManager.Activate(aKey))
            {
                Console.WriteLine("Failed to activate CAD Exchanger license.");
                return 1;
            }
            if (!LicenseManager.Activate(anMTKKey))
            {
                Console.WriteLine("Failed to activate Manufacturing Toolkit license.");
                return 1;
            }
 
            if (args.Length != 2)
            {
                Console.WriteLine("Usage: " +
                    $"{System.Reflection.Assembly.GetExecutingAssembly().Location} <input_file> <operation>, where:");
                Console.WriteLine($"    <input_file> is a name of the file to be read");
                Console.WriteLine($"    <operation> is a name of desired machining operation");
                Console.WriteLine($"");
                PrintSupportedOperations();
                return 1;
            }
 
            string aSource = args[0];
 
            var aModel = new ModelData_Model();
            var aReader = new ModelData_ModelReader();
 
            // Reading the file
            if (!aReader.Read(new Base_UTF16String(aSource), aModel))
            {
                Console.WriteLine($"Failed to read the file {aSource}");
                return 1;
            }
            Console.WriteLine($"Model: {aModel.Name()}\n");
 
            string anOperationStr = args[1];
            Machining_OperationType anOperation = OperationType(anOperationStr);
            if (anOperation == Machining_OperationType.Machining_OT_Undefined)
            {
                Console.WriteLine($"Unsupported operation - {anOperationStr}");
                Console.WriteLine($"Please use one of the following.");
                PrintSupportedOperations();
                return 1;
            }
 
            var aPartProcessor = new PartProcessor(anOperation);
            var aVisitor = new ModelData_SceneGraphElementUniqueVisitor(aPartProcessor);
            aModel.Accept(aVisitor);
 
            return 0;
        }
 
        class PartProcessor : SolidProcessor
        {
            public PartProcessor (Machining_OperationType theOperation)
            {
                myOperation = theOperation;
            }
 
            public override void ProcessSolid(ModelData_Solid theSolid)
            {
                var aParam = new Machining_FeatureRecognizerParameters();
                aParam.SetOperation(myOperation);
                var aRecognizer = new Machining_FeatureRecognizer(aParam);
                var aFeatureList = aRecognizer.Perform(theSolid);
                PrintFeatures(aFeatureList);
            }
 
            private Machining_OperationType myOperation = Machining_OperationType.Machining_OT_Undefined;
        }
 
        static void PrintSupportedOperations()
        {
            Console.WriteLine($"Supported operations:");
            Console.WriteLine($"    milling:\t CNC Machining Milling feature recognition");
            Console.WriteLine($"    turning:\t CNC Machining Lathe+Milling feature recognition");
        }
 
        static Machining_OperationType OperationType(string theOperationStr)
        {
            var aProcessDictionary = new Dictionary<string, Machining_OperationType>()
            {
                { "milling", Machining_OperationType.Machining_OT_Milling},
                { "turning", Machining_OperationType.Machining_OT_LatheMilling}
            };
 
            Machining_OperationType aProcess = Machining_OperationType.Machining_OT_Undefined;
            bool aRes = aProcessDictionary.TryGetValue(theOperationStr, out aProcess);
            if (aRes)
            {
                return aProcess;
            }
 
            return Machining_OperationType.Machining_OT_Undefined;
        }
 
        static void PrintFeatures(MTKBase_FeatureList theFeatureList)
        {
            FeatureGroupManager aManager = new FeatureGroupManager();
 
            //group by parameters to provide more compact information about features
            for (uint i = 0; i < theFeatureList.Size(); ++i)
            {
                MTKBase_Feature aFeature = theFeatureList.Feature(i);
                if (Machining_TurningFace.CompareType(aFeature))
                {
                    Machining_TurningFace aTurningFace = Machining_TurningFace.Cast(aFeature);
                    aManager.AddFeature(FaceTypeToString(aTurningFace.Type()), "Turning Face(s)", true, aFeature);
                }
                else if (Machining_Face.CompareType(aFeature))
                {
                    Machining_Face aFace = Machining_Face.Cast(aFeature);
                    aManager.AddFeature(FaceTypeToString(aFace.Type()), "", false, aFeature);
                }
                else if (Machining_Countersink.CompareType(aFeature))
                {
                    aManager.AddFeature("Countersink(s)", "Countersink(s)", true, aFeature);
                }
                else if (Machining_Hole.CompareType(aFeature))
                {
                    Machining_Hole aHole = Machining_Hole.Cast(aFeature);
                    aManager.AddFeature(HoleTypeToString(aHole.Type()), "Hole(s)", true, aFeature);
                }
                else if (Machining_Pocket.CompareType(aFeature))
                {
                    aManager.AddFeature("Pocket(s)", "Pocket(s)", true, aFeature);
                }
                else if (MTKBase_Boss.CompareType(aFeature))
                {
                    aManager.AddFeature("Boss(es)", "Boss(es)", true, aFeature);
                }
            }
 
            //print
            Action<MTKBase_Feature> PrintFeatureParameters = theFeature =>
            {
                if (Machining_TurningFace.CompareType(theFeature))
                {
                    Machining_TurningFace aTurningFace = Machining_TurningFace.Cast(theFeature);
                    FeatureGroupManager.PrintFeatureParameter("radius", aTurningFace.Radius(), "mm");
                }
                else if (Machining_Face.CompareType(theFeature))
                {
                    //no parameters
                }
                else if (Machining_Countersink.CompareType(theFeature))
                {
                    Machining_Countersink aCountersink = Machining_Countersink.Cast(theFeature);
                    ModelData_Direction anAxis = aCountersink.Axis().Axis();
                    Direction aDir = new Direction(anAxis.X(), anAxis.Y(), anAxis.Z());
                    FeatureGroupManager.PrintFeatureParameter("radius", aCountersink.Radius(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("depth", aCountersink.Depth(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("axis", aDir, "");
                }
                else if (Machining_Hole.CompareType(theFeature))
                {
                    Machining_Hole aHole = Machining_Hole.Cast(theFeature);
                    ModelData_Direction anAxis = aHole.Axis().Axis();
                    Direction aDir = new 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 (Machining_Pocket.CompareType(theFeature))
                {
                    Machining_Pocket aPocket = Machining_Pocket.Cast(theFeature);
                    ModelData_Direction anAxis = aPocket.Axis().Direction();
                    Direction aDir = new Direction(anAxis.X(), anAxis.Y(), anAxis.Z());
                    FeatureGroupManager.PrintFeatureParameter("length", aPocket.Length(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("width", aPocket.Width(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("depth", aPocket.Depth(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("axis", aDir, "");
                }
                else if (MTKBase_Boss.CompareType(theFeature))
                {
                    MTKBase_Boss aBoss = MTKBase_Boss.Cast(theFeature);
                    FeatureGroupManager.PrintFeatureParameter("length", aBoss.Length(), "mm");
                    FeatureGroupManager.PrintFeatureParameter("width",  aBoss.Width(),  "mm");
                    FeatureGroupManager.PrintFeatureParameter("height", aBoss.Height(), "mm");
                }
            };
            aManager.Print("features", PrintFeatureParameters);
        }
 
        static string FaceTypeToString (Machining_FaceType theType)
        {
            switch (theType) {
            case Machining_FaceType.Machining_FT_FlatFaceMilled:           return "Flat Face Milled Face(s)";
            case Machining_FaceType.Machining_FT_FlatSideMilled:           return "Flat Side Milled Face(s)";
            case Machining_FaceType.Machining_FT_CurvedMilled:             return "Curved Milled Face(s)";
            case Machining_FaceType.Machining_FT_CircularMilled:           return "Circular Milled Face(s)";
            case Machining_FaceType.Machining_FT_Deburr:                   return "DeburrFace(s)";
            case Machining_FaceType.Machining_FT_ConvexProfileEdgeMilling: return "Convex Profile Edge Milling Face(s)";
            case Machining_FaceType.Machining_FT_ConcaveFilletEdgeMilling: return "Concave Fillet Edge Milling Face(s)";
            case Machining_FaceType.Machining_FT_FlatMilled:               return "Flat Milled Face(s)";
            case Machining_FaceType.Machining_FT_TurnDiameter:             return "Turn Diameter Face(s)";
            case Machining_FaceType.Machining_FT_TurnForm:                 return "Turn Form Face(s)";
            case Machining_FaceType.Machining_FT_TurnFace:                 return "Turn Face Face(s)";
            case Machining_FaceType.Machining_FT_Bore:                     return "Bore Face(s)";
            default:
                break;
            }
            return "Face(s)";
        }
 
        static string HoleTypeToString (Machining_HoleType theType)
        {
            switch (theType) {
            case Machining_HoleType.Machining_HT_Through:    return "Through Hole(s)";
            case Machining_HoleType.Machining_HT_FlatBottom: return "Flat Bottom Hole(s)";
            case Machining_HoleType.Machining_HT_Blind:      return "Blind Hole(s)";
            case Machining_HoleType.Machining_HT_Partial:    return "Partial Hole(s)";
            default:
                break;
            }
            return "Hole(s)";
        }
    }
}