Click or drag to resize
Light Properties

The Light type exposes the following members.

Properties
  NameDescription
Public propertyAmbient
Gets or sets the ambient color.
Public propertyAttenuationVector
Gets or Sets the attenuation vector.
Public propertyCoordinateSystem
Gets a value, determined by LightStyle, that explains whether the camera diretions are relative to World or Camera spaces.
Public propertyCode exampleDiffuse
Gets or sets the diffuse color.
Public propertyDirection
Gets or sets the vector direction of the camera.
Public propertyHasBrepForm
Returns true if the Brep.TryConvertBrep function will be successful for this object
(Inherited from GeometryBase.)
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
Public propertyHotSpot
The hot spot setting runs from 0.0 to 1.0 and is used to provides a linear interface for controling the focus or concentration of a spotlight. A hot spot setting of 0.0 corresponds to a spot exponent of 128. A hot spot setting of 1.0 corresponds to a spot exponent of 0.0.
Public propertyIntensity
Gets or sets the light intensity.
Public propertyIsDeformable
true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
(Inherited from GeometryBase.)
Public propertyIsDirectionalLight
Gets a value indicating whether the light style is LightStyle CameraDirectional or WorldDirectional.
Public propertyIsDocumentControlled
If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.
(Inherited from GeometryBase.)
Public propertyIsEnabled
Gets or sets a value that defines if the light is turned on (true) or off (false).
Public propertyIsLinearLight
Gets a value indicating whether the light style is LightStyle WorldLinear.
Public propertyIsPointLight
Gets a value indicating whether the light style is LightStyle CameraPoint or WorldPoint.
Public propertyIsRectangularLight
Gets a value indicating whether the light style is LightStyle WorldRectangular.
Public propertyIsSpotLight
Gets a value indicating whether the light style is LightStyle CameraSpot or WorldSpot.
Public propertyIsSunLight
Gets a value indicating whether this object is a Sun light.
Public propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyLength
Gets or sets the height in linear and rectangular lights.

(ignored for non-linear/rectangular lights.)

Public propertyLightStyle
Gets or sets a light style on this camera.
Public propertyLocation
Gets or sets the light or 3D position or location.
Public propertyName
Gets or sets the spot light name.
Public propertyObjectType
Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
(Inherited from GeometryBase.)
Public propertyPerpendicularDirection
Gets a perpendicular vector to the camera direction.
Public propertyPowerCandela
Gets or sets the light power in candelas (cd).
Public propertyPowerLumens
Gets or sets the light power in lumens (lm).
Public propertyPowerWatts
Gets or sets the light power in watts (W).
Public propertySpecular
Gets or sets the specular color.
Public propertySpotAngleRadians
Gets or sets the spot angle in radians.

Ignored for non-spot lights.

angle = 0 to pi/2 (0 to 90 degrees).

Public propertySpotExponent
The spot exponent varies from 0.0 to 128.0 and provides an exponential interface for controling the focus or concentration of a spotlight (like the OpenGL GL_SPOT_EXPONENT parameter). The spot exponent and hot spot parameters are linked; changing one will change the other. A hot spot setting of 0.0 corresponds to a spot exponent of 128. A hot spot setting of 1.0 corresponds to a spot exponent of 0.0.
Public propertySpotLightShadowIntensity
Gets or sets the spot light shadow intensity.

(ignored for non-spot lights.)

Public propertyUserData
List of custom information that is attached to this class.
(Inherited from CommonObject.)
Public propertyUserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use sharable set of information.
(Inherited from CommonObject.)
Public propertyUserStringCount
Gets the amount of user strings.
(Inherited from GeometryBase.)
Public propertyWidth
Gets or sets the width in linear and rectangular lights.

(ignored for non-linear/rectangular lights.)

Top
See Also