Struct RayStep

Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Physics
Assembly: cs.temp.dll.dll
Syntax
public struct RayStep

Constructors

RayStep(Vector3, Vector3)

Declaration
public RayStep(Vector3 origin, Vector3 terminus)
Parameters
Type Name Description
Vector3 origin
Vector3 terminus

Properties

Direction

Declaration
public Vector3 Direction { get; }
Property Value
Type Description
Vector3

Length

Declaration
public float Length { get; }
Property Value
Type Description
Single

Origin

Declaration
public Vector3 Origin { get; }
Property Value
Type Description
Vector3

Terminus

Declaration
public Vector3 Terminus { get; }
Property Value
Type Description
Vector3

Methods

Contains(Vector3)

Declaration
public bool Contains(Vector3 point)
Parameters
Type Name Description
Vector3 point
Returns
Type Description
Boolean

CopyRay(Ray, Single)

Declaration
public void CopyRay(Ray ray, float rayLength)
Parameters
Type Name Description
Ray ray
Single rayLength

GetDirectionByDistance(RayStep[], Single)

Returns a direction along an array of RaySteps by distance

Declaration
public static Vector3 GetDirectionByDistance(RayStep[] steps, float distance)
Parameters
Type Name Description
RayStep[] steps
Single distance
Returns
Type Description
Vector3

GetPoint(Single)

Declaration
public Vector3 GetPoint(float distance)
Parameters
Type Name Description
Single distance
Returns
Type Description
Vector3

GetPointByDistance(RayStep[], Single)

Returns a point along an array of RaySteps by distance

Declaration
public static Vector3 GetPointByDistance(RayStep[] steps, float distance)
Parameters
Type Name Description
RayStep[] steps
Single distance
Returns
Type Description
Vector3

GetStepByDistance(RayStep[], Single, ref Single)

Returns a RayStep along an array of RaySteps by distance

Declaration
public static RayStep GetStepByDistance(RayStep[] steps, float distance, ref float remainingDistance)
Parameters
Type Name Description
RayStep[] steps
Single distance
Single remainingDistance
Returns
Type Description
RayStep

UpdateRayStep(ref Vector3, ref Vector3)

Update current raystep with new origin and terminus points. Pass by ref to avoid unnecessary struct copy into function since values will be copied anyways locally

Declaration
public void UpdateRayStep(ref Vector3 origin, ref Vector3 terminus)
Parameters
Type Name Description
Vector3 origin

beginning of raystep origin
Vector3 terminus

end of raystep

Operators

Implicit(RayStep to Ray)

Declaration
public static implicit operator Ray(RayStep r)
Parameters
Type Name Description
RayStep r
Returns
Type Description
Ray