Manufacturing DevBlog

Inventor API to Redefine Work Features

by Vladimir Ananyev

The work feature collection objects – WorkPoints, WorkAxes, WorkPlanes – provide the wide range of Add methods to create corresponding work features in the part document. Autodesk Inventor API also provides a rich toolset for manipulating existing work features. In particular, you may redefine the existing work feature to re-associate it to another input geometry.

Take for example the work axis Axis1 in a part that was created by the intersection of two planes Plane1 and Plane2.

Workaxis.SetByTwoPlanes method allows you to redefine the Axis1 by specifying another pair of work planes – Plane1 and Plane3.

Sub RedefineWorkAxis()
  Dim oDoc As PartDocument
  Set oDoc = ThisApplication.ActiveDocument
  Dim oDef As PartComponentDefinition
  Set oDef = oDoc.ComponentDefinition
  Dim oAxis As WorkAxis
  Set oAxis = oDef.WorkAxes.Item("Axis1")
  Dim oPlane1 As WorkPlane
  Set oPlane1 = oDef.WorkPlanes.Item("Plane1")
  Dim oPlane3 As WorkPlane
  Set oPlane3 = oDef.WorkPlanes.Item("Plane3")
  Call oAxis.SetByTwoPlanes(oPlane1, oPlane3)
End Sub

Result:

 

You may redefine work features from iLogic rule as well.
Here is the equivalent iLogic code:

'parent Part document
Dim oDoc As PartDocument = ThisDoc.Document
'part document definition
Dim oDef As PartComponentDefinition = oDoc.ComponentDefinition
'reference to the existing work axis
Dim oAxis As WorkAxis = oDef.WorkAxes.Item("Axis1")
'1st workplane
Dim oPlane1 As WorkPlane = oDef.WorkPlanes.Item("Plane1")
'2nd workplane
Dim oPlane3 As WorkPlane = oDef.WorkPlanes.Item("Plane3")
'redefine Axis1 to be at the intersection of planes 1 and 3
oAxis.SetByTwoPlanes(oPlane1, oPlane3)

 

Here is the full list of Add and Set methods available to create and redefine existing work features.

 

WorkAxis object

AddByAnalyticEdge	SetByAnalyticEdge
AddByLine	SetByLine
AddByLineAndPlane	SetByLineAndPlane
AddByLineAndPoint	SetByLineAndPoint
AddByNormalToSurface	SetByNormalToSurface
AddByRevolvedFace	SetByRevolvedFace
AddByTwoPlanes	SetByTwoPlanes
AddByTwoPoints	SetByTwoPoints
AddFixed	SetFixed

 

WorkPlane

AddByLineAndTangent	SetByLineAndTangent
AddByLinePlaneAndAngle	SetByLinePlaneAndAngle
AddByNormalToCurve	SetByNormalToCurve
AddByPlaneAndOffset	SetByPlaneAndOffset
AddByPlaneAndPoint	SetByPlaneAndPoint
AddByPlaneAndTangent	SetByPlaneAndTangent
AddByPointAndTangent	SetByPointAndTangent
AddByThreePoints	SetByThreePoints
AddByTorusMidPlane	SetByTorusMidPlane
AddByTwoLines	SetByTwoLines
AddByTwoPlanes	SetByTwoPlanes
AddFixed	SetFixed

 

Workpoint

AddAtCentroid	SetAtCentroid
AddByCurveAndEntity	SetByCurveAndEntity
AddByMidPoint	SetByMidPoint
AddByPoint	SetByPoint
AddBySphereCenterPoint	SetBySphereCenterPoint
AddByThreePlanes	SetByThreePlanes
AddByTorusCenterPoint	SetByTorusCenterPoint
AddByTwoLines	SetByTwoLines
AddFixed	SetFixed

Learning with you on Fusion 360 API

By Xiaodong Liang

Fusion 360 has been well known in the CAD world now. More and more designers, engineers, artists, manufacturers are getting exciting designs, assemblies, and more business opportunities. Like other products of Autodesk, Fusion 360 is the solution as a platform. Fusion 360 also provides API that allows 3^rd party or even the end user to extend the abilities of the platform. Since the API was born in September, 2014, it has got a lot of attentions. Some customers have taken it for commercial applications.

