## On this page

  

 

 # Namespace ZOSAPI::Common

 Last update: 13.03.2026 

<a id="namespace_z_o_s_a_p_i_1_1_common"></a>

![](https://img.shields.io/badge/language-C%23-blue "C#")

**Definition**:

## Classes

- [ZOSAPI::Common::ICoordinateTransform](interface_z_o_s_a_p_i_1_1_common_1_1_i_coordinate_transform.md#interface_z_o_s_a_p_i_1_1_common_1_1_i_coordinate_transform)
- [ZOSAPI::Common::IMatrixData](interface_z_o_s_a_p_i_1_1_common_1_1_i_matrix_data.md#interface_z_o_s_a_p_i_1_1_common_1_1_i_matrix_data)
- [ZOSAPI::Common::IMetadata](interface_z_o_s_a_p_i_1_1_common_1_1_i_metadata.md#interface_z_o_s_a_p_i_1_1_common_1_1_i_metadata)
- [ZOSAPI::Common::ISettingsData](interface_z_o_s_a_p_i_1_1_common_1_1_i_settings_data.md#interface_z_o_s_a_p_i_1_1_common_1_1_i_settings_data)
- [ZOSAPI::Common::IVectorData](interface_z_o_s_a_p_i_1_1_common_1_1_i_vector_data.md#interface_z_o_s_a_p_i_1_1_common_1_1_i_vector_data)

## Enumeration types

### Enumeration type ZemaxColor

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**:

```csharp
enum ZemaxColor {
  Default,
  Color1,
  Color2,
  Color3,
  Color4,
  Color5,
  Color6,
  Color7,
  Color8,
  Color9,
  Color10,
  Color11,
  Color12,
  Color13,
  Color14,
  Color15,
  Color16,
  Color17,
  Color18,
  Color19,
  Color20,
  Color21,
  Color22,
  Color23,
  Color24,
  NoColor
}

```

#### Enumerator Default

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a7a1920d61156abc05a60135aefe8bc67"></a>

#### Enumerator Color1

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a10d80f0d320a1f0d44f4d5b81d2806bf"></a>

#### Enumerator Color2

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89ae2a7898b335d86cfce3647176ed64660"></a>

#### Enumerator Color3

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89aa768a1a754fe61345d8268ac9cbba90b"></a>

#### Enumerator Color4

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89ae2e4e0d0046eb80c1a3a6a44085448a4"></a>

#### Enumerator Color5

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a6a13b6d8b42dd3580ddf94cd8adddc04"></a>

#### Enumerator Color6

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89ab5ab4d4d35fe76b5dce0d22ca018c784"></a>

#### Enumerator Color7

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a615211c915b857c848bb2523aebcb87b"></a>

#### Enumerator Color8

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a7564c1632afb8a6aaca05e9bd5f93515"></a>

#### Enumerator Color9

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a2832ee537c7101260b3d5e20c0922c9e"></a>

#### Enumerator Color10

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89ab35c05431951c287d43b6e99dc4094ff"></a>

#### Enumerator Color11

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a5ca39723547d0bf4d5bdf297f4a8b5ef"></a>

#### Enumerator Color12

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a236b2a160b1d7e13ea0301fdb2e4c705"></a>

#### Enumerator Color13

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a7e43937d34383a1fc77337a4b7a8ba36"></a>

#### Enumerator Color14

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a487886d364eef41a559632d8db73d116"></a>

#### Enumerator Color15

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89afdd652ed15bd62101b361b632185016e"></a>

#### Enumerator Color16

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a6d29615d6bea6274f0991fd3748ad057"></a>

#### Enumerator Color17

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a958df9f8af09ea8893d5757a22898bed"></a>

#### Enumerator Color18

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a0621ae2fac8718fe568084b6ece99c36"></a>

#### Enumerator Color19

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a66214a22dfb1ade311a75beb3db34993"></a>

#### Enumerator Color20

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a848bb011e14014088deaa18ee1e98c3b"></a>

#### Enumerator Color21

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a3bf709d431160b4e8ddb4c9780571e7b"></a>

#### Enumerator Color22

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89ab0cdf0d99e99d76aecf311b7db789b20"></a>

#### Enumerator Color23

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89adbef8b9213ec31d4044cbaf1f9663bb3"></a>

#### Enumerator Color24

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89acfa2c86e5a10caaf8bf0d2cf7a853fbf"></a>

#### Enumerator NoColor

<a id="namespace_z_o_s_a_p_i_1_1_common_1aa74995b87d76e49d5d756895353aad89a745ff66e655ea022e59182e15f301c8c"></a>

### Enumeration type ZemaxOpacity

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcb"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**:

```csharp
enum ZemaxOpacity {
  P100,
  P90,
  P80,
  P70,
  P60,
  P50,
  P40,
  P30,
  P20,
  P10,
  P00
}

```

Usage (see [Example 17](../apiexamples/example_17.md) for a full sample)

C#

```csharp
            //Rectangular Volume
            //Scattering properties
            //Draw:opacity set to 50%
            IObjectTypeSettings oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
            Object_2.ChangeType(oType_2);
            Object_2.ZPosition = 2;
            Object_2.Material = "N-BK7";
            IObjectRectangularVolume RectVolume2_data = Object_2.ObjectData as IObjectRectangularVolume;
            RectVolume2_data.X1HalfWidth = 12;
            RectVolume2_data.Y1HalfWidth = 12;
            RectVolume2_data.ZLength = 40;
            RectVolume2_data.X2HalfWidth = 12;
            RectVolume2_data.Y2HalfWidth = 12;
            INCEVolumePhysicsData RectVolume2_volphysdata = Object_2.VolumePhysicsData;
            RectVolume2_volphysdata.Model = VolumePhysicsModelType.AngleScattering;
            RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5;
            RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30;
            INCEDrawData RectVolume2_Drawdata = Object_2.DrawData;
            RectVolume2_Drawdata.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

```

C++

```csharp
    //Rectangular Volume
    //Scattering properties
    //Draw:opacity set to 50%
    IObjectTypeSettingsPtr oType_2 = Object_2->GetObjectTypeSettings(ObjectType_RectangularVolume);
    Object_2->ChangeType(oType_2);
    Object_2->ZPosition = 2;
    Object_2->Material = "N-BK7";
    IObjectRectangularVolumePtr RectVolume2_data = Object_2->ObjectData;
    RectVolume2_data->X1HalfWidth = 12;
    RectVolume2_data->Y1HalfWidth = 12;
    RectVolume2_data->ZLength = 40;
    RectVolume2_data->X2HalfWidth = 12;
    RectVolume2_data->Y2HalfWidth = 12;
    INCEVolumePhysicsDataPtr RectVolume2_volphysdata = Object_2->VolumePhysicsData;
    RectVolume2_volphysdata->Model = VolumePhysicsModelType_AngleScattering;
    RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->MeanPath = 5;
    RectVolume2_volphysdata->ModelSettings->_S_AngleScattering->Angle = 30;
    INCEDrawDataPtr RectVolume2_Drawdata = Object_2->DrawData;
    RectVolume2_Drawdata->Opacity = ZemaxOpacity_P50;

```

Matlab

```csharp
    % Rectangular Volume
    % Scattering Properties
    % Draw:opacity set to 50%
    oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume);
    Object_2.ChangeType(oType_2);
    Object_2.ZPosition = 2;
    Object_2.Material = 'N-BK7';
    RectVolume2_data = Object_2.ObjectData;
    RectVolume2_data.X1HalfWidth = 12;
    RectVolume2_data.Y1HalfWidth = 12;
    RectVolume2_data.ZLength = 40;
    RectVolume2_data.X2HalfWidth = 12;
    RectVolume2_data.Y2HalfWidth = 12;
    RectVolume2_volphysdata = Object_2.VolumePhysicsData;
    RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering;
    RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.MeanPath = 5;
    RectVolume2_volphysdata.ModelSettings.S_AngleScattering_.Angle = 30;
    RectVolume2_DrawData = Object_2.DrawData;
    RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50;

```

Python

```csharp
    # Rectangular Volume
    # Scattering Properties
    # Draw:opacity set to 50%
    oType_2 = Object_2.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.RectangularVolume)
    Object_2.ChangeType(oType_2)
    Object_2.ZPosition = 2
    Object_2.Material = "N-BK7"
    RectVolume2_data = Object_2.ObjectData
    RectVolume2_data.X1HalfWidth = 12
    RectVolume2_data.Y1HalfWidth = 12
    RectVolume2_data.ZLength = 40
    RectVolume2_data.X2HalfWidth = 12
    RectVolume2_data.Y2HalfWidth = 12
    RectVolume2_volphysdata = Object_2.VolumePhysicsData
    RectVolume2_volphysdata.Model = ZOSAPI.Editors.NCE.VolumePhysicsModelType.AngleScattering
    RectVolume2_volphysdata.ModelSettings._S_AngleScattering.MeanPath = 5
    RectVolume2_volphysdata.ModelSettings._S_AngleScattering.Angle = 30
    RectVolume2_DrawData = Object_2.DrawData
    RectVolume2_DrawData.Opacity = ZOSAPI.Common.ZemaxOpacity.P50

```

#### Enumerator P100

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcba9e776ce9dbca3d1ccdcc42a288bf2d16"></a>

#### Enumerator P90

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcba94d84f61c9b1ca10a7651203d685539a"></a>

#### Enumerator P80

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcba148fb42c49bedf684e19dce8ff58a5f1"></a>

#### Enumerator P70

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcba36ad4f3e5d60ba949427f719fe5256be"></a>

#### Enumerator P60

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcbae14abdda2f1a04dd8828c73540a1ce09"></a>

#### Enumerator P50

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcbae0e09951f61fed537fba9bd4673c6673"></a>

#### Enumerator P40

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcbaf8fad38873381c3fe36228ceda07f8cf"></a>

#### Enumerator P30

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcba09d6d0ff190eac94313f1dc0565780e5"></a>

#### Enumerator P20

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcba10d0da4c8a5f5ee1e90f05239ab78d03"></a>

#### Enumerator P10

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcbaa8c1f8495e10277718398939ece8a2ae"></a>

#### Enumerator P00

<a id="namespace_z_o_s_a_p_i_1_1_common_1a0071f2287ecefd1f9c2486f0f36d0bcba21978e3f07166e693efbf87c4b5ee3a3"></a>

### Enumeration type SettingsDataType

<a id="namespace_z_o_s_a_p_i_1_1_common_1a3f54742c5ea7ea3449f67a65dea61289"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**:

```csharp
enum SettingsDataType {
  None,
  Integer,
  Double,
  Float,
  String,
  Byte,
  Boolean
}

```

#### Enumerator None

<a id="namespace_z_o_s_a_p_i_1_1_common_1a3f54742c5ea7ea3449f67a65dea61289a6adf97f83acf6453d4a6a4b1070f3754"></a>

#### Enumerator Integer

<a id="namespace_z_o_s_a_p_i_1_1_common_1a3f54742c5ea7ea3449f67a65dea61289aa0faef0851b4294c06f2b94bb1cb2044"></a>

#### Enumerator Double

<a id="namespace_z_o_s_a_p_i_1_1_common_1a3f54742c5ea7ea3449f67a65dea61289ad909d38d705ce75386dd86e611a82f5b"></a>

#### Enumerator Float

<a id="namespace_z_o_s_a_p_i_1_1_common_1a3f54742c5ea7ea3449f67a65dea61289a22ae0e2b89e5e3d477f988cc36d3272b"></a>

#### Enumerator String

<a id="namespace_z_o_s_a_p_i_1_1_common_1a3f54742c5ea7ea3449f67a65dea61289a27118326006d3829667a400ad23d5d98"></a>

#### Enumerator Byte

<a id="namespace_z_o_s_a_p_i_1_1_common_1a3f54742c5ea7ea3449f67a65dea61289aa245c3230debe5c956484ecc6fa93877"></a>

#### Enumerator Boolean

<a id="namespace_z_o_s_a_p_i_1_1_common_1a3f54742c5ea7ea3449f67a65dea61289a27226c864bac7454a8504f8edb15d95b"></a>