The IGAEdgeXYZ class gives you access to IGA edge xyz cards in PRIMER. More...
The PRIMER JavaScript API provides many class constants, properties and methods. For Arup to
be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase
or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you
should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your
own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:
| Name | Type | Description |
| eid | integer | IGAEdgeXYZ number. Also see the label property which is an alternative name for this. |
| exists (read only) | logical | true if IGA Edge XYZ exists, false if referred to but not defined. |
| include | integer | The Include file number that the IGA Edge XYZ is in. |
| label | integer | IGAEdgeXYZ number. Also see the eid property which is an alternative name for this. |
| model (read only) | integer | The Model number that the IGA Edge XYZ is in. |
| ori | integer | Orientation with respect to the physical univariate NURBS. |
| patchid | integer | Physical univariate NURBS patch ID. |
| pidend | integer | Parametric point ID defining the end of the trimmed physical NURBS. |
| pidstart | integer | Parametric point ID defining the start of the trimmed physical NURBS. |
| psid | integer | Parametric point set ID. *SET_IGA_POINT_UVW. |
Detailed DescriptionThe IGAEdgeXYZ class allows you to create, modify, edit and manipulate IGA edge xyz cards. See the documentation below for more details. |
Constructornew IGAEdgeXYZ(Model[Model], details[object])DescriptionCreate a new IGAEdgeXYZ object. |
Model that IGA edge xyz will be created in
Details for creating the IGAEdgeXYZ
Object has the following properties:
| Name | Type | Description |
| eid | integer | ID of the IGA Edge XYZ. |
| ori (optional) | integer | Orientation with respect to the physical univariate NURBS. |
| patchid (optional) | integer | Physical univariate NURBS patch ID. |
| pidend (optional) | integer | Parametric point ID defining the end of the trimmed physical NURBS. |
| pidstart (optional) | integer | Parametric point ID defining the start of the trimmed physical NURBS. |
| psid (optional) | integer | Parametric point set ID. *SET_IGA_POINT_UVW. |
ReturnsIGAEdgeXYZ object Return typeIGAEdgeXYZ |
Details of functionsAssociateComment(Comment[Comment])DescriptionAssociates a comment with a IGA Edge XYZ. |
Comment that will be attached to the IGA Edge XYZ
ReturnsNo return value |
ExampleTo associate comment c to the IGA Edge XYZ igex: igex.AssociateComment(c);
|
Browse(modal (optional)[boolean])DescriptionStarts an edit panel in Browse mode. |
If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.
Returnsno return value |
ExampleTo Browse IGA Edge XYZ igex: igex.Browse();
|
ClearFlag(flag[Flag])DescriptionClears a flag on the IGA Edge XYZ. |
Flag to clear on the IGA Edge XYZ
ReturnsNo return value |
ExampleTo clear flag f for IGA Edge XYZ igex: igex.ClearFlag(f);
|
Copy(range (optional)[boolean])DescriptionCopies the IGA Edge XYZ. The target include of the copied IGA Edge XYZ can be set using Options.copy_target_include. |
If you want to keep the copied item in the range specified for the current include. Default value is false. To set current include, use Include.MakeCurrentLayer().
ReturnsIGAEdgeXYZ object Return typeIGAEdgeXYZ |
ExampleTo copy IGA Edge XYZ igex into IGA Edge XYZ z: var z = igex.Copy();
|
Create(Model[Model], modal (optional)[boolean]) [static]DescriptionStarts an interactive editing panel to create a IGA Edge XYZ |
Model that the IGA Edge XYZ will be created in.
If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.
ReturnsIGAEdgeXYZ object (or null if not made). Return typeIGAEdgeXYZ |
ExampleTo start creating a IGA Edge XYZ in model m: var igex = IGAEdgeXYZ.Create(m);
|
DetachComment(Comment[Comment])DescriptionDetaches a comment from a IGA Edge XYZ. |
Comment that will be detached from the IGA Edge XYZ
ReturnsNo return value |
ExampleTo detach comment c from the IGA Edge XYZ igex: igex.DetachComment(c);
|
Edit(modal (optional)[boolean])DescriptionStarts an interactive editing panel. |
If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.
Returnsno return value |
ExampleTo Edit IGA Edge XYZ igex: igex.Edit();
|
Error(message[string], details (optional)[string])DescriptionAdds an error for IGA Edge XYZ. For more details on checking see the Check class. |
The error message to give
An optional detailed error message
ReturnsNo return value |
ExampleTo add an error message "My custom error" for IGA Edge XYZ igex: igex.Error("My custom error");
|
First(Model[Model]) [static]DescriptionReturns the first IGA Edge XYZ in the model. |
Model to get first IGA Edge XYZ in
ReturnsIGAEdgeXYZ object (or null if there are no IGA Edge XYZs in the model). Return typeIGAEdgeXYZ |
ExampleTo get the first IGA Edge XYZ in model m: var igex = IGAEdgeXYZ.First(m);
|
FirstFreeLabel(Model[Model], layer (optional)[Include number]) [static]DescriptionReturns the first free IGA Edge XYZ label in the model. Also see IGAEdgeXYZ.LastFreeLabel(), IGAEdgeXYZ.NextFreeLabel() and Model.FirstFreeItemLabel(). |
Model to get first free IGA Edge XYZ label in
Include file (0 for the main file) to search for labels in (Equivalent to First free in layer in editing panels). If omitted the whole model will be used (Equivalent to First free in editing panels).
ReturnsIGAEdgeXYZ label. Return typeNumber |
ExampleTo get the first free IGA Edge XYZ label in model m: var label = IGAEdgeXYZ.FirstFreeLabel(m);
|
FlagAll(Model[Model], flag[Flag]) [static]DescriptionFlags all of the IGA Edge XYZs in the model with a defined flag. |
Model that all IGA Edge XYZs will be flagged in
Flag to set on the IGA Edge XYZs
ReturnsNo return value |
ExampleTo flag all of the IGA Edge XYZs with flag f in model m: IGAEdgeXYZ.FlagAll(m, f);
|
Flagged(flag[Flag])DescriptionChecks if the IGA Edge XYZ is flagged or not. |
Flag to test on the IGA Edge XYZ
Returnstrue if flagged, false if not. Return typeBoolean |
ExampleTo check if IGA Edge XYZ igex has flag f set on it: if (igex.Flagged(f) ) do_something...
|
ForEach(Model[Model], func[function], extra (optional)[any]) [static]DescriptionCalls a function for each IGA Edge XYZ in the model. |
Model that all IGA Edge XYZs are in
Function to call for each IGA Edge XYZ
An optional extra object/array/string etc that will appended to arguments when calling the function
ReturnsNo return value |
GetAll(Model[Model], property (optional)[string]) [static]DescriptionReturns an array of IGAEdgeXYZ objects or properties for all of the IGA Edge XYZs in a model in PRIMER. If the optional property argument is not given then an array of IGAEdgeXYZ objects is returned. If the property argument is given, that property value for each IGA Edge XYZ is returned in the array instead of a IGAEdgeXYZ object |
Model to get IGA Edge XYZs from
Name for property to get for all IGA Edge XYZs in the model
ReturnsArray of IGAEdgeXYZ objects or properties Return typeArray |
GetComments()DescriptionExtracts the comments associated to a IGA Edge XYZ. |
No arguments
ReturnsArray of Comment objects (or null if there are no comments associated to the node). Return typeArray |
ExampleTo get the array of comments associated to the IGA Edge XYZ igex: var comm_array = igex.GetComments();
|
GetFlagged(Model[Model], flag[Flag], property (optional)[string]) [static]DescriptionReturns an array of IGAEdgeXYZ objects for all of the flagged IGA Edge XYZs in a model in PRIMER If the optional property argument is not given then an array of IGAEdgeXYZ objects is returned. If the property argument is given, then that property value for each IGA Edge XYZ is returned in the array instead of a IGAEdgeXYZ object |
Model to get IGA Edge XYZs from
Flag set on the IGA Edge XYZs that you want to retrieve
Name for property to get for all flagged IGA Edge XYZs in the model
ReturnsArray of IGAEdgeXYZ objects or properties Return typeArray |
GetFromID(Model[Model], number[integer]) [static]DescriptionReturns the IGAEdgeXYZ object for a IGA Edge XYZ ID. |
Model to find the IGA Edge XYZ in
number of the IGA Edge XYZ you want the IGAEdgeXYZ object for
ReturnsIGAEdgeXYZ object (or null if IGA Edge XYZ does not exist). Return typeIGAEdgeXYZ |
ExampleTo get the IGAEdgeXYZ object for IGA Edge XYZ 100 in model m var igex = IGAEdgeXYZ.GetFromID(m, 100);
|
GetParameter(prop[string])DescriptionChecks if a IGAEdgeXYZ property is a parameter or not. Note that object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. For this function to work the JavaScript interpreter must use the parameter name instead of the value. This can be done by setting the Options.property_parameter_names option to true before calling the function and then resetting it to false afterwards.. This behaviour can also temporarily be switched by using the IGAEdgeXYZ.ViewParameters() method and 'method chaining' (see the examples below). |
IGA Edge XYZ property to get parameter for
ReturnsParameter object if property is a parameter, null if not. Return typeParameter |
Keyword()DescriptionReturns the keyword for this IGA edge xyz (*IGA_EDGE_XYZ). Note that a carriage return is not added. See also IGAEdgeXYZ.KeywordCards() |
No arguments
Returnsstring containing the keyword. Return typeString |
ExampleTo get the keyword for IGA edge xyz igex: var key = igex.Keyword();
|
KeywordCards()DescriptionReturns the keyword cards for the IGA edge xyz. Note that a carriage return is not added. See also IGAEdgeXYZ.Keyword() |
No arguments
Returnsstring containing the cards. Return typeString |
ExampleTo get the cards for IGA edge xyz igex: var cards = igex.KeywordCards();
|
Last(Model[Model]) [static]DescriptionReturns the last IGA Edge XYZ in the model. |
Model to get last IGA Edge XYZ in
ReturnsIGAEdgeXYZ object (or null if there are no IGA Edge XYZs in the model). Return typeIGAEdgeXYZ |
ExampleTo get the last IGA Edge XYZ in model m: var igex = IGAEdgeXYZ.Last(m);
|
LastFreeLabel(Model[Model], layer (optional)[Include number]) [static]DescriptionReturns the last free IGA Edge XYZ label in the model. Also see IGAEdgeXYZ.FirstFreeLabel(), IGAEdgeXYZ.NextFreeLabel() and see Model.LastFreeItemLabel() |
Model to get last free IGA Edge XYZ label in
Include file (0 for the main file) to search for labels in (Equivalent to Highest free in layer in editing panels). If omitted the whole model will be used.
ReturnsIGAEdgeXYZ label. Return typeNumber |
ExampleTo get the last free IGA Edge XYZ label in model m: var label = IGAEdgeXYZ.LastFreeLabel(m);
|
Next()DescriptionReturns the next IGA Edge XYZ in the model. |
No arguments
ReturnsIGAEdgeXYZ object (or null if there are no more IGA Edge XYZs in the model). Return typeIGAEdgeXYZ |
ExampleTo get the IGA Edge XYZ in model m after IGA Edge XYZ igex: var igex = igex.Next();
|
NextFreeLabel(Model[Model], layer (optional)[Include number]) [static]DescriptionReturns the next free (highest+1) IGA Edge XYZ label in the model. Also see IGAEdgeXYZ.FirstFreeLabel(), IGAEdgeXYZ.LastFreeLabel() and Model.NextFreeItemLabel() |
Model to get next free IGA Edge XYZ label in
Include file (0 for the main file) to search for labels in (Equivalent to Highest+1 in layer in editing panels). If omitted the whole model will be used (Equivalent to Highest+1 in editing panels).
ReturnsIGAEdgeXYZ label. Return typeNumber |
ExampleTo get the next free IGA Edge XYZ label in model m: var label = IGAEdgeXYZ.NextFreeLabel(m);
|
Previous()DescriptionReturns the previous IGA Edge XYZ in the model. |
No arguments
ReturnsIGAEdgeXYZ object (or null if there are no more IGA Edge XYZs in the model). Return typeIGAEdgeXYZ |
ExampleTo get the IGA Edge XYZ in model m before IGA Edge XYZ igex: var igex = igex.Previous();
|
RenumberAll(Model[Model], start[integer]) [static]DescriptionRenumbers all of the IGA Edge XYZs in the model. |
Model that all IGA Edge XYZs will be renumbered in
Start point for renumbering
ReturnsNo return value |
ExampleTo renumber all of the IGA Edge XYZs in model m, from 1000000: IGAEdgeXYZ.RenumberAll(m, 1000000);
|
RenumberFlagged(Model[Model], flag[Flag], start[integer]) [static]DescriptionRenumbers all of the flagged IGA Edge XYZs in the model. |
Model that all the flagged IGA Edge XYZs will be renumbered in
Flag set on the IGA Edge XYZs that you want to renumber
Start point for renumbering
ReturnsNo return value |
ExampleTo renumber all of the IGA Edge XYZs in model m flagged with f, from 1000000: IGAEdgeXYZ.RenumberFlagged(m, f, 1000000);
|
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]DescriptionAllows the user to select IGA Edge XYZs using standard PRIMER object menus. |
Flag to use when selecting IGA Edge XYZs
Text to display as a prompt to the user
If the argument is a Model then only IGA Edge XYZs from that model can be selected. If the argument is a Flag then only IGA Edge XYZs that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any IGA Edge XYZs can be selected. from any model.
If selection is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the selection will be modal.
ReturnsNumber of IGA Edge XYZs selected or null if menu cancelled Return typeNumber |
SetFlag(flag[Flag])DescriptionSets a flag on the IGA Edge XYZ. |
Flag to set on the IGA Edge XYZ
ReturnsNo return value |
ExampleTo set flag f for IGA Edge XYZ igex: igex.SetFlag(f);
|
Sketch(redraw (optional)[boolean])DescriptionSketches the IGA Edge XYZ. The IGA Edge XYZ will be sketched until you either call IGAEdgeXYZ.Unsketch(), IGAEdgeXYZ.UnsketchAll(), Model.UnsketchAll(), or delete the model |
If model should be redrawn or not after the IGA Edge XYZ is sketched. If omitted redraw is true. If you want to sketch several IGA Edge XYZs and only redraw after the last one then use false for redraw and call View.Redraw().
ReturnsNo return value |
ExampleTo sketch IGA Edge XYZ igex: igex.Sketch();
|
SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]DescriptionSketches all of the flagged IGA Edge XYZs in the model. The IGA Edge XYZs will be sketched until you either call IGAEdgeXYZ.Unsketch(), IGAEdgeXYZ.UnsketchFlagged(), Model.UnsketchAll(), or delete the model |
Model that all the flagged IGA Edge XYZs will be sketched in
Flag set on the IGA Edge XYZs that you want to sketch
If model should be redrawn or not after the IGA Edge XYZs are sketched. If omitted redraw is true. If you want to sketch flagged IGA Edge XYZs several times and only redraw after the last one then use false for redraw and call View.Redraw().
ReturnsNo return value |
ExampleTo sketch all IGA Edge XYZs flagged with flag in model m: IGAEdgeXYZ.SketchFlagged(m, flag);
|
Total(Model[Model], exists (optional)[boolean]) [static]DescriptionReturns the total number of IGA Edge XYZs in the model. |
Model to get total for
true if only existing IGA Edge XYZs should be counted. If false or omitted referenced but undefined IGA Edge XYZs will also be included in the total.
Returnsnumber of IGA Edge XYZs Return typeNumber |
ExampleTo get the total number of IGA Edge XYZs in model m: var total = IGAEdgeXYZ.Total(m);
|
UnflagAll(Model[Model], flag[Flag]) [static]DescriptionUnsets a defined flag on all of the IGA Edge XYZs in the model. |
Model that the defined flag for all IGA Edge XYZs will be unset in
Flag to unset on the IGA Edge XYZs
ReturnsNo return value |
ExampleTo unset the flag f on all the IGA Edge XYZs in model m: IGAEdgeXYZ.UnflagAll(m, f);
|
Unsketch(redraw (optional)[boolean])DescriptionUnsketches the IGA Edge XYZ. |
If model should be redrawn or not after the IGA Edge XYZ is unsketched. If omitted redraw is true. If you want to unsketch several IGA Edge XYZs and only redraw after the last one then use false for redraw and call View.Redraw().
ReturnsNo return value |
ExampleTo unsketch IGA Edge XYZ igex: igex.Unsketch();
|
UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]DescriptionUnsketches all IGA Edge XYZs. |
Model that all IGA Edge XYZs will be unblanked in
If model should be redrawn or not after the IGA Edge XYZs are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().
ReturnsNo return value |
ExampleTo unsketch all IGA Edge XYZs in model m: IGAEdgeXYZ.UnsketchAll(m);
|
UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]DescriptionUnsketches all flagged IGA Edge XYZs in the model. |
Model that all IGA Edge XYZs will be unsketched in
Flag set on the IGA Edge XYZs that you want to unsketch
If model should be redrawn or not after the IGA Edge XYZs are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().
ReturnsNo return value |
ExampleTo unsketch all IGA Edge XYZs flagged with flag in model m: IGAEdgeXYZ.UnsketchAll(m, flag);
|
No arguments
ReturnsIGAEdgeXYZ object. Return typeIGAEdgeXYZ |
ExampleTo check if IGAEdgeXYZ property igex.example is a parameter by using the IGAEdgeXYZ.GetParameter() method: if (igex.ViewParameters().GetParameter(igex.example) ) do_something...
|
Warning(message[string], details (optional)[string])DescriptionAdds a warning for IGA Edge XYZ. For more details on checking see the Check class. |
The warning message to give
An optional detailed warning message
ReturnsNo return value |
ExampleTo add a warning message "My custom warning" for IGA Edge XYZ igex: igex.Warning("My custom warning");
|
Xrefs()DescriptionReturns the cross references for this IGA Edge XYZ. |
No arguments
ReturnsXrefs object. Return typeXrefs |
ExampleTo get the cross references for IGA Edge XYZ igex: var xrefs = igex.Xrefs();
|
toString()DescriptionCreates a string containing the IGA edge xyz data in keyword format. Note that this contains the keyword header and the keyword cards. See also IGAEdgeXYZ.Keyword() and IGAEdgeXYZ.KeywordCards(). |
No arguments
Returnsstring Return typeString |
ExampleTo get data for IGA edge xyz igex in keyword format var s = igex.toString();
|