UltimateXR.Manipulation Namespace

Classes

	Class	Description
	UxrApplyConstraintsEventArgs	Event arguments for UxrGrabbableObject ConstraintsApplying and ConstraintsApplied.
	UxrGrabbableObject	Component that, added to a GameObject, will enable the object to be grabbed by the UxrGrabber components found in the hands of an UxrAvatar. Some of the main features of grabbable objects are: Manipulation is handled automatically by the UxrGrabManager. There is no special requirement to enable it in a scene, the grab manager will be available as soon as it is invoked. Grabbable objects can be grabbed, released and placed. Releasing an object means dropping it mid-air, while placing it is releasing an object close enough to a compatible UxrGrabbableObjectAnchor. Objects can be grabbed from different grab points. Additionally, grab points can be expanded using UxrGrabPointShape components opening up more complex manipulation by describing grab points as composite shapes. Although all avatars that have UxrGrabber components are able to interact with UxrGrabbableObject objects, it is possible to register the way specific avatars will interact with it. This allows to specify snap points and poses for different avatars and make sure that all have precise and realistic manipulation. The Hand Pose Editor can create poses that are used by UxrGrabbableObject in order to tell how objects are grabbed. The inspector window will preview grab poses and enable editing them. Events such as Grabbed, Released and Placed allow to write logic when a user interacts with the object. Each has pre and post events. ConstraintsApplying, ConstraintsApplied and ConstraintsFinished allow to program more complex logic when grabbing objects.
	UxrGrabbableObjectAnchor	Component that, added to a GameObject, will enable UxrGrabbableObject objects to be placed on it. Some of the main features of grabbable object anchors are: Placement mechanics are handled automatically by the UxrGrabManager. There is no special requirement to set it up in a scene, the grab manager will be available as soon as it is required. Compatible tags allow to model which objects can be placed on the anchor. If the list is empty, the anchor is compatible with all other UxrGrabbableObject that do not have a tag. Events such as Placed and Removed allow to write logic when a user interacts with the anchor. Each one has pre and post events. ActivateOnCompatibleNear, ActivateOnCompatibleNotNear, ActivateOnHandNearAndGrabbable, ActivateOnPlaced and ActivateOnEmpty can be used to activate/deactivate objects on manipulation events. They can be assigned during edit-time using the inspector and also at runtime. AddPlacingValidator(Func(UxrGrabbableObject, Boolean)) and RemovePlacingValidator(Func(UxrGrabbableObject, Boolean)) can be used to model complex compatibility behaviour that changes at runtime.
	UxrGrabbableObjectPreviewMesh	Component used internally by the editor. They are added to keep track of grab pose preview meshes and delete them when the preview is no longer needed.
	UxrGrabbableObjectSnapTransform	Component used internally by the editor. It renders grab pose meshes in the Scene Window when a grab point’s snap transform is selected and moved/rotated. It also allows to modify the blend factor in blend poses and gives access to some handy repositioning tools.
	UxrGrabber	Component that added to an UxrAvatar allows to interact with UxrGrabbableObject entities. Normally there are two per avatar, one on each hand. They are usually added to the hand object since it is the UxrGrabber transform where grabbable objects will be snapped to when snapping is used. By default, the grabber transform is also used to compute distances to grabbable objects. Additional proximity transforms can be specified on the grabber so that grabbable objects can choose which one is used. This can be useful in some scenarios: In an aircraft cockpit most knobs and buttons will prefer the distance from the tip of the index finger, while bigger objects will prefer from the palm of the hand.
	UxrGrabManager	Manager that takes care of updating all the manipulation mechanics. The manipulation system handles three main types of entities: UxrGrabber: Components usually assigned to each hand of an UxrAvatar and that are able to grab objects UxrGrabbableObject: Objects that can be grabbed UxrGrabbableObjectAnchor: Anchors where grabbable objects can be placed
	UxrGrabPointIndex	Enables nicer formatting of the grab point this shape is bound to in the editor. It will show strings like Main, Additional 0, Additional 1… etc. because there is an CustomPropertyDrawer for this class (see GrabPointIndexDrawer).
	UxrGrabPointInfo	Defines a UxrGrabbableObject grab point. A grab point describes a point of an object which can be grabbed. Objects can have multiple grab points to allow it to be grabbed from different angles. Grab points can be further expanded by using a UxrGrabPointShape, which gives flexibility by allowing it to be grabbed around or along an axis passing through that point, for example.
	UxrGrabPointShape	Base class to create more advanced grips (cylindrical, box…). An UxrGrabbableObject enables grabbing an object. A grabPoint inside the UxrGrabbableObject defines where and how the object will snap to the hand. Additionally, if there is an UxrGrabPointShape based component on the same object, it will “expand” the snapping from a single point to a more complex shape like a an axis, a cylinder, a box… This way an object can be picked up from many different places just by specifying a snap point and some additional properties.
	UxrGrabPointShapeAxisAngle	Grab shape used to grab cylindrical objects. The cylinder is described by an axis and a length. It is possible to specify if the object can be grabbed in both directions or a direction only.
	UxrGripPoseInfo	Describes how an object is grabbed. It tells the pose that will be used and how it will be snapped to the hand. The key is stored in the object, ideally we would have Dictionary(key, GripPoseInfo) but since Unity does not serialize Dictionaries we use a List(GripPoseInfo) containing the key (AvatarPrefabGuid) as well.
	UxrManipulationEventArgs	Event parameters for most manipulation events: UxrGrabManager: GrabTrying ObjectGrabbing ObjectGrabbed ObjectReleasing ObjectReleased ObjectPlacing ObjectPlaced ObjectRemoving ObjectRemoved AnchorRangeEntered AnchorRangeLeft PlacedObjectRangeEntered PlacedObjectRangeLeft UxrGrabbableObject: Grabbing Grabbed Releasing Released Placing Placed UxrGrabbableObjectAnchor: Placing Placed Removing Removed SmoothPlaceTransitionEnded
	UxrManipulationSyncEventArgs	Describes an event raised by the UxrGrabManager that can also be played back. This facilitates the manipulation synchronization through network.

