Updated docs

This commit is contained in:
Matthias 2016-02-20 15:24:02 +02:00
parent b14845a749
commit 96fb7b7846
2 changed files with 32 additions and 29 deletions

View file

@ -1194,7 +1194,6 @@ namespace OpenTK
/// <summary>Transform a Vector by the given Matrix using right-handed notation</summary> /// <summary>Transform a Vector by the given Matrix using right-handed notation</summary>
/// <param name="vec">The vector to transform</param> /// <param name="vec">The vector to transform</param>
/// <param name="mat">The desired transformation</param> /// <param name="mat">The desired transformation</param>
/// <param name="result">The transformed vector</param>
public static Vector3 RightHandedTransform(Vector3 vec, Matrix3 mat) public static Vector3 RightHandedTransform(Vector3 vec, Matrix3 mat)
{ {
Vector3 result; Vector3 result;
@ -1217,7 +1216,6 @@ namespace OpenTK
/// <summary>Transform a Vector by the given Matrix using right-handed notation</summary> /// <summary>Transform a Vector by the given Matrix using right-handed notation</summary>
/// <param name="vec">The vector to transform</param> /// <param name="vec">The vector to transform</param>
/// <param name="mat">The desired transformation</param> /// <param name="mat">The desired transformation</param>
/// <param name="result">The transformed vector</param>
public static Vector3 RightHandedTransform(Vector3 vec, Matrix4 mat) public static Vector3 RightHandedTransform(Vector3 vec, Matrix4 mat)
{ {
Vector3 result; Vector3 result;
@ -1231,7 +1229,7 @@ namespace OpenTK
/// <param name="result">The transformed vector</param> /// <param name="result">The transformed vector</param>
public static void RightHandedTransform(ref Vector3 vec, ref Matrix4 mat, out Vector3 result) public static void RightHandedTransform(ref Vector3 vec, ref Matrix4 mat, out Vector3 result)
{ {
result = new OpenTK.Vector3( result = new Vector3(
mat.Row0.X * vec.X + mat.Row0.Y * vec.Y + mat.Row0.Z * vec.Z + mat.Row0.W, mat.Row0.X * vec.X + mat.Row0.Y * vec.Y + mat.Row0.Z * vec.Z + mat.Row0.W,
mat.Row1.X * vec.X + mat.Row1.Y * vec.Y + mat.Row1.Z * vec.Z + mat.Row1.W, mat.Row1.X * vec.X + mat.Row1.Y * vec.Y + mat.Row1.Z * vec.Z + mat.Row1.W,
mat.Row2.X * vec.X + mat.Row2.Y * vec.Y + mat.Row2.Z * vec.Z + mat.Row2.W); mat.Row2.X * vec.X + mat.Row2.Y * vec.Y + mat.Row2.Z * vec.Z + mat.Row2.W);
@ -1572,13 +1570,13 @@ namespace OpenTK
return vec; return vec;
} }
/// <summary> /// <summary>
/// Transform a Vector by the given Matrix. /// Transform a Vector by the given Matrix.
/// </summary> /// </summary>
/// <param name="vec">The vector to transform</param> /// <param name="vec">The vector to transform</param>
/// <param name="mat">The desired transformation</param> /// <param name="mat">The desired transformation</param>
/// <returns></returns> /// <returns>The transformed vector</returns>
public static Vector3 operator *(Vector3 vec, Matrix3 mat) public static Vector3 operator *(Vector3 vec, Matrix3 mat)
{ {
Vector3 result; Vector3 result;
Vector3.Transform(ref vec, ref mat, out result); Vector3.Transform(ref vec, ref mat, out result);
@ -1590,7 +1588,7 @@ namespace OpenTK
/// </summary> /// </summary>
/// <param name="vec">The vector to transform</param> /// <param name="vec">The vector to transform</param>
/// <param name="mat">The desired transformation</param> /// <param name="mat">The desired transformation</param>
/// <returns></returns> /// <returns>The transformed vector</returns>
public static Vector3 operator *(Vector3 vec, Matrix4 mat) public static Vector3 operator *(Vector3 vec, Matrix4 mat)
{ {
Vector3 result; Vector3 result;
@ -1598,7 +1596,9 @@ namespace OpenTK
return result; return result;
} }
/// <summary>Transform a Vector by the given Matrix using right-handed notation</summary> /// <summary>
/// Transform a Vector by the given Matrix using right-handed notation
/// </summary>
/// <param name="vec">The vector to transform</param> /// <param name="vec">The vector to transform</param>
/// <param name="mat">The desired transformation</param> /// <param name="mat">The desired transformation</param>
/// <returns>The transformed vector</returns> /// <returns>The transformed vector</returns>
@ -1609,7 +1609,9 @@ namespace OpenTK
return result; return result;
} }
/// <summary>Transform a Vector by the given Matrix using right-handed notation</summary> /// <summary>
/// Transform a Vector by the given Matrix using right-handed notation
/// </summary>
/// <param name="vec">The vector to transform</param> /// <param name="vec">The vector to transform</param>
/// <param name="mat">The desired transformation</param> /// <param name="mat">The desired transformation</param>
/// <returns>The transformed vector</returns> /// <returns>The transformed vector</returns>

View file

@ -1020,7 +1020,6 @@ namespace OpenTK
/// <summary>Transform a Vector by the given Matrix using right-handed notation</summary> /// <summary>Transform a Vector by the given Matrix using right-handed notation</summary>
/// <param name="vec">The vector to transform</param> /// <param name="vec">The vector to transform</param>
/// <param name="mat">The desired transformation</param> /// <param name="mat">The desired transformation</param>
/// <param name="result">The transformed vector</param>
public static Vector4 RightHandedTransform(Vector4 vec, Matrix4 mat) public static Vector4 RightHandedTransform(Vector4 vec, Matrix4 mat)
{ {
Vector4 result; Vector4 result;
@ -1530,20 +1529,22 @@ namespace OpenTK
return vec; return vec;
} }
/// <summary> /// <summary>
/// Transform a Vector by the given Matrix. /// Transform a Vector by the given Matrix.
/// </summary> /// </summary>
/// <param name="vec">The vector to transform</param> /// <param name="vec">The vector to transform</param>
/// <param name="mat">The desired transformation</param> /// <param name="mat">The desired transformation</param>
/// <returns></returns> /// <returns>The transformed vector</returns>
public static Vector4 operator *(Vector4 vec, Matrix4 mat) public static Vector4 operator *(Vector4 vec, Matrix4 mat)
{ {
Vector4 result; Vector4 result;
Vector4.Transform(ref vec, ref mat, out result); Vector4.Transform(ref vec, ref mat, out result);
return result; return result;
} }
/// <summary>Transform a Vector by the given Matrix using right-handed notation</summary> /// <summary>
/// Transform a Vector by the given Matrix using right-handed notation
/// </summary>
/// <param name="vec">The vector to transform</param> /// <param name="vec">The vector to transform</param>
/// <param name="mat">The desired transformation</param> /// <param name="mat">The desired transformation</param>
/// <returns>The transformed vector</returns> /// <returns>The transformed vector</returns>
@ -1554,13 +1555,13 @@ namespace OpenTK
return result; return result;
} }
/// <summary> /// <summary>
/// Transforms a vector by a quaternion rotation. /// Transforms a vector by a quaternion rotation.
/// </summary> /// </summary>
/// <param name="vec">The vector to transform.</param> /// <param name="vec">The vector to transform.</param>
/// <param name="quat">The quaternion to rotate the vector by.</param> /// <param name="quat">The quaternion to rotate the vector by.</param>
/// <returns></returns> /// <returns>The transformed vector</returns>
public static Vector4 operator *(Quaternion quat, Vector4 vec) public static Vector4 operator *(Quaternion quat, Vector4 vec)
{ {
Vector4 result; Vector4 result;
Vector4.Transform(ref vec, ref quat, out result); Vector4.Transform(ref vec, ref quat, out result);