Class AnnotationTool | Unity Reflect | 1.0.0-preview.11
docs.unity3d.com
    Show / Hide Table of Contents

    Class AnnotationTool

    Inheritance
    Object
    AnnotationTool
    Namespace: UnityEditor.Experimental.EditorVR.Tools
    Syntax
    [MainMenuItem("Annotation", "Create", "Draw in 3D", null)]
    [SpatialMenuItem("Annotation", "Tools", "Draw in 3D")]
    public class AnnotationTool : MonoBehaviour, ITool, ICustomActionMap, IProcessInput, IUsesRayOrigin, IUsesRayVisibilitySettings, IFunctionalitySubscriber<IProvidesRayVisibilitySettings>, IInstantiateUI, IUsesInstantiateMenuUI, IFunctionalitySubscriber<IProvidesInstantiateMenuUI>, IUsesMenuOrigins, IUsesViewerScale, IFunctionalitySubscriber<IProvidesViewerScale>, IUsesSpatialHash, IFunctionalitySubscriber<IProvidesSpatialHash>, IUsesIsHoveringOverUI, IFunctionalitySubscriber<IProvidesIsHoveringOverUI>, IMultiDeviceTool, IUsesDeviceType, ISerializePreferences, ILinkedObject, IUsesNode, IUsesRequestFeedback, IFunctionalitySubscriber<IProvidesRequestFeedback>, IUsesConnectInterfaces, IFunctionalitySubscriber<IProvidesConnectInterfaces>, IUsesSelectTool, IFunctionalitySubscriber<IProvidesSelectTool>, IFunctionalitySubscriber

    Fields

    AnnotationFinished

    Declaration
    public static AnnotationTool.AnnotationFinishedCallback AnnotationFinished
    Field Value
    Type Description
    AnnotationTool.AnnotationFinishedCallback

    AnnotationUpdated

    Declaration
    public static AnnotationTool.AnnotationUpdatedCallback AnnotationUpdated
    Field Value
    Type Description
    AnnotationTool.AnnotationUpdatedCallback

    MaxBrushSize

    Declaration
    public const float MaxBrushSize = 0.05F
    Field Value
    Type Description
    Single

    MinBrushSize

    Declaration
    public const float MinBrushSize = 0.0025F
    Field Value
    Type Description
    Single

    TipDistance

    Declaration
    public const float TipDistance = 0.05F
    Field Value
    Type Description
    Single

    Properties

    actionMap

    Declaration
    public ActionMap actionMap { get; }
    Property Value
    Type Description
    ActionMap
    Implements
    ICustomActionMap.actionMap

    alternateMenuOrigin

    Declaration
    public Transform alternateMenuOrigin { set; }
    Property Value
    Type Description
    Transform
    Implements
    IUsesMenuOrigins.alternateMenuOrigin

    ignoreActionMapInputLocking

    Declaration
    public bool ignoreActionMapInputLocking { get; }
    Property Value
    Type Description
    Boolean
    Implements
    ICustomActionMap.ignoreActionMapInputLocking

    linkedObjects

    Declaration
    public List<ILinkedObject> linkedObjects { set; }
    Property Value
    Type Description
    List<ILinkedObject>
    Implements
    ILinkedObject.linkedObjects

    menuOrigin

    Declaration
    public Transform menuOrigin { set; }
    Property Value
    Type Description
    Transform
    Implements
    IUsesMenuOrigins.menuOrigin

    node

    Declaration
    public Node node { set; }
    Property Value
    Type Description
    Node
    Implements
    IUsesNode.node

    primary

    Declaration
    public bool primary { set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiDeviceTool.primary

    rayOrigin

    Declaration
    public Transform rayOrigin { get; set; }
    Property Value
    Type Description
    Transform
    Implements
    IUsesRayOrigin.rayOrigin

    Methods

    OnDeserializePreferences(Object)

    Declaration
    public void OnDeserializePreferences(object obj)
    Parameters
    Type Name Description
    Object obj

    OnSerializePreferences()

    Declaration
    public object OnSerializePreferences()
    Returns
    Type Description
    Object

    ProcessInput(ActionMapInput, ConsumeControlDelegate)

    Declaration
    public void ProcessInput(ActionMapInput input, ConsumeControlDelegate consumeControl)
    Parameters
    Type Name Description
    ActionMapInput input
    ConsumeControlDelegate consumeControl
    Implements
    IProcessInput.ProcessInput(ActionMapInput, ConsumeControlDelegate)

    VerticesToPolygon(Int32, Int32, Int32, Int32, Boolean)

    Declaration
    public static int[] VerticesToPolygon(int upperLeft, int upperRight, int lowerLeft, int lowerRight, bool doubleSided = true)
    Parameters
    Type Name Description
    Int32 upperLeft
    Int32 upperRight
    Int32 lowerLeft
    Int32 lowerRight
    Boolean doubleSided
    Returns
    Type Description
    Int32[]

    Explicit Interface Implementations

    IFunctionalitySubscriber<IProvidesConnectInterfaces>.provider

    Declaration
    IProvidesConnectInterfaces IFunctionalitySubscriber<IProvidesConnectInterfaces>.provider { get; set; }
    Returns
    Type Description
    IProvidesConnectInterfaces
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    IFunctionalitySubscriber<IProvidesInstantiateMenuUI>.provider

    Declaration
    IProvidesInstantiateMenuUI IFunctionalitySubscriber<IProvidesInstantiateMenuUI>.provider { get; set; }
    Returns
    Type Description
    IProvidesInstantiateMenuUI
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    IFunctionalitySubscriber<IProvidesIsHoveringOverUI>.provider

    Declaration
    IProvidesIsHoveringOverUI IFunctionalitySubscriber<IProvidesIsHoveringOverUI>.provider { get; set; }
    Returns
    Type Description
    IProvidesIsHoveringOverUI
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    IFunctionalitySubscriber<IProvidesRayVisibilitySettings>.provider

    Declaration
    IProvidesRayVisibilitySettings IFunctionalitySubscriber<IProvidesRayVisibilitySettings>.provider { get; set; }
    Returns
    Type Description
    IProvidesRayVisibilitySettings
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    IFunctionalitySubscriber<IProvidesRequestFeedback>.provider

    Declaration
    IProvidesRequestFeedback IFunctionalitySubscriber<IProvidesRequestFeedback>.provider { get; set; }
    Returns
    Type Description
    IProvidesRequestFeedback
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    IFunctionalitySubscriber<IProvidesSelectTool>.provider

    Declaration
    IProvidesSelectTool IFunctionalitySubscriber<IProvidesSelectTool>.provider { get; set; }
    Returns
    Type Description
    IProvidesSelectTool
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    IFunctionalitySubscriber<IProvidesSpatialHash>.provider

    Declaration
    IProvidesSpatialHash IFunctionalitySubscriber<IProvidesSpatialHash>.provider { get; set; }
    Returns
    Type Description
    IProvidesSpatialHash
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    IFunctionalitySubscriber<IProvidesViewerScale>.provider

    Declaration
    IProvidesViewerScale IFunctionalitySubscriber<IProvidesViewerScale>.provider { get; set; }
    Returns
    Type Description
    IProvidesViewerScale
    Implements
    IFunctionalitySubscriber<TProvider>.provider

    Extension Methods

    IInstantiateUIMethods.InstantiateUI(IInstantiateUI, GameObject, Transform, Boolean, Transform)
    ILinkedObjectMethods.IsSharedUpdater(ILinkedObject, ILinkedObject)
    IUsesDeviceTypeMethods.GetDeviceType(IUsesDeviceType)
    UsesConnectInterfacesMethods.ConnectInterfaces(IUsesConnectInterfaces, Object, Object)
    UsesConnectInterfacesMethods.DisconnectInterfaces(IUsesConnectInterfaces, Object, Object)
    UsesIsHoveringOverUIMethods.IsHoveringOverUI(IUsesIsHoveringOverUI, Transform)
    UsesRayVisibilitySettingsMethods.AddRayVisibilitySettings(IUsesRayVisibilitySettings, Transform, Object, Boolean, Boolean, Int32)
    UsesRayVisibilitySettingsMethods.RemoveRayVisibilitySettings(IUsesRayVisibilitySettings, Transform, Object)
    UsesRequestFeedbackMethods.AddFeedbackRequest(IUsesRequestFeedback, FeedbackRequest)
    UsesRequestFeedbackMethods.RemoveFeedbackRequest(IUsesRequestFeedback, FeedbackRequest)
    UsesRequestFeedbackMethods.ClearFeedbackRequests(IUsesRequestFeedback, IUsesRequestFeedback)
    UsesRequestFeedbackMethods.GetFeedbackRequestObject<TRequest>(IUsesRequestFeedback, IUsesRequestFeedback)
    UsesSelectToolMethods.SelectTool(IUsesSelectTool, Transform, Type, Boolean, Boolean)
    UsesSelectToolMethods.IsToolActive(IUsesSelectTool, Transform, Type)
    UsesSpatialHashMethods.AddToSpatialHash(IUsesSpatialHash, GameObject)
    UsesSpatialHashMethods.RemoveFromSpatialHash(IUsesSpatialHash, GameObject)
    UsesViewerScaleMethods.GetViewerScale(IUsesViewerScale)
    UsesViewerScaleMethods.SetViewerScale(IUsesViewerScale, Single)
    UsesInstantiateMenuUIMethods.InstantiateMenuUI(IUsesInstantiateMenuUI, Transform, IMenu)
    Back to top
    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