Interfaces

	Interface	Description
	IUxrGrabbable	Interface for all objects that can be grabbed/manipulated using the UxrGrabManager.
	IUxrGrabbableModifier	Interface that can be implemented in components that modify a UxrGrabbableObject in the same GameObject so that the inspector shows which information is being controlled by the modifier.

Enumerations

	Enumeration	Description
	UxrGrabbableModifierFlags	Flags that represent parts in an UxrGrabbableObject that can be modified/hidden by components in the same GameObject that implement the IUxrGrabbableModifier interface.
	UxrGrabMode	What controller input we need to grab and release.
	UxrGrabProximityMode	Enumerates how the distance from a UxrGrabber to a UxrGrabbableObject can be computed.
	UxrHandSnapDirection	Enumerates the different ways snapping can be handled when grabbing an object. For constrained objects, this will always be hand to the object
	UxrManipulationSyncEventType	Enumerates the different events that can be synced for networking using UxrManipulationSyncEventArgs .
	UxrPlacementType	Enumerates the different ways a UxrGrabbableObject can transition when being placed on an UxrGrabbableObjectAnchor.
	UxrPreviewGrabPoses	Flags enumerating the different modes that can be used to preview the grab poses in the editor while an UxrGrabbableObject is selected.
	UxrRotationConstraintMode	Enumerates the ways a UxrGrabbableObject rotation can be constrained when being manipulated.
	UxrRotationProvider	Enumerates the different ways a UxrGrabbableObject with rotation constraints can be rotated while being manipulated.
	UxrSnapReference	Enumerates which transforms can be used to align a UxrGrabbableObject to a UxrGrabber
	UxrSnapToAnchorMode	Enumerates how a UxrGrabbableObject can snap to a UxrGrabbableObjectAnchor when being placed on it.
	UxrSnapToHandMode	Enumerates the ways a UxrGrabbableObject can snap to a UxrGrabber.
	UxrTranslationConstraintMode	Enumerates the ways a UxrGrabbableObject position can be constrained when being manipulated.