SolidWorksMakroprogrammierung

Objekt · SldWorks

RayTraceRendererOptions-Objekt

Die Einstellungen eines Ray-Trace-Renderers: Bildgröße und Format, Qualität von Vorschau und endgültigem Rendern, Effekte wie Bloom, Kaustik und Kontur- oder Cartoon-Darstellung und das Rendern im Netzwerk.

Deklaration Dim x As SldWorks.RayTraceRendererOptions · in der englischen .NET-Hilfe: IRayTraceRendererOptions

Beschreibung

RayTraceRendererOptions gibt Zugriff auf die Einstellungen eines Ray-Trace-Renderers (RayTraceRenderer). Du stellst damit ein, wie groß und in welchem Format das Bild wird, in welcher Qualität Vorschau und endgültiges Rendern laufen und welche Effekte dazukommen. Die ersten Befehle gibt es seit SOLIDWORKS 2011, viele seit 2016.

Zugriff

Beispiel

' Stellt Größe, Format und Qualität ein und rendert das aktive Modell in eine Datei.
' Vorbedingung: Ein Modell ist offen, ein Ray-Trace-Renderer ist geladen,
'               der Ordner C:\Temp existiert.
' Ergebnis:     C:\Temp\Render.png mit 1280 x 720 Pixel, die Einstellungen stehen
'               im Direktfenster. Das Rendern kann einige Minuten dauern.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swRenderer As SldWorks.RayTraceRenderer
    Dim swOptionen As SldWorks.RayTraceRendererOptions

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    Set swRenderer = swApp.GetRayTraceRenderer(0)       ' die Hilfe nennt keine Konstante dafür
    If swRenderer Is Nothing Then
        Debug.Print "Kein Ray-Trace-Renderer geladen."
        Exit Sub
    End If

    Set swOptionen = swRenderer.RayTraceRendererOptions
    Debug.Print "Bisher: " & swOptionen.ImageWidth & " x " & swOptionen.ImageHeight & _
                " Pixel, Format " & swOptionen.ImageFormat & ", Qualität " & swOptionen.FinalRenderQuality

    swOptionen.ImageWidth = 1280
    swOptionen.ImageHeight = 720
    swOptionen.ImageFormat = swImageFormat_PNG
    swOptionen.FinalRenderQuality = swRenderQuality_Better
    swOptionen.BloomEnabled = False

    If swRenderer.RenderToFile("C:\Temp\Render", 0, 0) Then
        Debug.Print "Gespeichert: C:\Temp\Render.png"
    Else
        Debug.Print "Rendern fehlgeschlagen."
    End If
    swRenderer.CloseRayTraceRender
End Sub

Bemerkungen

Renderer holen: SldWorks.GetRayTraceRenderer erwartet einen Wert aus swRayTraceRenderType_e, die Hilfe führt dort aber keinen auf. Das Hilfebeispiel „Update Graphics Area After Changing Render Options“ übergibt 0, die übrigen Hilfebeispiele lassen die Zeile auskommentiert. Der Ray-Trace-Renderer muss in SOLIDWORKS geladen sein, das Beispiel „Render Model“ verlangt außerdem eine Premium-Lizenz.

Vorschau und endgültiges Rendern: Viele Effekte, etwa Bloom und direkte Kaustik, sieht man nur im endgültigen Rendern. Geänderte Einstellungen zeigst du vorher mit RayTraceRendererOptions.UpdateGraphics im Grafikbereich.

Abhängige Einstellungen: Die Einstellungen für Konturlinien und Cartoon-Stil gelten nur, wenn RayTraceRendererOptions.ContourCartoonRenderingEnabled True ist. Spiegelungen und Brechungen gelten nur mit RayTraceRendererOptions.CustomRenderSettings.

Netzwerk: Rendern auf mehreren Rechnern können nur Kunden mit SOLIDWORKS Subscription Services.

Veraltet: ContourEnabled ist durch RayTraceRendererOptions.ContourCartoonRenderingEnabled ersetzt.

Unvollständige Hilfe: Für ContourCartoonRenderingEnabled, IncludeAnnotationsInRendering, RenderAnnotationsToSeparateImage, UseSceneBackgroundImageAspectRatio und UseSolidWorksViewAspectRatio hat die Hilfe nur die VBA-Syntax und eine Zeile in der Mitgliederliste. Für die Bloom-, Kaustik- und Gammawerte nennt sie weder Einheit noch Bereich.

Eigenschaften und Methoden

Eigenschaften 35, davon 34 beschrieben, 1 veraltet

