Package com.openinventor.inventor.nodes

Class SoQuadAreaLight

java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.inventor.misc.SoBase
com.openinventor.inventor.fields.SoFieldContainer
com.openinventor.inventor.nodes.SoNode
com.openinventor.inventor.nodes.SoLight
com.openinventor.inventor.nodes.SoQuadAreaLight
All Implemented Interfaces:
SafeDisposable
public class SoQuadAreaLight extends SoLight
Node representing a rectangular area light source. This node defines a light source that covers a rectangular area.

As a light source node, this node affects subsequent shapes in the scene graph, depending on the current lighting model. The current transformation affects this node, and you can place it inside a SoSeparator node to avoid affecting any objects outside that SoSeparator.

You can also use a node kit to create a light; see the reference page for SoLightKit.

Unlike other light nodes, SoQuadAreaLight only supports the SoLightModel.PHYSICALLY_BASED lighting model. This node has no effect on the rendering if any another lighting model is simultaneously used.

Use the color and intensity fiels to control the color and intensity of the light.

The location, orientation, width, and height fields define the geometry of the rectangular area covered by the light.

The twoSided field defines whether or not to use both sides of the rectangular area as a source of illumination.

File format/default:

QuadAreaLight {

    on true
    intensity 1
    color 1 1 1
    location 0 0 0
    orientation 0 0 1 0
    width 1
    height 1
    twoSided false
}

Action behavior:

SoGLRenderAction
Activates this light (if so specified) during traversal. All shape nodes that come after this light in the scene graph are illuminated by this light. The current transformation affects the light's direction. Sets: SoLightElement, SoLightIdElement

Since:
Open Inventor 2025.1

See Also:

  • Field Details

    • location

      public final SoSFVec3f location
      Location of the source (center of the area). Default is (0, 0, 0).

    • orientation

      public final SoSFRotation orientation
      Principal orientation of illumination (normal vector of the area), defined as a SoSFRotation object. The actual direction of illumination is the vector obtained after applying this rotation to its default (0, 0, -1) vector.

      See SoSFRotation and SbRotation for more details.

    • width

      public final SoSFFloat width
      Width of the area. Default is 1.

    • height

      public final SoSFFloat height
      Height of the area. Default is 1.

    • twoSided

      public final SoSFBool twoSided
      Two-Sided illumination. When true, this enables illumination on both sides of the area.

      Default is false

  • Constructor Details

    • SoQuadAreaLight

      public SoQuadAreaLight()
      Creates an area light source node with default settings.