SetPhotometryUnit

Request a photometry-unit change through the registered action.

Undo support: Registered as undoable; see limitations below.

Syntax

SetPhotometryUnit <emitterId> [<emitterId> ...] -> <lm|mW|W|PAR>

Parameters

Unit tokens are case-insensitive. PAR denotes the photon-flux unit used by the application.

Example

SetPhotometryUnit 12 -> lm

Example IDs are placeholders; replace them with IDs from your current session.

Response

Can return OK without changing the unit.

Notes

Current limitation: IntensityMesh::SetPhotometryUnit has an empty implementation. This command does not perform a unit change or physical conversion. Never use it to convert watts to lumens.

Implementation: EikonalWorksTools/EWIntensityView/src/actions/edit/SetPhotometryUnitAction.h.

See API connection, grammar and client examples for quoting, error handling and model IDs.