MAXScript Language Reference > 3ds Max Objects > Node : MAXWrapper > Node Subclasses > Helper : Node > Helper - Standard >

# LightMeter : Helper

    LightMeter - superclass: helper; super-superclass:node - 9:0 - classID: #(-2088554037, -1774534477)

Value > MAXWrapper > Node > Helper > LightMeter

| Helpers - Quick Navigation

The LightMeterHelper allows the generation of lighting analysis data on a custom grid in world space. It works in conjunction with the Lighting_Analysis_Overlay : RenderEffect

Note

This feature is exposed in 3ds Max Design only.

Scenes saved from 3ds Max Design will open and render correctly in 3ds Max, but you cannot construct class instances via MAXScript in 3ds Max.

3ds Max Design Constructor:

    LightMeter...

3ds Max Constructor:

    Class Instances not creatable in 3ds Max

Properties:

## Parameters

    <LightMeter>.active BooleanClass default: true -- Boolean

Get/set the state of the On checkbox.

### Dimensions

    <LightMeter>.length Float default: 1.0 -- animatable; worldUnits

Get/set the Lengthof the LightMeter.

    <LightMeter>.width Float default: 1.0 -- animatable; worldUnits

Get/set the Width of the LightMeter.

    <LightMeter>.length_segs Integer default: 3 -- integer

Get/set the Length Segments of the LightMeter.

    <LightMeter>.width_segs Integer default: 3 -- integer

Get/set the Width Segments of the LightMeter.

## Display

    <LightMeter>.showOrientation BooleanClass default: true -- boolean; Show_Orientation

Get/set the state of the Show Orientation checkbox.

    <LightMeter>.showPsuedoColor BooleanClass default: true -- boolean; Show_Pseudo_Color

Get/set the state of the Show Pseudo Color checkbox.

    <LightMeter>.showViewportText BooleanClass default: true -- boolean; Show_Viewport_Text

Get/set the state of the Show Viewport Text checkbox.

### Values To Display

    <LightMeter>.valuesToDisplay Integer default: 0 -- integer; Values_To_Display

Get/set the selection of the Values To Display radio buttons list.

Possible values are:

0 -Total Illuminance(default)

1 -Direct Illuminance

2 -Indirect Illuminance

3 - Daylight Factor

### Calculate and Export Buttons

The functionality of the Calculate and Export to CSV buttons is exposed by the Interface: LightMeterManager

## LightMeter interfaces:

Interface:lightMeterInterface

Methods:

    <bool>GetIlluminance <time>time <index>index <&float>illuminance
    illuminance is In and Out parameter

GetstheTotalIlluminance at the given time and indexed point into the by-reference third parameter.Returns true on success, false on failure.

    <bool>GetDirectIlluminance <time>time <index>index <&float>directIlluminance
    directIlluminance is In and Out parameter

Gets the Direct Illuminance at the given time and indexed point into the by-reference third parameter. Returns true on success, false on failure.

    <bool>GetIndirectIlluminance <time>time <index>index <&float>indirectIlluminance
    indirectIlluminance is In and Out parameter

Gets the Indirect Illuminance at the given time and indexed point into the by-reference third parameter. Returns true on success, false on failure.

    <bool>GetDaylightFactor <time>time <index>index <&float>daylightFactor
    daylightFactor is In and Out parameter

Gets the DaylightFactor at the given time and indexed point into the by-reference third parameter. Returns true on success, false on failure.

    <bool>GetMeterTransform <time>time <index>index <&matrix3>transform
    transform is In and Outparameter

Gets the LightMeter Transformation Matrix at the given time and indexed point into the by-reference third parameter. Returns true on success, false on failure.

    <bool>GetLocalMeterPosition <index>index <&point3>position
    position is In and Outparameter

Gets the Local Position of the indexed point into the by-reference second parameter. Returns true on success, false on failure.

#### See Also

- Interface: LightMeterManager

- Lighting Analysis and Daylight Simulation Tools