SolidWorksMakroprogrammierung

Objekt · SldWorks

DSPBRMaterial-Objekt

Die physikalisch basierten Werte (DSPBR) eines Erscheinungsbilds: Grundfarbe, Metall und Rauheit, Transparenz, Klarlack, Flocken, Schimmer, dünne Schicht, Emission und Texturen.

Deklaration Dim x As SldWorks.DSPBRMaterial · in der englischen .NET-Hilfe: IDSPBRMaterial

Beschreibung

DSPBRMaterial gibt Zugriff auf das Material nach dem physikalisch basierten Rendering von Dassault Systèmes (Dassault Systemes Physically Based Rendering, DSPBR). Gemeint ist das Enterprise PBR Shading Model, ein Materialmodell für Echtzeit-Darstellung und Raytracing. Es verbindet ein metallisches und ein nichtmetallisches (dielektrisches) Streuverhalten, mit Transparenz für dünnwandige und für Volumenkörper. Dazu kommen Emission, Klarlack, Metallflocken und Schimmer (sheen). Die Eigenschaften entsprechen den Einstellungen des Erscheinungsbilds in der Oberfläche, wenn dort die DSPBR-Darstellung aktiv ist. Alle Befehle sind Eigenschaften zum Lesen und Setzen. Es gibt sie seit SOLIDWORKS 2026, fünf davon seit 2026 SP01.

Zugriff

Beispiel

' Gibt für jedes Erscheinungsbild des aktiven Modells im aktiven Anzeigezustand
' die wichtigsten DSPBR-Werte aus.
' Vorbedingung: Ein Teil oder eine Baugruppe mit Erscheinungsbildern ist offen.
' Ergebnis:     Die Werte stehen im Direktfenster (Strg+G).
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swMaterial As SldWorks.RenderMaterial
    Dim swDspbr As SldWorks.DSPBRMaterial
    Dim vListe As Variant
    Dim nFarbe As Long
    Dim i As Long

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    Debug.Print "DSPBR-Darstellung: " & swApp.GetUserPreferenceToggle(swDisplayDspbrAppearances)

    vListe = swModel.Extension.GetRenderMaterials2(swThisDisplayState, Empty)
    If Not IsArray(vListe) Then Exit Sub
    For i = 0 To UBound(vListe)
        Set swMaterial = vListe(i)
        If swMaterial.HasDSPBRProperties Then
            Set swDspbr = swMaterial.GetDSPBRMaterial
            nFarbe = swDspbr.Albedo
            Debug.Print swMaterial.FileName
            Debug.Print "  Untertyp " & swDspbr.SubType & ", Version " & swDspbr.Version
            Debug.Print "  Grundfarbe R " & (nFarbe And &HFF&) & ", G " & ((nFarbe \ &H100&) And &HFF&) & _
                        ", B " & ((nFarbe \ &H10000) And &HFF&)
            Debug.Print "  Metallisch " & swDspbr.Metallic & ", Rauheit " & swDspbr.Roughness
            Debug.Print "  Transparenz " & swDspbr.Transparency & ", Brechungsindex " & swDspbr.IndexOfRefraction
            Debug.Print "  Emission " & swDspbr.EmissionValue & " (Modus " & swDspbr.EmissionMode & ")"
        End If
    Next i
End Sub

Bemerkungen

DSPBR einschalten: Die DSPBR-Darstellung aktivierst du in der Oberfläche unter Systemoptionen › Anzeige › Darstellungsstil der Erscheinungsbilder (Appearance Visual Style). Dann öffnest du ein Modell, stellst unten im Grafikbereich das Einheitensystem MMGS ein, klickst auf „Erscheinungsbild bearbeiten“ und wählst auf der Registerkarte DSPBR als Art „Enterprise PBR Shading Model“. Per API ist die Systemoption swDisplayDspbrAppearances aus swUserPreferenceToggle_e. Sie gilt nur, wenn die verbesserte Grafikleistung (Enhanced Graphics Performance) eingeschaltet ist.

