EikonalWorks User's Manual
  • Workbench
  • IntensityView
  • Core Calculations
Search Results for

    Show / Hide Table of Contents
    • Overview and Client Examples
    • Complete Agent Reference
    • File Input and Output
      • OpenFile
      • SaveFile
      • RemoveLid
    • Queries
      • GetParameter
      • GetProperty
      • GetPropertyField
    • Properties and Flux
      • SetProperty
      • SetLuminousFlux
      • SetLampFlux
      • SetLampNumber
      • SetInputPower
      • SetEmitterLOR
      • SetPhotometryUnit
    • Photometric Transforms
      • SetSymmetryData
      • SetResolution
      • RotateEuler
      • RotateQuaternion
      • Scale
      • AutoAlignPhotometry
      • Smoothen
    • Geometry
      • SetGeometry
    • Luminaire and Channel Management
      • ConfigureLuminaire
      • DuplicateLuminaire
      • MoveMesh
      • RemoveMesh
      • Combine
    • Map Modification
      • PaintBrush
      • FillSelection
      • ScaleAdd
      • CloneTool
      • ApplyTransform
    • Roadway Scenarios
      • LoadRoadwayScenarioFile
      • SaveRoadwayScenarioFile
    • View
      • SetCoordinateSystem
    • Session and History
      • Undo
      • Redo
      • StartCommandServer
      • StopCommandServer

    ConfigureLuminaire

    Rename a parent luminaire and set channel contribution percentages.

    Undo support: Registered as undoable; see limitations below.

    Syntax

    ConfigureLuminaire <luminaireId> "<alias>" [<channel1Percent> <channel2Percent> ...]
    

    Parameters

    Use a parent ID, a nonempty alias and optional finite nonnegative percentages in existing channel order. Do not supply more percentages than channels; omitted channels retain their values.

    Example

    ConfigureLuminaire 4 "Road luminaire" 100 50
    

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

    Response

    OK or an error for invalid configuration.

    Notes

    Percentages use 100 for full contribution. This does not rename individual channel aliases. Confirm the parent and channel order before updating.

    Implementation: EikonalWorksTools/EWIntensityView/src/actions/ui/LuminaireConfiguratorAction.h.

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

    In this article
    Back to top Generated by DocFX