This functionality is provided as a preview
of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the
Fusion API and Scripts forum.
Because this is a preview of future functionality, there is the possibility that it will change, which will possibly
break any existing programs that use this functionality. Because of that, you should never deliver any programs that use
any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.
A photometric light models real-world luminaires using physical intensity units, a luminous distribution, and an emitter shape. The luminous distribution is represented by the LightDistribution object returned by the distribution property and the emitter shape by the LightShape object returned by the shape property. The remaining properties define the physically based intensity and color of the light, matching the inputs shown for photometric lights in the light editing command.
| Name | Description |
| classType |
Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType(). |
| copy |
Creates a copy of this light in the same collection. This is equivalent to the Copy command in the user interface. The new light has the same settings as this light and is given a unique name. |
| deleteMe |
Deletes the light. |
| setDistribution |
Sets the luminous distribution type of the light and returns the new LightDistribution object. Setting the distribution to Web requires a valid IES profile to be assigned through the returned WebLightDistribution. |
| setShape |
Sets the emitter shape type of the light and returns the new LightShape object. |
| Name | Description |
| colorMode | Gets and sets how the color of the light is defined, either by a color temperature (Kelvin) or by an explicit RGB color. When a photometric light is created, the default is KelvinPhotometricColorMode. |
| colorPreset | Gets and sets the standard illuminant preset used to define the color when the color mode is Kelvin. Use Custom to specify the temperature directly. When a photometric light is created, the default preset is CustomPhotometricColorPreset. |
| colorShift | Gets and sets the color shift applied to the light when the color mode is Kelvin. When a photometric light is created, the default is NonePhotometricColorShift. |
| direction | Gets and sets the direction the light is pointing, defined in world space. |
| distribution | Returns the object that defines the luminous distribution of the light. Down-cast the returned object to the type that matches its distributionType (for example, SpotLightDistribution or WebLightDistribution) to access type-specific properties. Use setDistribution to change the distribution type. When a photometric light is created, the default distribution is a UniformLightDistribution. |
| filterColor | Gets and sets the filter color applied to the light. The filter color tints the light regardless of the color mode. When a photometric light is created, the default filter color is white. Only the red, green, and blue components are used; the opacity component is ignored. |
| intensity | Gets and sets the photometric intensity value of the light, expressed in the unit returned by the intensityUnit property. When a photometric light is created, the default intensity is 1500.0 (candela). |
| intensityUnit | Gets and sets the unit used to interpret the intensity value. When a photometric light is created, the default unit is CandelaPhotometricIntensityUnit. |
| isSuppressed | Gets and sets whether the light is suppressed. A suppressed light does not contribute to the lighting of the scene. This corresponds to the Suppress and Unsuppress commands in the user interface. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| lightType | Returns the type of this light. Use this to safely down-cast to the matching derived light type (PointLight, DirectionalLight, SpotLight, or PhotometricLight). |
| name | Gets and sets the name of the light as it is displayed in the user interface. |
| objectType | This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object. It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType(): |
| position | Gets and sets the position of the light in world space. |
| rgbColor | Gets and sets the explicit RGB color of the light. This applies when the color mode is RGB. When a photometric light is created, the default color is white. Only the red, green, and blue components are used; the opacity component is ignored. |
| shape | Returns the object that defines the emitter shape of the light. Down-cast the returned object to the type that matches its shapeType (for example, LineLightShape or CylinderLightShape) to access its dimensions. Use setShape to change the shape type. When a photometric light is created, the default shape is a PointLightShape. |
| temperature | Gets and sets the color temperature in Kelvin. This applies when the color mode is Kelvin and the color preset is Custom. When a photometric light is created, the default temperature is 3500.0. |