docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class PointCloudVisualizerSettings

    ScriptableObject settings for the PointCloud visualizer. Mirrors the channel and color-mode configuration of PointCloud2VisualizerSettings for the legacy sensor_msgs/PointCloud message type.

    Inheritance
    object
    Object
    ScriptableObject
    VisualizerSettingsGeneric<PointCloudMsg>
    PointCloudVisualizerSettings
    Inherited Members
    VisualizerSettingsGeneric<PointCloudMsg>.MessageTypeName
    VisualizerSettingsGeneric<PointCloudMsg>.m_TFTrackingSettings
    VisualizerSettingsGeneric<PointCloudMsg>.TFTrackingSettings
    VisualizerSettingsGeneric<PointCloudMsg>.CreateGUI(PointCloudMsg, MessageMetadata)
    VisualizerSettingsGeneric<PointCloudMsg>.Draw(Drawing3d, PointCloudMsg, MessageMetadata, Transform)
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetEntityId()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Global Namespace
    Assembly: Unity.SimulationPro.Foundation.Visualizations.dll
    Syntax
    [CreateAssetMenu(fileName = "PointCloudVisualizerSettings", menuName = "Robotics/Sensor Visualizers/PointCloud", order = 1)]
    public class PointCloudVisualizerSettings : VisualizerSettingsGeneric<PointCloudMsg>

    Properties

    BChannel

    Gets or sets the channel name used as the blue color component.

    Declaration
    public string BChannel { get; set; }
    Property Value
    Type Description
    string

    BRange

    Gets or sets the [min, max] range for normalizing the blue channel.

    Declaration
    public float[] BRange { get; set; }
    Property Value
    Type Description
    float[]

    Channels

    Gets or sets the channel names present in the most recently received message.

    Declaration
    public string[] Channels { get; set; }
    Property Value
    Type Description
    string[]

    ColorMode

    Gets or sets the active color mode for deriving per-point colors from named channels.

    Declaration
    public PointCloud2VisualizerSettings.ColorMode ColorMode { get; set; }
    Property Value
    Type Description
    PointCloud2VisualizerSettings.ColorMode

    GChannel

    Gets or sets the channel name used as the green color component.

    Declaration
    public string GChannel { get; set; }
    Property Value
    Type Description
    string

    GRange

    Gets or sets the [min, max] range for normalizing the green channel.

    Declaration
    public float[] GRange { get; set; }
    Property Value
    Type Description
    float[]

    HueChannel

    Gets or sets the channel name used as the HSV hue source.

    Declaration
    public string HueChannel { get; set; }
    Property Value
    Type Description
    string

    HueRange

    Gets or sets the [min, max] range for normalizing the hue channel.

    Declaration
    public float[] HueRange { get; set; }
    Property Value
    Type Description
    float[]

    RChannel

    Gets or sets the channel name used as the red color component.

    Declaration
    public string RChannel { get; set; }
    Property Value
    Type Description
    string

    RRange

    Gets or sets the [min, max] range for normalizing the red channel.

    Declaration
    public float[] RRange { get; set; }
    Property Value
    Type Description
    float[]

    RgbChannel

    Gets or sets the channel name that provides a packed RGB value.

    Declaration
    public string RgbChannel { get; set; }
    Property Value
    Type Description
    string

    Size

    Gets or sets the base point radius in world units used when UseSizeChannel is false.

    Declaration
    public float Size { get; set; }
    Property Value
    Type Description
    float

    SizeChannel

    Gets or sets the channel name used as a per-point radius source when UseSizeChannel is true.

    Declaration
    public string SizeChannel { get; set; }
    Property Value
    Type Description
    string

    SizeRange

    Gets or sets the [min, max] range for normalizing the size channel when UseSizeChannel is true.

    Declaration
    public float[] SizeRange { get; set; }
    Property Value
    Type Description
    float[]

    UseRgbChannel

    Gets or sets whether a color channel drives per-point colors.

    Declaration
    public bool UseRgbChannel { get; set; }
    Property Value
    Type Description
    bool

    UseSeparateRgb

    Gets or sets whether RGB components are read from three separate channels rather than a single packed channel.

    Declaration
    public bool UseSeparateRgb { get; set; }
    Property Value
    Type Description
    bool

    UseSizeChannel

    Gets or sets whether a size channel drives per-point radius rather than the fixed Size.

    Declaration
    public bool UseSizeChannel { get; set; }
    Property Value
    Type Description
    bool

    Methods

    CreateGUI(PointCloudMsg, MessageMetadata)

    Creates a GUI callback that renders an Inspector panel for the message data.

    Declaration
    public override Action CreateGUI(PointCloudMsg message, MessageMetadata meta)
    Parameters
    Type Name Description
    PointCloudMsg message

    The message data to visualize.

    MessageMetadata meta

    Metadata about the received message (topic, timestamp, frame).

    Returns
    Type Description
    Action

    An action that draws the GUI.

    Overrides
    VisualizerSettingsGeneric<PointCloudMsg>.CreateGUI(PointCloudMsg, MessageMetadata)

    Draw(Drawing3d, PointCloudMsg, MessageMetadata, Transform)

    Draws a 3D visualization of the message data.

    Declaration
    public override void Draw(Drawing3d drawing, PointCloudMsg message, MessageMetadata meta, Transform visualizerTransform)
    Parameters
    Type Name Description
    Drawing3d drawing

    The 3D drawing context to render into.

    PointCloudMsg message

    The message data to visualize.

    MessageMetadata meta

    Metadata about the received message (topic, timestamp, frame).

    Transform visualizerTransform

    The visualizerTransform.

    Overrides
    VisualizerSettingsGeneric<PointCloudMsg>.Draw(Drawing3d, PointCloudMsg, MessageMetadata, Transform)
    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)