Hide Table of Contents
SetSpotlightProperties Method (IModelDoc2)

Sets the spotlight properties.

.NET Syntax

Visual Basic (Declaration) 
Function SetSpotlightProperties( _
   ByVal Name As System.String, _
   ByVal Ambient As System.Double, _
   ByVal Diffuse As System.Double, _
   ByVal Specular As System.Double, _
   ByVal Colour As System.Integer, _
   ByVal Enabled As System.Boolean, _
   ByVal Fixed As System.Boolean, _
   ByVal Posx As System.Double, _
   ByVal Posy As System.Double, _
   ByVal Posz As System.Double, _
   ByVal Targetx As System.Double, _
   ByVal Targety As System.Double, _
   ByVal Targetz As System.Double, _
   ByVal 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 Posx As System.Double
Dim Posy As System.Double
Dim Posz 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.SetSpotlightProperties(Name, Ambient, Diffuse, Specular, Colour, Enabled, Fixed, Posx, Posy, Posz, Targetx, Targety, Targetz, ConeAngle)
C# 
System.bool SetSpotlightProperties( 
   System.string Name,
   System.double Ambient,
   System.double Diffuse,
   System.double Specular,
   System.int Colour,
   System.bool Enabled,
   System.bool Fixed,
   System.double Posx,
   System.double Posy,
   System.double Posz,
   System.double Targetx,
   System.double Targety,
   System.double Targetz,
   System.double ConeAngle
)
C++/CLI 
System.bool SetSpotlightProperties( 
&   System.String^ Name,
&   System.double Ambient,
&   System.double Diffuse,
&   System.double Specular,
&   System.int Colour,
&   System.bool Enabled,
&   System.bool Fixed,
&   System.double Posx,
&   System.double Posy,
&   System.double Posz,
&   System.double Targetx,
&   System.double Targety,
&   System.double Targetz,
&   System.double ConeAngle
) 

Parameters

Name

Light name to modify

Ambient

Light source ambient value

Diffuse

Light source diffuse value

Specular

Light source specular value

Colour

COLORREF color value

Enabled

True to enable light, false to not

Fixed

True to fix light, false to not

Posx

x location of the spotlight

Posy

y location of the spotlight

Posz

z location of the spotlight

Targetx

x location of the spotlight target

Targety

y location of the spotlight target

Targetz

z location of the spotlight target

ConeAngle

Cone angle through which the beam spreads in degrees

Return Value

True if light properties are modified, false if not

 

See Also

Availability

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

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SetSpotlightProperties Method (IModelDoc2)
*Comment:  
*   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:



x

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
x

Web Help Content Version: API Help (English only) 2017 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.