This value class describes a quaternion representation and associated operations.
Namespace: Cognex.VisionPro3DAssembly: Cognex.VisionPro3D.Core (in Cognex.VisionPro3D.Core.dll) Version: 65.1.0.0
Syntax
The Cog3DQuaternion type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Cog3DQuaternion |
Construct this Cog3DQuaternion with the supplied W,X,Y,Z values.
|
Methods
| Name | Description | |
|---|---|---|
| ComputeConjugate |
Gets the conjugate quaternion of this quaternion, which is defined
as follows: W - X i - Y j - Z k
|
| ComputeGrassmannProduct |
Compute the Grassmann product of this Cog3DQuaternion with the supplied other.
|
| ComputeInnerProduct |
Compute the inner product of this Cog3DQuaternion with the supplied other.
|
| ComputeUnitQuaternion |
Gets the normalized quaternion (a unit quaternion) whose Norm
value is 1.
|
| Equals | (Overrides ValueType Equals(Object).) |
| GetHashCode | (Overrides ValueType GetHashCode .) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | RealEqual |
Compares the internal state of the specified instances and returns
true if the internal state is within epsilon.
|
| ToString |
Override of ToString method to get a string for describing this object.
(Overrides ValueType ToString .) |
Operators
| Name | Description | |
|---|---|---|
 | Addition |
Add two quaternions.
|
| Equality |
Compare two Cog3DQuaternion.
|
| Inequality |
Compare two Cog3DQuaternion.
|
| Multiply |
Multiply a Cog3DQuaternion by a scalar.
|
| Subtraction |
Subtract two quaternions: alpha - beta.
|
Properties
| Name | Description | |
|---|---|---|
 | Norm |
Gets the norm (magnitude) value of this quaternion object.
|
| NormSquared |
Gets the norm squared value of this quaternion object.
|
| W |
Gets the scalar part (the first component) of this quaternion.
|
| X |
Gets the second component of this quaternion object.
|
| XYZ |
Gets the vector (imaginary) part of this quaternion object.
|
| Y |
Gets the third component of this quaternion object.
|
| Z |
Gets the fourth component of this quaternion object.
|
Remarks
- This class is immutable - it may not be changed once it has been constructed.
- The default constructor creates a zero quaternion, which is not valid for usage by Cog3DTransformRotation.
- Although quaternions are useful in calculations involving 3D rotations, users should use Cog3DTransformRotation for general 3D rotation operations.
See Also