I am also a learner. The help document is well written and the API is very easy to understand. I do not want to repeat the content of existing tutorial. I am just making a tiny note what I have had for the friends to whom Fusion 360 are brand new.

Firstly, I took a look at the relevant tutorials on Fusion Help, where key features are introduced in videos. In Fusion 360 environment, the Help button is on the typical location. It can direct to Fusion Help.

By the material, it helped me to know what Fusion is and how to work with it. I also found many interesting demo videos/blogs/articles on internet. How a design could be by Fusion 360? I strongly recommend Fusion Gallery. Global fans share their wonderful works there. We can download, comment, share. We can also share our own works. I really envy these designs They are so cool!

Next, I started to play with API. As known, normally, the access way of an API could be script, plugin, standalone EXE, and web services in web era etc. Fusion 360 provides script as the beginning. At the time when our API designer Brian wrote the blog, only Javascript was available. Now, Python is also exposed. We can access both of them in Script dialog. The demo samples of JS and Python are listed. The typical scenarios are demoed. We can easily play with them.

In programming interfaces of Fusion Help, you can find how to write a helloworld, how to debug. Fusion integrates Bracket IDE for Javascript editing, borrowing Chrome as debugger. While for Python, it integrates Spyder IDE for editing and debugging. You could compose the source code by any other editor which are comfortable to you and paste it to Fusion. This Fusion Help includes the latest update of API, the known issues and objects manual.

I have been working on Inventor API for years. I had never known the object model of Fusion is exactly similar to that of Inventor API. e.g. the top entry object is also Application. A Design object is similar to Document of Inventor API. There is also component definition in which sketches, features, workfeatures are organized like Inventor, even the Brep geometries structure. So if you have knowledge of Inventor (API), you would be able to get started with Fusion API quickly.

 

Forum of Fusion 360 API is the most beautiful board on Autodesk forum. Autodesk engineers, our team and global gurus are active there to help the questions. When you are scratching the head to find an answer, do not forget to leave a message on this board.

I am happy to learn the API with you. I will try to keep updating this article if I have tricks for beginners. Any of your sharing is also welcome.

Last, do not forget to attend the webnair on March 25^th. see you there..

Learning with you on Fusion 360 API

By Xiaodong Liang

Fusion 360 has been well known in the CAD world now. More and more designers, engineers, artists, manufacturers are getting exciting designs, assemblies, and more business opportunities. Like other products of Autodesk, Fusion 360 is the solution as a platform. Fusion 360 also provides API that allows 3^rd party or even the end user to extend the abilities of the platform. Since the API was born in September, 2014, it has got a lot of attentions. Some customers have taken it for commercial applications.

I am also a learner. The help document is well written and the API is very easy to understand. I do not want to repeat the content of existing tutorial. I am just making a tiny note what I have had for the friends to whom Fusion 360 are brand new.

Firstly, I took a look at the relevant tutorials on Fusion Help, where key features are introduced in videos. In Fusion 360 environment, the Help button is on the typical location. It can direct to Fusion Help.

By the material, it helped me to know what Fusion is and how to work with it. I also found many interesting demo videos/blogs/articles on internet. How a design could be by Fusion 360? I strongly recommend Fusion Gallery. Global fans share their wonderful works there. We can download, comment, share. We can also share our own works. I really envy these designs :S

Next, I started to play with API. As known, normally, the access way of an API could be script, plugin, standalone EXE, and web services in web era etc. Fusion 360 provides script as the beginning. At the time when our API designer Brian wrote the blog, only Javascript was available. Now, Python is also exposed. We can access both of them in Script dialog. The demo samples of JS and Python are listed:

In the repository of Fusion Help, you can find how to write a helloworld, how to debug. Fusion integrates Bracket IDE for Javascript editing, borrowing Chrome as debugger. While for Python, it integrates Spyder IDE for editing and debugging. You could compose the source code by any other editor which are comfortable to you and paste it to Fusion. This Fusion Help includes the latest update of API, the known issues and objects manual.

