mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class InspectorFieldsUtility

    A collection of helper functions for adding InspectorFields to a custom Inspector

    Inheritance
    Object
    InspectorFieldsUtility
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.Utilities.Editor
    Assembly: cs.temp.dll.dll
    Syntax
    public static class InspectorFieldsUtility

    Methods

    AddFieldsToSettingsList(SerializedProperty, List<InspectorFieldData>)

    Adds InspectorFields to list of serialized PropertySettings

    Declaration
    public static void AddFieldsToSettingsList(SerializedProperty settings, List<InspectorFieldData> data)
    Parameters
    Type Name Description
    SerializedProperty settings
    List<InspectorFieldData> data

    AddFieldsToSettingsList(SerializedProperty, List<InspectorFieldData>)

    Adds InspectorFields to list of serialized PropertySettings

    Declaration
    public static void AddFieldsToSettingsList(SerializedProperty settings, List<InspectorFieldData> data)
    Parameters
    Type Name Description
    SerializedProperty settings
    List<InspectorFieldData> data

    AreFieldsSame(SerializedProperty, List<InspectorFieldData>)

    Declaration
    public static bool AreFieldsSame(SerializedProperty settings, List<InspectorFieldData> fieldList)
    Parameters
    Type Name Description
    SerializedProperty settings
    List<InspectorFieldData> fieldList
    Returns
    Type Description
    Boolean

    AreFieldsSame(SerializedProperty, List<InspectorFieldData>)

    Declaration
    public static bool AreFieldsSame(SerializedProperty settings, List<InspectorFieldData> fieldList)
    Parameters
    Type Name Description
    SerializedProperty settings
    List<InspectorFieldData> fieldList
    Returns
    Type Description
    Boolean

    ClearSettingsList(SerializedProperty, List<InspectorFieldData>)

    Create a new list of serialized PropertySettings from InspectorFields

    Declaration
    public static void ClearSettingsList(SerializedProperty settings, List<InspectorFieldData> data)
    Parameters
    Type Name Description
    SerializedProperty settings
    List<InspectorFieldData> data

    ClearSettingsList(SerializedProperty, List<InspectorFieldData>)

    Create a new list of serialized PropertySettings from InspectorFields

    Declaration
    public static void ClearSettingsList(SerializedProperty settings, List<InspectorFieldData> data)
    Parameters
    Type Name Description
    SerializedProperty settings
    List<InspectorFieldData> data

    DisplayPropertyField(SerializedProperty)

    Render a PropertySettings UI field based on the InspectorField Settings

    Declaration
    public static void DisplayPropertyField(SerializedProperty prop)
    Parameters
    Type Name Description
    SerializedProperty prop

    DisplayPropertyField(SerializedProperty)

    Render a PropertySettings UI field based on the InspectorField Settings

    Declaration
    public static void DisplayPropertyField(SerializedProperty prop)
    Parameters
    Type Name Description
    SerializedProperty prop

    GetInspectorFields(Object)

    Declaration
    public static List<InspectorFieldData> GetInspectorFields(object target)
    Parameters
    Type Name Description
    Object target
    Returns
    Type Description
    List<InspectorFieldData>

    GetInspectorFields(Object)

    Declaration
    public static List<InspectorFieldData> GetInspectorFields(object target)
    Parameters
    Type Name Description
    Object target
    Returns
    Type Description
    List<InspectorFieldData>

    IsPropertyType(SerializedProperty, InspectorField.FieldTypes)

    Checks the type a property field and returns if it matches the passed in type

    Declaration
    public static bool IsPropertyType(SerializedProperty prop, InspectorField.FieldTypes type)
    Parameters
    Type Name Description
    SerializedProperty prop
    InspectorField.FieldTypes type
    Returns
    Type Description
    Boolean

    IsPropertyType(SerializedProperty, InspectorField.FieldTypes)

    Checks the type a property field and returns if it matches the passed in type

    Declaration
    public static bool IsPropertyType(SerializedProperty prop, InspectorField.FieldTypes type)
    Parameters
    Type Name Description
    SerializedProperty prop
    InspectorField.FieldTypes type
    Returns
    Type Description
    Boolean

    UpdatePropertySettings(SerializedProperty, Int32, Object)

    Update a property value in a serialized PropertySettings

    Declaration
    public static void UpdatePropertySettings(SerializedProperty prop, int type, object update)
    Parameters
    Type Name Description
    SerializedProperty prop
    Int32 type
    Object update

    UpdatePropertySettings(SerializedProperty, Int32, Object)

    Update a property value in a serialized PropertySettings

    Declaration
    public static void UpdatePropertySettings(SerializedProperty prop, int type, object update)
    Parameters
    Type Name Description
    SerializedProperty prop
    Int32 type
    Object update

    UpdateSettingsList(SerializedProperty, List<InspectorFieldData>)

    Update list of serialized PropertySettings from new or removed InspectorFields

    Declaration
    public static void UpdateSettingsList(SerializedProperty settings, List<InspectorFieldData> fieldList)
    Parameters
    Type Name Description
    SerializedProperty settings
    List<InspectorFieldData> fieldList

    UpdateSettingsList(SerializedProperty, List<InspectorFieldData>)

    Update list of serialized PropertySettings from new or removed InspectorFields

    Declaration
    public static void UpdateSettingsList(SerializedProperty settings, List<InspectorFieldData> fieldList)
    Parameters
    Type Name Description
    SerializedProperty settings
    List<InspectorFieldData> fieldList
    In This Article
    • Methods
      • AddFieldsToSettingsList(SerializedProperty, List<InspectorFieldData>)
      • AddFieldsToSettingsList(SerializedProperty, List<InspectorFieldData>)
      • AreFieldsSame(SerializedProperty, List<InspectorFieldData>)
      • AreFieldsSame(SerializedProperty, List<InspectorFieldData>)
      • ClearSettingsList(SerializedProperty, List<InspectorFieldData>)
      • ClearSettingsList(SerializedProperty, List<InspectorFieldData>)
      • DisplayPropertyField(SerializedProperty)
      • DisplayPropertyField(SerializedProperty)
      • GetInspectorFields(Object)
      • GetInspectorFields(Object)
      • IsPropertyType(SerializedProperty, InspectorField.FieldTypes)
      • IsPropertyType(SerializedProperty, InspectorField.FieldTypes)
      • UpdatePropertySettings(SerializedProperty, Int32, Object)
      • UpdatePropertySettings(SerializedProperty, Int32, Object)
      • UpdateSettingsList(SerializedProperty, List<InspectorFieldData>)
      • UpdateSettingsList(SerializedProperty, List<InspectorFieldData>)
    Back to top Generated by DocFX