Skip to content

Commit a175e88

Browse files
Add RotateInOneHand options comment
Describes our philosophy for what should be found in RotateInOneHand options and what should be made into a constraint.
1 parent 7f480da commit a175e88

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

Assets/MixedRealityToolkit.SDK/Experimental/Features/Input/Handlers/ObjectManipulator.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,19 @@ namespace Microsoft.MixedReality.Toolkit.Experimental.UI
2323
public class ObjectManipulator : MonoBehaviour, IMixedRealityPointerHandler, IMixedRealityFocusChangedHandler
2424
{
2525
#region Public Enums
26+
27+
/// <summary>
28+
/// Describes what pivot the manipulated object will rotate about when
29+
/// you rotate your hand. This is not a description of any limits or
30+
/// additional rotation logic. If no other factors (such as constraints)
31+
/// are involved, rotating your hand by an amount should rotate the object
32+
/// by the same amount.
33+
/// For example a possible future value here is RotateAboutUserDefinedPoint
34+
/// where the user could specify a pivot that the object is to rotate
35+
/// around.
36+
/// An example of a value that should not be found here is MaintainRotationToUser
37+
/// as this restricts rotation of the object when we rotate the hand.
38+
/// </summary>
2639
public enum RotateInOneHandType
2740
{
2841
RotateAboutObjectCenter,

0 commit comments

Comments
 (0)