## On this page

  

 

 # Class GearTrainDocumentAPI

 Last update: 16.07.2025 

Namespace: [VM.API.Pre.GearTrain](VM.API.Pre.GearTrain.md)  
Assembly: VM.API.Pre.GearTrain.dll

This class implements APIs for gear train document.

```csharp
public static class GearTrainDocumentAPI

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [GearTrainDocumentAPI](VM.API.Pre.GearTrain.GearTrainDocumentAPI.md)

#### Extension Methods

[LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### CreateNewGearTrainDocument(string, string, Vector, Unit, double, bool, Plane, bool, LengthUnitType, double, double, double)

Create .

```csharp
public static GearTrainDocument CreateNewGearTrainDocument(string newGearTrainFilePath, string documentName = "Subsystem", Vector gravity = default, Unit unit = null, double iconSize = 1, bool advancedMode = true, Plane symmetricPlane = Plane.YZ, bool useSymmetric = false, LengthUnitType kernelLengthUnit = LengthUnitType.MM, double shaftDirectionX = 0, double shaftDirectionY = 1, double shaftDirectionZ = 0)

```

#### Parameters

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

The file path of new gear train subsystem.

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

The name of document. The default value is Subsystem.

`gravity` Vector

The gravity value.

`unit` Unit

The unit information.

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

The size of icon.

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

The flag whether using advanced mode.

`symmetricPlane` Plane

The symetric plane.

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

The flag whether using symmetric.

`kernelLengthUnit` LengthUnitType

The length unit of kernel.

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

The x direction of shaft.

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

The y direction of shaft.

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

The z direction of shaft.

#### Returns

GearTrainDocument

The new DocumentChainedPath object that is created by this API.

#### Exceptions

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

Will be thrown if 'newLinkPathFilePath' argument is null.