docs.unity3d.com
    Show / Hide Table of Contents

    Class IScanPattern

    The role of this class is to provide a common interface for all type of scan pattern so the user can set the scan patter he wants on an input port.

    Inheritance
    Object
    NodeRuntime
    IScanPattern
    Inherited Members
    NodeRuntime._parent
    NodeRuntime._portList
    NodeRuntime._queryPath
    NodeRuntime._tickCPUTimeNs
    NodeRuntime.Initialize(SystemGraphComponent)
    NodeRuntime.InternalInitialize()
    NodeRuntime.Start()
    NodeRuntime.Disable()
    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("Interface", "IScanPattern", NodeTick.Asynchronous, (LifeCycle)0, 0F, NodeMode.Standard, false)]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.sensorsdk@1.0/manual/DeveloperGuide/ScanPattern.html")]
    public class IScanPattern : NodeRuntime

    Fields

    resolution

    Declaration
    [Tooltip("Number of samples that define the sweep orientation.")]
    [Field("Resolution", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<uint> resolution
    Field Value
    Type Description
    PortType<UInt32>

    samples

    Declaration
    [Tooltip("A sampled curve that represent the sweep orientation.")]
    [Field("Sampled Curve", PortDirection.Right, FieldExtra.Write)]
    [SerializeField]
    public PortTypeCurveSampleQuaternion samples
    Field Value
    Type Description
    PortTypeCurveSampleQuaternion

    scanPattern

    Binding with the pattern implementation.

    Declaration
    [Binding("Pattern Implementation")]
    [SerializeField]
    public Binding<ScanPatternHandler> scanPattern
    Field Value
    Type Description
    Binding<ScanPatternHandler>

    sweepFrequency

    Declaration
    [Tooltip("The number of time the scan pattern complete a cycle per second.")]
    [Field("Sweep Frequency(Hz)", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<float> sweepFrequency
    Field Value
    Type Description
    PortType<Single>

    timeOffset

    Declaration
    [Tooltip("Time in second before starting a cycle.")]
    [Field("Time Offset(s)", PortDirection.Left, FieldExtra.Read)]
    [SerializeField]
    protected PortType<float> timeOffset
    Field Value
    Type Description
    PortType<Single>

    Methods

    Enable(Scheduler.ClockState)

    Initialize the sampled curved of the sweep orientation.

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

    The parameters of the waveform associated to this node

    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