Class SplitAPI
Last update: 16.07.2025Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll
This class implements APIs for split.
public static class SplitAPI
Inheritance
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)
Methods
SplitFaceWithCirclePlane(IDocument, IEnumerable<Obj>, Vector, Vector, ExpressionValueVariable?)
Split a face with circle plane.
[NotNull(new string[] { "document", "targetFaces" })]
public static void SplitFaceWithCirclePlane(this IDocument document, IEnumerable<Obj> targetFaces, Vector point, Vector direction, ExpressionValueVariable? radius = null)
Parameters
document IDocument
The
targetFaces IEnumerable<Obj>
The target faces of a face with circle plane.
point Vector
The point of a face with circle plane.
direction Vector
The direction of a face with circle plane.
radius ExpressionValueVariable?
The radius of a face with circle plane.
Exceptions
Will be thrown if 'document', 'targetFaces' argument is null.
Will be thrown if the type of 'document' is not
Will be thrown if the type of 'targetFaces' is not
Will be thrown if the 'radius' value is equal to or less than 0.
SplitFaceWithImprintFaceAndBody(IDocument, IEnumerable<Obj>, Obj, bool)
Split a face with Imprint.
[NotNull(new string[] { "document", "targetFaces" })]
[NotNullObj(new string[] { "toolBody" })]
public static void SplitFaceWithImprintFaceAndBody(this IDocument document, IEnumerable<Obj> targetFaces, Obj toolBody, bool parametric = true)
Parameters
document IDocument
The
targetFaces IEnumerable<Obj>
The target faces of a face with imprint.
toolBody Obj
The tool body of a face with imprint.
parametric bool
The flag of parametric of a face with imprint.
Exceptions
Will be thrown if 'document', 'targetFaces', 'toolBody' argument is null.
Will be thrown if the type of 'document' is not
Will be thrown if the type of 'targetFaces' is not
Will be thrown if the type of 'toolBody' is not
SplitFaceWithImprintTwoBodies(IDocument, Obj, Obj, bool)
Split a face with Imprint.
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "targetBody", "toolBody" })]
public static void SplitFaceWithImprintTwoBodies(this IDocument document, Obj targetBody, Obj toolBody, bool parametric = true)
Parameters
document IDocument
The
targetBody Obj
The target body of a face with imprint.
toolBody Obj
The tool body of a face with imprint.
parametric bool
The flag of parametric of a face with imprint.
Exceptions
Will be thrown if 'document', 'targetBody', 'toolBody' argument is null.
Will be thrown if the type of 'document' is not
Will be thrown if the type of 'targetBody', 'toolBody' is not
Will be thrown if the 'toolBody' is equal to the 'targetBody'.
SplitFaceWithImprintTwoFaces(IDocument, IEnumerable<Obj>, IEnumerable<Obj>, bool)
Split a face with Imprint.
[NotNull(new string[] { "document", "targetFaces", "toolFaces" })]
public static void SplitFaceWithImprintTwoFaces(this IDocument document, IEnumerable<Obj> targetFaces, IEnumerable<Obj> toolFaces, bool parametric = true)
Parameters
document IDocument
The
targetFaces IEnumerable<Obj>
The target faces of a face with imprint.
toolFaces IEnumerable<Obj>
The tool faces of a face with imprint.
parametric bool
The flag of parametric of a face with imprint.
Exceptions
Will be thrown if 'document', 'targetFaces', 'toolFaces' argument is null.
Will be thrown if the type of 'document' is not
Will be thrown if the type of 'targetFaces', 'toolFaces' is not
SplitFaceWithRectanglePlane(IDocument, IEnumerable<Obj>, Vector, TMatrix, ExpressionValueVariable?, ExpressionValueVariable?)
Split a face with rectangle plane.
[NotNull(new string[] { "document", "targetFaces" })]
public static void SplitFaceWithRectanglePlane(this IDocument document, IEnumerable<Obj> targetFaces, Vector point, TMatrix transform, ExpressionValueVariable? width = null, ExpressionValueVariable? height = null)
Parameters
document IDocument
The
targetFaces IEnumerable<Obj>
The target faces of a face with rectangle plane.
point Vector
The point of a face with rectangle plane.
transform TMatrix
The transform of a face with rectangle plane.
width ExpressionValueVariable?
The width of a face with rectangle plane.
height ExpressionValueVariable?
The height of a face with rectangle plane.
Exceptions
Will be thrown if 'document', 'targetFaces' argument is null.
Will be thrown if the type of 'document' is not
Will be thrown if the type of 'targetFaces' is not
Will be thrown if the magnitude of transform X, Y, Z values is equal to 0.
Will be thrown if 'width', 'height' values are equal to or less than 0.
