Objekt · SldWorks
MacroFeatureData-Objekt
Die Daten eines Makro-Features, also eines eigenen Features, dessen Neuaufbau ein Makro oder Add-in übernimmt: Parameter, Auswahlen, Körper, IDs, Bemaßungen und die Rückruf-Funktionen.
Beschreibung
MacroFeatureData gibt Zugriff auf die Daten, die ein Makro-Feature festlegen. Ein Makro-Feature ist ein Feature, das ein Programm festlegt: Was es am Modell bewirkt, berechnet bei jedem Neuaufbau eine Funktion in einem VBA-Makro (*.swp) oder in einem COM-Server (DLL oder EXE, etwa einem Add-in). Es kann neue Körper erzeugen, vorhandene Körper ändern oder ganz ohne Geometrie Daten prüfen, in Teilen, Baugruppen und Zeichnungen. Die meisten Befehle gibt es seit SOLIDWORKS 2003.
Ablauf: Ein Makro legt das Makro-Feature mit FeatureManager.InsertMacroFeature3 an und übergibt dabei Parameter (Namen, Typen, Werte), auf Wunsch Bemaßungen und die Körper, die das Feature ändert. Was beim Einfügen ausgewählt ist, speichert SOLIDWORKS als Auswahlen des Features. Danach ruft SOLIDWORKS drei Rückruf-Funktionen auf. Jede bekommt das Makro-Feature und holt sich die Daten mit Feature.GetDefinition:
- Neuaufbau (rebuild, Pflicht): bei jedem Neuaufbau des Features. Liest Parameter und Auswahlen, erzeugt oder ändert Körper und meldet das Ergebnis zurück.
- Bearbeiten (edit definition, Pflicht): bei Feature bearbeiten. Öffnet mit
MacroFeatureData.AccessSelectionsdie Auswahlen, lässt den Benutzer Auswahlen und Werte ändern und übernimmt sie mitFeature.ModifyDefinition. Das löst einen Neuaufbau aus. - Sicherheit (security, in VBA freiwillig): gibt mit Werten aus
swMacroFeatureSecurityOptions_ezurück, ob der Benutzer das Feature löschen, bearbeiten, unterdrücken, ersetzen oder zurückrollen darf.
Zugriff
Feature.GetDefinition: aus einem Makro-Feature, TypnameMacroFeaturebeiFeature.GetTypeName2. In den Rückruf-Funktionen ist das Makro-Feature der dritte Parameter.FeatureManager.InsertMacroFeature3: legt ein Makro-Feature an und liefert seinFeature, die Daten holst du dann mit GetDefinition.
Beispiel
' Fügt ein Makro-Feature mit dem Text-Parameter "Text" ein. Die drei Rückruf-Funktionen
' stehen im selben Modul wie main.
' Vorbedingung: Ein Teil ist offen. Das Makro ist gespeichert, der Code steht im Modul "Module1".
' Ergebnis: Im FeatureManager steht das Makro-Feature "Prüfhinweis1". Feature bearbeiten
' fragt nach einem neuen Text. Unterdrücken lässt sich das Feature nicht.
Option Explicit
Sub main()
Dim swApp As SldWorks.SldWorks
Dim swModel As SldWorks.ModelDoc2
Dim swFeat As SldWorks.Feature
Dim sDatei As String
Dim vMethoden(8) As String
Dim vNamen(0) As String, vTypen(0) As Long, vWerte(0) As String
Set swApp = Application.SldWorks
Set swModel = swApp.ActiveDoc
If swModel Is Nothing Then Exit Sub
sDatei = swApp.GetCurrentMacroPathName
vMethoden(0) = sDatei: vMethoden(1) = "Module1": vMethoden(2) = "swmNeuaufbau"
vMethoden(3) = sDatei: vMethoden(4) = "Module1": vMethoden(5) = "swmBearbeiten"
vMethoden(6) = sDatei: vMethoden(7) = "Module1": vMethoden(8) = "swmSicherheit"
vNamen(0) = "Text": vTypen(0) = swMacroFeatureParamTypeString: vWerte(0) = "Bitte prüfen"
Set swFeat = swModel.FeatureManager.InsertMacroFeature3("Prüfhinweis", "", vMethoden, _
vNamen, vTypen, vWerte, Empty, Empty, Empty, Empty, swMacroFeatureByDefault)
If swFeat Is Nothing Then Debug.Print "Makro-Feature nicht erzeugt."
End Sub
' Neuaufbau: liest die Daten, fragt nichts und legt keine Features an.
Function swmNeuaufbau(varApp As Variant, varDoc As Variant, varFeat As Variant) As Variant
Dim swFeat As SldWorks.Feature
Dim swDaten As SldWorks.MacroFeatureData
Dim sText As String
Set swFeat = varFeat
Set swDaten = swFeat.GetDefinition
swDaten.GetStringByName "Text", sText
If sText = "" Then
swmNeuaufbau = "Der Text fehlt." ' ein Text erscheint als Fehlermeldung
Else
swmNeuaufbau = True
End If
End Function
' Feature bearbeiten: Auswahlen öffnen, Parameter ändern, Definition übernehmen.
Function swmBearbeiten(varApp As Variant, varDoc As Variant, varFeat As Variant) As Variant
Dim swFeat As SldWorks.Feature
Dim swModel As SldWorks.ModelDoc2
Dim swDaten As SldWorks.MacroFeatureData
Dim sText As String
Dim bOk As Boolean
Set swFeat = varFeat
Set swModel = varDoc
Set swDaten = swFeat.GetDefinition
If swDaten.AccessSelections(swModel, Nothing) Then
swDaten.GetStringByName "Text", sText
sText = InputBox("Text des Hinweises:", swFeat.Name, sText)
If sText <> "" Then
swDaten.SetStringByName "Text", sText
bOk = swFeat.ModifyDefinition(swDaten, swModel, Nothing)
End If
If False = bOk Then swDaten.ReleaseSelectionAccess ' abgebrochen oder nicht übernommen
End If
swmBearbeiten = bOk
End Function
' Sicherheit: Das Feature lässt sich nicht unterdrücken.
Function swmSicherheit(varApp As Variant, varDoc As Variant, varFeat As Variant) As Variant
swmSicherheit = swMacroFeatureSecurityCannotBeSuppressed
End FunctionBemerkungen
In VBA: Die Rückruf-Funktionen eines VBA-Makro-Features stehen in einer gespeicherten Makrodatei (*.swp), in einem oder mehreren Modulen. Ihre Namen müssen mit swm beginnen. Jede bekommt drei Parameter vom Typ Variant: die SOLIDWORKS-Anwendung, das Dokument (PartDoc, AssemblyDoc oder DrawingDoc) und das Makro-Feature. Datei, Modul und Name der drei Funktionen übergibst du im Array MacroMethods von FeatureManager.InsertMacroFeature3, ohne Sicherheitsfunktion mit drei leeren Texten. Der zweite Weg ist ein COM-Server (DLL oder EXE, etwa ein Add-in), der die Schnittstelle ISwComFeature mit Edit, Regenerate und Security umsetzt. Solche Makro-Features erkennst du an MacroFeatureData.IsCOMFeature.
Neuaufbau: Die Funktion gibt True für Erfolg, False für einen Fehler ohne weitere Angabe oder einen Text zurück, den SOLIDWORKS als Fehlermeldung zeigt. Erzeugt sie Körper, gibt sie den neuen Body2 oder ein Array von Körpern zurück. Sie darf keine Rückfragen stellen, im selben Modell keine Features einfügen, keine Definitionen anderer Features ändern und den FeatureManager nicht neu aufbauen oder zurückrollen. Körper aus der API haben nicht immer IDs auf Flächen und Kanten, dann scheitern boolesche Operationen. Deshalb prüfst du mit MacroFeatureData.GetEntitiesNeedUserId und vergibst IDs mit MacroFeatureData.SetFaceUserId und MacroFeatureData.SetEdgeUserId.
Bearbeiten: Für die Eingaben eignet sich eine PropertyManager-Seite (PropertyManagerPage2), nötig ist sie nicht, eine UserForm geht auch. Das Hilfebeispiel „Cut Body in Half Using Macro Feature“ baut die Seite in VBA mit Klassenmodulen. Bricht der Benutzer ab, rufst du MacroFeatureData.ReleaseSelectionAccess auf oder verwirfst das Objekt. In Zeichnungen gibt es keine Rollback-Leiste: Dort rufst du AccessSelections und ReleaseSelectionAccess nicht auf, Feature.ModifyDefinition geht trotzdem. Bei Bemaßungen, die je Konfiguration verschieden sind, soll nur die Bearbeiten-Funktion die Konfigurationen berücksichtigen, etwa mit Dimension.SetSystemValue3, nicht die Neuaufbau-Funktion.
Sicherheit und GetDefinition: SOLIDWORKS ruft die Sicherheitsfunktion jedes Mal auf, wenn jemand Feature.GetDefinition an einem Makro-Feature aufruft, um zu prüfen, ob es bearbeitet werden darf. Ruft die Sicherheitsfunktion selbst GetDefinition auf, droht deshalb eine Endlosschleife. Die Hilfe rät dann zu einem statischen Merker, den die Funktion beim ersten Aufruf setzt. Einen Hinweis für den Benutzer fügst du mit FeatureManager.InsertSecurityNote ein und gibst dafür swMacroFeatureSecurityEnableNote zurück.
Ändern von außen: Bei vielen Befehlen verweist die Hilfe auf den Abschnitt „Accessing Selections that Define Features“. Willst du Parameter oder Auswahlen aus einem anderen Makro ändern, rufst du wie bei anderen Feature-Daten erst MacroFeatureData.AccessSelections auf und übernimmst die Änderung mit Feature.ModifyDefinition, sonst gibst du den Zugriff mit ReleaseSelectionAccess frei. ModifyDefinition löst den Neuaufbau aus.
Makrodatei: Ist die Makrodatei nicht eingebettet, muss SOLIDWORKS sie beim Neuaufbau finden, sonst steht ein Fehler unter „Was ist falsch?“. Den Text dafür setzt MacroFeatureData.Provider. Einbetten lässt sie sich mit swMacroFeatureEmbedMacroFile (swMacroFeatureOptions_e) beim Einfügen oder mit MacroFeatureData.EmbedMacroFile. Die externen Dateien aller Makro-Features listet ModelDoc2.ListAuxiliaryExternalFileReferences.
Veraltete Befehle: GetSelections und GetSelections2 ersetzt MacroFeatureData.GetSelections3, SetSelections ersetzt MacroFeatureData.SetSelections2 und EditBody ersetzt MacroFeatureData.EditBodies. Das Hilfebeispiel „Assign Tracking ID Using Macro Feature“ nimmt noch die alten Befehle.
Eigenschaften und Methoden
Eigenschaften 19, davon 18 beschrieben, 1 veraltet
| Name | Beschreibung |
|---|---|
| CurrentConfiguration | Liefert die Konfiguration, für die SOLIDWORKS das Makro-Feature gerade neu aufbaut. |
| EditBodies | Liest oder setzt die Körper, die das Makro-Feature ändert. |
| EditBody | veraltet ersetzt durch MacroFeatureData.EditBodies |
| EnableMultiBodyConsume | Liest oder setzt, ob mehrere Körper aus dem Neuaufbau eines Makro-Features den ursprünglichen Körper ersetzen statt ihn zu ergänzen. |
| FeatureTransform | Liest oder setzt die Transformation des Makro-Features. |
| IconFiles | Liest oder setzt die Bilddateien der Symbole, die das Makro-Feature im FeatureManager zeigt. |
| MacroFileEmbedded | Liefert, ob die Makrodatei mit dem Makro-Feature im Modell eingebettet ist. |
| MacroFileName | Liest oder setzt Pfad und Namen der Makrodatei des Makro-Features. |
| ModuleName | Liest oder setzt den Namen des Moduls im Makro des Makro-Features. |
| Parents | Liest oder setzt die Eltern-Features des Makro-Features. |
| PatternTransform | Liefert die Transformation des Musters zum Makro-Feature. |
| ProcedureName | Liest oder setzt den Namen der Prozedur im Makro des Makro-Features. |
| PropertyManagerHandleMacroFileName | Liest oder setzt Pfad und Namen der Makrodatei für den PropertyManager-Handle des Makro-Features, also die Datei der Bearbeiten-Funktion. |
| PropertyManagerHandleModuleName | Liest oder setzt den Namen des Moduls für den PropertyManager-Handle des Makro-Features, also das Modul der Bearbeiten-Funktion. |
| PropertyManagerHandleProcedureName | Liest oder setzt den Namen der Prozedur für den PropertyManager-Handle des Makro-Features, also der Bearbeiten-Funktion. |
| Provider | Liest oder setzt die Fehlermeldung für den Dialog „Was ist falsch?“, wenn ein nicht eingebettetes Makro-Feature wegen fehlender Dateien nicht lädt oder nicht neu aufgebaut wird. |
| SecurityHandleMacroFileName | Liest oder setzt Pfad und Namen der Makrodatei mit der Sicherheitsfunktion des Makro-Features. |
| SecurityHandleModuleName | Liest oder setzt den Namen des Moduls mit der Sicherheitsfunktion des Makro-Features. |
| SecurityHandleProcedureName | Liest oder setzt den Namen der Sicherheitsfunktion des Makro-Features. |
Methoden 44, davon 41 beschrieben, 3 veraltet
| Name | Beschreibung |
|---|---|
| AccessSelections | Setzt das Modell vor das Makro-Feature zurück, damit du die Auswahlen und Daten lesen und ändern kannst, die es festlegen. |
| EmbedMacroFile | Legt fest, dass die Makrodatei mit dem Makro-Feature im Modell eingebettet wird. |
| GetBaseName | Liefert den Grundnamen des Makro-Features, den es beim Einfügen bekommen hat. |
| GetDisplayDimensionCount | Liefert die Zahl der Bemaßungen des Makro-Features. |
| GetDisplayDimensions | Liefert die Bemaßungen des Makro-Features. |
| GetDoubleByName | Liest den Wert eines Double-Parameters des Makro-Features über seinen Namen. |
| GetEdgeIdType | Liefert, welche Art von ID eine Kante im Körper des Makro-Features hat. |
| GetEdgeUserId | Liest die beiden eigenen IDs einer Kante im Körper des Makro-Features. |
| GetEditBodiesCount | Liefert die Zahl der Körper, die das Makro-Feature ändert. |
| GetEditTargetTransform | Liefert die Transformation der Komponente, in der das Makro-Feature liegt, wenn eine seiner Auswahlen zu einer anderen Komponente gehört. |
| GetEntitiesNeedUserId | Liefert die Flächen und Kanten eines Körpers, die für das Makro-Feature noch eine eigene ID brauchen. |
| GetEntitiesNeedUserIdCount | Liefert, wie viele Flächen und Kanten eines Körpers für das Makro-Feature noch eine eigene ID brauchen. |
| GetFaceIdType | Liefert, welche Art von ID eine Fläche im Körper des Makro-Features hat. |
| GetFaceUserId | Liest die beiden eigenen IDs einer Fläche im Körper des Makro-Features. |
| GetIconFileCount | Liefert die Zahl der Bilddateien für die Symbole des Makro-Features. |
| GetIntegerByName | Liest den Wert eines Integer-Parameters des Makro-Features über seinen Namen. |
| GetModuleCount | Liefert die Zahl der Module im Makro des Makro-Features. |
| GetModuleNames | Liefert die Namen der Module im Makro des Makro-Features. |
| GetParameterCount | Liefert die Zahl der eigenen Parameter des Makro-Features. |
| GetParameters | Liefert Namen, Typen und Werte aller eigenen Parameter des Makro-Features. |
| GetParentsCount | Liefert die Zahl der Eltern-Features des Makro-Features. |
| GetProcedureCount | Liefert die Zahl der Prozeduren in einem Modul des Makros zum Makro-Feature. |
| GetProcedureNames | Liefert die Namen der Prozeduren in einem Modul des Makros zum Makro-Feature. |
| GetProgId | Liefert die ProgID des COM-Servers, der die Rückruf-Funktionen eines COM-Makro-Features umsetzt. |
| GetPropertyManagerHandleModuleCount | Liefert die Zahl der Module im Makro für den PropertyManager-Handle des Makro-Features. |
| GetPropertyManagerHandleModuleNames | Liefert die Namen der Module im Makro für den PropertyManager-Handle des Makro-Features. |
| GetPropertyManagerHandleProcedureCount | Liefert die Zahl der Prozeduren in einem Modul des Makros für den PropertyManager-Handle des Makro-Features. |
| GetPropertyManagerHandleProcedureNames | Liefert die Namen der Prozeduren in einem Modul des Makros für den PropertyManager-Handle des Makro-Features. |
| GetSelectionCount | Liefert die Zahl der ausgewählten Objekte, die zum Makro-Feature gespeichert sind. |
| GetSelections | veraltet ersetzt durch MacroFeatureData.GetSelections3 |
| GetSelections2 | veraltet ersetzt durch MacroFeatureData.GetSelections3 |
| GetSelections3 | Liefert die ausgewählten Objekte des Makro-Features mit Art, Markierung, Zeichenansicht und der Transformation ihrer Komponente. |
| GetStringByName | Liest den Wert eines Text-Parameters des Makro-Features über seinen Namen. |
| IsCOMFeature | Liefert, ob das Makro-Feature ein COM-Feature ist, dessen Rückruf-Funktionen ein COM-Server statt eines VBA-Makros umsetzt. |
| ReleaseSelectionAccess | Hebt den Rücksetz-Zustand nach AccessSelections wieder auf, wenn du das Makro-Feature nicht geändert hast. |
| SetDoubleByName | Setzt den Wert eines Double-Parameters des Makro-Features über seinen Namen. |
| SetEdgeUserId | Gibt einer Kante im Körper des Makro-Features zwei eigene IDs. |
| SetFaceUserId | Gibt einer Fläche im Körper des Makro-Features zwei eigene IDs. |
| SetIntegerByName | Setzt den Wert eines Integer-Parameters des Makro-Features über seinen Namen. |
| SetParameters | Setzt Namen, Typen und Werte der eigenen Parameter des Makro-Features. |
| SetProgId | Setzt die ProgID des COM-Servers, der die Rückruf-Funktionen eines COM-Makro-Features umsetzt. |
| SetSelections | veraltet ersetzt durch MacroFeatureData.SetSelections2 |
| SetSelections2 | Setzt die ausgewählten Objekte des Makro-Features mit Markierungen und Zeichenansichten. |
| SetStringByName | Setzt den Wert eines Text-Parameters des Makro-Features über seinen Namen. |
Nicht aufgeführt sind 21 C++-Varianten (Namen mit I davor, zum Beispiel IAccessSelections). In VBA nimmst du immer den Befehl ohne I.
Siehe auch
Englisches Original: IMacroFeatureData in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)
Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.