Orbital Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Utilities.Solvers

Assembly:: Microsoft.MixedReality.Toolkit.SDK.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class Orbital : Microsoft::MixedReality::Toolkit::Utilities::Solvers::Solver

[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/Orbital")]
public class Orbital : Microsoft.MixedReality.Toolkit.Utilities.Solvers.Solver

[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/Orbital")>]
type Orbital = class
    inherit Solver

Public Class Orbital
Inherits Solver

Inheritance: UnityEngine.MonoBehaviour

Solver
Orbital

Attributes: UnityEngine.AddComponentMenuAttribute

Constructors

Orbital()

Fields

SolverHandler

The handler reference for this solver that's attached to this GameObject

(Inherited from Solver)

Properties

GoalPosition	The final position to be attained (Inherited from Solver)
GoalRotation	The final rotation to be attained (Inherited from Solver)
GoalScale	The final scale to be attained (Inherited from Solver)
LocalOffset	XYZ offset for this object in relation to the TrackedObject/TargetTransform.
MoveLerpTime	If 0, the position will update immediately. Otherwise, the greater this attribute the slower the position updates (Inherited from Solver)
OrientationType	The desired orientation of this object.
RotateLerpTime	If 0, the rotation will update immediately. Otherwise, the greater this attribute the slower the rotation updates")] (Inherited from Solver)
ScaleLerpTime	If 0, the scale will update immediately. Otherwise, the greater this attribute the slower the scale updates (Inherited from Solver)
Smoothing	If true, updates are smoothed to the target. Otherwise, they are snapped to the target (Inherited from Solver)
TetherAngleSteps	The division of steps this object can tether to. Higher the number, the more snapping steps.
UpdateLinkedTransform	If true, the position and orientation will be calculated, but not applied, for other components to use (Inherited from Solver)
UseAngleStepping	Lock the rotation to a specified number of steps around the tracked object.
WorkingPosition	Automatically uses the shared position if the solver is set to use the 'linked transform'. UpdateLinkedTransform may be set to false, and a solver will automatically update the object directly, and not inherit work done by other solvers to the shared position (Inherited from Solver)
WorkingRotation	Rotation version of WorkingPosition (Inherited from Solver)
WorkingScale	Scale version of WorkingPosition (Inherited from Solver)
WorldOffset	XYZ offset for this object in worldspace, best used with the YawOnly orientationType.

Methods

AddOffset(Vector3)	Add an offset position to the target goal position. (Inherited from Solver)
Awake()	(Inherited from Solver)
OnDestroy()	(Inherited from Solver)
OnEnable()	Typically when a solver becomes enabled, it should update its internal state to the system, in case it was disabled far away (Inherited from Solver)
SnapGoalTo(Vector3, Quaternion)	Obsolete. SnapGoalTo only sets the goal orientation. Not really useful. (Inherited from Solver)
SnapGoalTo(Vector3, Quaternion, Vector3)	SnapGoalTo only sets the goal orientation. Not really useful. (Inherited from Solver)
SnapTo(Vector3, Quaternion)	Obsolete. Snaps the solver to the desired pose. (Inherited from Solver)
SnapTo(Vector3, Quaternion, Vector3)	Snaps the solver to the desired pose. (Inherited from Solver)
SolverUpdate()	Should be implemented in derived classes, but Solver can be used to flush shared transform to real transform
SolverUpdateEntry()	Tracks lifetime of the solver, disabling it when expired, and finally runs the orientation update logic (Inherited from Solver)
Start()	(Inherited from Solver)
UpdateTransformToGoal()	Updates all object orientations to the goal orientation for this solver, with smoothing accounted for (smoothing may be off) (Inherited from Solver)
UpdateWorkingPositionToGoal()	Updates only the working position to goal with smoothing, if enabled (Inherited from Solver)
UpdateWorkingRotationToGoal()	Updates only the working rotation to goal with smoothing, if enabled (Inherited from Solver)
UpdateWorkingScaleToGoal()	Updates only the working scale to goal with smoothing, if enabled (Inherited from Solver)
UpdateWorkingToGoal()	Updates the Working orientation (which may be the object, or the shared orientation) to the goal with smoothing, if enabled (Inherited from Solver)

Applies to