SolidWorksMakroprogrammierung

Objekt · SldWorks

RenderMaterial-Objekt

Ein Erscheinungsbild (früher Material): Farben, Textur und ihre Abbildung, Beleuchtung, Oberflächenbeschaffenheit und die Elemente, auf denen es liegt.

Deklaration Dim x As SldWorks.RenderMaterial · in der englischen .NET-Hilfe: IRenderMaterial

Beschreibung

Mit RenderMaterial bringst du Erscheinungsbilder auf Modelle. Seit SOLIDWORKS 2008 heißen die früheren Materialien (materials) Erscheinungsbilder (appearances). Ein Erscheinungsbild stammt aus einer Datei (*.p2m) und legt Farben, eine Textur, das Verhalten im Licht und eine Oberflächenbeschaffenheit fest. Du legst es auf Elemente des Modells, in den Hilfebeispielen auf Flächen und Komponenten. Die meisten Befehle gibt es seit SOLIDWORKS 2008, einige für Abbildung und Oberflächenbeschaffenheit seit 2013 und 2025, die für DSPBR (DSPBRMaterial) seit 2026.

Zugriff

Beispiel

' Erzeugt ein Erscheinungsbild aus einer Datei, färbt es rot, legt es auf die
' ausgewählte Fläche und gibt es für alle Anzeigezustände der aktiven Konfiguration frei.
' Vorbedingung: Ein Teil ist offen, eine Fläche ist ausgewählt. Die Datei unter sDatei
'               gibt es. RealView ist eingeschaltet.
' Ergebnis:     Die Fläche ist rot, die Angaben stehen im Direktfenster.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swExt As SldWorks.ModelDocExtension
    Dim swMaterial As SldWorks.RenderMaterial
    Dim swFace As SldWorks.Face2
    Dim vZustaende As Variant
    Dim nId1 As Long, nId2 As Long
    Dim sDatei As String

    sDatei = "C:\Program Files\SOLIDWORKS Corp\SOLIDWORKS\data\graphics\Materials\plastic\low gloss\blue low gloss plastic.p2m"
    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    If swModel.SelectionManager.GetSelectedObjectType3(1, -1) <> swSelFACES Then Exit Sub
    Set swFace = swModel.SelectionManager.GetSelectedObject6(1, -1)
    Set swExt = swModel.Extension

    Set swMaterial = swExt.CreateRenderMaterial(sDatei)
    If swMaterial Is Nothing Then Exit Sub
    If False = swMaterial.AddEntity(swFace) Then Exit Sub
    swMaterial.PrimaryColor = RGB(200, 30, 30)
    swModel.ClearSelection2 True

    vZustaende = swModel.ConfigurationManager.ActiveConfiguration.GetDisplayStates
    If swExt.AddDisplayStateSpecificRenderMaterial(swMaterial, swAllDisplayState, vZustaende, nId1, nId2) Then
        Debug.Print "Datei: " & swMaterial.FileName
        Debug.Print "Kennungen: " & nId1 & ", " & nId2
        Debug.Print "Beleuchtung (swRenderMaterialIlluminationTypes_e): " & swMaterial.IlluminationShaderType
        Debug.Print "Elemente: " & swMaterial.GetEntitiesCount
    End If
End Sub

Bemerkungen

Zuweisen: Die Hilfebeispiele „Get Appearance File Name“ und „Add and Delete Appearances from Specific Display States“ erzeugen das Erscheinungsbild mit ModelDocExtension.CreateRenderMaterial, legen es mit RenderMaterial.AddEntity auf eine Fläche oder Komponente und bringen es dann mit ModelDocExtension.AddDisplayStateSpecificRenderMaterial in die Anzeigezustände. Entfernen kannst du es mit ModelDocExtension.DeleteDisplayStateSpecificRenderMaterial.

Sichtbar: Erscheinungsbilder siehst du nur, wenn RealView eingeschaltet ist (ModelDocExtension.ViewDisplayRealView). RenderMaterial.DoubleSided und RenderMaterial.RoundSharpEdges gelten nur, wenn ein Raytracing-Renderer geladen ist.

Was wann gilt: Viele Eigenschaften gelten nur unter Bedingungen, etwa nur bei einer bestimmten Abbildung (RenderMaterial.MappingType), Beleuchtung (RenderMaterial.IlluminationShaderType) oder Oberflächenbeschaffenheit (RenderMaterial.SurfaceFinishShaderType). Die Bedingungen stehen auf den Seiten der Befehle. Ob eine Änderung an einem schon zugewiesenen Erscheinungsbild sofort wirkt, sagt die Hilfe nicht.

