Class DocumentAPIImpl

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

This class implements APIs for gear train document.

public static class DocumentAPIImpl

Inheritance

object ← DocumentAPIImpl

Extension Methods

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

Methods

CreateNewGearTrainDocumentImpl<T>(string, string, Vector, Unit, double, bool, Plane, bool, LengthUnitType, Vector, string, string)

Create .

[NotNullOrEmpty(new string[] { "newGearTrainFilePath" })]
public static T CreateNewGearTrainDocumentImpl<T>(string newGearTrainFilePath, string documentName, Vector gravity, Unit unit, double iconSize, bool advancedMode, Plane symmetricPlane, bool useSymmetric, LengthUnitType kernelLengthUnit, Vector shaftDirection, string extension, string documentType) where T : GearTrainDocument

Parameters

newGearTrainFilePath string

The file path of new gear train.

documentName string

The name of document.

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.

shaftDirection Vector

The direction of shaft.

extension string

The extension.

documentType string

The document type.

Returns

T

The new object that is created by this API.

Type Parameters

T

The document type

Exceptions

ArgumentNullException

Will be thrown if 'newMeshFilePath' argument is empty.