Hide Table of Contents
GetAmbientLightProperties Method (IModelDoc2)

Gets the ambient light properties for this model document.

.NET Syntax

Visual Basic (Declaration) 
Function GetAmbientLightProperties( _
   ByVal Name As String, _
   ByRef Ambient As Double, _
   ByRef Diffuse As Double, _
   ByRef Specular As Double, _
   ByRef Colour As Integer, _
   ByRef Enabled As Boolean, _
   ByRef Fixed As Boolean _
) As Boolean
Visual Basic (Usage) 
Dim instance As IModelDoc2
Dim Name As String
Dim Ambient As Double
Dim Diffuse As Double
Dim Specular As Double
Dim Colour As Integer
Dim Enabled As Boolean
Dim Fixed As Boolean
Dim value As Boolean
 
value = instance.GetAmbientLightProperties(Name, Ambient, Diffuse, Specular, Colour, Enabled, Fixed)
C# 
bool GetAmbientLightProperties( 
   string Name,
   ref double Ambient,
   ref double Diffuse,
   ref double Specular,
   ref int Colour,
   ref bool Enabled,
   ref bool Fixed
)
C++/CLI 
bool GetAmbientLightProperties( 
&   String^ Name,
&   double% Ambient,
&   double% Diffuse,
&   double% Specular,
&   int% Colour,
&   bool% Enabled,
&   bool% Fixed
)

Parameters

Name

Light name

Ambient

Light source ambient value

Diffuse

Light source diffuse value

Specular

Light source specular value

Colour

COLORREF color value

Enabled

True if a light is enabled, false if not

Fixed

True if a light is fixed, false if not

Return Value

True if light properties determined without a problem, 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:   GetAmbientLightProperties 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) 2012 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.

0.20.26