Class ConstraintAPI
Last update: 16.07.2025Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll
This class implements APIs for
public static class ConstraintAPI
Inheritance
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)
Methods
CreateBall(SubSystemDocument, Obj, Obj, Vector, string, FrictionBall, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
public static Obj CreateBall(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, string name = "", FrictionBall friction = null, SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a ball constraint.
actionEntity Obj
The action entity of a ball constraint.
position Vector
The position of a ball constraint.
name string
The name of a ball constraint.
friction FrictionBall
The friction of a ball constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the type of 'baseEntity', 'actionEntity' is not
CreateConstantVelocity(SubSystemDocument, Obj, Obj, Vector, Vector, Vector, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "baseZAxis", "actionZAxis", "orthogonalAxis" })]
public static Obj CreateConstantVelocity(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, Vector baseZAxis, Vector actionZAxis, Vector orthogonalAxis, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a constant velocity constraint.
actionEntity Obj
The action entity of a constant velocity constraint.
position Vector
The position of a constant velocity constraint.
baseZAxis Vector
The base Z-Axis of a constant velocity constraint.
actionZAxis Vector
The action Z-Axis of a constant velocity constraint.
orthogonalAxis Vector
The orthogonal Axis of a constant velocity constraint.
name string
The name of a constant velocity constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'baseZAxis', 'actionZAxis', 'orthogonalAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
Will be thrown if 'baseZAxis' is equal to 'actionZAxis', 'orthogonalAxis' or if 'actionZAxis' is equal to 'orthogonalAxis'.
CreateCylindrical(SubSystemDocument, Obj, Obj, Vector, Vector, string, Relative, Relative, Restriction?, Restriction?, AdvancedRestriction?, AdvancedRestriction?, FrictionTranslational, FrictionRevolute, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "zAxis" })]
public static Obj CreateCylindrical(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, Vector zAxis, string name = "", Relative relativeT = null, Relative relativeR = null, Restriction? restrictionT = null, Restriction? restrictionR = null, AdvancedRestriction? avancedRestrictionT = null, AdvancedRestriction? advancedRestrictionR = null, FrictionTranslational frictionT = null, FrictionRevolute frictionR = null, SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a cylindrical constraint.
actionEntity Obj
The action entity of a cylindrical constraint.
position Vector
The position of a cylindrical constraint.
zAxis Vector
The Z-Axis of cylindrical constraint.
name string
The name of a cylindrical constraint.
relativeT Relative
The translational relative of a revolute constraint. It's type can be 'None', 'Motion Function', 'Initial Conditions', 'Motion User Subroutine'.
relativeR Relative
The revolute relative of a revolute constraint. It's type can be 'None', 'Motion Function', 'Initial Conditions', 'Motion User Subroutine'.
restrictionT Restriction?
The translational restriction of a cylindrical constraint.
restrictionR Restriction?
The revolute restriction of a cylindrical constraint.
avancedRestrictionT AdvancedRestriction?
The translational advanced restriction of a cylindrical constraint.
advancedRestrictionR AdvancedRestriction?
The revolute advanced restriction of a cylindrical constraint.
frictionT FrictionTranslational
The translational friction of a cylindrical constraint.
frictionR FrictionRevolute
The revolute friction of a cylindrical constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'zAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
CreateDistance(SubSystemDocument, Obj, Obj, Vector, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
public static Obj CreateDistance(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector basePosition, Vector actionPosition, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a distance constraint.
actionEntity Obj
The action entity of a distance constraint.
basePosition Vector
The base position of a distance constraint.
actionPosition Vector
The action position of a distance constraint.
name string
The name of a distance constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the type of 'baseEntity', 'actionEntity' is not
Will be thrown if 'basePosition' is equal to 'actionPosition'.
CreateFixed(SubSystemDocument, Obj, Obj, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
public static Obj CreateFixed(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a fixed constraint.
actionEntity Obj
The action entity of a fixed constraint.
position Vector
The position of a fixed constraint.
name string
The name of a fixed constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the type of 'baseEntity', 'actionEntity' is not
CreateGroupAutoConnector(SubSystemDocument, IEnumerable<Obj>)
[NotNull(new string[] { "subSystemDocument", "groups" })]
public static void CreateGroupAutoConnector(this SubSystemDocument subSystemDocument, IEnumerable<Obj> groups)
Parameters
subSystemDocument SubSystemDocument
groups IEnumerable<Obj>
CreateInline(SubSystemDocument, Obj, Obj, Vector, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
public static Obj CreateInline(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector basePosition, Vector actionPosition, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a inline constraint.
actionEntity Obj
The action entity of a inline constraint.
basePosition Vector
The base position of a inline constraint.
actionPosition Vector
The action position of a inline constraint.
name string
The name of a inline constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the type of 'baseEntity', 'actionEntity' is not
Will be thrown if the type of 'basePosition' is equal to 'actionPosition'..
CreateInplane(SubSystemDocument, Obj, Obj, Vector, Vector, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "zAxis" })]
public static Obj CreateInplane(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector basePosition, Vector actionPosition, Vector zAxis, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a inplane constraint.
actionEntity Obj
The action entity of a inplane constraint.
basePosition Vector
The base position of a inplane constraint.
actionPosition Vector
The action position of a inplane constraint.
zAxis Vector
The Z-Axis of a inplane constraint.
name string
The name of a inplane constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'zAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
CreateOrientation(SubSystemDocument, Obj, Obj, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
public static Obj CreateOrientation(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a orientation constraint.
actionEntity Obj
The action entity of a orientation constraint.
position Vector
The position of a orientation constraint.
name string
The name of a orientation constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the type of 'baseEntity', 'actionEntity' is not
CreateParallel(SubSystemDocument, Obj, Obj, Vector, Vector, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "zAxis" })]
public static Obj CreateParallel(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector basePosition, Vector actionPosition, Vector zAxis, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a parallel constraint.
actionEntity Obj
The action entity of a parallel constraint.
basePosition Vector
The base position of a parallel constraint.
actionPosition Vector
The action position of a parallel constraint.
zAxis Vector
The Z-Axis of a parallel constraint.
name string
The name of a parallel constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'zAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
CreatePerpendicular(SubSystemDocument, Obj, Obj, Vector, Vector, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "baseZAxis", "actionZAxis" })]
public static Obj CreatePerpendicular(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, Vector baseZAxis, Vector actionZAxis, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a perpendicular constraint.
actionEntity Obj
The action entity of a perpendicular constraint.
position Vector
The position of a perpendicular constraint.
baseZAxis Vector
The base Z-Axis of a perpendicular constraint.
actionZAxis Vector
The action Z-Axis of a perpendicular constraint.
name string
The name of a perpendicular constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'baseZAxis', 'actionZAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
CreatePerpendicular(SubSystemDocument, Obj, Obj, Vector, Vector, Vector, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "baseZAxis", "actionZAxis" })]
public static Obj CreatePerpendicular(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector basePosition, Vector actionPosition, Vector baseZAxis, Vector actionZAxis, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a perpendicular constraint.
actionEntity Obj
The action entity of a perpendicular constraint.
basePosition Vector
The base position of a perpendicular constraint.
actionPosition Vector
The action position of a perpendicular constraint.
baseZAxis Vector
The base Z-Axis of a perpendicular constraint.
actionZAxis Vector
The action Z-Axis of a perpendicular constraint.
name string
The name of a perpendicular constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'baseZAxis', 'actionZAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
Will be thrown if 'baseZAxis' is equal to 'actionZAxis'.
CreatePlane(SubSystemDocument, Obj, Obj, Vector, Vector, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "zAxis" })]
public static Obj CreatePlane(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, Vector zAxis, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a planar constraint.
actionEntity Obj
The action entity of a planar constraint.
position Vector
The position of a planar constraint.
zAxis Vector
The Z-Axis of a planar constraint.
name string
The name of a planar constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'zAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
CreateRevolute(SubSystemDocument, Obj, Obj, Vector, string, Relative, Restriction?, AdvancedRestriction?, FrictionRevolute, ClearanceRevolute, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
public static Obj CreateRevolute(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, string name = "", Relative relative = null, Restriction? restriction = null, AdvancedRestriction? advancedRestriction = null, FrictionRevolute friction = null, ClearanceRevolute clearance = null, SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a revolute constraint.
actionEntity Obj
The action entity of a revolute constraint.
position Vector
The position of a revolute constraint.
name string
The name of a revolute constraint.
relative Relative
The relative of a revolute constraint. It's type can be 'None', 'Motion Function', 'Initial Conditions', 'Motion User Subroutine'.
restriction Restriction?
The restriction of a revolute constraint.
advancedRestriction AdvancedRestriction?
The advanced restriction of a revolute constraint.
friction FrictionRevolute
The friction of a revolute constraint.
clearance ClearanceRevolute
The clearance of a revolute constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the type of 'baseEntity', 'actionEntity' is not
CreateRevolute(SubSystemDocument, Obj, Obj, Vector, Vector, string, Relative, Restriction?, AdvancedRestriction?, FrictionRevolute, ClearanceRevolute, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "zAxis" })]
public static Obj CreateRevolute(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, Vector zAxis, string name = "", Relative relative = null, Restriction? restriction = null, AdvancedRestriction? advancedRestriction = null, FrictionRevolute friction = null, ClearanceRevolute clearance = null, SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a revolute constraint.
actionEntity Obj
The action entity of a revolute constraint.
position Vector
The position of a revolute constraint.
zAxis Vector
The Z-Axis of a revolute constraint.
name string
The name of a revolute constraint.
relative Relative
The relative of a revolute constraint. It's type can be 'None', 'Motion Function', 'Initial Conditions', 'Motion User Subroutine'.
restriction Restriction?
The restriction of a revolute constraint.
advancedRestriction AdvancedRestriction?
The advanced restriction of a revolute constraint.
friction FrictionRevolute
The friction of a revolute constraint.
clearance ClearanceRevolute
The clearance of a revolute constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'zAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
CreateScrew(SubSystemDocument, Obj, Obj, Vector, Vector, ExpressionValueVariable?, string, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "zAxis" })]
public static Obj CreateScrew(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, Vector zAxis, ExpressionValueVariable? pitch = null, string name = "", SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a screw.
actionEntity Obj
The action entity of a screw.
position Vector
The position of a screw.
zAxis Vector
The Z-Axis of a screw.
pitch ExpressionValueVariable?
The pitch of a screw.
name string
The name of a screw.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'zAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
CreateTranslational(SubSystemDocument, Obj, Obj, Vector, Vector, string, Relative, Restriction?, AdvancedRestriction?, FrictionTranslational, ClearanceTranslational, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "zAxis" })]
public static Obj CreateTranslational(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, Vector zAxis, string name = "", Relative relative = null, Restriction? restriction = null, AdvancedRestriction? advancedRestriction = null, FrictionTranslational friction = null, ClearanceTranslational clearance = null, SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a translational constraint.
actionEntity Obj
The action entity of a translational constraint.
position Vector
The position of a translational constraint.
zAxis Vector
The Z-Axis of a translational constraint.
name string
The name of a translational constraint.
relative Relative
The relative of a translational constraint. It's type can be 'None', 'Motion Function', 'Initial Conditions', 'Motion User Subroutine'.
restriction Restriction?
The restriction of a translational constraint.
advancedRestriction AdvancedRestriction?
The advanced restriction of a translational constraint.
friction FrictionTranslational
The friction of a translational constraint.
clearance ClearanceTranslational
The clearance of a translational constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'zAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
CreateUniversal(SubSystemDocument, Obj, Obj, Vector, Vector, Vector, string, FrictionUniversal, FrictionUniversal, SymmetricType)
Create
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "baseEntity", "actionEntity" })]
[MatchTypeObj(new object[] { "baseEntity", typeof(IConnectable), "actionEntity", typeof(IConnectable) })]
[NotZeroMagnitude(new string[] { "baseXAxis", "actionXAxis" })]
public static Obj CreateUniversal(this SubSystemDocument subSystemDocument, Obj baseEntity, Obj actionEntity, Vector position, Vector baseXAxis, Vector actionXAxis, string name = "", FrictionUniversal baseFriction = null, FrictionUniversal actionFriction = null, SymmetricType symmetricType = SymmetricType.None)
Parameters
subSystemDocument SubSystemDocument
The
baseEntity Obj
The base entity of a universal constraint.
actionEntity Obj
The action entity of a universal constraint.
position Vector
The position of a universal constraint.
baseXAxis Vector
The base X-Axis of a universal constraint.
actionXAxis Vector
The action X-Axis of a universal constraint.
name string
The name of a universal constraint.
baseFriction FrictionUniversal
The base friction of a universal constraint.
actionFriction FrictionUniversal
The action friction of a universal constraint.
symmetricType SymmetricType
The symmetric type of the new
Returns
the new
Exceptions
Will be thrown if 'subSystemDocument', 'baseEntity', 'actionEntity' argument is null.
Will be thrown if the magnitude of 'baseXAxis', 'actionXAxis' is 0 and if the type of 'baseEntity', 'actionEntity' is not
GetSymmetricObject<T>(SymmetricType, IObjectBase)
Get a symmetric object.
public static T GetSymmetricObject<T>(SymmetricType symmetricType, IObjectBase objectBase) where T : class
Parameters
symmetricType SymmetricType
The symmetric type of the object.
objectBase IObjectBase
The obejct.
Returns
T
the object seleted by this API.
Type Parameters
T
The object type
GetSymmetricResult(SymmetricType, IObjectBase)
Get a symmetric result.
public static Obj GetSymmetricResult(SymmetricType symmetricType, IObjectBase objectBase)
Parameters
symmetricType SymmetricType
The symmetric type of the object.
objectBase IObjectBase
The obejct.
Returns
the object seleted by this API.
