HandPosing.SnapSurfaces.SphereSurface Class Reference

Especifies an entire sphere around an object in which the grip point is valid. More...

Inheritance diagram for HandPosing.SnapSurfaces.SphereSurface:

Public Member Functions
override HandPose	InvertedPose (HandPose pose)
	STUB: Inverts a hand pose to an upside-down position. More...
override Pose	MirrorPose (Pose pose)
	Method for mirroring a Pose around the surface. Different surfaces will prefer mirroring along different axis. More...
override Vector3	NearestPointInSurface (Vector3 targetPosition)
	The nearest position at the surface from a given position. More...
override Pose	MinimalRotationPoseAtSurface (Pose userPose, Pose snapPose)
	Calculates a valid pose at the surface with the most similar rotation possible to the user's hand More...
override Pose	MinimalTranslationPoseAtSurface (Pose userPose, Pose snapPose)
	Calculates a valid pose at the surface with the most similar position possible to the user's hand More...

Protected Member Functions
Quaternion	RotationAtPoint (Vector3 surfacePoint, Quaternion baseRot, Quaternion desiredRotation)

Properties
override SnapSurfaceData	Data [get, set]
Vector3	Centre [get, set]
	The centre of the sphere in world coordinates. More...
float	Radious [get]
	The radious of the sphere, this is automatically calculated as the distance between the centre and the original grip pose. More...
Vector3	Direction [get]
	The direction of the sphere, measured from the centre to the original grip position. More...
Quaternion	Rotation [get]
	The rotation of the sphere from the recorded grip position. More...
Properties inherited from HandPosing.SnapSurfaces.SnapSurface
virtual SnapSurfaceData	Data [get, set]
	Getter for the data-only version of this surface. Used so it can be stored when created at Play-Mode. More...
Transform	GripPoint [get]
	Valid point at which the hand can snap, typically the SnapPoint position itself. More...

Additional Inherited Members
Public Attributes inherited from HandPosing.SnapSurfaces.SnapSurface
Transform	relativeTo
	Object to which the surface refers to. More...

Detailed Description

Especifies an entire sphere around an object in which the grip point is valid.

One of the main advantages of spheres is that the rotation of the hand pose does not really matters, as it will always fit the surface correctly.

Member Function Documentation

InvertedPose()

override HandPose HandPosing.SnapSurfaces.SphereSurface.InvertedPose ( HandPose  pose )

virtual

STUB: Inverts a hand pose to an upside-down position.

Parameters

pose	The hand pose to be inverted

Returns

An upside-down version of the given pose.

Implements HandPosing.SnapSurfaces.SnapSurface.

MinimalRotationPoseAtSurface()

override Pose HandPosing.SnapSurfaces.SphereSurface.MinimalRotationPoseAtSurface ( Pose  userPose, Pose  snapPose  )

virtual

Calculates a valid pose at the surface with the most similar rotation possible to the user's hand

Parameters

userPose	The user's hand pose
snapPose	The pose for the snap point

Returns

A valid pose at the surface

Implements HandPosing.SnapSurfaces.SnapSurface.

MinimalTranslationPoseAtSurface()

override Pose HandPosing.SnapSurfaces.SphereSurface.MinimalTranslationPoseAtSurface ( Pose  userPose, Pose  snapPose  )

virtual

Calculates a valid pose at the surface with the most similar position possible to the user's hand

Parameters

userPose	The user's hand pose
snapPose	The pose for the snap point

Returns

A valid pose at the surface

Implements HandPosing.SnapSurfaces.SnapSurface.

MirrorPose()

override Pose HandPosing.SnapSurfaces.SphereSurface.MirrorPose ( Pose  pose )

virtual

Method for mirroring a Pose around the surface. Different surfaces will prefer mirroring along different axis.

Parameters

pose	The Pose to be mirrored.

Returns

A new pose mirrored at this surface.

Reimplemented from HandPosing.SnapSurfaces.SnapSurface.

NearestPointInSurface()

override Vector3 HandPosing.SnapSurfaces.SphereSurface.NearestPointInSurface ( Vector3  targetPosition )

virtual

The nearest position at the surface from a given position.

Parameters

targetPosition

The position to measure from at world coordinates.

Returns

A valid position at the surface in world coordinates.

Implements HandPosing.SnapSurfaces.SnapSurface.

Property Documentation

Centre

Vector3 HandPosing.SnapSurfaces.SphereSurface.Centre

getset

The centre of the sphere in world coordinates.

Direction

Vector3 HandPosing.SnapSurfaces.SphereSurface.Direction

get

The direction of the sphere, measured from the centre to the original grip position.

Radious

float HandPosing.SnapSurfaces.SphereSurface.Radious

get

The radious of the sphere, this is automatically calculated as the distance between the centre and the original grip pose.

Rotation

Quaternion HandPosing.SnapSurfaces.SphereSurface.Rotation

get

The rotation of the sphere from the recorded grip position.

---

The documentation for this class was generated from the following file:

• Runtime/SnapRecording/SnapSurfaces/SphereSurface.cs