Get DimXpert Compound Width and Best Fit Plane Features Example (VB.NET)
This example shows how to build a part and get attributes
for the following DimXpert features:
*
Compound
width
*
Best fit
plane
'---------------------------------------------------------------------------
' Preconditions:
' 1.
Open <SolidWorks_install_dir>\samples\tutorial\api\block.sldprt.
' 2.
Open the DimXpert toolbar from View > Toolbars
' (select the first instance
of Toolbars on the View menu).
' 3.
Create the best fit plane feature:
' a.
Click the Location Dimension icon on the DimXpert toolbar.
' b.
Select the left front face of the block.
' c.
Click the Compound Plane icon on the DimXpert pop up toolbar.
' d.
Select the right front face of the block.
' e.
Click the green check mark on the DimXpert pop up toolbar.
' f.
Select the back face of the block.
' g.
Click off the part to place the location dimension annotation.
' 4.
Create the compound width Feature:
' a.
Click the Size Dimension icon on the DimXpert toolbar.
' b.
Select a front face of the block.
' c.
Click the Width icon on the DimXpert pop up toolbar.
' d.
Select the back face of the block.
' e.
Click the green check mark on the DimXpert pop up toolbar.
' f.
Click off the part to place the size dimension annotation.
' 5.
Observe the following DimXpert features on the DimXpertManager tab:
' Plane2,
Plane3, Width1.
' 6.
Open an Immediate Window in the IDE.
' 7.
Ensure that the SolidWorks.Interop.swdimxpert.dll
interop assembly
' is loaded (right-click
on the project in the Project Explorer window,
' click Add Reference,
click the .NET tab).
'
' Postconditions: Compare
the output in the Immediate Window
' with the features displayed on the DimXpertManager tab of the Management Panel.
' NOTE:
Because this part is used in a SolidWorks online tutorial,
' do not save
any changes when you close it.
'--------------------------------------------------
Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swdimxpert
Imports SolidWorks.Interop.swconst
Imports System
Imports System.Diagnostics
Partial Class SolidWorksMacro
Dim
swModel As IModelDoc2
Dim
swModelDocExt As IModelDocExtension
Dim
swSelMgr As ISelectionMgr
Dim
swConfig As IConfiguration
Dim
swFeature As IFeature
Dim
swAnn As IFeature
Dim
swSchema As IDimXpertManager
Dim
swDXPart As IDimXpertPart
Dim
featureType As swDimXpertFeatureType_e
Dim
features As Object
Dim
appliedFeatures As Object
Dim
appliedAnnotations As Object
Dim
appliedAnnotation As IDimXpertAnnotation
Dim
feature As IDimXpertFeature
Dim
appliedFeature As IDimXpertFeature
Dim
msgStr As String
Dim
msgStr2 As String
Dim
msgStr3 As String
Dim
msgStr4 As String
Dim
n As Long
Dim
o As Long
Dim
p As Long
Dim
boolstatus As Boolean
Sub
main()
swModel
= swApp.ActiveDoc
swModelDocExt
= swModel.Extension
swSelMgr
= swModel.SelectionManager
'
Get the default DimXpert schema using IModelDocExtension.DimXpertManager()
swSchema
= swModelDocExt.DimXpertManager("Default", True)
'
Get IDimXpertPart from the IDimXpertManager
swDXPart
= swSchema.DimXpertPart
Dim
featCount As Long
featCount
= swDXPart.GetFeatureCount
msgStr
= "Total of "
msgStr2
= featCount
msgStr
= msgStr + msgStr2 + " DimXpert features in " + (swSchema.SchemaName)
Debug.Print("")
Debug.Print(msgStr)
'
Get IDimXpert features through IDimXpertPart
features
= swDXPart.GetFeatures
msgStr
= (swSchema.SchemaName) + " has the following features: "
Debug.Print("")
Debug.Print(msgStr)
For
n = 0 To UBound(features)
feature
= features(n)
Debug.Print("
"
+ "Feature name: " + (feature.Name))
featureType
= feature.Type
Call
GetPatternType(featureType, msgStr2)
msgStr
= " Feature
type "
msgStr3
= " is suppressed on the DimXpertManager tab? "
msgStr4
= feature.IsSuppressed()
Debug.Print(msgStr
+ msgStr2 + msgStr3 + msgStr4)
msgStr
= " "
+ "Model feature: "
swFeature
= feature.GetModelFeature()
If
Not (swFeature Is Nothing) Then
msgStr2
= swFeature.GetTypeName2()
Debug.Print(msgStr
+ msgStr2)
End
If
msgStr
= " "
+ "Number of SolidWorks face entities in this feature: "
msgStr2
= feature.GetFaceCount
Debug.Print(msgStr
+ msgStr2)
msgStr
= " "
+ "Number of applied features: "
msgStr2
= feature.GetAppliedFeatureCount()
Debug.Print(msgStr
+ msgStr2)
appliedFeatures
= feature.GetAppliedFeatures()
If
Not (IsNothing(appliedFeatures)) Then
For
o = 0 To UBound(appliedFeatures)
appliedFeature
= appliedFeatures(o)
Debug.Print("
"
+ "Applied feature name: " + (appliedFeature.Name))
Next
End
If
msgStr
= " "
+ "Number of applied annotations: "
msgStr2
= feature.GetAppliedAnnotationCount()
Debug.Print(msgStr
+ msgStr2)
appliedAnnotations
= feature.GetAppliedAnnotations()
If
Not (IsNothing(appliedAnnotations)) Then
For
p = 0 To UBound(appliedAnnotations)
appliedAnnotation
= appliedAnnotations(p)
Debug.Print("
"
+ "Applied annotation name: " + (appliedAnnotation.Name))
Next
End
If
Debug.Print("
")
Next
'
If you know the name of a DimXpert feature, you can get it directly using
IDimXpertPart.GetFeature("name"),
'
which can return a general IDimXpertFeature or a more specific interface
on the feature
'
Get IDimXpertCompoundWidthFeature for the Width1 feature
Dim
widthFeature As IDimXpertCompoundWidthFeature
widthFeature
= swDXPart.GetFeature("Width1")
msgStr
= widthFeature.Name + " is
a DimXpert Width feature"
Debug.Print("")
Debug.Print(msgStr)
Debug.Print("")
'
Get the nominal width coordinates
Dim
width As Double
Dim
x As Double
Dim
y As Double
Dim
z As Double
Dim
i As Double
Dim
j As Double
Dim
k As Double
Debug.Print("Nominal
width of Width1")
Debug.Print("")
boolstatus
= widthFeature.GetNominalCompoundWidth(width,
x, y, z, i, j, k)
msgStr
= "Width is "
msgStr2
= width
Debug.Print(msgStr
+ msgStr2)
msgStr
= "X-coordinate is "
msgStr2
= x
Debug.Print(msgStr
+ msgStr2)
msgStr
= "Y-coordinate is "
msgStr2
= y
Debug.Print(msgStr
+ msgStr2)
msgStr
= "Z-coordinate is "
msgStr2
= z
Debug.Print(msgStr
+ msgStr2)
msgStr
= "I-component of pierce vector is "
msgStr2
= i
Debug.Print(msgStr
+ msgStr2)
msgStr
= "J-component of pierce vector is "
msgStr2
= j
Debug.Print(msgStr
+ msgStr2)
msgStr
= "K-component of pierce vector is "
msgStr2
= k
Debug.Print(msgStr
+ msgStr2)
Debug.Print("")
'
Get whether the width is a hole or a pin
boolstatus
= widthFeature.Inner
msgStr
= "The width is for a hole and not a pin: "
msgStr2
= boolstatus
Debug.Print(msgStr
+ msgStr2)
'
Get IDimXpertBestfitPlaneFeature for the Plane2 feature
Dim
bestfitPlaneFeature As IDimXpertBestfitPlaneFeature
bestfitPlaneFeature
= swDXPart.GetFeature("Plane2")
msgStr
= bestfitPlaneFeature.Name + "
is a DimXpert Bestfit Plane feature"
Debug.Print("")
Debug.Print(msgStr)
Debug.Print("")
Dim
featureCount As Integer
featureCount
= bestfitPlaneFeature.GetSubFeatureCount
msgStr
= "The number of sub-features of the bestfit plane is "
msgStr2
= featureCount
Debug.Print(msgStr
+ msgStr2)
features
= bestfitPlaneFeature.GetSubFeatures
For
n = 0 To UBound(features)
feature
= features(n)
Debug.Print("
"
+ "Feature name: " + (feature.Name))
featureType
= feature.Type
Call
GetPatternType(featureType, msgStr2)
msgStr
= " Feature
type is "
Debug.Print(msgStr
+ msgStr2)
Next
End
Sub
Public
Sub GetPatternType(ByRef featureType As swDimXpertFeatureType_e, ByRef
msgStr2 As String)
If
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_Plane) Then
msgStr2
= "Plane"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_Cylinder) Then
msgStr2
= "Cylinder"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_Cone) Then
msgStr2
= "Cone"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_Extrude) Then
msgStr2
= "Extrude"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_Fillet) Then
msgStr2
= "Fillet"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_Chamfer) Then
msgStr2
= "Chamfer"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_CompoundHole)
Then
msgStr2
= "CompoundHole"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_CompoundWidth)
Then
msgStr2
= "CompoundWidth"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_CompoundNotch)
Then
msgStr2
= "CompoundNotch"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_CompoundClosedSlot3D)
Then
msgStr2
= "CompoundClosedSlot3D"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_IntersectPoint)
Then
msgStr2
= "IntersectPoint"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_IntersectLine)
Then
msgStr2
= "IntersectLine"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_IntersectCircle)
Then
msgStr2
= "IntersectCircle"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_IntersectPlane)
Then
msgStr2
= "IntersectPlane"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_Pattern) Then
msgStr2
= "Pattern"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_Sphere) Then
msgStr2
= "Sphere"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_BestfitPlane)
Then
msgStr2
= "Bestfit Plane"
ElseIf
(featureType = swDimXpertFeatureType_e.swDimXpertFeature_Surface) Then
msgStr2
= "Surface"
End
If
End
Sub
Public
swApp As SldWorks
End Class