API reference
CylinderGrabSurface Class
Extends MonoBehaviour, IGrabSurface
This type of surface defines a cylinder in which the grip pose is valid around an object.
An angle and offset can be used to constrain the cylinder and not use a full circle. The radius is automatically specified as the distance from the axis of the cylinder to the original grip position.
Protected Fields
CylinderSurfaceData _data[Get]
Properties
Pose RelativePose[Get]
float ArcOffset[Get]
Degrees from the starting radius from which the arc section starts.
float ArcLength[Get]
The maximum angle for the surface of the cylinder, starting from the ArcOffset.
To invert the direction of the angle, swap the caps order.
Vector3 LocalPerpendicularDir[Get]
The direction of the main radius of the cylinder.
This is the radius from the center of the cylinder to the reference position.
Vector3 LocalDirection[Get]
The direction of the central axis of the cylinder in local space.
Member Functions
Pose GetReferencePose
( Transform relativeTo )
The reference pose of the surface.
It defines the radius of the cylinder as the point from the relative transform to the reference pose to ensure that the cylinder covers this pose.
Parameters
relativeTo
The reference transform to apply the surface to
Returns
Pose in world space
Vector3 GetPerpendicularDir
( Transform relativeTo )
Direction from the axis of the cylinder to the original grip position.
Parameters
relativeTo
The reference transform to apply the surface to
Returns
Direction in world space
Vector3 GetStartArcDir
( Transform relativeTo )
Direction from the axis of the cylinder to the minimum angle allowance.
Parameters
relativeTo
The reference transform to apply the surface to
Returns
Direction in world space
Vector3 GetEndArcDir
( Transform relativeTo )
Direction from the axis of the cylinder to the maximum angle allowance.
Parameters
relativeTo
The reference transform to apply the surface to
Returns
Direction in world space
Vector3 GetStartPoint
( Transform relativeTo )
Base cap of the cylinder, in world coordinates.
Parameters
relativeTo
The reference transform to apply the surface to
Returns
Position in world space
void SetStartPoint
( Vector3 point,
Transform relativeTo )
Vector3 GetEndPoint
( Transform relativeTo )
End cap of the cylinder, in world coordinates.
Parameters
relativeTo
The reference transform to apply the surface to
Returns
Position in world space
void SetEndPoint
( Vector3 point,
Transform relativeTo )
float GetRadius
( Transform relativeTo )
The generated radius of the cylinder.
Represents the distance from the axis of the cylinder to the original grip position.
Parameters
relativeTo
The reference transform to apply the surface to
Returns
Distance in world space
Vector3 GetDirection
( Transform relativeTo )
Direction of the cylinder, from the start cap to the end cap.
Parameters
relativeTo
The reference transform to apply the surface to
Returns
Direction in world space
Pose MirrorPose
( in Pose gripPose,
Transform relativeTo )
Method for mirroring a Pose around the surface.
Different surfaces will prefer mirroring along different axis.
Parameters
gripPose
The Pose to be mirrored.
relativeTo
Reference transform to mirror the pose around
Returns
A new pose mirrored at this surface.
GrabPoseScore CalculateBestPoseAtSurface
( in Pose targetPose,
out Pose bestPose,
in PoseMeasureParameters scoringModifier,
Transform relativeTo )
Finds the Pose at the surface that is the closest to the given pose.
Parameters
targetPose
The root pose to find the nearest to.
bestPose
The best found pose at the surface.<
scoringModifier
Weight used to decide which target pose to select
relativeTo
Reference transform to measure the poses against
Returns
The score indicating how good the found pose was, -1 for invalid result.
GrabPoseScore CalculateBestPoseAtSurface
( in Pose targetPose,
in Pose offset,
out Pose bestPose,
in PoseMeasureParameters scoringModifier,
Transform relativeTo )
Finds the Pose at the surface that is the closest to the given pose.
Parameters
targetPose
The root pose to find the nearest to.
offset
The offset from the root, for accurate scoring
bestPose
The best found pose at the surface.<
scoringModifier
Weight used to decide which target pose to select
relativeTo
Reference transform to measure the poses against
Returns
The score indicating how good the found pose was, -1 for invalid result.
IGrabSurface CreateMirroredSurface
( GameObject gameObject )
Creates a new IGrabSurface under the selected gameobject that is a mirror version of the current.
Parameters
gameObject
The gameobject in which to place the new IGrabSurface.
Returns
A mirror of this IGrabSurface.
IGrabSurface CreateDuplicatedSurface
( GameObject gameObject )
Creates a new IGrabSurface under the selected gameobject with the same data as this one.
Parameters
gameObject
The gameobject in which to place the new IGrabSurface.
Returns
A clone of this IGrabSurface.
bool CalculateBestPoseAtSurface
( Ray targetRay,
out Pose bestPose,
Transform relativeTo )
Finds the Pose at the surface that is the closest to the given ray.
Parameters
targetRay
Ray searching for the nearest snap pose
bestPose
The best found pose at the surface.
relativeTo
Reference transform to measure the poses against
Returns
True if the pose was found
void InjectAllCylinderSurface
( CylinderSurfaceData data,
Transform relativeTo )
void InjectData
( CylinderSurfaceData data )
void InjectRelativeTo
( Transform relativeTo )
Protected Functions
virtual void Reset ( )
virtual void Start ( )
Vector3 NearestPointInSurface
( Vector3 targetPosition,
Transform relativeTo )
Pose MinimalRotationPoseAtSurface
( in Pose userPose,
Transform relativeTo )
Pose MinimalTranslationPoseAtSurface
( in Pose userPose,
Transform relativeTo )
Quaternion CalculateRotationOffset
( Vector3 surfacePoint,
Transform relativeTo )
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta