docs.unity3d.com
    Show / Hide Table of Contents

    Class FeatureSet

    A feature set contains features (e.g., variants or packs) of which one can be selected at a time.

    Inheritance
    Object
    FeatureSet
    FeatureSet<T>
    Namespace: Unity.Industrial.Forma.Core.Variants
    Syntax
    public abstract class FeatureSet : MonoBehaviour

    Fields

    _thumbnailCamera

    The thumbnail camera

    Declaration
    protected Camera _thumbnailCamera
    Field Value
    Type Description
    Camera

    _thumbnailCameraHolder

    Store position of the Camera that creates the Thumbnails for all of this VariantSet's Variants

    Declaration
    protected GameObject _thumbnailCameraHolder
    Field Value
    Type Description
    GameObject

    Properties

    code

    Label of the feature set.

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

    The code.

    codes

    Readonly list of codes in the feature set.

    Declaration
    public abstract IReadOnlyList<string> codes { get; }
    Property Value
    Type Description
    IReadOnlyList<String>

    The codes.

    features

    The features in the set.

    Declaration
    public IReadOnlyList<Feature> features { get; }
    Property Value
    Type Description
    IReadOnlyList<Feature>

    The features.

    selectedFeature

    The currently selected feature.

    Declaration
    public Feature selectedFeature { get; }
    Property Value
    Type Description
    Feature

    The selected feature.

    ThumbnailCamera

    Gets the thumbnail camera.

    Declaration
    public Camera ThumbnailCamera { get; }
    Property Value
    Type Description
    Camera

    The thumbnail camera.

    ThumbnailCameraHolder

    Gets the thumbnail camera holder.

    Declaration
    public GameObject ThumbnailCameraHolder { get; }
    Property Value
    Type Description
    GameObject

    The thumbnail camera holder.

    Methods

    DeselectFeature()

    Deselects the feature.

    Declaration
    public abstract void DeselectFeature()

    featureIndexOf(Feature)

    Index of feature in this feature set

    Declaration
    public abstract int featureIndexOf(Feature feature)
    Parameters
    Type Name Description
    Feature feature

    The feature.

    Returns
    Type Description
    Int32

    System.Int32.

    GetFeatures()

    Returns all features as a read-only list.

    Declaration
    protected abstract IReadOnlyList<Feature> GetFeatures()
    Returns
    Type Description
    IReadOnlyList<Feature>

    IReadOnlyList<Feature>.

    GetSelectedFeature()

    Returns the currently selected feature.

    Declaration
    protected abstract Feature GetSelectedFeature()
    Returns
    Type Description
    Feature

    Feature.

    OnValidate()

    Called when [validate].

    Declaration
    public void OnValidate()

    RaiseFeatureSetChanged(Object, FeatureSetChangedArgs)

    Raises the feature set changed.

    Declaration
    protected void RaiseFeatureSetChanged(object sender, FeatureSetChangedArgs args)
    Parameters
    Type Name Description
    Object sender

    The sender.

    FeatureSetChangedArgs args

    The arguments.

    ResetSelection()

    Selects the first feature.

    Declaration
    public abstract void ResetSelection()

    Events

    featureSetChanged

    Raised when the feature set has changed, i.e., a feature has been added or removed.

    Declaration
    public event FeatureSetChangedHandler featureSetChanged
    Event Type
    Type Description
    FeatureSetChangedHandler

    globalFeatureSetChangedHandler

    Occurs when [global feature set changed handler].

    Declaration
    public static event FeatureSetChangedHandler globalFeatureSetChangedHandler
    Event Type
    Type Description
    FeatureSetChangedHandler
    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