Hide Table of Contents
GetSpotlightProperties Method (IModelDoc2)

Gets the spotlight properties.

.NET Syntax

Visual Basic (Declaration) 
Function GetSpotlightProperties( _
   ByVal Name As System.String, _
   ByRef Ambient As System.Double, _
   ByRef Diffuse As System.Double, _
   ByRef Specular As System.Double, _
   ByRef Colour As System.Integer, _
   ByRef Enabled As System.Boolean, _
   ByRef Fixed As System.Boolean, _
   ByRef X As System.Double, _
   ByRef Y As System.Double, _
   ByRef Z As System.Double, _
   ByRef Targetx As System.Double, _
   ByRef Targety As System.Double, _
   ByRef Targetz As System.Double, _
   ByRef ConeAngle As System.Double _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IModelDoc2
Dim Name As System.String
Dim Ambient As System.Double
Dim Diffuse As System.Double
Dim Specular As System.Double
Dim Colour As System.Integer
Dim Enabled As System.Boolean
Dim Fixed As System.Boolean
Dim X As System.Double
Dim Y As System.Double
Dim Z As System.Double
Dim Targetx As System.Double
Dim Targety As System.Double
Dim Targetz As System.Double
Dim ConeAngle As System.Double
Dim value As System.Boolean
value = instance.GetSpotlightProperties(Name, Ambient, Diffuse, Specular, Colour, Enabled, Fixed, X, Y, Z, Targetx, Targety, Targetz, ConeAngle)
System.bool GetSpotlightProperties( 
   System.string Name,
   ref System.double Ambient,
   ref System.double Diffuse,
   ref System.double Specular,
   ref System.int Colour,
   ref System.bool Enabled,
   ref System.bool Fixed,
   ref System.double X,
   ref System.double Y,
   ref System.double Z,
   ref System.double Targetx,
   ref System.double Targety,
   ref System.double Targetz,
   ref System.double ConeAngle
System.bool GetSpotlightProperties( 
&   System.String^ Name,
&   System.double% Ambient,
&   System.double% Diffuse,
&   System.double% Specular,
&   System.int% Colour,
&   System.bool% Enabled,
&   System.bool% Fixed,
&   System.double% X,
&   System.double% Y,
&   System.double% Z,
&   System.double% Targetx,
&   System.double% Targety,
&   System.double% Targetz,
&   System.double% ConeAngle


Light name used internally (returned by IModelDoc2::GetLightSourceName)

Light source ambient value


Light source diffuse value


Light source specular value


COLORREF color value


True if a light is enabled, false if not


True if a light is fixed, false if not


x location of the spot light


y location of the spot light

location of the spot light target
x location of the spot light target

y location of the spot light target


z location of the spot light target


Cone angle through which the beam spreads in degrees

Return Value

True if light properties determined without a problem, false if not


See Also


SOLIDWORKS 2001Plus FCS, Revision Number 10.0

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:   GetSpotlightProperties Method (IModelDoc2)
*   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) 2016 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.