docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class IlluminanceMsg

    ROS sensor_msgs/Illuminance message.

    Inheritance
    object
    IlluminanceMsg
    Implements
    IMessage
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.SimulationPro.Foundation.SensorMessages
    Assembly: Unity.SimulationPro.Foundation.dll
    Syntax
    [Serializable]
    public class IlluminanceMsg : IMessage

    Constructors

    IlluminanceMsg()

    0 is interpreted as variance unknown

    Declaration
    public IlluminanceMsg()

    IlluminanceMsg(HeaderMsg, double, double)

    Initializes a new instance with default values.

    Declaration
    public IlluminanceMsg(HeaderMsg header, double illuminance, double variance)
    Parameters
    Type Name Description
    HeaderMsg header

    ROS message header containing timestamp and coordinate frame identifier.

    double illuminance

    Measured illuminance in Lux.

    double variance

    Measurement variance; zero indicates unknown variance.

    Fields

    header

    Single photometric illuminance measurement. Light should be assumed to be measured along the sensor's x-axis (the area of detection is the y-z plane). The illuminance should have a 0 or positive value and be received with the sensor's +X axis pointing toward the light source. Photometric illuminance is the measure of the human eye's sensitivity of the intensity of light encountering or passing through a surface. All other Photometric and Radiometric measurements should not use this message. This message cannot represent:

    • Luminous intensity (candela/light source output)
    • Luminance (nits/light output per area)
    • Irradiance (watt/area), etc.
    Declaration
    public HeaderMsg header
    Field Value
    Type Description
    HeaderMsg

    illuminance

    timestamp is the time the illuminance was measured frame_id is the location and direction of the reading

    Declaration
    public double illuminance
    Field Value
    Type Description
    double

    k_MessageTypeId

    Identifier for this message type.

    Declaration
    public static readonly MessageTypeId k_MessageTypeId
    Field Value
    Type Description
    MessageTypeId

    k_MessageTypeName

    The ROS message type name string used for serialization and topic matching.

    Declaration
    public const string k_MessageTypeName = "sensor_msgs/Illuminance"
    Field Value
    Type Description
    string

    variance

    Measurement of the Photometric Illuminance in Lux.

    Declaration
    public double variance
    Field Value
    Type Description
    double

    Properties

    MessageTypeId

    Gets the unique runtime identifier for this message type.

    Declaration
    public MessageTypeId MessageTypeId { get; }
    Property Value
    Type Description
    MessageTypeId

    MessageTypeName

    Gets the ROS message type name for this message.

    Declaration
    public string MessageTypeName { get; }
    Property Value
    Type Description
    string

    Methods

    Deserialize(IMessageDeserializer)

    Deserializes a IlluminanceMsg from the given deserializer.

    Declaration
    public static IlluminanceMsg Deserialize(IMessageDeserializer deserializer)
    Parameters
    Type Name Description
    IMessageDeserializer deserializer

    The deserializer.

    Returns
    Type Description
    IlluminanceMsg

    A new IlluminanceMsg instance.

    Register()

    Registers this message type with the MessageTypeRegistry.

    Declaration
    [InitializeOnLoadMethod]
    public static void Register()

    ToString()

    Returns a human-readable string representation of this message.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string representation of this instance.

    Overrides
    object.ToString()

    WriteTo(IMessageSerializer)

    Serializes this message to the given serializer.

    Declaration
    public void WriteTo(IMessageSerializer serializer)
    Parameters
    Type Name Description
    IMessageSerializer serializer

    The serializer.

    Implements

    IMessage
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)