Werte: Die meisten Zahlenwerte liegen zwischen 0,0 und 1,0. Wertebereich und Vorgabe stehen auf den Seiten der Befehle. Für DSPBRMaterial.Displacement und DSPBRMaterial.FlakeSize nennt die Hilfe Millimeter, nicht Meter, für DSPBRMaterial.ThinFilmThickness Mikrometer. Der Winkel in DSPBRMaterial.AnisotropyRotation ist kein Bogenmaß: 0,0 bis 1,0 steht für 0 bis 360 Grad.

Farben: Die Farben sind COLORREF-Werte als Dezimalzahl (Long). In VBA bildest du sie mit RGB. Die Oberfläche zeigt die Farben als RGB.

Ein und aus: DSPBRMaterial.ThinWalled und DSPBRMaterial.EmissionEnergyNormalization sind als Long deklariert und nehmen 1 für ein und 0 für aus.

Texturen: Die Eigenschaften mit der Endung Texture nehmen den Namen der Textur (texture map) als Text. Ob das ein Dateiname oder ein ganzer Pfad ist, sagt die Hilfe nicht.

Mehr in der Spezifikation: Fast jede Seite der Hilfe verweist für die Bedeutung der Werte auf die Beschreibung des Enterprise PBR Shading Model (Version 2025x) unter https://dassaultsystemes-technology.github.io/EnterprisePBRShadingModel/spec-2025x.md.html. Die API-Hilfe selbst erklärt viele Werte nur in einem Satz.

Wirkung: Ob eine Änderung sofort in der Grafik sichtbar wird und ob du das Erscheinungsbild danach neu zuweisen musst, sagt die Hilfe nicht. Ein Hilfebeispiel zu DSPBRMaterial gibt es nicht.

In SOLIDWORKS 2024 nicht prüfbar: Die Typbibliothek kennt DSPBRMaterial noch nicht, schon Dim swDspbr As SldWorks.DSPBRMaterial brach beim Kompilieren ab („Benutzerdefinierter Typ nicht definiert“). Das Objekt gibt es erst ab SOLIDWORKS 2026.

Eigenschaften und Methoden

Eigenschaften 52, davon 52 beschrieben

NameBeschreibung
AbbeNumberLiest oder setzt die Abbe-Zahl, also die Dispersion des Materials.
AlbedoLiest oder setzt die Grundfarbe (Albedo) des Materials.
AlbedoTextureLiest oder setzt die Textur für die Grundfarbe (Albedo) des Materials.
AnisotropyLiest oder setzt die Stärke der Anisotropie, also wie stark die Glanzlichter in eine Richtung gezogen werden.
AnisotropyRotationLiest oder setzt die Drehung der Anisotropie um die Flächennormale, als Anteil einer vollen Umdrehung.
AttenuationColorLiest oder setzt die Farbe, zu der Licht im Inneren des Materials abgeschwächt wird.
AttenuationDistanceLiest oder setzt die Strecke, auf der Licht im Inneren des Materials abgeschwächt wird.
ClearcoatLiest oder setzt, wie stark die Klarlackschicht (clearcoat) des Materials spiegelt.
ClearcoatNormalStrengthLiest oder setzt die Stärke der Normalen-Textur der Klarlackschicht.
ClearcoatNormalTextureLiest oder setzt die Normalen-Textur (Normal Map) der Klarlackschicht.
ClearcoatRoughnessLiest oder setzt die Rauheit der Klarlackschicht.
CutoutOpacityLiest oder setzt die Ausschnitt-Deckkraft (cut-out opacity) des Materials, von durchsichtig bis deckend.
CutoutOpacityTextureLiest oder setzt die Textur für die Ausschnitt-Deckkraft (cut-out opacity) des Materials.
DisplacementLiest oder setzt die Verschiebung der Oberfläche entlang der Flächennormale, die der Geometrie Details hinzufügt.
DisplacementTextureLiest oder setzt die Textur für die Verschiebung (displacement) der Oberfläche.
EmissionColorLiest oder setzt die Farbe, in der das Material selbst leuchtet.
EmissionColorTextureLiest oder setzt die Textur für die Farbe der Emission.
EmissionEnergyNormalizationLiest oder setzt, ob die Energie der Emission normalisiert wird.
EmissionModeLiest oder setzt, ob der Wert der Emission als spezifische Lichtausstrahlung oder als Lichtleistung gilt.
EmissionValueLiest oder setzt, wie viel Licht das Material abgibt.
FlakeColorLiest oder setzt die Farbe der Flocken (flakes) im Material.
FlakeCoverageLiest oder setzt, wie dicht die Flocken (flakes) das Material bedecken.
FlakeRoughnessLiest oder setzt die Rauheit der Verteilung, die die Ausrichtung der Flocken steuert.
FlakeSizeLiest oder setzt den Durchmesser der Flocken im Weltkoordinatensystem.
FlakeTextureLiest oder setzt die Textur der Flocken im Material.
FlipFlopLiest oder setzt, wie stark die Farbe des Materials vom Blickwinkel abhängt (Flip-Flop).
FlipFlopColorLiest oder setzt die Farbe der Flocken bei senkrechtem Blick, wenn der Flip-Flop-Effekt eingeschaltet ist.
IndexOfRefractionLiest oder setzt den Brechungsindex des Materials.
MetallicLiest oder setzt, wie metallisch das Material ist, von nichtmetallisch bis metallisch.
MetallicTextureLiest oder setzt die Textur für den metallischen Anteil des Materials.
NormalStrengthLiest oder setzt die Stärke der Normalen-Textur des Materials.
NormalTextureLiest oder setzt die Normalen-Textur (Normal Map) des Materials.
RealViewToDSPBRTextureScaleLiest oder setzt den Maßstab zwischen den Texturen von RealView und von DSPBR.
RoughnessLiest oder setzt die Streuung der Glanzlichter (Rauheit) des Materials.
RoughnessTextureLiest oder setzt die Textur für die Rauheit der Oberfläche.
SheenColorLiest oder setzt die Farbe des Schimmers (sheen) des Materials.
SheenRoughnessLiest oder setzt die Rauheit der Mikrofacetten-Verteilung des Schimmers (sheen).
SpecularLiest oder setzt die Stärke der Glanzlichter des Materials.
SpecularTintColorLiest oder setzt die Tönung der Glanzlichter bei senkrechtem Blick.
SubsurfaceAnisotropyLiest oder setzt die Richtung der Streuung unter der Oberfläche (subsurface scattering), von rückwärts bis vorwärts.
SubsurfaceColorLiest oder setzt die Farbe der Streuung unter der Oberfläche (subsurface scattering).
SubTypeLiest oder setzt den Untertyp des Materials, etwa „Metal“ oder „Glass“, der nur die passenden Parameter zeigt.
ThinFilmLiest oder setzt die Gewichtung einer dünnen Schicht (thin film) auf dem Material.
ThinFilmIORLiest oder setzt den Brechungsindex der dünnen Schicht (thin film).
ThinFilmThicknessLiest oder setzt die Dicke der dünnen Schicht (thin film) in Mikrometer.
ThinFilmThicknessTextureLiest oder setzt die Textur für die Dicke der dünnen Schicht (thin film).
ThinWalledLiest oder setzt, ob das Material dünnwandig ist oder die Grenze eines Volumens beschreibt.
TranslucencyLiest oder setzt, wie stark das Material Licht filtert und streut (Lichtdurchlässigkeit).
TranslucencyColorLiest oder setzt die Farbe der Lichtdurchlässigkeit (translucency) des Materials.
TransparencyLiest oder setzt, wie viel Licht das Material durchlässt (Transparenz).
TransparencyTextureLiest oder setzt die Textur für die Transparenz des Materials.
VersionLiest oder setzt die Version des Materialmodells (DSPBR-Spezifikation), nach der das Material beschrieben ist.

Siehe auch

Englisches Original: IDSPBRMaterial in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)

Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.