Class EFForceAPI
Last update: 09.03.2026Namespace: VM.API.Pre.EasyFlex
Assembly: VM.API.Pre.EasyFlex.dll
This class implements APIs for
public static class EFForceAPI
Inheritance
object ← EFForceAPI
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)
Methods
CreateConcentratedLoadFaceWithColor(SubSystemDocument, Obj, IEnumerable<Color>, Vector?, string, string)
Create
[NotNull(new string[] { "subSystemDocument", "colors" })]
[NotNullObj(new string[] { "body" })]
[MatchTypeObj(new object[] { "body", typeof(SolidBody) })]
public static Obj CreateConcentratedLoadFaceWithColor(this SubSystemDocument subSystemDocument, Obj body, IEnumerable<Color> colors, Vector? direction = null, string force = "1.0", string name = "")
Parameters
subSystemDocument SubSystemDocument
The
body Obj
The body of the concentrated load
colors IEnumerable<Color>
The colors of the concentrated load.
direction Vector?
The direction of the concentrated load.
force string
The force of the concentrated load.
name string
The name of the concentrated load. If empty, default name starts with 'CLOAD_' will be generated and used.
Returns
the new
Exceptions
ArgumentNullException
Will be thrown if 'subSystemDocument', 'body', 'colors' argument is null.
ArgumentException
Will be thrown if the type of 'body' is not
ArgumentException
Will be thrown if the magnitude of 'direction' is 0.
CreateConcentratedLoadFaceWithFaces(SubSystemDocument, IEnumerable<Obj>, Vector?, string, string)
Create
[NotNull(new string[] { "subSystemDocument", "baseGeometry" })]
public static Obj CreateConcentratedLoadFaceWithFaces(this SubSystemDocument subSystemDocument, IEnumerable<Obj> baseGeometry, Vector? direction = null, string force = "1.0", string name = "")
Parameters
subSystemDocument SubSystemDocument
The
baseGeometry IEnumerable<Obj>
The base geometry of the concentrated load
direction Vector?
The direction of the concentrated load.
force string
The force of the concentrated load.
name string
The name of the concentrated load. If empty, default name starts with 'CLOAD_' will be generated and used.
Returns
the new
Exceptions
ArgumentNullException
Will be thrown if 'subSystemDocument', 'baseGeometry' argument is null.
ArgumentException
Will be thrown if the type of 'baseGeometry' is not
ArgumentException
Will be thrown if the magnitude of 'direction' is 0.
CreateConcentratedLoadFaceWithFaceset(SubSystemDocument, Obj, Vector?, string, string)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseGeometry" })]
[MatchTypeObj(new object[] { "baseGeometry", typeof(IContactableRigid3D) })]
public static Obj CreateConcentratedLoadFaceWithFaceset(this SubSystemDocument subSystemDocument, Obj baseGeometry, Vector? direction = null, string force = "1.0", string name = "")
Parameters
subSystemDocument SubSystemDocument
The
baseGeometry Obj
The base geometry of the concentrated load
direction Vector?
The direction of the concentrated load.
force string
The force of the concentrated load.
name string
The name of the concentrated load. If empty, default name starts with 'CLOAD_' will be generated and used.
Returns
the new
Exceptions
ArgumentNullException
Will be thrown if 'subSystemDocument', 'baseGeometry' argument is null.
ArgumentException
Will be thrown if the type of 'baseGeometry' is not
ArgumentException
Will be thrown if the magnitude of 'direction' is 0.
CreateConcentratedLoadRange(SubSystemDocument, Obj, Vector, Vector, ExpressionValueVariable?, Vector?, string, string)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "body" })]
[NotZeroMagnitude(new string[] { "normalDirectionOfRange" })]
public static Obj CreateConcentratedLoadRange(this SubSystemDocument subSystemDocument, Obj body, Vector point, Vector normalDirectionOfRange, ExpressionValueVariable? radius = null, Vector? direction = null, string force = "1.0", string name = "")
Parameters
subSystemDocument SubSystemDocument
The
body Obj
The body of the concentrated load
point Vector
The point of the concentrated load.
normalDirectionOfRange Vector
The normal direction of the concentrated load.
radius ExpressionValueVariable?
The radius of the concentrated load.
direction Vector?
The direction of the concentrated load.
force string
The force of the concentrated load.
name string
The name of the concentrated load. If empty, default name starts with 'CLOAD_' will be generated and used.
Returns
the new
Exceptions
ArgumentNullException
Will be thrown if 'subSystemDocument', 'body' argument is null.
ArgumentException
Will be thrown if the type of 'body' is not
ArgumentException
Will be thrown if the magnitude of 'normalDirectionOfRange' is 0.
ArgumentOutOfRangeException
Will be thrown if the magnitude of 'direction' is 0 or if the 'radius' value is equal to or less than 0.
CreatePressureLoadWithColor(SubSystemDocument, Obj, IEnumerable<Color>, bool, string, string)
Create
[NotNull(new string[] { "subSystemDocument", "colors" })]
[NotNullObj(new string[] { "body" })]
[MatchTypeObj(new object[] { "body", typeof(SolidBody) })]
public static Obj CreatePressureLoadWithColor(this SubSystemDocument subSystemDocument, Obj body, IEnumerable<Color> colors, bool isNormal = true, string normal = "1.0", string name = "")
Parameters
subSystemDocument SubSystemDocument
The
body Obj
The body of the pressure load
colors IEnumerable<Color>
The colors of the pressure load.
isNormal bool
The flag of normal of the pressure load.
normal string
The normal of the pressure load.
name string
The name of the pressure load. If empty, default name starts with 'PLOAD_' will be generated and used.
Returns
the new
Exceptions
ArgumentNullException
Will be thrown if 'subSystemDocument', 'body', 'colors' argument is null.
ArgumentException
Will be thrown if the type of 'body' is not
ArgumentException
Will be thrown if the magnitude of 'direction' is 0.
CreatePressureLoadWithFaces(SubSystemDocument, IEnumerable<Obj>, bool, string, string)
Create
[NotNull(new string[] { "subSystemDocument", "baseGeometry" })]
public static Obj CreatePressureLoadWithFaces(this SubSystemDocument subSystemDocument, IEnumerable<Obj> baseGeometry, bool isNormal = true, string normal = "1.0", string name = "")
Parameters
subSystemDocument SubSystemDocument
The
baseGeometry IEnumerable<Obj>
The base geometry of the pressure load
isNormal bool
The flag of normal of the pressure load.
normal string
The normal of the pressure load.
name string
The name of the pressure load. If empty, default name starts with 'PLOAD_' will be generated and used.
Returns
the new
Exceptions
ArgumentNullException
Will be thrown if 'subSystemDocument', 'baseGeometry' argument is null.
ArgumentException
Will be thrown if the type of 'baseGeometry' is not
CreatePressureLoadWithFaceset(SubSystemDocument, Obj, bool, string, string)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseGeometry" })]
[MatchTypeObj(new object[] { "baseGeometry", typeof(IContactableRigid3D) })]
public static Obj CreatePressureLoadWithFaceset(this SubSystemDocument subSystemDocument, Obj baseGeometry, bool isNormal = true, string normal = "1.0", string name = "")
Parameters
subSystemDocument SubSystemDocument
The
baseGeometry Obj
The base geometry of the pressure load
isNormal bool
The flag of normal of the pressure load.
normal string
The normal of the pressure load.
name string
The name of the pressure load. If empty, default name starts with 'PLOAD_' will be generated and used.
Returns
the new
Exceptions
ArgumentNullException
Will be thrown if 'subSystemDocument', 'baseGeometry' argument is null.
ArgumentException
Will be thrown if the type of 'baseGeometry' is not
