ColliderGrabSurface Class

Extends MonoBehaviour, IGrabSurface

Protected Functions

virtual void Start ( )

Member Functions

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.

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

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.

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.

void InjectAllColliderGrabSurface

( Collider collider )

void InjectCollider

( Collider collider )

Did you find this page helpful?