I have been working on Inventor API for years. I had never known the object model of Fusion is exactly similar to that of Inventor API. e.g. the top entry object is also Application. A Design object is similar to Document of Inventor API. There is also component definition in which sketches, features, workfeatures are organized like Inventor, even the Brep geometries structure. So if you have knowledge of Inventor (API), you would be able to get started with Fusion API quickly.

 

Forum of Fusion 360 API is the most beautiful board on Autodesk forum. Autodesk engineers, our team and global gurus are active there to help the questions. When you are scratching the head to find an answer, do not forget to leave a message on this board.

I am happy to learn the API with you. I will try to keep updating this article if I have tricks for beginners. Any of your sharing is also welcome.

Last, do not forget to attend the webnair on March 25^th. see you there..

Which .NET Framework version is Inventor using

By Adam Nagy

The easiest way to check which .NET Framework version Inventor or other products are using is by looking into their config file. In case of Inventor 2015 it's "C:\Program Files\Autodesk\Inventor 2015\Bin\Inventor.exe.config" 

There you'll find the <startup> tag. In case of Inventor 2015 it has the following content, which shows it's using v4.5:

Based on that you should use a Visual Studio version that supports the given version of the .NET Framework.

Visual Studio versions so far have been backward compatible, so if you have a newer version that could be used to create a project that uses an older .NET Framework. E.g. Visual Studio 2012 offers the following:

 

 

Add Feature to MirrorFeature

By Adam Nagy

You tried to use this code, but it does not work:

Sub UpdateMirrorFeature()
  Dim ss As SelectSet
  Set ss = ThisApplication.ActiveDocument.SelectSet
  
  Dim mf As MirrorFeature
  Set mf = ss(1)
  
  Dim ptf As PunchToolFeature
  Set ptf = ss(2)
  
  Call mf.ParentFeaturesAdd(ptf)
End Sub

Sometimes the API is not completely intuitive and you run into a scenario similar to the one mentioned here - i.e. first you have to take the property object, modify it, then assign it back to the property.

First select the MirrorFeature then the Feature you want to add to it (make sure it is shown in the browser before the MirrorFeature otherwise it will not be available in the UI either to be added to that MirrorFeature), then run the code:

Sub UpdateMirrorFeature()
  Dim ss As SelectSet
  Set ss = ThisApplication.ActiveDocument.SelectSet
  
  Dim mf As MirrorFeature
  Set mf = ss(1)
  
  Dim ptf As PunchToolFeature
  Set ptf = ss(2)
  
  ' Take the property object
  Dim oc As ObjectCollection
  Set oc = mf.ParentFeatures
  
  ' Modify it
  Call oc.Add(ptf)
  
  ' Assign it back to the property
  mf.ParentFeatures = oc
End Sub

And the result:

 

Delete suppressed components in iLogic

By Adam Nagy

I have written a blog post on this topic and provided VBA code. If you want to convert it to iLogic then first of all you need to have a basic understanding of iLogic. Going through the help could be a good start.

Then, one by one, try to resolve the error messages given by the iLogic editor.

Here is the iLogic version of the VBA code:

Sub Main()
    Dim doc As AssemblyDocument
    doc = ThisApplication.ActiveDocument
    
    Dim acd As AssemblyComponentDefinition
    acd = doc.ComponentDefinition
    
    Call DeleteSuppressedComponent(acd.Occurrences)
End Sub

Sub DeleteSuppressedComponent(occs As ComponentOccurrences)
  Dim occ As ComponentOccurrence
  For Each occ In occs
    If occ.Suppressed Then
      occ.Delete
    Else
      Call DeleteSuppressedComponent(occ.SubOccurrences)
    End If
  Next
End Sub

Upcoming Fusion 360 API Webinar

Are you using Fusion 360 or just curious about it?  It’s API is still relatively new and is growing significantly with each frequent release.  This webinar will discuss the programming capabilities of Fusion, including the new Add-In functionality that is coming and will be available by the Webinar.

The webinar is on March 25 at 9:00 AM Pacific time.  To attend the webinar, please register for Get started with Fusion 360 API at:

