The IGAEdgeUVW class gives you access to IGA edge uvw 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 | Description |
| IGAEdgeUVW.BASIS_TRANSFORM | BASIS_TRANSFORM is *IGA_EDGE_UVW_BASIS_TRANSFORM. |
| IGAEdgeUVW.NONE | NONE is *IGA_EDGE_UVW. |
| Name | Type | Description |
| edgeid | integer | Parametric Edge ID. |
| eid | integer | IGAEdgeUVW number. Also see the label property which is an alternative name for this. |
| elid | integer | Element ID local to a basis transform. |
| exists (read only) | logical | true if IGA Edge UVW exists, false if referred to but not defined. |
| exyzid | integer | Physical edge ID. *IGA_EDGE_XYZ. |
| include | integer | The Include file number that the IGA Edge UVW is in. |
| label | integer | IGAEdgeUVW number. Also see the eid property which is an alternative name for this. |
| model (read only) | integer | The Model number that the IGA Edge UVW is in. |
| option | constant | IGA Edge UVW option. |
| patchid | integer | Parametric univariate NURBS patch ID. |
| rend | real | Parametric coordinate defining the end of the trimmed parametric NURBS. |
| rstart | real | Parametric coordinate defining the start of the trimmed parametric NURBS. |
| sense | integer | Sense of orientation with respect to the physical edge. |
Detailed DescriptionThe IGAEdgeUVW class allows you to create, modify, edit and manipulate IGA edge uvw cards. See the documentation below for more details. |
Constructornew IGAEdgeUVW(Model[Model], details[object])DescriptionCreate a new IGAEdgeUVW object. |
Model that IGA edge uvw will be created in
Details for creating the IGAEdgeUVW
Object has the following properties:
| Name | Type | Description |
| edgeid (optional) | integer | Parametric Edge ID. |
| eid | integer | ID of the IGA Edge UVW. |
| elid (optional) | integer | Element ID local to a basis transform. |
| exyzid (optional) | integer | Physical edge ID. *IGA_EDGE_XYZ. |
| option (optional) | constant | IGA Edge UVW option. IGAEdgeUVW.NONE or IGAEdgeUVW.BASIS_TRANSFORM |
| patchid (optional) | integer | Parametric univariate NURBS patch ID. |
| rend (optional) | real | Parametric coordinate defining the end of the trimmed parametric NURBS. |
| rstart (optional) | real | Parametric coordinate defining the start of the trimmed parametric NURBS. |
| sense (optional) | integer | Sense of orientation with respect to the physical edge. |
ReturnsIGAEdgeUVW object Return typeIGAEdgeUVW |
Details of functionsAssociateComment(Comment[Comment])DescriptionAssociates a comment with a IGA Edge UVW. |
Comment that will be attached to the IGA Edge UVW
ReturnsNo return value |
ExampleTo associate comment c to the IGA Edge UVW igeu: igeu.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 UVW igeu: igeu.Browse();
|
ClearFlag(flag[Flag])DescriptionClears a flag on the IGA Edge UVW. |
Flag to clear on the IGA Edge UVW
ReturnsNo return value |
ExampleTo clear flag f for IGA Edge UVW igeu: igeu.ClearFlag(f);
|
Copy(range (optional)[boolean])DescriptionCopies the IGA Edge UVW. The target include of the copied IGA Edge UVW 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().
ReturnsIGAEdgeUVW object Return typeIGAEdgeUVW |
ExampleTo copy IGA Edge UVW igeu into IGA Edge UVW z: var z = igeu.Copy();
|
Create(Model[Model], modal (optional)[boolean]) [static]DescriptionStarts an interactive editing panel to create a IGA Edge UVW |
Model that the IGA Edge UVW 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.
ReturnsIGAEdgeUVW object (or null if not made). Return typeIGAEdgeUVW |
ExampleTo start creating a IGA Edge UVW in model m: var igeu = IGAEdgeUVW.Create(m);
|
DetachComment(Comment[Comment])DescriptionDetaches a comment from a IGA Edge UVW. |
Comment that will be detached from the IGA Edge UVW
ReturnsNo return value |
ExampleTo detach comment c from the IGA Edge UVW igeu: igeu.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 UVW igeu: igeu.Edit();
|
Error(message[string], details (optional)[string])DescriptionAdds an error for IGA Edge UVW. 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 UVW igeu: igeu.Error("My custom error");
|
First(Model[Model]) [static]DescriptionReturns the first IGA Edge UVW in the model. |
Model to get first IGA Edge UVW in
ReturnsIGAEdgeUVW object (or null if there are no IGA Edge UVWs in the model). Return typeIGAEdgeUVW |
ExampleTo get the first IGA Edge UVW in model m: var igeu = IGAEdgeUVW.First(m);
|
FirstFreeLabel(Model[Model], layer (optional)[Include number]) [static]DescriptionReturns the first free IGA Edge UVW label in the model. Also see IGAEdgeUVW.LastFreeLabel(), IGAEdgeUVW.NextFreeLabel() and Model.FirstFreeItemLabel(). |
Model to get first free IGA Edge UVW 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).
ReturnsIGAEdgeUVW label. Return typeNumber |
ExampleTo get the first free IGA Edge UVW label in model m: var label = IGAEdgeUVW.FirstFreeLabel(m);
|
FlagAll(Model[Model], flag[Flag]) [static]DescriptionFlags all of the IGA Edge UVWs in the model with a defined flag. |
Model that all IGA Edge UVWs will be flagged in
Flag to set on the IGA Edge UVWs
ReturnsNo return value |
ExampleTo flag all of the IGA Edge UVWs with flag f in model m: IGAEdgeUVW.FlagAll(m, f);
|
Flagged(flag[Flag])DescriptionChecks if the IGA Edge UVW is flagged or not. |
Flag to test on the IGA Edge UVW
Returnstrue if flagged, false if not. Return typeBoolean |
ExampleTo check if IGA Edge UVW igeu has flag f set on it: if (igeu.Flagged(f) ) do_something...
|
ForEach(Model[Model], func[function], extra (optional)[any]) [static]DescriptionCalls a function for each IGA Edge UVW in the model. |
Model that all IGA Edge UVWs are in
Function to call for each IGA Edge UVW
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 IGAEdgeUVW objects or properties for all of the IGA Edge UVWs in a model in PRIMER. If the optional property argument is not given then an array of IGAEdgeUVW objects is returned. If the property argument is given, that property value for each IGA Edge UVW is returned in the array instead of a IGAEdgeUVW object |
Model to get IGA Edge UVWs from
Name for property to get for all IGA Edge UVWs in the model
ReturnsArray of IGAEdgeUVW objects or properties Return typeArray |
GetComments()DescriptionExtracts the comments associated to a IGA Edge UVW. |
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 UVW igeu: var comm_array = igeu.GetComments();
|
GetFlagged(Model[Model], flag[Flag], property (optional)[string]) [static]DescriptionReturns an array of IGAEdgeUVW objects for all of the flagged IGA Edge UVWs in a model in PRIMER If the optional property argument is not given then an array of IGAEdgeUVW objects is returned. If the property argument is given, then that property value for each IGA Edge UVW is returned in the array instead of a IGAEdgeUVW object |
Model to get IGA Edge UVWs from
Flag set on the IGA Edge UVWs that you want to retrieve
Name for property to get for all flagged IGA Edge UVWs in the model
ReturnsArray of IGAEdgeUVW objects or properties Return typeArray |
GetFromID(Model[Model], number[integer]) [static]DescriptionReturns the IGAEdgeUVW object for a IGA Edge UVW ID. |
Model to find the IGA Edge UVW in
number of the IGA Edge UVW you want the IGAEdgeUVW object for
ReturnsIGAEdgeUVW object (or null if IGA Edge UVW does not exist). Return typeIGAEdgeUVW |
ExampleTo get the IGAEdgeUVW object for IGA Edge UVW 100 in model m var igeu = IGAEdgeUVW.GetFromID(m, 100);
|
GetParameter(prop[string])DescriptionChecks if a IGAEdgeUVW 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 IGAEdgeUVW.ViewParameters() method and 'method chaining' (see the examples below). |
IGA Edge UVW 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 uvw (*IGA_EDGE_UVW). Note that a carriage return is not added. See also IGAEdgeUVW.KeywordCards() |
No arguments
Returnsstring containing the keyword. Return typeString |
ExampleTo get the keyword for IGA edge uvw igeu: var key = igeu.Keyword();
|
KeywordCards()DescriptionReturns the keyword cards for the IGA edge uvw. Note that a carriage return is not added. See also IGAEdgeUVW.Keyword() |
No arguments
Returnsstring containing the cards. Return typeString |
ExampleTo get the cards for IGA edge uvw igeu: var cards = igeu.KeywordCards();
|
Last(Model[Model]) [static]DescriptionReturns the last IGA Edge UVW in the model. |
Model to get last IGA Edge UVW in
ReturnsIGAEdgeUVW object (or null if there are no IGA Edge UVWs in the model). Return typeIGAEdgeUVW |
ExampleTo get the last IGA Edge UVW in model m: var igeu = IGAEdgeUVW.Last(m);
|
LastFreeLabel(Model[Model], layer (optional)[Include number]) [static]DescriptionReturns the last free IGA Edge UVW label in the model. Also see IGAEdgeUVW.FirstFreeLabel(), IGAEdgeUVW.NextFreeLabel() and see Model.LastFreeItemLabel() |
Model to get last free IGA Edge UVW 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.
ReturnsIGAEdgeUVW label. Return typeNumber |
ExampleTo get the last free IGA Edge UVW label in model m: var label = IGAEdgeUVW.LastFreeLabel(m);
|
Next()DescriptionReturns the next IGA Edge UVW in the model. |
No arguments
ReturnsIGAEdgeUVW object (or null if there are no more IGA Edge UVWs in the model). Return typeIGAEdgeUVW |
ExampleTo get the IGA Edge UVW in model m after IGA Edge UVW igeu: var igeu = igeu.Next();
|
NextFreeLabel(Model[Model], layer (optional)[Include number]) [static]DescriptionReturns the next free (highest+1) IGA Edge UVW label in the model. Also see IGAEdgeUVW.FirstFreeLabel(), IGAEdgeUVW.LastFreeLabel() and Model.NextFreeItemLabel() |
Model to get next free IGA Edge UVW 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).
ReturnsIGAEdgeUVW label. Return typeNumber |
ExampleTo get the next free IGA Edge UVW label in model m: var label = IGAEdgeUVW.NextFreeLabel(m);
|
Previous()DescriptionReturns the previous IGA Edge UVW in the model. |
No arguments
ReturnsIGAEdgeUVW object (or null if there are no more IGA Edge UVWs in the model). Return typeIGAEdgeUVW |
ExampleTo get the IGA Edge UVW in model m before IGA Edge UVW igeu: var igeu = igeu.Previous();
|
RenumberAll(Model[Model], start[integer]) [static]DescriptionRenumbers all of the IGA Edge UVWs in the model. |
Model that all IGA Edge UVWs will be renumbered in
Start point for renumbering
ReturnsNo return value |
ExampleTo renumber all of the IGA Edge UVWs in model m, from 1000000: IGAEdgeUVW.RenumberAll(m, 1000000);
|
RenumberFlagged(Model[Model], flag[Flag], start[integer]) [static]DescriptionRenumbers all of the flagged IGA Edge UVWs in the model. |
Model that all the flagged IGA Edge UVWs will be renumbered in
Flag set on the IGA Edge UVWs that you want to renumber
Start point for renumbering
ReturnsNo return value |
ExampleTo renumber all of the IGA Edge UVWs in model m flagged with f, from 1000000: IGAEdgeUVW.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 UVWs using standard PRIMER object menus. |
Flag to use when selecting IGA Edge UVWs
Text to display as a prompt to the user
If the argument is a Model then only IGA Edge UVWs from that model can be selected. If the argument is a Flag then only IGA Edge UVWs that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any IGA Edge UVWs 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 UVWs selected or null if menu cancelled Return typeNumber |
SetFlag(flag[Flag])DescriptionSets a flag on the IGA Edge UVW. |
Flag to set on the IGA Edge UVW
ReturnsNo return value |
ExampleTo set flag f for IGA Edge UVW igeu: igeu.SetFlag(f);
|
Sketch(redraw (optional)[boolean])DescriptionSketches the IGA Edge UVW. The IGA Edge UVW will be sketched until you either call IGAEdgeUVW.Unsketch(), IGAEdgeUVW.UnsketchAll(), Model.UnsketchAll(), or delete the model |
If model should be redrawn or not after the IGA Edge UVW is sketched. If omitted redraw is true. If you want to sketch several IGA Edge UVWs and only redraw after the last one then use false for redraw and call View.Redraw().
ReturnsNo return value |
ExampleTo sketch IGA Edge UVW igeu: igeu.Sketch();
|
SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]DescriptionSketches all of the flagged IGA Edge UVWs in the model. The IGA Edge UVWs will be sketched until you either call IGAEdgeUVW.Unsketch(), IGAEdgeUVW.UnsketchFlagged(), Model.UnsketchAll(), or delete the model |
Model that all the flagged IGA Edge UVWs will be sketched in
Flag set on the IGA Edge UVWs that you want to sketch
If model should be redrawn or not after the IGA Edge UVWs are sketched. If omitted redraw is true. If you want to sketch flagged IGA Edge UVWs 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 UVWs flagged with flag in model m: IGAEdgeUVW.SketchFlagged(m, flag);
|
Total(Model[Model], exists (optional)[boolean]) [static]DescriptionReturns the total number of IGA Edge UVWs in the model. |
Model to get total for
true if only existing IGA Edge UVWs should be counted. If false or omitted referenced but undefined IGA Edge UVWs will also be included in the total.
Returnsnumber of IGA Edge UVWs Return typeNumber |
ExampleTo get the total number of IGA Edge UVWs in model m: var total = IGAEdgeUVW.Total(m);
|
UnflagAll(Model[Model], flag[Flag]) [static]DescriptionUnsets a defined flag on all of the IGA Edge UVWs in the model. |
Model that the defined flag for all IGA Edge UVWs will be unset in
Flag to unset on the IGA Edge UVWs
ReturnsNo return value |
ExampleTo unset the flag f on all the IGA Edge UVWs in model m: IGAEdgeUVW.UnflagAll(m, f);
|
Unsketch(redraw (optional)[boolean])DescriptionUnsketches the IGA Edge UVW. |
If model should be redrawn or not after the IGA Edge UVW is unsketched. If omitted redraw is true. If you want to unsketch several IGA Edge UVWs and only redraw after the last one then use false for redraw and call View.Redraw().
ReturnsNo return value |
ExampleTo unsketch IGA Edge UVW igeu: igeu.Unsketch();
|
UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]DescriptionUnsketches all IGA Edge UVWs. |
Model that all IGA Edge UVWs will be unblanked in
If model should be redrawn or not after the IGA Edge UVWs 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 UVWs in model m: IGAEdgeUVW.UnsketchAll(m);
|
UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]DescriptionUnsketches all flagged IGA Edge UVWs in the model. |
Model that all IGA Edge UVWs will be unsketched in
Flag set on the IGA Edge UVWs that you want to unsketch
If model should be redrawn or not after the IGA Edge UVWs 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 UVWs flagged with flag in model m: IGAEdgeUVW.UnsketchAll(m, flag);
|
No arguments
ReturnsIGAEdgeUVW object. Return typeIGAEdgeUVW |
ExampleTo check if IGAEdgeUVW property igeu.example is a parameter by using the IGAEdgeUVW.GetParameter() method: if (igeu.ViewParameters().GetParameter(igeu.example) ) do_something...
|
Warning(message[string], details (optional)[string])DescriptionAdds a warning for IGA Edge UVW. 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 UVW igeu: igeu.Warning("My custom warning");
|
Xrefs()DescriptionReturns the cross references for this IGA Edge UVW. |
No arguments
ReturnsXrefs object. Return typeXrefs |
ExampleTo get the cross references for IGA Edge UVW igeu: var xrefs = igeu.Xrefs();
|
toString()DescriptionCreates a string containing the IGA edge uvw data in keyword format. Note that this contains the keyword header and the keyword cards. See also IGAEdgeUVW.Keyword() and IGAEdgeUVW.KeywordCards(). |
No arguments
Returnsstring Return typeString |
ExampleTo get data for IGA edge uvw igeu in keyword format var s = igeu.toString();
|