Vector3d
References[StructLayout(LayoutKind.Sequential, Pack = 8, Size = 24)]
[DebuggerDisplay("({m_x}, {m_y}, {m_z})")]
[Serializable]
public struct Vector3d : ISerializable, IEquatable<Vector3d>, IComparable<Vector3d>, IComparable, IEpsilonComparable<Vector3d>, ICloneable, IFormattable
Represents the three components of a vector in three-dimensional space, using double-precision floating point numbers.
Constructors
Initializes a new instance of a vector, using its three components.
Initializes a new instance of a vector, copying the three components from the three coordinates of a point.
Parameters:
| point (Point3d) | The point to copy from. |
public Vector3d(Vector3d vector)
Initializes a new instance of a vector, copying the three components from a vector.
Parameters:
| vector (Vector3d) | A double-precision vector. |
Properties
Gets a value indicating whether or not this is a unit vector. A unit vector has length 1.
Gets a value indicating whether this vector is valid. A valid vector must be formed of valid component values for x, y and z.
Gets a value indicating whether the X, Y, and Z values are all equal to 0.0.
Computes the length (or magnitude, or size) of this vector. This is an application of Pythagoras' theorem. If this vector is invalid, its length is considered 0.
Gets the largest (both positive and negative) component value in this vector, as an absolute value.
Gets the smallest (both positive and negative) component value in this vector.
Computes the squared length (or magnitude, or size) of this vector. This is an application of Pythagoras' theorem. While the Length property checks for input validity, this property does not. You should check validity in advance, if this vector can be invalid.
Gets the value of the vector with each component set to RhinoMath.UnsetValue.
Gets the value of the vector with components 1,0,0.
Gets the value of the vector with components 0,1,0.
Gets the value of the vector with components 0,0,1.
Indexers
Methods
Sums up two vectors.
(Provided for languages that do not support operator overloading. You can use the + operator otherwise)
Test whether three vectors describe an orthogonal axis system. All vectors must be mutually perpendicular this to be the case.
Test whether three vectors describe an orthogonal, unit axis system. All vectors must be mutually perpendicular and have unit length for this to be the case.
Test whether three vectors describe a right-handed, orthogonal, unit axis system. The vectors must be orthonormal and follow the right-hand ordering; index-finger=x, middle-finger=y, thumb=z.
Computes the cross product (or vector product, or exterior product) of two vectors.
This operation is not commutative.
Find scalars x and y so that the component of v in the plane of a and b is x*a + y*b
Divides a Vector3d by a number, having the effect of shrinking it.
(Provided for languages that do not support operator overloading. You can use the / operator otherwise)
Check that all values in other are within epsilon of the values in this
Implements: EpsilonEquals
Equals
#Determines whether the specified System.Object is a Vector3d and has the same values as the present vector.
Parameters:
| obj (object) | The specified object. |
Returns: true if obj is a Vector3d and has the same coordinates as this; otherwise false.
Overrides: ValueType.Equals
Determines whether the specified vector has the same value as the present vector.
Parameters:
| vector (Vector3d) | The specified vector. |
Returns: true if vector has the same coordinates as this; otherwise false.
GetHashCode
#Computes the hash code for the current vector.
Returns: A non-unique number that represents the components of this vector.
Overrides: ValueType.GetHashCode
Determines whether this vector is parallel to another vector, within a provided tolerance.
Determines whether this vector is parallel to another vector, within one degree (within Pi / 180).
Parameters:
| other (Vector3d) | Vector to use for comparison. |
Returns: Parallel indicator:
+1 = both vectors are parallel
0 = vectors are not parallel, or at least one of the vectors is zero
-1 = vectors are anti-parallel.
Determines whether this vector is perpendicular to another vector, within a provided angle tolerance.
Test to see whether this vector is perpendicular to within one degree of another one.
Parameters:
| other (Vector3d) | Vector to compare to. |
Returns: true if both vectors are perpendicular, false if otherwise.
Uses RhinoMath.ZeroTolerance for IsTiny calculation.
Returns: true if vector is very small, otherwise false.
Determines whether a vector is very short.
Parameters:
| tolerance (double) | A nonzero value used as the coordinate zero tolerance. . |
Returns: (Math.Abs(X) <= tiny_tol) AND (Math.Abs(Y) <= tiny_tol) AND (Math.Abs(Z) <= tiny_tol).
Multiplies two vectors together, returning the dot product (or inner product). This differs from the cross product.
(Provided for languages that do not support operator overloading. You can use the * operator otherwise)
Multiplies a vector by a number, having the effect of scaling it.
(Provided for languages that do not support operator overloading. You can use the * operator otherwise)
Multiplies a vector by a number, having the effect of scaling it.
(Provided for languages that do not support operator overloading. You can use the * operator otherwise)
Computes the reversed vector.
(Provided for languages that do not support operator overloading. You can use the - unary operator otherwise)
Set this vector to be perpendicular to a plane defined by 3 points.
Sets this vector to be perpendicular to another vector. Result is not unitized.
Parameters:
| other (Vector3d) | Vector to use as guide. |
Returns: true on success, false if input vector is zero or invalid.
Reverses this vector in place (reverses the direction).
If this vector is Invalid, no changes will occur and false will be returned.
Remarks: Similar to Negate, that is only provided for CLR language compliance.
Returns: true on success or false if the vector is invalid.
Rotates this vector around a given axis.
Subtracts the second vector from the first one.
(Provided for languages that do not support operator overloading. You can use the - operator otherwise)
Parameters:
| obj (object) |
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
Parameters:
| info (SerializationInfo) | |
| context (StreamingContext) |
ToString
#Returns the string representation of the current vector, in the form X,Y,Z.
Returns: A string with the current location of the point.
Overrides: ValueType.ToString
Formats the value of the current instance using the specified format.
Parameters:
| format (string) | The format to use. -or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation. |
| formatProvider (IFormatProvider) | The provider to use to format the value. -or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. |
Returns: The value of the current instance in the specified format.
public void Transform(Transform transformation)
Transforms the vector in place.
The transformation matrix acts on the left of the vector; i.e.,
result = transformation*vector
Parameters:
| transformation (Transform) | Transformation matrix to apply. |
Unitizes the vector in place. A unit vector has length 1 unit.
An invalid or zero length vector cannot be unitized.
Returns: true on success or false on failure.
Computes the angle on a plane between two vectors.
Compute the angle between two vectors.
This operation is commutative.
Computes the angle of v1, v2 with a normal vector.
Operators
| Operation | Result | Description | ||
|---|---|---|---|---|
| Vector3d | + | Vector3d | Vector3d | Sums up two vectors. |
| Vector3d | / | double | Vector3d | Divides a Vector3d by a number, having the effect of shrinking it. |
| Vector3d | == | Vector3d | bool | Determines whether two vectors have the same value. |
| Vector3d | > | Vector3d | bool | Determines whether the first specified vector comes after (has superior sorting value than) the second vector. Components evaluation priority is first X, then Y, then Z. |
| Vector3d | >= | Vector3d | bool | Determines whether the first specified vector comes after (has superior sorting value than) the second vector, or it is equal to it. Components evaluation priority is first X, then Y, then Z. |
| Vector3d | != | Vector3d | bool | Determines whether two vectors have different values. |
| Vector3d | < | Vector3d | bool | Determines whether the first specified vector comes before (has inferior sorting value than) the second vector. Components evaluation priority is first X, then Y, then Z. |
| Vector3d | <= | Vector3d | bool | Determines whether the first specified vector comes before (has inferior sorting value than) the second vector, or it is equal to it. Components evaluation priority is first X, then Y, then Z. |
| Vector3d | * | Vector3d | double | Multiplies two vectors together, returning the dot product (or inner product). This differs from the cross product. |
| double | * | Vector3d | Vector3d | Multiplies a vector by a number, having the effect of scaling it. |
| Vector3d | * | double | Vector3d | Multiplies a vector by a number, having the effect of scaling it. |
| Vector3d | - | Vector3d | Vector3d | Subtracts the second vector from the first one. |
| - | Vector3d | Vector3d | Computes the opposite vector. | |