MixedRealityToolkit-Unity/org.mixedrealitytoolkit.spatialmanipulation/BoundsControl/BoundsControlTypes.cs at 6ecfe9ae63bb18b3b97c233ce020d5d3837e34c7 · MixedRealityToolkit/MixedRealityToolkit-Unity · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
// Copyright (c) Mixed Reality Toolkit Contributors
// Licensed under the BSD 3-Clause

using System;
using UnityEngine;

namespace MixedReality.Toolkit.SpatialManipulation
{
    /// <summary>
    /// Enum specifying whether an object should be rotated
    /// around its origin, or around the center of the calculated bounds.
    /// </summary>
    public enum RotateAnchorType
    {
        /// <summary>
        /// Rotate around the object's origin.
        /// </summary>
        ObjectOrigin = 0,

        /// <summary>
        /// Rotate around the center of the calculated bounds.
        /// </summary>
        BoundsCenter
    }

    /// <summary>
    /// Enum specifying whether an object should be scaled
    /// around the opposite corner, or around the center of the calculated bounds.
    /// </summary>
    public enum ScaleAnchorType
    {
        /// <summary>
        /// Scale around the opposite bounds corner.
        /// </summary>
        OppositeCorner = 0,

        /// <summary>
        /// Scale around the bounds center point.
        /// </summary>
        BoundsCenter
    }

    /// <summary>
    /// An enumeration describing a type of handle on a <see cref="BoundsControl"/>. grabbed can be a rotation (edge-mounted)
    /// handle, a scaling (corner-mounted) handle, or a translation (face-mounted)
    /// handle.
    /// </summary>
    [Flags]
    public enum HandleType
    {
        /// <summary>
        /// No handles on the <see cref="BoundsControl"/>.
        /// </summary>
        None = 0,

        /// <summary>
        /// A handle that is mounted to the edge of a <see cref="BoundsControl"/>, and can rotate the object.
        /// </summary>
        Rotation = 1 << 0,

        /// <summary>
        /// A handle that is mounted to the corner of a <see cref="BoundsControl"/>, and can scale the object.
        /// </summary>
        Scale = 1 << 1,

        /// <summary>
        /// A handle that is mounted to the face of a <see cref="BoundsControl"/>, and can move the object along the forward axis.
        /// </summary>
        /// <remarks>
        /// Handles of this type are currently not supported.
        /// </remarks>
        Translation = 1 << 2,

        /// <summary>
        /// A handle that is mounted to the face of a <see cref="BoundsControl"/>, and can move the object normal to the forward axis.
        /// </summary>
        Translation2D = 1 << 3,

        /// <summary>
        /// A handle that is mounted to the face of a <see cref="BoundsControl"/>, and can move the object in all three dimensions.
        /// </summary>
        Translation3D = 1 << 4,
    }

    /// <summary>
    /// Scale mode that is used for scaling behavior of bounds control.
    /// </summary>
    public enum HandleScaleMode
    {
        /// <summary>
        /// Control will be scaled uniformly.
        /// </summary>
        Uniform,

        /// <summary>
        /// Scales non uniformly according to movement in 3d space.
        /// </summary>
        NonUniform
    }

    /// <summary>
    /// Scale mode that is used for scaling behavior of bounds control.
    /// </summary>
    public enum FlattenMode
    {
        /// <summary>
        /// Regardless of how thin the bounds are, the BoundsControl will not flatten.
        /// </summary>
        Never,

        /// <summary>
        /// If the bounds is sufficiently thin, the BoundsControl will automatically flatten along
        /// the thinnest axis.
        /// </summary>
        Auto,

        /// <summary>
        /// Regardless of how thin or thick the bounds are,
        /// the BoundsControl will always flatten along the thinnest axis.
        /// </summary>
        Always,
    }

    /// <summary>
    /// Scale adjusting type that is used for determining how to maintain target scale of bounds control.
    /// </summary>
    public enum ScaleMaintainType
    {
        /// <summary>
        /// Maintain global size, even as the object changes size.
        /// </summary>
        [Tooltip("Maintain global size, even as the object changes size.")]
        GlobalSize,

        /// <summary>
        /// Adjust the handle's scale based on the initial parent scale.
        /// </summary>
        [Tooltip("Adjust the handle's scale based on the initial parent scale.")]
        FixedScale,

        /// <summary>
        /// Adjust the handle's scale to be the same size regardless of the initial parent scale and clamp the scale to a min and max value.
        /// </summary>
        [Tooltip("Adjust the handle's scale to be the same size regardless of the initial parent scale and clamp the scale to a min and max value.")]
        Advanced
    }
}