LightType Enumeration — NXOpen Python API Reference 12.0.0 documentation

# LightType Enumeration

class `NXOpen.``LightType`

  Bases: `object`

  The type of a light. For now, you can only modify lights of type `LightType.Scene` via automation languages.

  This class is restricted to being called from a program running during an Interactive NX session. If run from a non-interactive session it will return None.

  Enum Members

  Enum Member | Enum Member Description
  --- | ---
  Ambient | An ambient light provides global illumination for the scene. It does not cause shadows, and illuminates all objects equally regardless of the orientation. You can control the intensity and color.
  Distant | A distant light can be thought of as being located for all practical purposes infinitely far away, such as the sun. You can control the intensity, color, and a vector that defines the direction of the light. A distant light can cast shadows in High Quality Images and requires the computation to determine shadowing.
  Eye | An eye light is Located at the viewpoint or directly on the Z axis of the screen. You can control the color and intensity. An eye light cannot cause shadows in your scene.
  Point | A point light emits light equally in all directions. You can specify the location, intensity, and color. You can also set it to generate shadows in High Quality Images. The default position for point lights is in the right-hand corner of the view.
  Spot | A spot light is the same as a point light, except that it is constrained by a cone shape. You can specify the location, intensity, and color. You can also set it to generate shadows in High Quality Images. The default light source position for spot lights is in the upper right corner of the view. The default target position is the center of the view.
  Scene | A scene lights is a light whose parameters, except for intensity, are fixed. Interactively, these lights may be modified only in the Basic Lights dialog, while the other light types may be modified only in the Advanced Lights dialog.

  `ValueOf`()

    Returns enum member equivalent to the value passed. Useful for bit operations of enum members.

    Signature `ValueOf(value)`

    Parameters: | value – Any integer value or bit operation result of enum members:type value: int:returns: Enum member equivalent to the value passed.
    Return type: | Enum Member type.

    New in version NX9.0.1.

    License requirements: None.