Class EFConstraintAPI

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

This class implements APIs for , , , class.

public static class EFConstraintAPI

Inheritance

object ← EFConstraintAPI

Extension Methods

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

Methods

CreateBoundaryConditionWithColor(SubSystemDocument, Obj, IEnumerable<Color>, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, Obj?, string)

[NotNull(new string[] { "document", "colors" })]
[NotNullObj(new string[] { "body" })]
[MatchTypeObj(new object[] { "body", typeof(SolidBody) })]
public static Obj CreateBoundaryConditionWithColor(this SubSystemDocument document, Obj body, IEnumerable<Color> colors, ExpressionValueVariable? pointX = null, ExpressionValueVariable? pointY = null, ExpressionValueVariable? pointZ = null, Obj? referenceFrame = null, string name = "")

Parameters

document SubSystemDocument

body Obj

colors IEnumerable<Color>

pointX ExpressionValueVariable?

pointY ExpressionValueVariable?

pointZ ExpressionValueVariable?

referenceFrame Obj?

name string

Returns

Obj

CreateBoundaryConditionWithFaces(SubSystemDocument, IEnumerable<Obj>, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, Obj?, string)

[NotNull(new string[] { "document", "baseGeometry" })]
public static Obj CreateBoundaryConditionWithFaces(this SubSystemDocument document, IEnumerable<Obj> baseGeometry, ExpressionValueVariable? pointX = null, ExpressionValueVariable? pointY = null, ExpressionValueVariable? pointZ = null, Obj? referenceFrame = null, string name = "")

Parameters

document SubSystemDocument

baseGeometry IEnumerable<Obj>

pointX ExpressionValueVariable?

pointY ExpressionValueVariable?

pointZ ExpressionValueVariable?

referenceFrame Obj?

name string

Returns

Obj

CreateBoundaryConditionWithFaceset(SubSystemDocument, Obj, ExpressionValueVariable?, ExpressionValueVariable?, ExpressionValueVariable?, Obj?, string)

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseGeometry" })]
[MatchTypeObj(new object[] { "baseGeometry", typeof(IContactableRigid3D) })]
public static Obj CreateBoundaryConditionWithFaceset(this SubSystemDocument document, Obj baseGeometry, ExpressionValueVariable? pointX = null, ExpressionValueVariable? pointY = null, ExpressionValueVariable? pointZ = null, Obj? referenceFrame = null, string name = "")

Parameters

document SubSystemDocument

baseGeometry Obj

pointX ExpressionValueVariable?

pointY ExpressionValueVariable?

pointZ ExpressionValueVariable?

referenceFrame Obj?

name string

Returns

Obj

CreateRange(SubSystemDocument, Obj, Vector, Vector, ExpressionValueVariable?, string)

Create .

[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "body" })]
[MatchTypeObj(new object[] { "body", typeof(SolidBody) })]
[NotZeroMagnitude(new string[] { "normalDirectionOfRange" })]
public static Obj CreateRange(this SubSystemDocument subSystemDocument, Obj body, Vector point, Vector normalDirectionOfRange, ExpressionValueVariable? radius = null, string name = "")

Parameters

subSystemDocument SubSystemDocument

The to create the range.

body Obj

The body of the range.

point Vector

The point of the range.

normalDirectionOfRange Vector

The normal direction of the range.

radius ExpressionValueVariable?

The radius of the range.

name string

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

Returns

Obj

the new General object created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'subSystemDocument', 'body' argument is null.

ArgumentException

Will be thrown if the type of 'body' is not or if the magnitude of 'normalDirectionOfRange' is 0.

ArgumentOutOfRangeException

Will be thrown if the 'radius' value is equal to or less than 0.

CreateRigidBodyElementPairWithColor(SubSystemDocument, Obj, IEnumerable<Color>, Obj, IEnumerable<Color>, Vector, string)

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseBody", "actionBody" })]
[MatchTypeObj(new object[] { "baseBody", typeof(SolidBody), "actionBody", typeof(SolidBody) })]
public static Obj CreateRigidBodyElementPairWithColor(this SubSystemDocument document, Obj baseBody, IEnumerable<Color> baseColors, Obj actionBody, IEnumerable<Color> actionColors, Vector point, string name = "")

