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 spot light emits light from a position in a direction within a cone.
| 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. |
| Name | Description |
| attenuationType | Gets and sets how the light falls off with distance. When a light is created, the default is ConstantLightAttenuationType. |
| color | Gets and sets the color of the light. This is the primary color the light contributes. When a light is created, the default color is white. Only the red, green, and blue components of the color are used for lighting; the opacity component is ignored. |
| direction | Gets and sets the direction the light is pointing, defined in world space. |
| falloffConeAngle | Gets and sets the falloff cone angle of the spot light, in radians. The light fades to zero between the hotspot and falloff cone angles. When a spot light is created, the default falloff cone angle is 1.0 radians. |
| hotspotConeAngle | Gets and sets the hotspot cone angle of the spot light, in radians. Within this angle the light is at full intensity. When a spot light is created, the default hotspot cone angle is 0.5 radians. |
| intensity | Gets and sets the intensity multiplier of the light. When a light is created, the default intensity is 1.0. |
| 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. |