https://attendee.gotowebinar.com/register/7034449259570533633

After registering, you will receive a confirmation email containing information about joining the webinar.

-Brian

List suppressed components in LOD

By Adam Nagy

When a given LOD (Level Of Detail) is active inside Inventor that simply means that you are looking at a specific document inside the file: each LOD is a separate document stored inside the same file - see File vs Document 

If you want to list which components are suppressed inside a given LOD - not the one currently active in the UI - then you don't have to activate it just for that. You can simply open that LOD document in the background, check which components are suppressed, then close the document if it's not the currently active LOD:

Sub ListWhatsSuppressed()
  Dim asm As AssemblyDocument
  Set asm = ThisApplication.ActiveDocument
  
  Dim acd As AssemblyComponentDefinition
  Set acd = asm.ComponentDefinition
  
  Dim rm As RepresentationsManager
  Set rm = acd.RepresentationsManager
  
  Dim nvm As NameValueMap
  Set nvm = ThisApplication.TransientObjects.CreateNameValueMap()
  
  Dim doc As AssemblyDocument
  Dim occ As ComponentOccurrence
  
  Dim lod As LevelOfDetailRepresentation
  For Each lod In rm.LevelOfDetailRepresentations
    Debug.Print lod.name
    Call nvm.Add("LevelOfDetailRepresentation", lod.name)
    Set doc = ThisApplication.Documents.OpenWithOptions( _
      asm.FullFileName, nvm, False)
    Call nvm.Clear
    
    For Each occ In doc.ComponentDefinition.Occurrences
      Debug.Print " >> " + occ.name + _
        " Suppressed = " + Str(occ.Suppressed)
    Next
    
    ' Don't forget to close the document not used anymore
    If Not lod Is rm.ActiveLevelOfDetailRepresentation Then
      Call doc.Close(True)
    End If
  Next
End Sub

In this document I added two of my own LOD's as well: one has Combo Assembly, the other has Catch Post component suppressed:

The above VBA code gives the following result:

Master
 >> Combo Assembly:1 Suppressed = False
 >> Catch Post:1 Suppressed = False
 >> Lock Shackle:1 Suppressed = False
 >> Case Inner:1 Suppressed = False
 >> Case Outer:1 Suppressed = False
 >> Case Back:1 Suppressed = False
 >> Dial:1 Suppressed = False
 >> Catch Assembly:1 Suppressed = False
 >> Catch:2 Suppressed = False
 >> Retainer:1 Suppressed = False
All Components Suppressed
 >> Combo Assembly:1 Suppressed = True
 >> Catch Post:1 Suppressed = True
 >> Lock Shackle:1 Suppressed = True
 >> Case Inner:1 Suppressed = True
 >> Case Outer:1 Suppressed = True
 >> Case Back:1 Suppressed = True
 >> Dial:1 Suppressed = True
 >> Catch Assembly:1 Suppressed = True
 >> Catch:2 Suppressed = True
 >> Retainer:1 Suppressed = True
All Parts Suppressed
 >> Combo Assembly:1 Suppressed = False
 >> Catch Post:1 Suppressed = True
 >> Lock Shackle:1 Suppressed = True
 >> Case Inner:1 Suppressed = True
 >> Case Outer:1 Suppressed = True
 >> Case Back:1 Suppressed = True
 >> Dial:1 Suppressed = True
 >> Catch Assembly:1 Suppressed = False
 >> Catch:2 Suppressed = True
 >> Retainer:1 Suppressed = True
All Content Center Suppressed
 >> Combo Assembly:1 Suppressed = False
 >> Catch Post:1 Suppressed = False
 >> Lock Shackle:1 Suppressed = False
 >> Case Inner:1 Suppressed = False
 >> Case Outer:1 Suppressed = False
 >> Case Back:1 Suppressed = False
 >> Dial:1 Suppressed = False
 >> Catch Assembly:1 Suppressed = False
 >> Catch:2 Suppressed = False
 >> Retainer:1 Suppressed = False
