## On this page

  

 

 # Struct OMatrix

 Last update: 16.07.2025 

Namespace: [VM](VM.md)  
Assembly: VM.dll

```csharp
public struct OMatrix : IOMatrix

```

#### Implements

[IOMatrix](VM.IOMatrix.md)

## Constructors

### OMatrix(OMatrix)

Copy construct orientation matrix

```csharp
public OMatrix(OMatrix mat)

```

#### Parameters

`mat` [OMatrix](VM.OMatrix.md)

The matrix to copy

### OMatrix(Plane, Vector, Vector)

Construct orientation matrix with two principal axis

```csharp
public OMatrix(Plane type, Vector vecMaster, Vector vecSlave)

```

#### Parameters

`type` [Plane](VM.Plane.md)

The plane type

`vecMaster` [Vector](VM.Vector.md)

The master axis

`vecSlave` [Vector](VM.Vector.md)

The slave axis

### OMatrix(double\[\])

Construct orientation matrix with array of double

```csharp
public OMatrix(double[] arr)

```

#### Parameters

`arr` [double](https://learn.microsoft.com/dotnet/api/system.double)\[\]

The array contains orientation matrix

## Properties

### Array

Get/Set the array of matrix value

```csharp
public double[] Array { get; set; }

```

#### Property Value

[double](https://learn.microsoft.com/dotnet/api/system.double)\[\]

### Identity

Gets the Identity Orientation Matrix.

```csharp
public static OMatrix Identity { get; }

```

#### Property Value

[OMatrix](VM.OMatrix.md)

### XVector

Get/Set X vector of matrix

```csharp
public Vector XVector { get; set; }

```

#### Property Value

[Vector](VM.Vector.md)

### YVector

Get/Set Y vector of matrix

```csharp
public Vector YVector { get; set; }

```

#### Property Value

[Vector](VM.Vector.md)

### ZVector

Get/Set Z vector of matrix

```csharp
public Vector ZVector { get; set; }

```

#### Property Value

[Vector](VM.Vector.md)

### this\[int\]

Get/Set the specific vector of matrix

```csharp
public Vector this[int nIndex] { get; set; }

```

#### Property Value

[Vector](VM.Vector.md)

### this\[Coordinate\]

Get/Set the specific vector of matrix

```csharp
public Vector this[Coordinate enIndex] { get; set; }

```

#### Property Value

[Vector](VM.Vector.md)

### this\[int, int\]

Get/Set the specific value of matrix element

```csharp
public double this[int nRow, int nCol] { get; set; }

```

#### Property Value

[double](https://learn.microsoft.com/dotnet/api/system.double)

### this\[Coordinate, Coordinate\]

Get/Set the specific value of matrix element

```csharp
public double this[Coordinate enRow, Coordinate enCol] { get; set; }

```

#### Property Value

[double](https://learn.microsoft.com/dotnet/api/system.double)

## Methods

### CopyTo(double\[\], int)

Copy matrix values to the array

```csharp
public void CopyTo(double[] arr, int nStartIndex)

```

#### Parameters

`arr` [double](https://learn.microsoft.com/dotnet/api/system.double)\[\]

The array values copied to

`nStartIndex` [int](https://learn.microsoft.com/dotnet/api/system.int32)

The start index of array

### Equals(object)

Determines whether the specified object is equal to the current object.

```csharp
public override bool Equals(object obj)

```

#### Parameters

`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)

The object to compare.

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

true if the objects are equal, otherwise false.

### GetDirectionVector(Coordinate)

Get the direction vector for axis.

```csharp
public Vector GetDirectionVector(Coordinate axis)

```

#### Parameters

`axis` [Coordinate](VM.Coordinate.md)

The type of axis.

#### Returns

[Vector](VM.Vector.md)

The direction vector.

### GetDirectionVector(int)

Get the direction vector for axis.

```csharp
public Vector GetDirectionVector(int axis)

```

#### Parameters

`axis` [int](https://learn.microsoft.com/dotnet/api/system.int32)

The type of axis.

#### Returns

[Vector](VM.Vector.md)

The direction vector.

### GetHashCode()

Returns the hash code for this vector

```csharp
public override int GetHashCode()

```

#### Returns

[int](https://learn.microsoft.com/dotnet/api/system.int32)

A 32-bit signed integer hash code.

### Initialize()

Initialize the Orientation Matrix

```csharp
public void Initialize()

```

### Normalize()

Normalize the Orientation Matrix

```csharp
public void Normalize()

```

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The normalize operation failed .

### RotateAxisDeg(Coordinate, double)

To rotate counterclockwise for coordinate.

```csharp
public void RotateAxisDeg(Coordinate c, double dAngle)

```

#### Parameters

`c` [Coordinate](VM.Coordinate.md)

The rotation coordinate.

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The degree.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### RotateAxisDeg(int, double)

To rotate counterclockwise for coordinate.

```csharp
public void RotateAxisDeg(int nCoord, double dAngle)

```

#### Parameters

`nCoord` [int](https://learn.microsoft.com/dotnet/api/system.int32)

The rotation coordinate.

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The degree.

### RotateAxisDeg(Vector, double)

To rotate counterclockwise for axis.

```csharp
public void RotateAxisDeg(Vector axis, double dAngle)

```

#### Parameters

`axis` [Vector](VM.Vector.md)

The rotation axis.

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The degree.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### RotateAxisRad(Coordinate, double)

To rotate counterclockwise for coordinate.

```csharp
public void RotateAxisRad(Coordinate c, double dAngle)

```

#### Parameters

`c` [Coordinate](VM.Coordinate.md)

The rotation coordinate.

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The radian.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### RotateAxisRad(int, double)

To rotate counterclockwise for coordinate.

```csharp
public void RotateAxisRad(int nCoord, double dAngle)

```

#### Parameters

`nCoord` [int](https://learn.microsoft.com/dotnet/api/system.int32)

The rotation coordinate.

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The radian.

### RotateAxisRad(Vector, double)

To rotate counterclockwise for axis.

```csharp
public void RotateAxisRad(Vector axis, double dAngle)

```

#### Parameters

`axis` [Vector](VM.Vector.md)

The rotation axis.

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The radian.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### RotateXDeg(double)

To rotate counterclockwise for x-axis.

```csharp
public void RotateXDeg(double dAngle)

```

#### Parameters

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The degree.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### RotateXRad(double)

To rotate counterclockwise for x-axis.

```csharp
public void RotateXRad(double dAngle)

```

#### Parameters

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The radian.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### RotateYDeg(double)

To rotate counterclockwise for y-axis.

```csharp
public void RotateYDeg(double dAngle)

```

#### Parameters

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The degree.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### RotateYRad(double)

To rotate counterclockwise for y-axis.

```csharp
public void RotateYRad(double dAngle)

```

#### Parameters

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The radian.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### RotateZDeg(double)

To rotate counterclockwise for z-axis.

```csharp
public void RotateZDeg(double dAngle)

```

#### Parameters

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The degree.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### RotateZRad(double)

To rotate counterclockwise for z-axis.

```csharp
public void RotateZRad(double dAngle)

```

#### Parameters

`dAngle` [double](https://learn.microsoft.com/dotnet/api/system.double)

The radian.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The rotate operation failed .

### SetOrientation(Plane, Vector, Vector)

Set data of orientation.

```csharp
public void SetOrientation(Plane type, Vector vecMaster, Vector vecSlave)

```

#### Parameters

`type` [Plane](VM.Plane.md)

The type of plane.

`vecMaster` [Vector](VM.Vector.md)

The vector for master.

`vecSlave` [Vector](VM.Vector.md)

The vector for slave.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The set data of orientation operation failed .

### SetOrientation(OMatrix)

Set data of orientation.

```csharp
public void SetOrientation(OMatrix mat)

```

#### Parameters

`mat` [OMatrix](VM.OMatrix.md)

The matrix of orientation.

### SetOrientation(double\[\])

Set data of orientation.

```csharp
public void SetOrientation(double[] arr)

```

#### Parameters

`arr` [double](https://learn.microsoft.com/dotnet/api/system.double)\[\]

The data of orientation.

### SetOrientationEADeg(RotationAxes, double, double, double)

Set data of orientation for euler angle. Unit is degree.

```csharp
public void SetOrientationEADeg(RotationAxes ea, double dAlpha, double dBeta, double dGamma)

```

#### Parameters

`ea` [RotationAxes](VM.RotationAxes.md)

The type of euler angle.

`dAlpha` [double](https://learn.microsoft.com/dotnet/api/system.double)

The alpha of euler angle.

`dBeta` [double](https://learn.microsoft.com/dotnet/api/system.double)

The beta of euler angle.

`dGamma` [double](https://learn.microsoft.com/dotnet/api/system.double)

The gamma of euler angle.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The set data of orientation operation failed .

### SetOrientationEARad(RotationAxes, double, double, double)

Set data of orientation for euler angle. Unit is radian.

```csharp
public void SetOrientationEARad(RotationAxes ea, double dAlpha, double dBeta, double dGamma)

```

#### Parameters

`ea` [RotationAxes](VM.RotationAxes.md)

The type of euler angle.

`dAlpha` [double](https://learn.microsoft.com/dotnet/api/system.double)

The alpha of euler angle.

`dBeta` [double](https://learn.microsoft.com/dotnet/api/system.double)

The beta of euler angle.

`dGamma` [double](https://learn.microsoft.com/dotnet/api/system.double)

The gamma of euler angle.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The set data of orientation operation failed .

### SetOrientationFixedAngleDeg(RotationAxes, double, double, double)

Set data of orientation for fixed angle. Unit is degree.

```csharp
public void SetOrientationFixedAngleDeg(RotationAxes ea, double dAlpha, double dBeta, double dGamma)

```

#### Parameters

`ea` [RotationAxes](VM.RotationAxes.md)

The type of fixed angle.

`dAlpha` [double](https://learn.microsoft.com/dotnet/api/system.double)

The alpha of fixed angle.

`dBeta` [double](https://learn.microsoft.com/dotnet/api/system.double)

The beta of fixed angle.

`dGamma` [double](https://learn.microsoft.com/dotnet/api/system.double)

The gamma of fixed angle.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The set data of orientation operation failed .

### SetOrientationFixedAngleRad(RotationAxes, double, double, double)

Set data of orientation for fixed angle. Unit is radian.

```csharp
public void SetOrientationFixedAngleRad(RotationAxes ea, double dAlpha, double dBeta, double dGamma)

```

#### Parameters

`ea` [RotationAxes](VM.RotationAxes.md)

The type of fixed angle.

`dAlpha` [double](https://learn.microsoft.com/dotnet/api/system.double)

The alpha of fixed angle.

`dBeta` [double](https://learn.microsoft.com/dotnet/api/system.double)

The beta of fixed angle.

`dGamma` [double](https://learn.microsoft.com/dotnet/api/system.double)

The gamma of fixed angle.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The set data of orientation operation failed .

### ToString()

```csharp
public override string ToString()

```

#### Returns

[string](https://learn.microsoft.com/dotnet/api/system.string)

### TransposeOrientation()

Transposed rows and columns of the matrix.

```csharp
public void TransposeOrientation()

```

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The transpose operation failed .

## Operators

### operator ==(OMatrix, OMatrix)

Compare two orientation matrices are same or not

```csharp
public static bool operator ==(OMatrix matLeft, OMatrix matRight)

```

#### Parameters

`matLeft` [OMatrix](VM.OMatrix.md)

The left matrix to compare

`matRight` [OMatrix](VM.OMatrix.md)

The right matrix to compare

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

true if two matrices are same, otherwise false.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The equality operation failed .

### operator !=(OMatrix, OMatrix)

Compare two orientation matrices are same or not

```csharp
public static bool operator !=(OMatrix matLeft, OMatrix matRight)

```

#### Parameters

`matLeft` [OMatrix](VM.OMatrix.md)

The left matrix to compare

`matRight` [OMatrix](VM.OMatrix.md)

The right matrix to compare

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

true if two matrices are not same, otherwise false.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The inequality operation failed .

### operator \*(OMatrix, OMatrix)

Cross product two orientation matrices.

```csharp
public static OMatrix operator *(OMatrix matA, OMatrix matB)

```

#### Parameters

`matA` [OMatrix](VM.OMatrix.md)

The left matrix to cross product

`matB` [OMatrix](VM.OMatrix.md)

The right matrix to cross product

#### Returns

[OMatrix](VM.OMatrix.md)

The cross product matrix.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The multiply operation failed .

### operator \*(Vector, OMatrix)

Multiply vector to the matrix.

```csharp
public static Vector operator *(Vector vec, OMatrix mat)

```

#### Parameters

`vec` [Vector](VM.Vector.md)

The vector to multiply value

`mat` [OMatrix](VM.OMatrix.md)

The matrix to multiply

#### Returns

[Vector](VM.Vector.md)

The Multiplied vector.

#### Exceptions

[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)

The multiply operation failed .