SplineDataProvider Class
Definition
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.
Creates a spline based on control points.
public ref class SplineDataProvider : Microsoft::MixedReality::Toolkit::Utilities::BaseMixedRealityLineDataProvider[UnityEngine.AddComponentMenu("Scripts/MRTK/Core/SplineDataProvider")]
public class SplineDataProvider : Microsoft.MixedReality.Toolkit.Utilities.BaseMixedRealityLineDataProvider[<UnityEngine.AddComponentMenu("Scripts/MRTK/Core/SplineDataProvider")>]
type SplineDataProvider = class
inherit BaseMixedRealityLineDataProviderPublic Class SplineDataProvider
Inherits BaseMixedRealityLineDataProvider- Inheritance
- Attributes
-
UnityEngine.AddComponentMenuAttribute
Constructors
| SplineDataProvider() |
Fields
| UnclampedWorldLengthSearchSteps | (Inherited from BaseMixedRealityLineDataProvider) |
Properties
| AlignAllControlPoints | |
| ControlPoints |
List of positions and orientations that define control points to generate the spline |
| Distorters |
A list of distorters that apply to this line (Inherited from BaseMixedRealityLineDataProvider) |
| DistortionEnabled |
Enabled / disables all distorters used by line. (Inherited from BaseMixedRealityLineDataProvider) |
| DistortionMode |
NormalizedLength mode uses the DistortionStrength curve for distortion strength, Uniform uses UniformDistortionStrength along entire line (Inherited from BaseMixedRealityLineDataProvider) |
| DistortionStrength |
Curve that defines distortion strength over distance, only used when DistortionMode = NormalizedLength (Inherited from BaseMixedRealityLineDataProvider) |
| FirstPoint |
Returns world position of first point along line as defined by this data provider (Inherited from BaseMixedRealityLineDataProvider) |
| FlipUpVector |
Reverses up vector when determining rotation along line (Inherited from BaseMixedRealityLineDataProvider) |
| LastPoint |
Returns world position of last point along line as defined by this data provider (Inherited from BaseMixedRealityLineDataProvider) |
| LineEndClamp |
Clamps the line's normalized end point. This setting will affect line renderers. (Inherited from BaseMixedRealityLineDataProvider) |
| LineStartClamp |
Clamps the line's normalized start point. This setting will affect line renderers. (Inherited from BaseMixedRealityLineDataProvider) |
| LineTransform |
Transform to use when translating points from local to world space. If null, this object's transform is used. (Inherited from BaseMixedRealityLineDataProvider) |
| Loops |
Controls whether this line loops (Inherited from BaseMixedRealityLineDataProvider) |
| ManualUpVectorBlend |
The weight of manual up vectors in Velocity rotation mode (Inherited from BaseMixedRealityLineDataProvider) |
| ManualUpVectors |
These vectors are used with ManualUpVectorBlend to determine rotation along the line in Velocity rotation mode. Vectors are distributed along the normalized length of the line. (Inherited from BaseMixedRealityLineDataProvider) |
| OriginOffset |
Local space offset to transform position. Used to determine rotation along line in RelativeToOrigin rotation mode (Inherited from BaseMixedRealityLineDataProvider) |
| PointCount |
The number of points this line has. |
| RotationMode |
The rotation mode used in the GetRotation function. You can visualize rotations by checking Draw Rotations under Editor Settings. (Inherited from BaseMixedRealityLineDataProvider) |
| TransformMode |
Defines how a base line data provider will transform its points (Inherited from BaseMixedRealityLineDataProvider) |
| UnClampedWorldLength | (Inherited from BaseMixedRealityLineDataProvider) |
| UniformDistortionStrength |
Float value that defines distortion strength uniformly over distance, only used when DistortionMode = Uniform (Inherited from BaseMixedRealityLineDataProvider) |
| VelocitySearchRange |
Used in Velocity rotation mode. (Inherited from BaseMixedRealityLineDataProvider) |
Methods
| DrawUnselectedGizmosPreview() | (Inherited from BaseMixedRealityLineDataProvider) |
| ForceUpdateAlignment() |
Forces all the control points into alignment. |
| GetClosestPoint(Vector3, Int32, Int32) |
Iterates along line until it finds the point closest to worldPosition (Inherited from BaseMixedRealityLineDataProvider) |
| GetNormalizedLengthFromWorldLength(Single, Int32) |
Returns a normalized length corresponding to a world length Useful for determining LineStartClamp / LineEndClamp values (Inherited from BaseMixedRealityLineDataProvider) |
| GetNormalizedLengthFromWorldPos(Vector3, Int32, Int32) |
Iterates along line until it finds the length closest to worldposition. (Inherited from BaseMixedRealityLineDataProvider) |
| GetPoint(Int32) |
Gets a point along the line at the specified index (Inherited from BaseMixedRealityLineDataProvider) |
| GetPoint(Single) |
Gets a point along the line at the specified normalized length. (Inherited from BaseMixedRealityLineDataProvider) |
| GetPointInternal(Int32) |
Get a point based on point index Point index will be pre-clamped |
| GetPointInternal(Single) |
Get a point based on normalized distance along line Normalized distance will be pre-clamped |
| GetRotation(Int32, LineRotationMode) |
Gets the rotation of a point along the line at the specified index (Inherited from BaseMixedRealityLineDataProvider) |
| GetRotation(Single, LineRotationMode) |
Gets the rotation of a point along the line at the specified length (Inherited from BaseMixedRealityLineDataProvider) |
| GetUnClampedPoint(Single) |
Gets a point along the line at the specified length without using LineStartClamp or LineEndClamp (Inherited from BaseMixedRealityLineDataProvider) |
| GetUnClampedWorldLengthInternal() |
Get the UnClamped world length of the line |
| GetUpVectorInternal(Single) |
Gets the up vector at a normalized length along line (used for rotation) |
| GetVelocity(Single) |
Gets the velocity along the line (Inherited from BaseMixedRealityLineDataProvider) |
| LateUpdate() | (Inherited from BaseMixedRealityLineDataProvider) |
| OnEnable() | (Inherited from BaseMixedRealityLineDataProvider) |
| SetPoint(Int32, Vector3) |
Sets a point in the line This function is not guaranteed to have an effect (Inherited from BaseMixedRealityLineDataProvider) |
| SetPointInternal(Int32, Vector3) |
Sets the point at index. |
| UpdateMatrix() | (Inherited from BaseMixedRealityLineDataProvider) |