Werte: Für die meisten Zahlenwerte nennt die Hilfe weder Einheit noch Wertebereich. Breite, Höhe und das Abrunden scharfer Kanten rechnet das Hilfebeispiel „Get Surface-finish Image Path and File Name“ mit * 1000 in Millimeter um, also Meter. Für die Winkel nennt die Hilfe keine Einheit.

Veraltete Befehle: RenderMaterial.SurfaceFinishShaderType ersetzt die Eigenschaft BumpMap, RenderMaterial.BumpStrength ersetzt BumpAmplitude und RenderMaterial.SurfaceFinishFile ersetzt BumpTextureFilename. Die Befehle mit der Endung 2, etwa RenderMaterial.GetCenterPoint2, ersetzen GetCenterPoint, SetCenterPoint, GetUDirection, SetUDirection, GetVDirection und SetVDirection.

Eigenschaften und Methoden

Eigenschaften 83, davon 80 beschrieben, 3 veraltet

NameBeschreibung
AboutAxisLiest oder setzt den Wert „um die Achse“ bei zylindrischer Abbildung des Erscheinungsbilds.
AccurateReflectionsLiest oder setzt die Einstellung „Genaue Spiegelungen (langsamer)“ des Erscheinungsbilds.
AlongAxisLiest oder setzt den Wert „entlang der Achse“ bei zylindrischer Abbildung des Erscheinungsbilds.
AmbientLiest oder setzt die Stärke des Umgebungslichts für das Erscheinungsbild.
AnisotropicBiasLiest oder setzt die anisotrope Neigung, die die Wirkung des Lichts waagerecht oder senkrecht verstärkt.
AnisotropicCylinderDistanceLiest oder setzt den Abstand der gedachten Zylinder, mit denen die anisotrope Spiegelung nachgebildet wird.
AnisotropicFloorHeightLiest oder setzt den Höhenunterschied zwischen benachbarten gedachten Zylindern bei anisotroper Spiegelung.
BrightnessLiest oder setzt, wie stark das Erscheinungsbild bei der Beleuchtungsart „Konstant“ selbst leuchtet.
BumpAmplitudeveraltet ersetzt durch RenderMaterial.BumpStrength
BumpBlendLiest oder setzt die Überblendung, also wie weit der Übergang zwischen einer Erhebung und der Oberfläche reicht.
BumpDetailLiest oder setzt den Detailgrad der Oberflächenbeschaffenheit.
BumpMapveraltet ersetzt durch RenderMaterial.SurfaceFinishShaderType
BumpRadiusLiest oder setzt den Radius, der Größe und Abstand der Erhebungen bei Grübchen und Riffelblech steuert.
BumpRoughHighLiest oder setzt die obere Schwelle der Oberflächenbeschaffenheit.
BumpRoughLowLiest oder setzt die untere Schwelle der Oberflächenbeschaffenheit.
BumpScaleLiest oder setzt den Maßstab, der bestimmt, wie dicht das Muster der Oberflächenbeschaffenheit ist.
BumpSharpnessLiest oder setzt die Schärfe, die die Form der Oberflächenbeschaffenheit beeinflusst.
BumpStrengthLiest oder setzt die Amplitude der Oberflächenbeschaffenheit.
BumpTextureFilenameveraltet ersetzt durch RenderMaterial.SurfaceFinishFile
BumpUseMappingScaleLiest oder setzt, ob die Oberflächenbeschaffenheit Maßstab und Abbildung des Erscheinungsbilds übernimmt.
CausticsCastLiest oder setzt, ob spiegelnde Erscheinungsbilder Kaustik-Photonen zurückwerfen.
CausticsReceiveLiest oder setzt, ob diffuse Erscheinungsbilder Kaustik-Photonen aufnehmen.
ColorFormLiest oder setzt, wie viele Farben das Erscheinungsbild beschreiben.
CustomHoleMeshFileLiest oder setzt die Datei mit dem eigenen Lochmuster bei der Oberflächenbeschaffenheit „Lochblech, eigenes Muster“.
DensityOfHolesLiest oder setzt die Dichte der Löcher bei korrodierten oder erodierten Erscheinungsbildern.
DiffuseLiest oder setzt die Stärke des Lichts, das die Oberfläche gleichmäßig aus allen Richtungen beleuchtet.
DimpleSizeLiest oder setzt die Größe der Grübchen bei der Oberflächenbeschaffenheit „mit Grübchen“.
Direction1RotationAngleLiest oder setzt den Winkel, um den die Textur gegen die waagerechte Achse gedreht wird.
Direction2RotationAngleLiest oder setzt den Winkel, um den die Textur gegen die senkrechte Achse gedreht wird.
DoubleSidedLiest oder setzt, ob Flächen beim Rendern mit einem Raytracing-Renderer von beiden Seiten schattiert werden.
EmissionLiest oder setzt, wie viel Licht das Erscheinungsbild abgibt.
FaceWidthLiest oder setzt die Flächenbreite (face width) des Erscheinungsbilds.
FileNameLiest oder setzt Pfad und Namen der Datei (*.p2m) des Erscheinungsbilds.
FitHeightLiest oder setzt, ob die Textur in der Höhe auf das ausgewählte Element gestreckt wird.
FitWidthLiest oder setzt, ob die Textur in der Breite auf das ausgewählte Element gestreckt wird.
FixedAspectRatioLiest oder setzt, ob das Seitenverhältnis der Textur fest ist.
GlobalIlluminationCastLiest oder setzt, ob spiegelnde Erscheinungsbilder Photonen für die indirekte Beleuchtung zurückwerfen.
GlobalIlluminationReceiveLiest oder setzt, ob diffuse Erscheinungsbilder Photonen der indirekten Beleuchtung aufnehmen.
GlossyLiest oder setzt den Glanzfaktor, mit dem das Erscheinungsbild Lichter spiegelt.
HasDSPBRPropertiesLiefert, ob das Erscheinungsbild DSPBR-Eigenschaften hat.
HeightLiest oder setzt die Höhe der Textur beim Abbilden des Erscheinungsbilds.
HeightMirrorLiest oder setzt, ob die Textur senkrecht gespiegelt wird.
HoleMeshSizeLiest oder setzt die Lochgröße bei den Oberflächenbeschaffenheiten „Lochblech“ mit rautenförmigen oder runden Löchern.
IgnoreMissingFileLiest oder setzt, ob Warnungen über fehlende Bilddateien unterdrückt werden.
IlluminationShaderTypeLiest oder setzt die Art der Beleuchtung des Erscheinungsbilds, etwa Kunststoff, Metall oder Glas.
IndexOfRefractionLiest oder setzt den Brechungsindex des Erscheinungsbilds.
KnurlAngleLiest oder setzt den Rändelwinkel bei der Oberflächenbeschaffenheit „gerändelt“.
KnurlHeightCapLiest oder setzt die größte Höhe der Rändelung bei der Oberflächenbeschaffenheit „gerändelt“.
LinkToFileLiest oder setzt, ob die Vorkommen des Erscheinungsbilds mit seiner Datei (*.p2m) verknüpft sind.
MappingTypeLiest oder setzt die Art der Abbildung (mapping) der Textur: Fläche, Projektion, Kugel, Zylinder oder automatisch.
MaterialIDLiefert die Kennung des Erscheinungsbilds; seit SOLIDWORKS 2011 nicht mehr unterstützt.
MetallicAmplitudeLiest oder setzt die Amplitude der Metallflocken in der metallischen Schicht.
MetallicFlakeMaterialLiest oder setzt das Metall der Flocken in der metallischen Schicht: Aluminium, Kupfer, Gold oder Silber.
MetallicMixLiest oder setzt den metallischen Anteil des Erscheinungsbilds.
MetallicRoughnessLiest oder setzt die Größe (Rauheit) der Glanzlichter auf der metallischen Oberfläche.
MetallicScaleLiest oder setzt die Größe der Metallflocken in der metallischen Schicht.
NSamplesLiest oder setzt die Zahl der Stichproben, mit der der Glanzanteil berechnet wird.
ObjectAreaLightLiest oder setzt, ob das Erscheinungsbild ein Flächenlicht ist, einen realistischen Lichtabfall hat oder beides.
OffsetLatitudeLiest oder setzt den Versatz in der Breite bei kugelförmiger Abbildung des Erscheinungsbilds.
OffsetLongitudeLiest oder setzt den Versatz in der Länge bei kugelförmiger Abbildung des Erscheinungsbilds.
PatternScaleLiest oder setzt den Maßstab des Musters bei prozeduralen Texturen.
PrimaryColorLiest oder setzt die erste Farbe des Erscheinungsbilds.
ProjectionReferenceLiest oder setzt die Projektionsrichtung beim Abbilden des Erscheinungsbilds.
ReflectivityLiest oder setzt das Reflexionsvermögen des Erscheinungsbilds.
RotationAngleLiest oder setzt den Winkel, um den die Textur gegen die Achsen gedreht wird.
RoughnessLiest oder setzt die Streuung der Glanzlichter (Rauheit) des Erscheinungsbilds.
RoundSharpEdgesLiest oder setzt, wie stark scharfe Kanten beim Rendern mit einem Raytracing-Renderer abgerundet werden.
SecondaryColorLiest oder setzt die zweite Farbe des Erscheinungsbilds.
SpecularLiest oder setzt die Stärke der Glanzlichter des Erscheinungsbilds.
SpecularColorLiest oder setzt die Farbe der Glanzlichter des Erscheinungsbilds.
SurfaceFinishFileLiest oder setzt die Bilddatei für eine Oberflächenbeschaffenheit aus einer Datei.
SurfaceFinishFileNormalMapLiest oder setzt, ob das Bild der Oberflächenbeschaffenheit als Normal Map verwendet wird.
SurfaceFinishShaderTypeLiest oder setzt die Art der Oberflächenbeschaffenheit des Erscheinungsbilds, etwa gebürstet, gerändelt oder Lochblech.
TertiaryColorLiest oder setzt die dritte Farbe des Erscheinungsbilds.
TextureFilenameLiest oder setzt Pfad und Namen der Texturdatei des Erscheinungsbilds.
ToonShaderTextureFilenameLiest oder setzt Pfad und Namen der Texturdatei für den Toon-Shader.
TranslucencyLiest oder setzt, wie stark das Material Licht filtert und streut (Lichtdurchlässigkeit).
TransparencyLiest oder setzt, wie viel Licht das Material durchlässt (Transparenz).
TransparencyMappingShaderTypeLiest oder setzt eine Einstellung für die Abbildung der Transparenz; die Hilfe enthält nur die Syntax.
WidthLiest oder setzt die Breite der Textur beim Abbilden des Erscheinungsbilds.
WidthMirrorLiest oder setzt, ob die Textur waagerecht gespiegelt wird.
XPositionLiest oder setzt die Verschiebung des Erscheinungsbilds in X-Richtung.
YPositionLiest oder setzt die Verschiebung des Erscheinungsbilds in Y-Richtung.

