mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class Orbital

    Provides a solver that follows the TrackedObject/TargetTransform in an orbital motion.

    Inheritance
    Object
    Solver
    Orbital
    Implements
    MonoBehaviour
    Inherited Members
    Solver.UpdateLinkedTransform
    Solver.MoveLerpTime
    Solver.RotateLerpTime
    Solver.ScaleLerpTime
    Solver.Smoothing
    Solver.SolverHandler
    Solver.GoalPosition
    Solver.GoalRotation
    Solver.GoalScale
    Solver.WorkingPosition
    Solver.WorkingRotation
    Solver.WorkingScale
    Solver.Awake()
    Solver.OnEnable()
    Solver.Start()
    Solver.OnDestroy()
    Solver.SolverUpdateEntry()
    Solver.SnapTo(Vector3, Quaternion, Vector3)
    Solver.SnapGoalTo(Vector3, Quaternion, Vector3)
    Solver.SnapTo(Vector3, Quaternion)
    Solver.SnapGoalTo(Vector3, Quaternion)
    Solver.AddOffset(Vector3)
    Solver.SmoothTo(Vector3, Vector3, Single, Single)
    Solver.SmoothTo(Quaternion, Quaternion, Single, Single)
    Solver.UpdateTransformToGoal()
    Solver.UpdateWorkingToGoal()
    Solver.UpdateWorkingPositionToGoal()
    Solver.UpdateWorkingRotationToGoal()
    Solver.UpdateWorkingScaleToGoal()
    Namespace: Microsoft.MixedReality.Toolkit.Utilities.Solvers
    Assembly: cs.temp.dll.dll
    Syntax
    public class Orbital : Solver, MonoBehaviour

    Properties

    LocalOffset

    XYZ offset for this object in relation to the TrackedObject/TargetTransform.

    Declaration
    public Vector3 LocalOffset { get; set; }
    Property Value
    Type Description
    Vector3
    Remarks

    Mixing local and world offsets is not recommended.

    LocalOffset

    XYZ offset for this object in relation to the TrackedObject/TargetTransform.

    Declaration
    public Vector3 LocalOffset { get; set; }
    Property Value
    Type Description
    Vector3
    Remarks

    Mixing local and world offsets is not recommended.

    OrientationType

    The desired orientation of this object.

    Declaration
    public SolverOrientationType OrientationType { get; set; }
    Property Value
    Type Description
    SolverOrientationType
    Remarks

    Default sets the object to face the TrackedObject/TargetTransform. CameraFacing sets the object to always face the user.

    OrientationType

    The desired orientation of this object.

    Declaration
    public SolverOrientationType OrientationType { get; set; }
    Property Value
    Type Description
    SolverOrientationType
    Remarks

    Default sets the object to face the TrackedObject/TargetTransform. CameraFacing sets the object to always face the user.

    TetherAngleSteps

    The division of steps this object can tether to. Higher the number, the more snapping steps.

    Declaration
    public int TetherAngleSteps { get; set; }
    Property Value
    Type Description
    Int32

    TetherAngleSteps

    The division of steps this object can tether to. Higher the number, the more snapping steps.

    Declaration
    public int TetherAngleSteps { get; set; }
    Property Value
    Type Description
    Int32

    UseAngleStepping

    Lock the rotation to a specified number of steps around the tracked object.

    Declaration
    public bool UseAngleStepping { get; set; }
    Property Value
    Type Description
    Boolean

    UseAngleStepping

    Lock the rotation to a specified number of steps around the tracked object.

    Declaration
    public bool UseAngleStepping { get; set; }
    Property Value
    Type Description
    Boolean

    WorldOffset

    XYZ offset for this object in worldspace, best used with the YawOnly orientationType.

    Declaration
    public Vector3 WorldOffset { get; set; }
    Property Value
    Type Description
    Vector3
    Remarks

    Mixing local and world offsets is not recommended.

    WorldOffset

    XYZ offset for this object in worldspace, best used with the YawOnly orientationType.

    Declaration
    public Vector3 WorldOffset { get; set; }
    Property Value
    Type Description
    Vector3
    Remarks

    Mixing local and world offsets is not recommended.

    Methods

    SolverUpdate()

    Declaration
    public override void SolverUpdate()
    Overrides
    Solver.SolverUpdate()

    SolverUpdate()

    Declaration
    public override void SolverUpdate()
    Overrides
    Solver.SolverUpdate()

    Implements

    MonoBehaviour
    In This Article
    • Properties
      • LocalOffset
      • LocalOffset
      • OrientationType
      • OrientationType
      • TetherAngleSteps
      • TetherAngleSteps
      • UseAngleStepping
      • UseAngleStepping
      • WorldOffset
      • WorldOffset
    • Methods
      • SolverUpdate()
      • SolverUpdate()
    • Implements
    Back to top Generated by DocFX