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