Class GearTrainDocumentAPI

Namespace: VM.API.Pre.GearTrain
Assembly: VM.API.Pre.GearTrain.dll

This class implements APIs for gear train document.

public static class GearTrainDocumentAPI

Inheritance

object ← GearTrainDocumentAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

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

Create .

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.M, double shaftDirectionX = 0, double shaftDirectionY = 1, double shaftDirectionZ = 0)

Parameters

newGearTrainFilePath string

The file path of new gear train subsystem.

documentName string

The name of document. The default value is Subsystem.

gravity Vector

The gravity value.

unit Unit

The unit information.

iconSize double

The size of icon.

advancedMode bool

The flag whether using advanced mode.

symmetricPlane Plane

The symetric plane.

useSymmetric bool

The flag whether using symmetric.

kernelLengthUnit LengthUnitType

The length unit of kernel.

shaftDirectionX double

The x direction of shaft.

shaftDirectionY double

The y direction of shaft.

shaftDirectionZ double

The z direction of shaft.

Returns

GearTrainDocument

The new DocumentChainedPath object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'newLinkPathFilePath' argument is null.