Class SplineAPI

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

This class implements APIs for spline class.

public static class SplineAPI

Inheritance

object ← SplineAPI

Extension Methods

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

Methods

CreateSpline(IDocument, string, IEnumerable<Point>, ExpressionValueVariable?, ExpressionValueVariable?, SymmetricType)

Create .

[NotNull(new string[] { "document" })]
public static Obj CreateSpline(this IDocument document, string name, IEnumerable<SplineData.Point> splineData, ExpressionValueVariable? scaleX = null, ExpressionValueVariable? scaleY = null, SymmetricType symmetricType = SymmetricType.None)

Parameters

document IDocument

The document to create the spline.

name string

The point X, Y of the spline.

splineData IEnumerable<SplineData.Point>

The density of the spline.

scaleX ExpressionValueVariable?

The X scale of spline.

scaleY ExpressionValueVariable?

The Y scale of spline.

symmetricType SymmetricType

The symmetric type of the new .

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'splineData' is null.

CreateSpline3D(IDocument, string, ExpressionValueVariable[,], ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, SymmetricType)

Create .

[NotNull(new string[] { "document", "points" })]
public static Obj CreateSpline3D(this IDocument document, string name, ExpressionValueVariable[,] points, ExpressionValueVariable? scaleX = null, ExpressionValueVariable? scaleY = null, ExpressionValueVariable? scaleZ = null, SymmetricType symmetricType = SymmetricType.None)

Parameters

document IDocument

The document to create the spline3D.

name string

The point X, Y of the spline3D.

points ExpressionValueVariable[,]

The points of the spline3D.

scaleX ExpressionValueVariable?

The X scale of spline3D.

scaleY ExpressionValueVariable?

The Y scale of spline3D.

scaleZ ExpressionValueVariable?

The Z scale of spline3D.

symmetricType SymmetricType

The symmetric type of the new .

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'points' is null.

ArgumentOutOfRangeException

Will be thrown if the count of the 'points' is less than 4.

CreateSplineWithFile(IDocument, string, string, string, ExpressionValueVariable?, ExpressionValueVariable?, SymmetricType)

Create .

[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "selectedSplineName" })]
[ExistFile(new string[] { "filePath" })]
public static Obj CreateSplineWithFile(this IDocument document, string name, string filePath, string selectedSplineName, ExpressionValueVariable? scaleX = null, ExpressionValueVariable? scaleY = null, SymmetricType symmetricType = SymmetricType.None)

Parameters

document IDocument

The document to create the spline.

name string

The point X, Y of the spline.

filePath string

The file path of the spline data.

selectedSplineName string

The name of the selected spline.

scaleX ExpressionValueVariable?

The X scale of spline.

scaleY ExpressionValueVariable?

The Y scale of spline.

symmetricType SymmetricType

The symmetric type of the new .

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'selectedSplineName' is null.