ComboSuppressed
 >> Combo Assembly:1 Suppressed = True
 >> Catch Post:1 Suppressed = False
 >> Lock Shackle:1 Suppressed = False
 >> Case Inner:1 Suppressed = False
 >> Case Outer:1 Suppressed = False
 >> Case Back:1 Suppressed = False
 >> Dial:1 Suppressed = False
 >> Catch Assembly:1 Suppressed = False
 >> Catch:2 Suppressed = False
 >> Retainer:1 Suppressed = False
CatchSuppressed
 >> Combo Assembly:1 Suppressed = False
 >> Catch Post:1 Suppressed = True
 >> Lock Shackle:1 Suppressed = False
 >> Case Inner:1 Suppressed = False
 >> Case Outer:1 Suppressed = False
 >> Case Back:1 Suppressed = False
 >> Dial:1 Suppressed = False
 >> Catch Assembly:1 Suppressed = False
 >> Catch:2 Suppressed = False
 >> Retainer:1 Suppressed = False

Transform imported geometry

By Adam Nagy

When importing geometry from another CAD format like *.step then you cannot specify the transformation for it in the UI. The only thing you can do is transform the geometry in another part document derived from the one that has the imported geometry.
However, using Brian's solution you can achieve that through the API directly in the part document that has the imported geometry. It also takes care of keeping the look of the component the same by copying the Appearance of the original faces:

Public Sub ReorientBaseBody()
  Dim partDoc As PartDocument
  Set partDoc = ThisApplication.ActiveDocument
  
  Dim pcd As PartComponentDefinition
  Set pcd = partDoc.ComponentDefinition
  
  Dim npbfs As NonParametricBaseFeatures
  Set npbfs = pcd.Features.NonParametricBaseFeatures

  ' Get the base feature that was created as a result of 
  ' the translation.
  Dim baseFeature As NonParametricBaseFeature
  Set baseFeature = npbfs(1)

  ' Get the body created by the translation.
  Dim originalBody As SurfaceBody
  Set originalBody = baseFeature.InputSurfaceBodies(1)

  ' Create a transient copy of the body.
  Dim newBody As SurfaceBody
  Set newBody = ThisApplication.TransientBRep.Copy(originalBody)

  Dim tg As TransientGeometry
  Set tg = ThisApplication.TransientGeometry
 
  Dim tr As TransientObjects
  Set tr = ThisApplication.TransientObjects

  ' Define the transform to apply to the body.
  Dim trans As Matrix
  Set trans = tg.CreateMatrix
  Call trans.SetCoordinateSystem( _
    tg.CreatePoint(2, 2, 2), tg.CreateVector(0, 1, 0), _
    tg.CreateVector(-1, 0, 0), tg.CreateVector(0, 0, 1))

  ' Apply the transform to the transient body.
  Call ThisApplication.TransientBRep.Transform(newBody, trans)

  ' Create a new base feature.
  Dim baseFeatureDef As NonParametricBaseFeatureDefinition
  Set baseFeatureDef = npbfs.CreateDefinition()
  Dim inputBodies As ObjectCollection
  Set inputBodies = tr.CreateObjectCollection
  Call inputBodies.Add(newBody)
  baseFeatureDef.BRepEntities = inputBodies
  baseFeatureDef.OutputType = kSolidOutputType
  Dim newFeature As NonParametricBaseFeature
  Set newFeature = npbfs.AddByDefinition(baseFeatureDef)

  Dim realBody As SurfaceBody
  Set realBody = newFeature.SurfaceBodies(1)

  Dim i As Integer
  For i = 1 To originalBody.Faces.count
    Dim originalFace As Face
    Set originalFace = originalBody.Faces(i)
    
    If originalFace.AppearanceSourceType = kOverrideAppearance Then
      Dim newFace As Face
      Set newFace = realBody.Faces(i)
        
      newFace.Appearance = originalFace.Appearance
    End If
  Next

  ' Delete the original feature.
  baseFeature.Delete
End Sub

 

Drive Rule in Sub Sheet Metal part to Export DWG/DXF by DataIO

By Xiaodong Liang

These days, I got one case, where one assembly includes some sheet metal parts. In each part, there are some rules, one of which exports the document to DWG/DXF, another exports to other file format. In the assembly, one rule iterates each parts and executes the rules.

