Hide Table of Contents

Get and Set Sunlight Source Property Values Example (C#)

This example shows how to get and set sunlight properties.


// Preconditions:

// 1. Open a part with a sunlight source.

// 2. Open an Immediate window.


// Postconditions: Inspect the Immediate window for the sunlight properties.

// ---------------------------------------------------------------------------

using Microsoft.VisualBasic;

using System;

using System.Collections;

using System.Collections.Generic;

using System.Data;

using System.Diagnostics;

using SolidWorks.Interop.sldworks;

using SolidWorks.Interop.swconst;

using System.Runtime.InteropServices;

namespace SunlightProperties_CSharp.csproj


partial class SolidWorksMacro


ModelDoc2 swModelDoc;

ModelDocExtension swModelDocExt;

bool retval;

MathVector NorthDirection;

string DateTime;

object vVector;

double[] nVector = new double[3];

MathUtility swMathUtil;

double NorthLatitude;

double EastLongitude;

double TimeZone;

double Haze;

double SunDiameter;

int GroundAlbedo;

double SkyGamma;

public void Main()


swModelDoc = (ModelDoc2)swApp.ActiveDoc;

swModelDocExt = swModelDoc.Extension;

//Get sunlight properties

retval = swModelDocExt.GetSunLightSourcePropertyValues(out NorthDirection, out NorthLatitude, out EastLongitude, out TimeZone, out DateTime);

retval = swModelDocExt.GetSunLightAdvancedPropertyValues(out Haze, out SunDiameter, out GroundAlbedo, out SkyGamma);

Debug.Print("North direction: " + ((double[])(NorthDirection.ArrayData))[0] + "," + ((double[])(NorthDirection.ArrayData))[1] + "," + ((double[])(NorthDirection.ArrayData))[2]);

Debug.Print("North latitude: " + NorthLatitude);

Debug.Print("East longitude: " + EastLongitude);

Debug.Print("Time zone: " + TimeZone);

Debug.Print("Date and time: " + DateTime);

Debug.Print("Haze (0.0 - 1.0): " + Haze);

Debug.Print("Sun diameter (0.01 - 21474836.47): " + SunDiameter);

Debug.Print("RGB for ground albedo: " + GroundAlbedo);

Debug.Print("Sky Gamma (0.1 = 100.0): " + SkyGamma);

Debug.Print("Minutes of sunlight: " + swModelDocExt.get_SunLightInformation((int)swSunlightInfoType_e.swSunlight_LengthOfDay));

Debug.Print("Sunrise (hours from midnight): " + swModelDocExt.get_SunLightInformation((int)swSunlightInfoType_e.swSunlight_Sunrise));

Debug.Print("Sunset (hours from midnight): " + swModelDocExt.get_SunLightInformation((int)swSunlightInfoType_e.swSunlight_Sunset));

//Set sunlight source property values

swMathUtil = (MathUtility)swApp.GetMathUtility();

nVector[0] = 1;

nVector[1] = 0;

nVector[2] = 0;

vVector = nVector;

NorthDirection = (MathVector)swMathUtil.CreateVector((vVector));

DateTime = "11/9/2012 2:48:13 PM";

NorthLatitude = NorthLatitude + 0.1;

EastLongitude = EastLongitude + 0.1;

TimeZone = TimeZone + 0.5;

retval = swModelDocExt.SetSunLightSourcePropertyValues(NorthDirection, NorthLatitude, EastLongitude, TimeZone, DateTime);


     public SldWorks swApp;



Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

Subject:   Feedback on Help Topics
Page:   Get and Set Sunlight Source Property Values Example (C#)
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:


We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again

Web Help Content Version: API Help (English only) 2018 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.