{"_id":"5b1f966cfd653400031d9730","project":"571fa55ca0acd42000af9545","version":{"_id":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":4,"forked_from":"594949e52be16d0026ec04cd","createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z","categories":["5b1f8576c2505d0003125424","5b1f8576c2505d0003125425","5b1f8576c2505d0003125426","5b1f8576c2505d0003125427","5b1f8576c2505d0003125428","5b1f8576c2505d0003125429","5b1f8576c2505d000312542a","5b1f8576c2505d000312542b","5b1f8576c2505d000312542c","5b1f8576c2505d000312542d","5b1f8576c2505d000312542e","5b1f8576c2505d000312542f","5b1f8576c2505d0003125430","5b1f8576c2505d0003125431","5b1f8576c2505d0003125432","5b1f8576c2505d0003125433","5b1f8576c2505d0003125434","5b1f8576c2505d0003125435","5b1f8576c2505d0003125436","5b1f8576c2505d0003125437","5b1f8576c2505d0003125438","5b1f8aab9c683000032979e7","5b1f8b2f3073470003ffa5da","5b1f8bd9fd653400031d94f4","5b1f900bd4c5f000036b57bd"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Mangalica","version_clean":"3.3.0","version":"3.3.0"},"category":{"_id":"5b1f8576c2505d0003125431","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-01T17:01:47.129Z","from_sync":false,"order":14,"slug":"utilities","title":"Utilities"},"user":"571fa519db52d01700f5cf3d","githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-12T09:46:20.647Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"## Overview\n\nThe Velocity Estimator is used to calculate an estimated velocity on a moving object that is moving outside of Unity physics.\n\nObjects that have rigidbodies and use Unity physics to move around will automatically provide accurate velocity and angular velocity information.\n\nAny object that is moved around using absolute positions or moving the transform position will not be able to provide accurate velocity or angular velocity information.\nWhen the Velocity Estimator script is applied to any GameObject it will provide a best case estimation of what the object's velocity and angular velocity is based on a given number of position and rotation samples.\nThe more samples used, the higher the precision but the script will be more demanding on processing time.\n\n## Inspector Parameters\n\n * **Auto Start Sampling:** Begin the sampling routine when the script is enabled.\n * **Velocity Average Frames:** The number of frames to average when calculating velocity.\n * **Angular Velocity Average Frames:** The number of frames to average when calculating angular velocity.\n\n## Class Methods\n\n### StartEstimation/0\n\n  > `public virtual void StartEstimation()`\n\n * Parameters\n   * _none_\n * Returns\n   * _none_\n\nThe StartEstimation method begins logging samples of position and rotation for the GameObject.\n\n### EndEstimation/0\n\n  > `public virtual void EndEstimation()`\n\n * Parameters\n   * _none_\n * Returns\n   * _none_\n\nThe EndEstimation method stops logging samples of position and rotation for the GameObject.\n\n### GetVelocityEstimate/0\n\n  > `public virtual Vector3 GetVelocityEstimate()`\n\n * Parameters\n   * _none_\n * Returns\n   * `Vector3` - The velocity estimate vector of the GameObject\n\nThe GetVelocityEstimate method returns the current velocity estimate.\n\n### GetAngularVelocityEstimate/0\n\n  > `public virtual Vector3 GetAngularVelocityEstimate()`\n\n * Parameters\n   * _none_\n * Returns\n   * `Vector3` - The angular velocity estimate vector of the GameObject\n\nThe GetAngularVelocityEstimate method returns the current angular velocity estimate.\n\n### GetAccelerationEstimate/0\n\n  > `public virtual Vector3 GetAccelerationEstimate()`\n\n * Parameters\n   * _none_\n * Returns\n   * `Vector3` - The acceleration estimate vector of the GameObject\n\nThe GetAccelerationEstimate method returns the current acceleration estimate.","excerpt":"","slug":"vrtk_velocityestimator","type":"basic","title":"VRTK_VelocityEstimator"}

VRTK_VelocityEstimator


## Overview The Velocity Estimator is used to calculate an estimated velocity on a moving object that is moving outside of Unity physics. Objects that have rigidbodies and use Unity physics to move around will automatically provide accurate velocity and angular velocity information. Any object that is moved around using absolute positions or moving the transform position will not be able to provide accurate velocity or angular velocity information. When the Velocity Estimator script is applied to any GameObject it will provide a best case estimation of what the object's velocity and angular velocity is based on a given number of position and rotation samples. The more samples used, the higher the precision but the script will be more demanding on processing time. ## Inspector Parameters * **Auto Start Sampling:** Begin the sampling routine when the script is enabled. * **Velocity Average Frames:** The number of frames to average when calculating velocity. * **Angular Velocity Average Frames:** The number of frames to average when calculating angular velocity. ## Class Methods ### StartEstimation/0 > `public virtual void StartEstimation()` * Parameters * _none_ * Returns * _none_ The StartEstimation method begins logging samples of position and rotation for the GameObject. ### EndEstimation/0 > `public virtual void EndEstimation()` * Parameters * _none_ * Returns * _none_ The EndEstimation method stops logging samples of position and rotation for the GameObject. ### GetVelocityEstimate/0 > `public virtual Vector3 GetVelocityEstimate()` * Parameters * _none_ * Returns * `Vector3` - The velocity estimate vector of the GameObject The GetVelocityEstimate method returns the current velocity estimate. ### GetAngularVelocityEstimate/0 > `public virtual Vector3 GetAngularVelocityEstimate()` * Parameters * _none_ * Returns * `Vector3` - The angular velocity estimate vector of the GameObject The GetAngularVelocityEstimate method returns the current angular velocity estimate. ### GetAccelerationEstimate/0 > `public virtual Vector3 GetAccelerationEstimate()` * Parameters * _none_ * Returns * `Vector3` - The acceleration estimate vector of the GameObject The GetAccelerationEstimate method returns the current acceleration estimate.