Methoden 20, davon 14 beschrieben, 6 veraltet

NameBeschreibung
AddEntityLegt das Erscheinungsbild auf ein Element, etwa eine Fläche oder Komponente.
GetCenterPointveraltet ersetzt durch RenderMaterial.GetCenterPoint2
GetCenterPoint2Liefert den Mittelpunkt der Abbildung bei einem texturbasierten Erscheinungsbild.
GetDSPBRMaterialLiefert das Objekt DSPBRMaterial des Erscheinungsbilds.
GetEntitiesLiefert die Elemente, auf denen das Erscheinungsbild liegt.
GetEntitiesCountLiefert die Zahl der Elemente, auf denen das Erscheinungsbild liegt.
GetLinkedDisplayStatesLiefert die Anzeigezustände, in denen das Erscheinungsbild gilt.
GetMaterialIdsLiefert die beiden Kennungen des Erscheinungsbilds.
GetUDirectionveraltet ersetzt durch RenderMaterial.GetUDirection2
GetUDirection2Liefert die U-Richtung eines texturbasierten Erscheinungsbilds.
GetVDirectionveraltet ersetzt durch RenderMaterial.GetVDirection2
GetVDirection2Liefert die V-Richtung eines texturbasierten Erscheinungsbilds.
RemoveAllEntitiesEntfernt das Erscheinungsbild von allen Elementen, auf denen es liegt.
SetCenterPointveraltet ersetzt durch RenderMaterial.SetCenterPoint2
SetCenterPoint2Setzt den Mittelpunkt der Abbildung bei einem texturbasierten Erscheinungsbild.
SetLinkedDisplayStatesLegt fest, in welchen Anzeigezuständen das Erscheinungsbild gilt.
SetUDirectionveraltet ersetzt durch RenderMaterial.SetUDirection2
SetUDirection2Setzt die U-Richtung eines texturbasierten Erscheinungsbilds.
SetVDirectionveraltet ersetzt durch RenderMaterial.SetVDirection2
SetVDirection2Setzt die V-Richtung eines texturbasierten Erscheinungsbilds.

Nicht aufgeführt sind 1 C++-Varianten (Namen mit I davor, zum Beispiel IGetEntities). In VBA nimmst du immer den Befehl ohne I.

Siehe auch

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

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