Class GlueAPI

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

This class implements APIs for and class.

public static class GlueAPI

Inheritance

object ← GlueAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)

Methods

CreateTieWithColor(SubSystemDocument, Obj, IEnumerable, Obj, IEnumerable, string, SymmetricType)

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseBody", "actionBody" })]
[MatchTypeObj(new object[] { "baseBody", typeof(SolidBody), "actionBody", typeof(SolidBody) })]
public static Obj CreateTieWithColor(this SubSystemDocument document, Obj baseBody, IEnumerable<color> baseColors, Obj actionBody, IEnumerable<color> actionColors, string tieName = "", SymmetricType symmetricType = SymmetricType.None)

Parameters

document SubSystemDocument

baseBody Obj

baseColors IEnumerableColor>

actionBody Obj

actionColors IEnumerableColor>

tieName string

symmetricType SymmetricType

Returns

Obj

CreateTieWithColor(PartDocument, Obj, IEnumerable, Obj, IEnumerable, string, SymmetricType)

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseBody", "actionBody" })]
public static Obj CreateTieWithColor(this PartDocument document, Obj baseBody, IEnumerable<color> baseColors, Obj actionBody, IEnumerable<color> actionColors, string tieName = "", SymmetricType symmetricType = SymmetricType.None)

Parameters

document PartDocument

baseBody Obj

baseColors IEnumerableColor>

actionBody Obj

actionColors IEnumerableColor>

tieName string

symmetricType SymmetricType

Returns

Obj

CreateTieWithFaces(IDocument, IEnumerable, IEnumerable, string, SymmetricType)

Create with faces.

[NotNull(new string[] { "document", "baseFaces", "actionFaces" })]
public static Obj CreateTieWithFaces(this IDocument document, IEnumerable<obj> baseFaces, IEnumerable<obj> actionFaces, string tieName = "", SymmetricType symmetricType = SymmetricType.None)

Parameters

document IDocument

The document to create the tie.

baseFaces IEnumerable

The base faces

actionFaces IEnumerable

The action faces

tieName string

The name of the tie. If empty, default name starts with 'TIE_' will be generated and used.

symmetricType SymmetricType

The symmetric type

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document' or 'baseContactable' or 'actionContactable' arguments are empty.

ArgumentException

Will be thrown if the type of 'document' is not SubSystemDocument and PartDocument.

CreateTieWithFaceset(IDocument, Obj, Obj, string, SymmetricType)

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseGeometry", "actionGeometry" })]
[MatchTypeObj(new object[] { "baseGeometry", typeof(IContactableRigid3D), "actionGeometry", typeof(IContactableRigid3D) })]
public static Obj CreateTieWithFaceset(this IDocument document, Obj baseGeometry, Obj actionGeometry, string tieName = "", SymmetricType symmetricType = SymmetricType.None)

Parameters

document IDocument

baseGeometry Obj

actionGeometry Obj

tieName string

symmetricType SymmetricType

Returns

Obj

CreateWeld(IDocument, Obj, Obj, Vector, Vector, Vector?, string, ExpressionValueVariable?, ExpressionValueVariable?, Obj?, Color?)

Create with two points.

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseBody", "actionBody" })]
[MatchTypeObj(new object[] { "material", typeof(ISO) })]
public static Obj CreateWeld(this IDocument document, Obj baseBody, Obj actionBody, Vector startPoint, Vector endPoint, Vector? tangentialDirection = null, string name = "", ExpressionValueVariable? number = null, ExpressionValueVariable? halfLength = null, Obj? material = null, Color? color = null)

Parameters

document IDocument

The to create the weld in mesh free.

baseBody Obj

The base body of the weld in mesh free.

actionBody Obj

The action body of the weld in mesh free.

startPoint Vector

The start point of the weld in mesh free.

endPoint Vector

The end point of the weld in mesh free.

tangentialDirection Vector?

The tangential direction of the weld in mesh free.

name string

The name of the weld in mesh free.

number ExpressionValueVariable?

The num of element of the weld in mesh free.

halfLength ExpressionValueVariable?

The half length of element of the weld in mesh free.

material Obj?

The material of the weld in mesh free. This type should be .

color Color?

The color of the weld in mesh free.

Returns

Obj

the new object created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'baseBody', 'actionBody' argument is null.

ArgumentException

Will be thrown if the magnitude of 'tangentialDirection' is 0 and if the type of 'material' is not 'ISO'.

ArgumentException

Will be thrown if 'document' is not and .

ArgumentException

Will be thrown if 'baseBody', 'actionBody' is not and or if 'baseBody' is equal to 'actionBody'.

ArgumentOutOfRangeException

Will be thrown if 'number' value is less than 2.

CreateWeld(IDocument, Obj, Obj, IEnumerable, Vector?, string, ExpressionValueVariable?, Obj?, Color?)

Create with multi points.

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseBody", "actionBody" })]
[MatchTypeObj(new object[] { "material", typeof(ISO) })]
public static Obj CreateWeld(this IDocument document, Obj baseBody, Obj actionBody, IEnumerable<vector> positions, Vector? tangentialDirection = null, string name = "", ExpressionValueVariable? halfLength = null, Obj? material = null, Color? color = null)

Parameters

document IDocument

The to create the weld in mesh free.

baseBody Obj

The base body of the weld in mesh free.

actionBody Obj

The action body of the weld in mesh free.

positions IEnumerable

The positions of the weld in mesh free.

tangentialDirection Vector?

The tangential direction of the weld in mesh free.

name string

The name of the weld in mesh free.

halfLength ExpressionValueVariable?

The half length of element of the weld in mesh free.

material Obj?

The material of the weld in mesh free. This type should be .

color Color?

The color of the weld in mesh free.

Returns

Obj

the new object created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'baseBody', 'actionBody' argument is null.

ArgumentException

Will be thrown if the magnitude of 'tangentialDirection' is 0 and if the type of 'material' is not 'ISO'.

ArgumentException

Will be thrown if 'document' is not and .

ArgumentException

Will be thrown if 'baseBody', 'actionBody' is not and or if 'baseBody' is equal to 'actionBody'.

CreateWeld(IDocument, string, Obj, Obj, string, Obj?, Color?)

Create with file.

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseBody", "actionBody" })]
[MatchTypeObj(new object[] { "material", typeof(ISO) })]
[ExistFile(new string[] { "filePath" })]
public static Obj CreateWeld(this IDocument document, string filePath, Obj baseBody, Obj actionBody, string name = "", Obj? material = null, Color? color = null)

Parameters

document IDocument

The to create the weld in mesh free.

filePath string

The file path of the weld in mesh free.

baseBody Obj

The base body of the weld in mesh free.

actionBody Obj

The action body of the weld in mesh free.

name string

The name of the weld in mesh free.

material Obj?

The material of the weld in mesh free. This type should be .

color Color?

The color of the weld in mesh free.

Returns

Obj

the new object created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'baseBody', 'actionBody' argument is null.

ArgumentException

Will be thrown if the type of 'material' is not 'ISO'.

FileNotFoundException

Will be thrown if 'filePath' files are not exist.

ArgumentException

Will be thrown if 'document' is not and .

ArgumentException

Will be thrown if 'baseBody', 'actionBody' is not and or if 'baseBody' is equal to 'actionBody'.