HandConstraintPalmUp Class

The handler reference for this solver that's attached to this GameObject

The distance threshold calculated between the planar intersection of the eye gaze ray and the activation transform. Uses square magnitude between two points for distance

The angle (in degrees) of the cone between the palm's up and camera's forward have to match. Only supported by IMixedRealityHand controllers.

The angle (in degrees) of the cone between the palm's up and triangle's normal formed from the palm, to index, to ring finger tip have to match. Only supported by IMixedRealityHand controllers.

Angle (in degrees) between hand up and camera forward, below which the hand menu follows the gaze, if followHandUntilFacingCamera is active.

With this active, solver will follow hand rotation until the menu is sufficiently aligned with the gaze, at which point it faces the camera.

Additional offset to apply towards the user.

The final position to be attained

The final rotation to be attained

The final scale to be attained

The distance threshold calculated between the planar intersection of the head gaze ray and the activation transform. Uses square magnitude between two points for distance This is used if eye gaze isn't available for the user

When a hand is activated for tracking, should the cursor(s) be disabled on that hand?

If 0, the position will update immediately. Otherwise, the greater this attribute the slower the position updates

Specifies how the solver's offset relative to the hand will be computed.

Event which is triggered when zero hands to one hand is tracked.

Event which is triggered when a hand begins being tracked.

Event which is triggered when a hand stops being tracked.

Event which is triggered when all hands are lost.

Do the fingers on the hand need to be straightened, rather than curled, to form a flat hand shape. Only supported by IMixedRealityHand controllers.

If 0, the rotation will update immediately. Otherwise, the greater this attribute the slower the rotation updates")]

Specifies how the solver should rotate when tracking the hand.

Which part of the hand to move the tracked object towards. The ulnar side of the hand is recommended for most situations.

Additional degree offset to apply clockwise from the stated SafeZone. Direction is clockwise on the left hand and anti-clockwise on the right hand.

Additional offset to apply to the intersection point with the hand bounds.

If 0, the scale will update immediately. Otherwise, the greater this attribute the slower the scale updates

If true, updates are smoothed to the target. Otherwise, they are snapped to the target

If true, the position and orientation will be calculated, but not applied, for other components to use

Should the solver continue to move when the opposite hand (hand which is not being tracked) is near the tracked hand. This can improve stability when one hand occludes the other."

With this active, solver will activate after the palm threshold has been met and the user gazes at the activation point. If eye gaze information is not available, the head gaze will be used.

Automatically uses the shared position if the solver is set to use the 'linked transform'. UpdateLinkedTransform may be set to false, and a solver will automatically update the object directly, and not inherit work done by other solvers to the shared position

Rotation version of WorkingPosition

Scale version of WorkingPosition

Add an offset position to the target goal position.

Performs a ray vs AABB test to determine where the solver can constrain the tracked object without intersection. The "safe zone" is calculated as if projected into the horizontal and vertical plane of the camera.

Determines the solver's goal rotation based off of the SolverRotationBehavior.

Performs an intersection test to see if the left hand is near the right hand or vice versa.

Determines if a controller meets the requirements for use with constraining the tracked object and determines if the palm is currently facing the user. This function will modify the position and rotation behavior of the hand constraint if the followHandUntilFacingCamera variable is enabled.

When enabled, ensure that there are no outlying status changes that would prevent HandConstraintPalmUp from properly working (like gazeActivationAlreadyTriggered being set to true previously)

SnapGoalTo only sets the goal orientation. Not really useful.

SnapGoalTo only sets the goal orientation. Not really useful.

Snaps the solver to the desired pose.

Snaps the solver to the desired pose.

Should be implemented in derived classes, but Solver can be used to flush shared transform to real transform

Tracks lifetime of the solver, disabling it when expired, and finally runs the orientation update logic

Coroutine function called by the ManipulationHandler of the attached object whenever the object is done being manipulated by the user. This triggers a coroutine that checks to see whether the object should reattach to the hand.

Enables/disables all cursors on the currently tracked hand.

Updates all object orientations to the goal orientation for this solver, with smoothing accounted for (smoothing may be off)

Updates only the working position to goal with smoothing, if enabled

Updates only the working rotation to goal with smoothing, if enabled

Updates only the working scale to goal with smoothing, if enabled

Updates the Working orientation (which may be the object, or the shared orientation) to the goal with smoothing, if enabled