Gets the spotlight properties.
.NET Syntax
| Visual Basic (Declaration) | |
|---|
Function GetSpotlightProperties( _
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, _
ByRef X As Double, _
ByRef Y As Double, _
ByRef Z As Double, _
ByRef Targetx As Double, _
ByRef Targety As Double, _
ByRef Targetz As Double, _
ByRef ConeAngle As Double _
) 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 X As Double
Dim Y As Double
Dim Z As Double
Dim Targetx As Double
Dim Targety As Double
Dim Targetz As Double
Dim ConeAngle As Double
Dim value As Boolean
value = instance.GetSpotlightProperties(Name, Ambient, Diffuse, Specular, Colour, Enabled, Fixed, X, Y, Z, Targetx, Targety, Targetz, ConeAngle)
|
| C# | |
|---|
bool GetSpotlightProperties(
string Name,
ref double Ambient,
ref double Diffuse,
ref double Specular,
ref int Colour,
ref bool Enabled,
ref bool Fixed,
ref double X,
ref double Y,
ref double Z,
ref double Targetx,
ref double Targety,
ref double Targetz,
ref double ConeAngle
) |
| C++/CLI | |
|---|
bool GetSpotlightProperties(
& String^ Name,
& double% Ambient,
& double% Diffuse,
& double% Specular,
& int% Colour,
& bool% Enabled,
& bool% Fixed,
& double% X,
& double% Y,
& double% Z,
& double% Targetx,
& double% Targety,
& double% Targetz,
& double% ConeAngle
) |
Parameters
- Name
- Light name used internally (returned by IModelDoc2::GetLightSourceName)
- 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
- X
x location of the spot light
- Y
y location of the spot light
- Z
- location of the spot light target
- Targetx
- x location of the spot light target
- Targety
y location of the spot light target
- Targetz
z location of the spot light target
- ConeAngle
Cone angle through which the beam spreads in degrees
Return Value
True if light properties determined without a problem, false if not
See Also
Availability
SolidWorks 2001Plus FCS, Revision Number 10.0