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.
Provides access to the lights used by the scene and supports creating new lights.
| Name | Description |
| addDirectionalLight |
Creates a new directional light pointing in the specified direction. |
| addPhotometricLight |
Creates a new photometric light at the specified position, pointing in the specified direction. |
| addPointLight |
Creates a new point light at the specified position. |
| addSpotLight |
Creates a new spot light at the specified position, pointing in the specified direction. |
| 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(). |
| item |
Function that returns the specified light using an index into the collection. |
| itemByName |
Returns the light with the specified name, as the name is displayed in the user interface. |
| Name | Description |
| count | The number of lights in the collection. |
| isLightBulbOn | Gets and sets whether the light bulb for the Lights folder is on. This corresponds to the Show/Hide light bulb toggle on the Lights folder in the browser, which controls whether the lights in the collection are displayed. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| 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(): |