Parameters

document SubSystemDocument

baseBody Obj

baseColors IEnumerable<Color>

actionBody Obj

actionColors IEnumerable<Color>

point Vector

name string

Returns

Obj

CreateRigidBodyElementPairWithColor(PartDocument, Obj, IEnumerable<Color>, Obj, IEnumerable<Color>, Vector, string)

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseBody", "actionBody" })]
public static Obj CreateRigidBodyElementPairWithColor(this PartDocument document, Obj baseBody, IEnumerable<Color> baseColors, Obj actionBody, IEnumerable<Color> actionColors, Vector point, string name = "")

Parameters

document PartDocument

baseBody Obj

baseColors IEnumerable<Color>

actionBody Obj

actionColors IEnumerable<Color>

point Vector

name string

Returns

Obj

CreateRigidBodyElementPairWithFaces(IDocument, IEnumerable<Obj>, IEnumerable<Obj>, Vector, string)

[NotNull(new string[] { "document", "baseGeometry", "actionGeometry" })]
public static Obj CreateRigidBodyElementPairWithFaces(this IDocument document, IEnumerable<Obj> baseGeometry, IEnumerable<Obj> actionGeometry, Vector point, string name = "")

Parameters

document IDocument

baseGeometry IEnumerable<Obj>

actionGeometry IEnumerable<Obj>

point Vector

name string

Returns

Obj

CreateRigidBodyElementPairWithFaceset(IDocument, Obj, Obj, Vector, string)

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseGeometry", "actionGeometry" })]
[MatchTypeObj(new object[] { "baseGeometry", typeof(IContactableRigid3D), "actionGeometry", typeof(IContactableRigid3D) })]
public static Obj CreateRigidBodyElementPairWithFaceset(this IDocument document, Obj baseGeometry, Obj actionGeometry, Vector point, string name = "")

Parameters

document IDocument

baseGeometry Obj

actionGeometry Obj

point Vector

name string

Returns

Obj

CreateRigidBodyElementWithColor(SubSystemDocument, Obj, IEnumerable<Color>, Vector, string)

[NotNull(new string[] { "document", "colors" })]
[NotNullObj(new string[] { "body" })]
[MatchTypeObj(new object[] { "body", typeof(SolidBody) })]
public static Obj CreateRigidBodyElementWithColor(this SubSystemDocument document, Obj body, IEnumerable<Color> colors, Vector point, string name = "")

Parameters

document SubSystemDocument

body Obj

colors IEnumerable<Color>

point Vector

name string

Returns

Obj

CreateRigidBodyElementWithColor(PartDocument, Obj, IEnumerable<Color>, Vector, string)

[NotNull(new string[] { "document", "colors" })]
[NotNullObj(new string[] { "body" })]
public static Obj CreateRigidBodyElementWithColor(this PartDocument document, Obj body, IEnumerable<Color> colors, Vector point, string name = "")

Parameters

document PartDocument

body Obj

colors IEnumerable<Color>

point Vector

name string

Returns

Obj

CreateRigidBodyElementWithFaces(IDocument, IEnumerable<Obj>, Vector, string)

[NotNull(new string[] { "document", "baseGeometry" })]
public static Obj CreateRigidBodyElementWithFaces(this IDocument document, IEnumerable<Obj> baseGeometry, Vector point, string name = "")

Parameters

document IDocument

baseGeometry IEnumerable<Obj>

point Vector

name string

Returns

Obj

CreateRigidBodyElementWithFaceset(IDocument, Obj, Vector, string)

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "baseGeometry" })]
[MatchTypeObj(new object[] { "baseGeometry", typeof(IContactableRigid3D) })]
public static Obj CreateRigidBodyElementWithFaceset(this IDocument document, Obj baseGeometry, Vector point, string name = "")

Parameters

document IDocument

baseGeometry Obj

point Vector

name string

Returns

Obj