NameBeschreibung
AlphaOutputLiest oder setzt, ob der Ray-Trace-Renderer eine Alpha-Ausgabe erzeugt statt des Bilds in Endfarben.
BloomEnabledLiest oder setzt, ob der Ray-Trace-Renderer den Bloom-Effekt (Überstrahlen heller Stellen) anwendet.
BloomRadiusLiest oder setzt, wie weit der Bloom-Effekt von der Lichtquelle ausstrahlt.
BloomThresholdLiest oder setzt, ab welcher Helligkeit oder Leuchtkraft der Bloom-Effekt wirkt.
CausticAmountLiest oder setzt die größte Zahl ausgesandter Photonen und damit die Menge sichtbarer Kaustik.
CausticQualityLiest oder setzt die Zahl der Photonen, die je Pixel ausgewertet werden, und damit die Qualität der Kaustik.
ClientWorkloadLiest oder setzt, wie viele Buckets (Abschnitte des Renderns) jeder Client-Rechner beim Rendern im Netzwerk bekommt.
ContourCartoonRenderingEnabledLiest oder setzt, ob der Ray-Trace-Renderer mit Konturlinien oder im Cartoon-Stil rendert.
ContourEnabledveraltet ersetzt durch RayTraceRendererOptions.ContourCartoonRenderingEnabled
ContourLineColorLiest oder setzt die Farbe der Konturlinien als RGB-Wert.
ContourLineThicknessLiest oder setzt die Breite der Konturlinien in Pixel.
CustomRenderSettingsLiest oder setzt, ob eigene Render-Einstellungen gelten, mit denen du die Zahl der Spiegelungen und Brechungen festlegst.
DefaultImagePathLiest oder setzt den Standardpfad, unter dem das gerenderte Bild gespeichert wird.
DirectCausticsLiest oder setzt, ob das endgültige Rendern direkte Kaustik zeigt.
FinalRenderQualityLiest oder setzt die Qualität des endgültigen Renderns.
GammaLiest oder setzt den Gammawert, der die Mitteltöne des gerenderten Bilds aufhellt oder abdunkelt.
HasCartoonEdgesLiest oder setzt, ob der Ray-Trace-Renderer im Cartoon-Stil Kanten zeichnet.
HasCartoonShadingLiest oder setzt, ob der Ray-Trace-Renderer im Cartoon-Stil schattiert.
ImageFormatLiest oder setzt das Dateiformat des gerenderten Bilds.
ImageHeightLiest oder setzt die Höhe des gerenderten Bilds in Pixel.
ImageWidthLiest oder setzt die Breite des gerenderten Bilds in Pixel.
IncludeAnnotationsInRenderingLiest oder setzt, ob die im Modell sichtbaren Beschriftungen und Bemaßungen beim Rendern in eine Datei mitgerendert werden.
NetworkRenderingLiest oder setzt, ob auf mehreren Rechnern im Netzwerk gerendert wird.
NetworkSharedDirectoryLiest oder setzt das freigegebene Netzwerkverzeichnis für das Rendern im Netzwerk.
NumberOfReflectionsLiest oder setzt die Zahl der Spiegelungen im endgültigen Rendern.
NumberOfRefractionsLiest oder setzt die Zahl der Brechungen im endgültigen Rendern.
OffloadedRenderingLiest oder setzt, ob das Rendern an andere Rechner im Netzwerk abgegeben wird.
OutputAmbientOcclusionLiest oder setzt, ob der Ray-Trace-Renderer mit Umgebungsverdeckung (ambient occlusion) rendert.
PreviewRenderQualityLiest oder setzt die Qualität des Renderns im Vorschaufenster.
RenderAnnotationsToSeparateImageLiest oder setzt, ob die im Modell sichtbaren Beschriftungen und Bemaßungen in ein eigenes Bild gerendert werden.
RenderTypeLiest oder setzt, ob der Ray-Trace-Renderer mit Konturlinien oder im Cartoon-Stil rendert.
SendDataForNetworkJobLiest oder setzt, ob die Daten für das Rendern im Netzwerk übers Netzwerk geschickt werden statt über ein freigegebenes Verzeichnis.
ShadedContourLiest oder setzt, ob die Konturlinien schattiert werden.
UseSceneBackgroundImageAspectRatioLiest oder setzt, ob Vorschau und endgültiges Rendern das Seitenverhältnis des Hintergrundbilds der Szene verwenden.
UseSolidWorksViewAspectRatioLiest oder setzt, ob Vorschau und endgültiges Rendern das Seitenverhältnis der SOLIDWORKS-Ansicht verwenden.

Methoden 1, davon 1 beschrieben

NameBeschreibung
UpdateGraphicsAktualisiert den Grafikbereich, damit du geänderte Render-Einstellungen vor dem Rendern prüfen kannst.

Siehe auch

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

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