API reference
API reference
Select your platform
No SDKs available
No versions available

TwoGrabPlaneTransformer Class

Extends MonoBehaviour
Legacy ITransformer that translates, rotates and scales the target on a plane.
For most usages, this has been superseded by GrabFreeTransformer, which can be constrained in Z scale to achieve planar behavior; for more information, see ScaleConstraints and GrabFreeTransformer.InjectOptionalScaleConstraints(ScaleConstraints).

Properties

Constraints : TwoGrabPlaneConstraints
[Get][Set]
Gets or sets the TwoGrabPlaneConstraints for this transformer.
If constraints have already been assigned through the Editor or through InjectOptionalConstraints(TwoGrabPlaneConstraints), this assignment will override them.
Signature
TwoGrabPlaneConstraints Oculus.Interaction.TwoGrabPlaneTransformer.Constraints

Methods

BeginTransform ()
Implementation of ITransformer.BeginTransform; for details, please refer to the related documentation provided for that interface.
Signature
void Oculus.Interaction.TwoGrabPlaneTransformer.BeginTransform()
Returns
void
EndTransform ()
Implementation of ITransformer.EndTransform; for details, please refer to the related documentation provided for that interface.
Signature
void Oculus.Interaction.TwoGrabPlaneTransformer.EndTransform()
Returns
void
Initialize ( grabbable )
Implementation of ITransformer.Initialize(IGrabbable); for details, please refer to the related documentation provided for that interface.
Signature
void Oculus.Interaction.TwoGrabPlaneTransformer.Initialize(IGrabbable grabbable)
Parameters
grabbable: IGrabbable
Returns
void
InjectOptionalConstraints ( constraints )
Sets the TwoGrabPlaneConstraints for a dynamically instantiated TwoGrabPlaneTransformer.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Signature
void Oculus.Interaction.TwoGrabPlaneTransformer.InjectOptionalConstraints(TwoGrabPlaneConstraints constraints)
Parameters
constraints: TwoGrabPlaneConstraints
Returns
void
InjectOptionalPlaneTransform ( planeTransform )
Injects all dependencies for a dynamically instantiated TwoGrabPlaneTransformer; effectively wraps InjectOptionalConstraints(TwoGrabPlaneConstraints).
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Signature
void Oculus.Interaction.TwoGrabPlaneTransformer.InjectOptionalPlaneTransform(Transform planeTransform)
Parameters
planeTransform: Transform
Returns
void
UpdateTransform ()
Implementation of ITransformer.UpdateTransform; for details, please refer to the related documentation provided for that interface.
Signature
void Oculus.Interaction.TwoGrabPlaneTransformer.UpdateTransform()
Returns
void

Static Methods

TwoGrabPlane ( p0 , p1 , planeNormal )
Signature
static TwoGrabPlaneState Oculus.Interaction.TwoGrabPlaneTransformer.TwoGrabPlane(Vector3 p0, Vector3 p1, Vector3 planeNormal)
Parameters
p0: Vector3
p1: Vector3
planeNormal: Vector3
Returns
TwoGrabPlaneState

Inner Class

TwoGrabPlaneConstraints Class

Constraints applied to a TwoGrabPlaneTransformer's transformation.
These constraints limit various aspects of how the target object can be transformed; for details, see the documentation remarks on the various individual component constraints.

Fields

MaxScale : FloatConstraint
Sets the maximum allowed scale the TwoGrabPlaneTransformer can apply to its target.
Scale constraints (MaxScale and MinScale) specifically constrain the local X scale of the target, keeping the ratio of that dimension to the other local scale dimensions constant.
Signature
FloatConstraint Oculus.Interaction.TwoGrabPlaneTransformer.TwoGrabPlaneConstraints.MaxScale
MaxY : FloatConstraint
Sets the minimum allowable value in a constraint operation along the Y direction.
Signature
FloatConstraint Oculus.Interaction.TwoGrabPlaneTransformer.TwoGrabPlaneConstraints.MaxY
MinScale : FloatConstraint
Sets the minimum allowed scale the TwoGrabPlaneTransformer can apply to its target.
Scale constraints (MaxScale and MinScale) specifically constrain the local X scale of the target, keeping the ratio of that dimension to the other local scale dimensions constant.
Signature
FloatConstraint Oculus.Interaction.TwoGrabPlaneTransformer.TwoGrabPlaneConstraints.MinScale
MinY : FloatConstraint
Sets the maximum allowable value in a constraint operation along the Y direction.
Signature
FloatConstraint Oculus.Interaction.TwoGrabPlaneTransformer.TwoGrabPlaneConstraints.MinY