The IGA2DBrep class gives you access to IGA 2d brep 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 |
| brid | integer | IGA2DBrep number. Also see the label property which is an alternative name for this. |
| entries (read only) | integer | Number of Parametric Face IDs (fid) added in IGA_2D_BREP. Can be used as index to add a new entry. |
| exists (read only) | logical | true if IGA 2D Brep exists, false if referred to but not defined. |
| include | integer | The Include file number that the IGA 2D Brep is in. |
| label | integer | IGA2DBrep number. Also see the brid property which is an alternative name for this. |
| model (read only) | integer | The Model number that the IGA 2D Brep is in. |
Detailed DescriptionThe IGA2DBrep class allows you to create, modify, edit and manipulate IGA 2d brep cards. See the documentation below for more details. |
Constructornew IGA2DBrep(Model[Model], details[object])DescriptionCreate a new IGA2DBrep object. |
Model that IGA 2d brep will be created in
Details for creating the IGA2DBrep
Object has the following properties:
| Name | Type | Description |
| brid | integer | ID of the IGA 2D Brep. |
ReturnsIGA2DBrep object Return typeIGA2DBrep |
ExampleTo create a new IGA 2d brep in model m of id 10: var ig2b = new IGA2DBrep(m, {brid:10});
|
Details of functionsAssociateComment(Comment[Comment])DescriptionAssociates a comment with a IGA 2D Brep. |
Comment that will be attached to the IGA 2D Brep
ReturnsNo return value |
ExampleTo associate comment c to the IGA 2D Brep ig2b: ig2b.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 2D Brep ig2b: ig2b.Browse();
|
ClearFlag(flag[Flag])DescriptionClears a flag on the IGA 2D Brep. |
Flag to clear on the IGA 2D Brep
ReturnsNo return value |
ExampleTo clear flag f for IGA 2D Brep ig2b: ig2b.ClearFlag(f);
|
Copy(range (optional)[boolean])DescriptionCopies the IGA 2D Brep. The target include of the copied IGA 2D Brep 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().
ReturnsIGA2DBrep object Return typeIGA2DBrep |
ExampleTo copy IGA 2D Brep ig2b into IGA 2D Brep z: var z = ig2b.Copy();
|
Create(Model[Model], modal (optional)[boolean]) [static]DescriptionStarts an interactive editing panel to create a IGA 2D Brep |
Model that the IGA 2D Brep 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.
ReturnsIGA2DBrep object (or null if not made). Return typeIGA2DBrep |
ExampleTo start creating a IGA 2D Brep in model m: var ig2b = IGA2DBrep.Create(m);
|
DetachComment(Comment[Comment])DescriptionDetaches a comment from a IGA 2D Brep. |
Comment that will be detached from the IGA 2D Brep
ReturnsNo return value |
ExampleTo detach comment c from the IGA 2D Brep ig2b: ig2b.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 2D Brep ig2b: ig2b.Edit();
|
Error(message[string], details (optional)[string])DescriptionAdds an error for IGA 2D Brep. 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 2D Brep ig2b: ig2b.Error("My custom error");
|
First(Model[Model]) [static]DescriptionReturns the first IGA 2D Brep in the model. |
Model to get first IGA 2D Brep in
ReturnsIGA2DBrep object (or null if there are no IGA 2D Breps in the model). Return typeIGA2DBrep |
ExampleTo get the first IGA 2D Brep in model m: var ig2b = IGA2DBrep.First(m);
|
FirstFreeLabel(Model[Model], layer (optional)[Include number]) [static]DescriptionReturns the first free IGA 2D Brep label in the model. Also see IGA2DBrep.LastFreeLabel(), IGA2DBrep.NextFreeLabel() and Model.FirstFreeItemLabel(). |
Model to get first free IGA 2D Brep 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).
ReturnsIGA2DBrep label. Return typeNumber |
ExampleTo get the first free IGA 2D Brep label in model m: var label = IGA2DBrep.FirstFreeLabel(m);
|
FlagAll(Model[Model], flag[Flag]) [static]DescriptionFlags all of the IGA 2D Breps in the model with a defined flag. |
Model that all IGA 2D Breps will be flagged in
Flag to set on the IGA 2D Breps
ReturnsNo return value |
ExampleTo flag all of the IGA 2D Breps with flag f in model m: IGA2DBrep.FlagAll(m, f);
|
Flagged(flag[Flag])DescriptionChecks if the IGA 2D Brep is flagged or not. |
Flag to test on the IGA 2D Brep
Returnstrue if flagged, false if not. Return typeBoolean |
ExampleTo check if IGA 2D Brep ig2b has flag f set on it: if (ig2b.Flagged(f) ) do_something...
|
ForEach(Model[Model], func[function], extra (optional)[any]) [static]DescriptionCalls a function for each IGA 2D Brep in the model. |
Model that all IGA 2D Breps are in
Function to call for each IGA 2D Brep
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 IGA2DBrep objects or properties for all of the IGA 2D Breps in a model in PRIMER. If the optional property argument is not given then an array of IGA2DBrep objects is returned. If the property argument is given, that property value for each IGA 2D Brep is returned in the array instead of a IGA2DBrep object |
Model to get IGA 2D Breps from
Name for property to get for all IGA 2D Breps in the model
ReturnsArray of IGA2DBrep objects or properties Return typeArray |
GetComments()DescriptionExtracts the comments associated to a IGA 2D Brep. |
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 2D Brep ig2b: var comm_array = ig2b.GetComments();
|
GetData(index[integer])DescriptionReturns the data for fid in *IGA_2D_BREP. |
Index you want the data for. Note that indices start at 0.
ReturnsThe ID of parametric face, *IGA_FACE_UVW. Return typeNumber |
ExampleTo get the 3rd data entry in IGA 2d brep ig2b: var data = ig2b.GetData(2);
|
GetFlagged(Model[Model], flag[Flag], property (optional)[string]) [static]DescriptionReturns an array of IGA2DBrep objects for all of the flagged IGA 2D Breps in a model in PRIMER If the optional property argument is not given then an array of IGA2DBrep objects is returned. If the property argument is given, then that property value for each IGA 2D Brep is returned in the array instead of a IGA2DBrep object |
Model to get IGA 2D Breps from
Flag set on the IGA 2D Breps that you want to retrieve
Name for property to get for all flagged IGA 2D Breps in the model
ReturnsArray of IGA2DBrep objects or properties Return typeArray |
GetFromID(Model[Model], number[integer]) [static]DescriptionReturns the IGA2DBrep object for a IGA 2D Brep ID. |
Model to find the IGA 2D Brep in
number of the IGA 2D Brep you want the IGA2DBrep object for
ReturnsIGA2DBrep object (or null if IGA 2D Brep does not exist). Return typeIGA2DBrep |
ExampleTo get the IGA2DBrep object for IGA 2D Brep 100 in model m var ig2b = IGA2DBrep.GetFromID(m, 100);
|
GetParameter(prop[string])DescriptionChecks if a IGA2DBrep 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 IGA2DBrep.ViewParameters() method and 'method chaining' (see the examples below). |
IGA 2D Brep property to get parameter for
ReturnsParameter object if property is a parameter, null if not. Return typeParameter |
Keyword()DescriptionReturns the keyword for this IGA 2d brep (*IGA_2D_BREP). Note that a carriage return is not added. See also IGA2DBrep.KeywordCards() |
No arguments
Returnsstring containing the keyword. Return typeString |
ExampleTo get the keyword for IGA 2d brep ig2b: var key = ig2b.Keyword();
|
KeywordCards()DescriptionReturns the keyword cards for the IGA 2d brep. Note that a carriage return is not added. See also IGA2DBrep.Keyword() |
No arguments
Returnsstring containing the cards. Return typeString |
ExampleTo get the cards for IGA 2d brep ig2b: var cards = ig2b.KeywordCards();
|
Last(Model[Model]) [static]DescriptionReturns the last IGA 2D Brep in the model. |
Model to get last IGA 2D Brep in
ReturnsIGA2DBrep object (or null if there are no IGA 2D Breps in the model). Return typeIGA2DBrep |
ExampleTo get the last IGA 2D Brep in model m: var ig2b = IGA2DBrep.Last(m);
|
LastFreeLabel(Model[Model], layer (optional)[Include number]) [static]DescriptionReturns the last free IGA 2D Brep label in the model. Also see IGA2DBrep.FirstFreeLabel(), IGA2DBrep.NextFreeLabel() and see Model.LastFreeItemLabel() |
Model to get last free IGA 2D Brep 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.
ReturnsIGA2DBrep label. Return typeNumber |
ExampleTo get the last free IGA 2D Brep label in model m: var label = IGA2DBrep.LastFreeLabel(m);
|
Next()DescriptionReturns the next IGA 2D Brep in the model. |
No arguments
ReturnsIGA2DBrep object (or null if there are no more IGA 2D Breps in the model). Return typeIGA2DBrep |
ExampleTo get the IGA 2D Brep in model m after IGA 2D Brep ig2b: var ig2b = ig2b.Next();
|
NextFreeLabel(Model[Model], layer (optional)[Include number]) [static]DescriptionReturns the next free (highest+1) IGA 2D Brep label in the model. Also see IGA2DBrep.FirstFreeLabel(), IGA2DBrep.LastFreeLabel() and Model.NextFreeItemLabel() |
Model to get next free IGA 2D Brep 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).
ReturnsIGA2DBrep label. Return typeNumber |
ExampleTo get the next free IGA 2D Brep label in model m: var label = IGA2DBrep.NextFreeLabel(m);
|
Previous()DescriptionReturns the previous IGA 2D Brep in the model. |
No arguments
ReturnsIGA2DBrep object (or null if there are no more IGA 2D Breps in the model). Return typeIGA2DBrep |
ExampleTo get the IGA 2D Brep in model m before IGA 2D Brep ig2b: var ig2b = ig2b.Previous();
|
RemoveData(index[integer])DescriptionRemoves fid for an index in *IGA_2D_BREP. |
The index you want to delete fid for. Note that indices start at 0, not 1.
ReturnsNo return value. |
ExampleTo delete the fid for the 3rd index for *IGA_2D_BREP in model m: if (ig2b.entries >= 3)
{
ig2b.RemoveData(2);
}
|
RenumberAll(Model[Model], start[integer]) [static]DescriptionRenumbers all of the IGA 2D Breps in the model. |
Model that all IGA 2D Breps will be renumbered in
Start point for renumbering
ReturnsNo return value |
ExampleTo renumber all of the IGA 2D Breps in model m, from 1000000: IGA2DBrep.RenumberAll(m, 1000000);
|
RenumberFlagged(Model[Model], flag[Flag], start[integer]) [static]DescriptionRenumbers all of the flagged IGA 2D Breps in the model. |
Model that all the flagged IGA 2D Breps will be renumbered in
Flag set on the IGA 2D Breps that you want to renumber
Start point for renumbering
ReturnsNo return value |
ExampleTo renumber all of the IGA 2D Breps in model m flagged with f, from 1000000: IGA2DBrep.RenumberFlagged(m, f, 1000000);
|
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]DescriptionAllows the user to select IGA 2D Breps using standard PRIMER object menus. |
Flag to use when selecting IGA 2D Breps
Text to display as a prompt to the user
If the argument is a Model then only IGA 2D Breps from that model can be selected. If the argument is a Flag then only IGA 2D Breps that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any IGA 2D Breps 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 2D Breps selected or null if menu cancelled Return typeNumber |
SetData(index[integer], fid[integer])DescriptionSets fid in *IGA_2D_BREP. |
Index you want to set the fid for. Note that indices start at 0.
The ID of parametric face.
ReturnsNo return value. |
SetFlag(flag[Flag])DescriptionSets a flag on the IGA 2D Brep. |
Flag to set on the IGA 2D Brep
ReturnsNo return value |
ExampleTo set flag f for IGA 2D Brep ig2b: ig2b.SetFlag(f);
|
Sketch(redraw (optional)[boolean])DescriptionSketches the IGA 2D Brep. The IGA 2D Brep will be sketched until you either call IGA2DBrep.Unsketch(), IGA2DBrep.UnsketchAll(), Model.UnsketchAll(), or delete the model |
If model should be redrawn or not after the IGA 2D Brep is sketched. If omitted redraw is true. If you want to sketch several IGA 2D Breps and only redraw after the last one then use false for redraw and call View.Redraw().
ReturnsNo return value |
ExampleTo sketch IGA 2D Brep ig2b: ig2b.Sketch();
|
SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]DescriptionSketches all of the flagged IGA 2D Breps in the model. The IGA 2D Breps will be sketched until you either call IGA2DBrep.Unsketch(), IGA2DBrep.UnsketchFlagged(), Model.UnsketchAll(), or delete the model |
Model that all the flagged IGA 2D Breps will be sketched in
Flag set on the IGA 2D Breps that you want to sketch
If model should be redrawn or not after the IGA 2D Breps are sketched. If omitted redraw is true. If you want to sketch flagged IGA 2D Breps 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 2D Breps flagged with flag in model m: IGA2DBrep.SketchFlagged(m, flag);
|
Total(Model[Model], exists (optional)[boolean]) [static]DescriptionReturns the total number of IGA 2D Breps in the model. |
Model to get total for
true if only existing IGA 2D Breps should be counted. If false or omitted referenced but undefined IGA 2D Breps will also be included in the total.
Returnsnumber of IGA 2D Breps Return typeNumber |
ExampleTo get the total number of IGA 2D Breps in model m: var total = IGA2DBrep.Total(m);
|
UnflagAll(Model[Model], flag[Flag]) [static]DescriptionUnsets a defined flag on all of the IGA 2D Breps in the model. |
Model that the defined flag for all IGA 2D Breps will be unset in
Flag to unset on the IGA 2D Breps
ReturnsNo return value |
ExampleTo unset the flag f on all the IGA 2D Breps in model m: IGA2DBrep.UnflagAll(m, f);
|
Unsketch(redraw (optional)[boolean])DescriptionUnsketches the IGA 2D Brep. |
If model should be redrawn or not after the IGA 2D Brep is unsketched. If omitted redraw is true. If you want to unsketch several IGA 2D Breps and only redraw after the last one then use false for redraw and call View.Redraw().
ReturnsNo return value |
ExampleTo unsketch IGA 2D Brep ig2b: ig2b.Unsketch();
|
UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]DescriptionUnsketches all IGA 2D Breps. |
Model that all IGA 2D Breps will be unblanked in
If model should be redrawn or not after the IGA 2D Breps 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 2D Breps in model m: IGA2DBrep.UnsketchAll(m);
|
UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]DescriptionUnsketches all flagged IGA 2D Breps in the model. |
Model that all IGA 2D Breps will be unsketched in
Flag set on the IGA 2D Breps that you want to unsketch
If model should be redrawn or not after the IGA 2D Breps 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 2D Breps flagged with flag in model m: IGA2DBrep.UnsketchAll(m, flag);
|
No arguments
ReturnsIGA2DBrep object. Return typeIGA2DBrep |
ExampleTo check if IGA2DBrep property ig2b.example is a parameter by using the IGA2DBrep.GetParameter() method: if (ig2b.ViewParameters().GetParameter(ig2b.example) ) do_something...
|
Warning(message[string], details (optional)[string])DescriptionAdds a warning for IGA 2D Brep. 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 2D Brep ig2b: ig2b.Warning("My custom warning");
|
Xrefs()DescriptionReturns the cross references for this IGA 2D Brep. |
No arguments
ReturnsXrefs object. Return typeXrefs |
ExampleTo get the cross references for IGA 2D Brep ig2b: var xrefs = ig2b.Xrefs();
|
toString()DescriptionCreates a string containing the IGA 2d brep data in keyword format. Note that this contains the keyword header and the keyword cards. See also IGA2DBrep.Keyword() and IGA2DBrep.KeywordCards(). |
No arguments
Returnsstring Return typeString |
ExampleTo get data for IGA 2d brep ig2b in keyword format var s = ig2b.toString();
|