It works well with other format. i.e. after running rule of assembly, the corresponding files are generated. But DWG/DXF are not generated. An unspecific error occurred. If activating the parts one by one and run the assembly rule again, the DWG/DXF files can be generated now.

I did a couple of test and found the problem is because of the way of exporting. For other format, the rule uses TranslatorAddin, while for DWG/DXF, the rule uses SheetMetalComponentDefinition.DataIO.WriteDataToFile
while it requires to in the editing mode of sheet metal: SheetMetalComponentDefinition.FlatPattern.Edit.
The code failed at FlatPattern.Edit. It looks if the sheet metal part has not been explicitly activated or opened, the flat pattern mode cannot be edited.

Finally, the workaround is to activate the components one by one (like activate manually) before running the rule will edit the flat pattern.

This is the test assembly and part: Download TestData

The relevant rules are as below:

assembly rule:

'for the rule that will edit flat pattern, 

' activate the parts in advance

DimoAssDocAsAssemblyDocumentoAssDoc = ThisApplication.ActiveDocument
DimoAssDefAsAssemblyComponentDefinitionoAssDef = oAssDoc.ComponentDefinition
DimoCompAsComponentOccurrence
For Each oComp In oAssDef.Occurrences   
    oComp.Edit() 
   oComp.ExitEdit(ExitTypeEnum.kExitToTop)
Next

DimopenDocAsDocumentopenDoc = ThisDoc.Document
DimdocFileAsDocument

'if this is an assembly document

If openDoc.DocumentType =     DocumentTypeEnum.kAssemblyDocumentObject Then

    For EachdocFile In openDoc.AllReferencedDocuments

        Dim FNamePos As Long
        FNamePos = InStrRev(docFile.FullFileName, "\", -1)                               

        Dim docFName As String  
        docFName = Right(docFile.FullFileName,     Len(docFile.FullFileName)-FNamePos) 

        'drive the sub rule   
        iLogicVb.RunRule(docFName, "exportDWG_DXF_ByDataIO")    
     Next

Else

    MessageBox.Show("This is not an assembly document", "Error")

End If 

sheet metal part rule: 

Dim curDoc = ThisDoc.Document 

'if this is a sheet metal part

If curDoc.SubType = "{9C464203-9BAE-11D3-8BAD-0060B0CE6BB4}" Then      

    Dim oCompDef As SheetMetalComponentDefinition   
   oCompDef = curDoc.ComponentDefinition

    'edit the flat pattern   
   oCompDef.FlatPattern.Edit    

    Dim sOut As String   
    Dim sPATH As String   
    sPATH = ThisDoc.Path

    DimsFnameAsString 

    sOut = "FLAT PATTERN DWG?AcadVersion=2004
&RebaseGeometry=True
&OuterProfileLayer=DIGI_CUTTING_TOOL_2
&OuterProfileLayerColor=102;102;102
&InteriorProfilesLayer=DIGI_CUTTING_TOOL_1
&InteriorProfilesLayerColor=255;255;255
&BendDownLayer=DIGI_MARKER_TOOL_2
&BendDownLayerColor=255;127;223
&BendUpLayer=DIGI_MARKER_TOOL_1
&BendUpLayerColor=0;255;0
&InvisibleLayers=IV_ARC_CENTERS;IV_TANGENT;IV_ROLL;IV_ROLL_TANGENT;IV_ALTREP_BACK;IV_ALTREP_FRONT;
IV_FEATURE_PROFILES_DOWN;IV_FEATURE_PROFILES;IV_TOOL_CENTER_DOWN"       sFname =

  sPATH&"\"&ThisDoc.FileName(False) &".dwg"    

    'sOut = "FLAT PATTERN DXF?AcadVersion=R12&OuterProfileLayer=Outer"   
  'sFname = sPATH & "\" & ThisDoc.FileName(False) & ".dxf" 

    oCompDef.DataIO.WriteDataToFile(sOut, sFname) 

    oCompDef.FlatPattern.ExitEdit   

Else

     MessageBox.Show("This is not a sheet metal part!","Error") 

EndIf