SolidWorksMakroprogrammierung

Methode · ModelDoc2

GetAmbientLightProperties-Methode (ModelDoc2)

Liest die Werte des Umgebungslichts.

Syntax

Function GetAmbientLightProperties( _
   ByVal Name As String, _
   ByRef Ambient As Double, _
   ByRef Diffuse As Double, _
   ByRef Specular As Double, _
   ByRef Colour As Long, _
   ByRef Enabled As Boolean, _
   ByRef Fixed As Boolean _
) As Boolean
bOk = swModel.GetAmbientLightProperties(sName, dUmg, dDiff, dGlanz, nFarbe, bAn, bFest)

Parameter

NameStringByVal
Name des Lichts.
AmbientDoubleByRef · Rückgabe
Gibt den Umgebungsanteil zurück.
DiffuseDoubleByRef · Rückgabe
Gibt den diffusen Anteil zurück.
SpecularDoubleByRef · Rückgabe
Gibt den Glanzanteil zurück.
ColourLongByRef · Rückgabe
Gibt die Farbe als COLORREF zurück.
EnabledBooleanByRef · Rückgabe
Gibt zurück, ob das Licht eingeschaltet ist.
FixedBooleanByRef · Rückgabe
Gibt zurück, ob das Licht fixiert ist.

Rückgabewert

True, wenn die Werte gelesen werden konnten.

Beispiel

' swModel ist das aktive Dokument.
Dim i As Long, sName As String
Dim dUmg As Double, dDiff As Double, dGlanz As Double
Dim nFarbe As Long, bAn As Boolean, bFest As Boolean
For i = 0 To swModel.GetLightSourceCount - 1
    sName = swModel.GetLightSourceName(i)
    If swModel.GetAmbientLightProperties(sName, dUmg, dDiff, dGlanz, nFarbe, bAn, bFest) Then
        Debug.Print sName & ": Umgebung " & dUmg & ", an = " & bAn
    End If
Next i

Bemerkungen

Die Hilfe sagt nicht, welcher Name gemeint ist. Das Beispiel nimmt den internen Namen aus ModelDoc2.GetLightSourceName und probiert alle Lichtquellen durch; nur beim Umgebungslicht kommt True zurück, das ist aber eine Annahme. COLORREF ist eine Zahl Rot + 256 × Grün + 65536 × Blau.

Der Befehl liefert nicht nur beim Umgebungslicht True, sondern auch bei gerichteten Lichtern samt Werten. Am Rückgabewert erkennst du die Art des Lichts also nicht.

Siehe auch

Verfügbarkeit

SOLIDWORKS 2001Plus

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

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