AR Design
UBC EML collab with UBC SALA - visualizing IoT data in AR
HoloToolkit.Unity.SolverOrbital Class Reference

SolverOrbital provides a solver that offsets from the TrackedObject/TargetTransform. Adjusting "LerpTime" properties changes how quickly the object moves to the TrackedObject/TargetTransform's position. More...

Inheritance diagram for HoloToolkit.Unity.SolverOrbital:
HoloToolkit.Unity.Solver

Public Types

enum  OrientationReferenceEnum {
  OrientationReferenceEnum.FollowTrackedObject, OrientationReferenceEnum.FaceTrackedObject, OrientationReferenceEnum.YawOnly, OrientationReferenceEnum.Unmodified,
  OrientationReferenceEnum.CameraFacing, OrientationReferenceEnum.CameraAligned
}
 

Public Member Functions

override void SolverUpdate ()
 
- Public Member Functions inherited from HoloToolkit.Unity.Solver
void SolverUpdateEntry ()
 Tracks lifetime of the solver, disabling it when expired, and finally runs the orientation update logic More...
 
virtual void SnapTo (Vector3 position, Quaternion rotation)
 SnapTo may be used to bypass smoothing to a certain position if the object is teleported or spawned More...
 
virtual void SnapGoalTo (Vector3 position, Quaternion rotation)
 SnapGoalTo only sets the goal orientation. Not really useful. More...
 
virtual void AddOffset (Vector3 offset)
 
void UpdateWorkingToGoal ()
 Updates the Working orientation (which may be the object, or the shared orientation) to the goal, with smoothing accounted for More...
 
void UpdateWorkingPosToGoal ()
 Updates only the working position to goal with smoothing More...
 
void UpdateWorkingRotToGoal ()
 Updates only the working rotation to goal with smoothing More...
 
void UpdateWorkingScaleToGoal ()
 Updates only the working scale to goal with smoothing More...
 

Properties

OrientationReferenceEnum Orientation [get, set]
 The desired orientation of this object. Default sets the object to face the TrackedObject/TargetTransform. CameraFacing sets the object to always face the user. More...
 
Vector3 LocalOffset [get, set]
 XYZ offset for this object in relation to the TrackedObject/TargetTransform. Mixing local and world offsets is not recommended. More...
 
Vector3 WorldOffset [get, set]
 XYZ offset for this object in worldspace, best used with the YawOnly orientation. Mixing local and world offsets is not recommended. More...
 
bool UseAngleSteppingForWorldOffset [get, set]
 Lock the rotation to a specified number of steps around the tracked object. More...
 
int TetherAngleSteps [get, set]
 TetherAngleSteps is the division of steps this object can tether to. Higher the number, the more snapple steps. More...
 
- Properties inherited from HoloToolkit.Unity.Solver
Vector3 WorkingPos [get, set]
 WorkingPos 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 More...
 
Quaternion WorkingRot [get, set]
 Rotation version of WorkingPos More...
 
Vector3 WorkingScale [get, set]
 Scale version of WorkingPos More...
 

Additional Inherited Members

- Static Public Member Functions inherited from HoloToolkit.Unity.Solver
static Vector3 SmoothTo (Vector3 source, Vector3 goal, float deltaTime, float lerpTime)
 Lerps Vector3 source to goal, handles lerpTime of 0 More...
 
static Quaternion SmoothTo (Quaternion source, Quaternion goal, float deltaTime, float lerpTime)
 Slerps Quaternion source to goal, handles lerpTime of 0 More...
 
- Public Attributes inherited from HoloToolkit.Unity.Solver
bool UpdateLinkedTransform = false
 
float MoveLerpTime = 0.1f
 
float RotateLerpTime = 0.1f
 
float ScaleLerpTime = 0
 
bool MaintainScale = true
 
Vector3 GoalPosition
 
Quaternion GoalRotation
 
Vector3 GoalScale
 
bool Smoothing = true
 
float Lifetime = 0
 
- Protected Member Functions inherited from HoloToolkit.Unity.Solver
virtual void Awake ()
 
virtual void OnEnable ()
 Typically when a solver becomes enabled, it should update its internal state to the system, in case it was disabled far away More...
 
void UpdateTransformToGoal ()
 Updates all object orientations to the goal orientation for this solver, with smoothing accounted for (smoothing may be off) More...
 
- Protected Attributes inherited from HoloToolkit.Unity.Solver
SolverHandler solverHandler
 

Detailed Description

SolverOrbital provides a solver that offsets from the TrackedObject/TargetTransform. Adjusting "LerpTime" properties changes how quickly the object moves to the TrackedObject/TargetTransform's position.

Definition at line 12 of file SolverOrbital.cs.

Member Enumeration Documentation

§ OrientationReferenceEnum

Enumerator
FollowTrackedObject 

Use the tracked object's pitch, yaw, and roll

FaceTrackedObject 

Face toward the tracked object

YawOnly 

Orient towards SolverHandler's tracked object or TargetTransform

Unmodified 

Leave the object's rotation alone

CameraFacing 

Orient toward Camera.main instead of SolverHandler's properties.

CameraAligned 

Align parallel to the direction the camera is facing

Definition at line 14 of file SolverOrbital.cs.

Member Function Documentation

§ SolverUpdate()

override void HoloToolkit.Unity.SolverOrbital.SolverUpdate ( )
virtual

Implements HoloToolkit.Unity.Solver.

Definition at line 116 of file SolverOrbital.cs.

Property Documentation

§ LocalOffset

Vector3 HoloToolkit.Unity.SolverOrbital.LocalOffset
getset

XYZ offset for this object in relation to the TrackedObject/TargetTransform. Mixing local and world offsets is not recommended.

Definition at line 64 of file SolverOrbital.cs.

§ Orientation

OrientationReferenceEnum HoloToolkit.Unity.SolverOrbital.Orientation
getset

The desired orientation of this object. Default sets the object to face the TrackedObject/TargetTransform. CameraFacing sets the object to always face the user.

Definition at line 51 of file SolverOrbital.cs.

§ TetherAngleSteps

int HoloToolkit.Unity.SolverOrbital.TetherAngleSteps
getset

TetherAngleSteps is the division of steps this object can tether to. Higher the number, the more snapple steps.

Definition at line 103 of file SolverOrbital.cs.

§ UseAngleSteppingForWorldOffset

bool HoloToolkit.Unity.SolverOrbital.UseAngleSteppingForWorldOffset
getset

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

Definition at line 90 of file SolverOrbital.cs.

§ WorldOffset

Vector3 HoloToolkit.Unity.SolverOrbital.WorldOffset
getset

XYZ offset for this object in worldspace, best used with the YawOnly orientation. Mixing local and world offsets is not recommended.

Definition at line 77 of file SolverOrbital.cs.


The documentation for this class was generated from the following file: