docs.unity3d.com
    Show / Hide Table of Contents

    Class BeamLight

    Provides ports to describe a laser light used inside a sensor device.

    Inheritance
    Object
    NodeRuntime
    BeamLight
    Inherited Members
    NodeRuntime._parent
    NodeRuntime._portList
    NodeRuntime._queryPath
    NodeRuntime._tickCPUTimeNs
    NodeRuntime.Initialize(SystemGraphComponent)
    NodeRuntime.InternalInitialize()
    NodeRuntime.Start()
    NodeRuntime.OnTick(Double, Double, Scheduler.ClockState, Scheduler.Signal)
    NodeRuntime.Update()
    NodeRuntime.FixedUpdate()
    NodeRuntime.OnPortAdded(String, Type, String, PortDirection, FieldExtra, IPortType)
    NodeRuntime.OnPortRemoved(String)
    NodeRuntime.InitializeDynamicPorts(SystemGraphComponent)
    NodeRuntime.QueryPath
    NodeRuntime.TickCPUTimeNs
    NodeRuntime.PortDataList
    Namespace: Mechatronics.SensorSDK
    Syntax
    [NodeCategory("Light", "Beam light", NodeTick.Asynchronous, (LifeCycle)0, 0F, NodeMode.Standard, false)]
    public class BeamLight : NodeRuntime

    Fields

    beamWidth

    Declaration
    [Tooltip("The width of the beam leaving the sensor in milimeters.")]
    [Field("Beam Width", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<float> beamWidth
    Field Value
    Type Description
    PortType<Single>

    diameter

    Declaration
    [Tooltip("The source is a disk.  The ray are emitted uniformly on this disk.  0 mean a single point.")]
    [Field("Diameter", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<float> diameter
    Field Value
    Type Description
    PortType<Single>

    divergence

    Declaration
    [Tooltip("How much the light diverge from the source disk.")]
    [Field("Divergence", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<float> divergence
    Field Value
    Type Description
    PortType<Single>

    power

    Declaration
    [Tooltip("Define the beam power in watts.")]
    [Field("Power", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<float> power
    Field Value
    Type Description
    PortType<Single>

    waveLength

    Declaration
    [Tooltip("Define the light wave length.  Photo detector with different wave length will filter this out.")]
    [Field("WaveLength", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<uint> waveLength
    Field Value
    Type Description
    PortType<UInt32>

    Methods

    Disable()

    Remove the beam light by adding it to the global list of beam light.

    Declaration
    public override void Disable()
    Overrides
    NodeRuntime.Disable()

    Enable(Scheduler.ClockState)

    Enable the beam light by adding it to the global list of beam light.

    Declaration
    public override void Enable(Scheduler.ClockState clockState)
    Parameters
    Type Name Description
    Scheduler.ClockState clockState

    No used.

    Overrides
    NodeRuntime.Enable(Scheduler.ClockState)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023