IGAPointUVW class

The IGAPointUVW class gives you access to IGA point 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:

_example
$example
ABC_example

Class functions

Create(Model[Model], modal (optional)[boolean])
First(Model[Model])
FirstFreeLabel(Model[Model], layer (optional)[Include number])
FlagAll(Model[Model], flag[Flag])
ForEach(Model[Model], func[function], extra (optional)[any])
GetAll(Model[Model], property (optional)[string])
GetFlagged(Model[Model], flag[Flag], property (optional)[string])
GetFromID(Model[Model], number[integer])
Last(Model[Model])
LastFreeLabel(Model[Model], layer (optional)[Include number])
NextFreeLabel(Model[Model], layer (optional)[Include number])
RenumberAll(Model[Model], start[integer])
RenumberFlagged(Model[Model], flag[Flag], start[integer])
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean])
SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])
Total(Model[Model], exists (optional)[boolean])
UnflagAll(Model[Model], flag[Flag])
UnsketchAll(Model[Model], redraw (optional)[boolean])
UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean])

Member functions

AssociateComment(Comment[Comment])
Browse(modal (optional)[boolean])
ClearFlag(flag[Flag])
Copy(range (optional)[boolean])
DetachComment(Comment[Comment])
Edit(modal (optional)[boolean])
Error(message[string], details (optional)[string])
Flagged(flag[Flag])
GetComments()
GetParameter(prop[string])
Keyword()
KeywordCards()
Next()
Previous()
SetFlag(flag[Flag])
Sketch(redraw (optional)[boolean])
Unsketch(redraw (optional)[boolean])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

IGAPointUVW constants

Name	Description
IGAPointUVW.BASIS_TRANSFORM	BASIS_TRANSFORM is *IGA_POINT_UVW_BASIS_TRANSFORM.
IGAPointUVW.NONE	NONE is *IGA_POINT_UVW.

IGAPointUVW properties

Name	Type	Description
elid	integer	Element ID local to a basis transform.
exists (read only)	logical	true if IGA Point UVW exists, false if referred to but not defined.
include	integer	The Include file number that the IGA Point UVW is in.
label	integer	IGAPointUVW number. Also see the pid property which is an alternative name for this.
model (read only)	integer	The Model number that the IGA Point UVW is in.
nid	integer	Node ID.
option	constant	IGA Edge UVW option. IGAPointUVW.NONE or IGAPointUVW.BASIS_TRANSFORM
pid	integer	IGAPointUVW number. Also see the label property which is an alternative name for this.
u	real	Coordinates in the parametric u-direction.
v	real	Coordinates in the parametric v-direction.
w	real	Coordinates in the parametric w-direction.

Detailed Description

The IGAPointUVW class allows you to create, modify, edit and manipulate IGA point uvw cards. See the documentation below for more details.

Constructor

new IGAPointUVW(Model[Model], details[object])

Description

Create a new IGAPointUVW object.

Arguments

Model (Model)

Model that IGA point uvw will be created in

details (object)

Details for creating the IGAPointUVW

Object has the following properties:

Name	Type	Description
nid	integer	Node ID.
option (optional)	constant	IGA Point UVW option. IGAPointUVW.NONE or IGAPointUVW.BASIS_TRANSFORM
pid	integer	ID of the IGA Point UVW.
u (optional)	real	Coordinates in the parametric u-direction.
v (optional)	real	Coordinates in the parametric v-direction.
w (optional)	real	Coordinates in the parametric w-direction.

Returns

IGAPointUVW object

Return type

IGAPointUVW

Example

To create a new IGA point uvw in model m using pid 10 and node 100:

var igpu = new IGAPointUVW(m, {pid: 10, nid:100});

To create a new IGA point uvw in model m using pid 20 with node 200 and option BASIS_TRANSFORM and parametric coordinates u, v, w, as 3.3, 4.4, 5.5, elid 15 respectively:

var igpu = new IGAPointUVW(m, {option:IGAPointUVW.BASIS_TRANSFORM, pid: 20, nid: 200, u: 3.3, v: 4.4, w: 5.5, elid: 15});

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a IGA Point UVW.

Arguments

Comment (Comment)

Comment that will be attached to the IGA Point UVW

Returns

No return value

Example

To associate comment c to the IGA Point UVW igpu:

igpu.AssociateComment(c);

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Arguments

modal (optional) (boolean)

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.

Returns

no return value

Example

To Browse IGA Point UVW igpu:

igpu.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the IGA Point UVW.

Arguments

flag (Flag)

Flag to clear on the IGA Point UVW

Returns

No return value

Example

To clear flag f for IGA Point UVW igpu:

igpu.ClearFlag(f);

Copy(range (optional)[boolean])

Description

Copies the IGA Point UVW. The target include of the copied IGA Point UVW can be set using Options.copy_target_include.

Arguments

range (optional) (boolean)

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().

Returns

IGAPointUVW object

Return type

IGAPointUVW

Example

To copy IGA Point UVW igpu into IGA Point UVW z:

var z = igpu.Copy();

Create(Model[Model], modal (optional)[boolean]) [static]

Description

Starts an interactive editing panel to create a IGA Point UVW

Arguments

Model (Model)

Model that the IGA Point UVW will be created in.

modal (optional) (boolean)

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.

Returns

IGAPointUVW object (or null if not made).

Return type

IGAPointUVW

Example

To start creating a IGA Point UVW in model m:

var igpu = IGAPointUVW.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a IGA Point UVW.

Arguments

Comment (Comment)

Comment that will be detached from the IGA Point UVW

Returns

No return value

Example

To detach comment c from the IGA Point UVW igpu:

igpu.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Arguments

modal (optional) (boolean)

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.

Returns

no return value

Example

To Edit IGA Point UVW igpu:

igpu.Edit();

Error(message[string], details (optional)[string])

Description

Adds an error for IGA Point UVW. For more details on checking see the Check class.

Arguments

message (string)

The error message to give

details (optional) (string)

An optional detailed error message

Returns

No return value

Example

To add an error message "My custom error" for IGA Point UVW igpu:

igpu.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first IGA Point UVW in the model.

Arguments

Model (Model)

Model to get first IGA Point UVW in

Returns

IGAPointUVW object (or null if there are no IGA Point UVWs in the model).

Return type

IGAPointUVW

Example

To get the first IGA Point UVW in model m:

var igpu = IGAPointUVW.First(m);

FirstFreeLabel(Model[Model], layer (optional)[Include number]) [static]

Description

Returns the first free IGA Point UVW label in the model. Also see IGAPointUVW.LastFreeLabel(), IGAPointUVW.NextFreeLabel() and Model.FirstFreeItemLabel().

Arguments

Model (Model)

Model to get first free IGA Point UVW label in

layer (optional) (Include number)

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).

Returns

IGAPointUVW label.

Return type

Number

Example

To get the first free IGA Point UVW label in model m:

var label = IGAPointUVW.FirstFreeLabel(m);

FlagAll(Model[Model], flag[Flag]) [static]

Description

Flags all of the IGA Point UVWs in the model with a defined flag.

Arguments

Model (Model)

Model that all IGA Point UVWs will be flagged in

flag (Flag)

Flag to set on the IGA Point UVWs

Returns

No return value

Example

To flag all of the IGA Point UVWs with flag f in model m:

IGAPointUVW.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the IGA Point UVW is flagged or not.

Arguments

flag (Flag)

Flag to test on the IGA Point UVW

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if IGA Point UVW igpu has flag f set on it:

if (igpu.Flagged(f) ) do_something...

ForEach(Model[Model], func[function], extra (optional)[any]) [static]

Description

Calls a function for each IGA Point UVW in the model.
Note that ForEach has been designed to make looping over IGA Point UVWs as fast as possible and so has some limitations.
Firstly, a single temporary IGAPointUVW object is created and on each function call it is updated with the current IGA Point UVW data. This means that you should not try to store the IGAPointUVW object for later use (e.g. in an array) as it is temporary.
Secondly, you cannot create new IGA Point UVWs inside a ForEach loop.

Arguments

Model (Model)

Model that all IGA Point UVWs are in

func (function)

Function to call for each IGA Point UVW

extra (optional) (any)

An optional extra object/array/string etc that will appended to arguments when calling the function

Returns

No return value

Example

To call function test for all of the IGA Point UVWs in model m:

IGAPointUVW.ForEach(m, test);
function test(igpu)
{
// igpu is IGAPointUVW object
}

To call function test for all of the IGA Point UVWs in model m with optional object:

var data = { x:0, y:0 };
IGAPointUVW.ForEach(m, test, data);
function test(igpu, extra)
{
// igpu is IGAPointUVW object
// extra is data
}

GetAll(Model[Model], property (optional)[string]) [static]

Description

Returns an array of IGAPointUVW objects or properties for all of the IGA Point UVWs in a model in PRIMER. If the optional property argument is not given then an array of IGAPointUVW objects is returned. If the property argument is given, that property value for each IGA Point UVW is returned in the array instead of a IGAPointUVW object

Arguments

Model (Model)

Model to get IGA Point UVWs from

property (optional) (string)

Name for property to get for all IGA Point UVWs in the model

Returns

Array of IGAPointUVW objects or properties

Return type

Array

Example

To make an array of IGAPointUVW objects for all of the IGA Point UVWs in model m:

var a = IGAPointUVW.GetAll(m);

To return an array containing the value of property 'foo' (for example 'x' for a node) for each IGA Point UVW in model m:

var a = IGAPointUVW.GetAll(m, 'foo');

GetComments()

Description

Extracts the comments associated to a IGA Point UVW.

Arguments

No arguments

Returns

Array of Comment objects (or null if there are no comments associated to the node).

Return type

Array

Example

To get the array of comments associated to the IGA Point UVW igpu:

var comm_array = igpu.GetComments();

GetFlagged(Model[Model], flag[Flag], property (optional)[string]) [static]

Description

Returns an array of IGAPointUVW objects for all of the flagged IGA Point UVWs in a model in PRIMER If the optional property argument is not given then an array of IGAPointUVW objects is returned. If the property argument is given, then that property value for each IGA Point UVW is returned in the array instead of a IGAPointUVW object

Arguments

Model (Model)

Model to get IGA Point UVWs from

flag (Flag)

Flag set on the IGA Point UVWs that you want to retrieve

property (optional) (string)

Name for property to get for all flagged IGA Point UVWs in the model

Returns

Array of IGAPointUVW objects or properties

Return type

Array

Example

To make an array of IGAPointUVW objects for all of the IGA Point UVWs in model m flagged with f:

var igpu = IGAPointUVW.GetFlagged(m, f);

To return an array containing the value of property 'foo' (for example 'x' for a node) for all of the IGA Point UVWs in model m flagged with f:

var a = IGAPointUVW.GetFlagged(m, f, 'foo');

GetFromID(Model[Model], number[integer]) [static]

Description

Returns the IGAPointUVW object for a IGA Point UVW ID.

Arguments

Model (Model)

Model to find the IGA Point UVW in

number (integer)

number of the IGA Point UVW you want the IGAPointUVW object for

Returns

IGAPointUVW object (or null if IGA Point UVW does not exist).

Return type

IGAPointUVW

Example

To get the IGAPointUVW object for IGA Point UVW 100 in model m

var igpu = IGAPointUVW.GetFromID(m, 100);

GetParameter(prop[string])

Description

Checks if a IGAPointUVW 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 IGAPointUVW.ViewParameters() method and 'method chaining' (see the examples below).

Arguments

prop (string)

IGA Point UVW property to get parameter for

Returns

Parameter object if property is a parameter, null if not.

Return type

Parameter

Example

To check if IGAPointUVW property igpu.example is a parameter:

Options.property_parameter_names = true;
if (igpu.GetParameter(igpu.example) ) do_something...
Options.property_parameter_names = false;

To check if IGAPointUVW property igpu.example is a parameter by using the GetParameter method:

if (igpu.ViewParameters().GetParameter(igpu.example) ) do_something...

Keyword()

Description

Returns the keyword for this IGA point uvw (*IGA_POINT_UVW). Note that a carriage return is not added. See also IGAPointUVW.KeywordCards()

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for IGA point uvw igpu:

var key = igpu.Keyword();

KeywordCards()

Description

Returns the keyword cards for the IGA point uvw. Note that a carriage return is not added. See also IGAPointUVW.Keyword()

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for IGA point uvw igpu:

var cards = igpu.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last IGA Point UVW in the model.

Arguments

Model (Model)

Model to get last IGA Point UVW in

Returns

IGAPointUVW object (or null if there are no IGA Point UVWs in the model).

Return type

IGAPointUVW

Example

To get the last IGA Point UVW in model m:

var igpu = IGAPointUVW.Last(m);

LastFreeLabel(Model[Model], layer (optional)[Include number]) [static]

Description

Returns the last free IGA Point UVW label in the model. Also see IGAPointUVW.FirstFreeLabel(), IGAPointUVW.NextFreeLabel() and see Model.LastFreeItemLabel()

Arguments

Model (Model)

Model to get last free IGA Point UVW label in

layer (optional) (Include number)

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.

Returns

IGAPointUVW label.

Return type

Number

Example

To get the last free IGA Point UVW label in model m:

var label = IGAPointUVW.LastFreeLabel(m);

Next()

Description

Returns the next IGA Point UVW in the model.

Arguments

No arguments

Returns

IGAPointUVW object (or null if there are no more IGA Point UVWs in the model).

Return type

IGAPointUVW

Example

To get the IGA Point UVW in model m after IGA Point UVW igpu:

var igpu = igpu.Next();

NextFreeLabel(Model[Model], layer (optional)[Include number]) [static]

Description

Returns the next free (highest+1) IGA Point UVW label in the model. Also see IGAPointUVW.FirstFreeLabel(), IGAPointUVW.LastFreeLabel() and Model.NextFreeItemLabel()

Arguments

Model (Model)

Model to get next free IGA Point UVW label in

layer (optional) (Include number)

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).

Returns

IGAPointUVW label.

Return type

Number

Example

To get the next free IGA Point UVW label in model m:

var label = IGAPointUVW.NextFreeLabel(m);

Previous()

Description

Returns the previous IGA Point UVW in the model.

Arguments

No arguments

Returns

IGAPointUVW object (or null if there are no more IGA Point UVWs in the model).

Return type

IGAPointUVW

Example

To get the IGA Point UVW in model m before IGA Point UVW igpu:

var igpu = igpu.Previous();

RenumberAll(Model[Model], start[integer]) [static]

Description

Renumbers all of the IGA Point UVWs in the model.

Arguments

Model (Model)

Model that all IGA Point UVWs will be renumbered in

start (integer)

Start point for renumbering

Returns

No return value

Example

To renumber all of the IGA Point UVWs in model m, from 1000000:

IGAPointUVW.RenumberAll(m, 1000000);

RenumberFlagged(Model[Model], flag[Flag], start[integer]) [static]

Description

Renumbers all of the flagged IGA Point UVWs in the model.

Arguments

Model (Model)

Model that all the flagged IGA Point UVWs will be renumbered in

flag (Flag)

Flag set on the IGA Point UVWs that you want to renumber

start (integer)

Start point for renumbering

Returns

No return value

Example

To renumber all of the IGA Point UVWs in model m flagged with f, from 1000000:

IGAPointUVW.RenumberFlagged(m, f, 1000000);

Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]

Description

Allows the user to select IGA Point UVWs using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting IGA Point UVWs

prompt (string)

Text to display as a prompt to the user

limit (optional) (Model or Flag)

If the argument is a Model then only IGA Point UVWs from that model can be selected. If the argument is a Flag then only IGA Point UVWs that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any IGA Point UVWs can be selected. from any model.

modal (optional) (boolean)

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.

Returns

Number of IGA Point UVWs selected or null if menu cancelled

Return type

Number

Example

To select IGA Point UVWs from model m, flagging those selected with flag f, giving the prompt 'Select IGA Point UVWs':

IGAPointUVW.Select(f, 'Select IGA Point UVWs', m);

To select IGA Point UVWs, flagging those selected with flag f but limiting selection to IGA Point UVWs flagged with flag l, giving the prompt 'Select IGA Point UVWs':

IGAPointUVW.Select(f, 'Select IGA Point UVWs', l);

SetFlag(flag[Flag])

Description

Sets a flag on the IGA Point UVW.

Arguments

flag (Flag)

Flag to set on the IGA Point UVW

Returns

No return value

Example

To set flag f for IGA Point UVW igpu:

igpu.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

Sketches the IGA Point UVW. The IGA Point UVW will be sketched until you either call IGAPointUVW.Unsketch(), IGAPointUVW.UnsketchAll(), Model.UnsketchAll(), or delete the model

Arguments

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Point UVW is sketched. If omitted redraw is true. If you want to sketch several IGA Point UVWs and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To sketch IGA Point UVW igpu:

igpu.Sketch();

SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Sketches all of the flagged IGA Point UVWs in the model. The IGA Point UVWs will be sketched until you either call IGAPointUVW.Unsketch(), IGAPointUVW.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

Arguments

Model (Model)

Model that all the flagged IGA Point UVWs will be sketched in

flag (Flag)

Flag set on the IGA Point UVWs that you want to sketch

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Point UVWs are sketched. If omitted redraw is true. If you want to sketch flagged IGA Point UVWs several times and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To sketch all IGA Point UVWs flagged with flag in model m:

IGAPointUVW.SketchFlagged(m, flag);

Total(Model[Model], exists (optional)[boolean]) [static]

Description

Returns the total number of IGA Point UVWs in the model.

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

true if only existing IGA Point UVWs should be counted. If false or omitted referenced but undefined IGA Point UVWs will also be included in the total.

Returns

number of IGA Point UVWs

Return type

Number

Example

To get the total number of IGA Point UVWs in model m:

var total = IGAPointUVW.Total(m);

UnflagAll(Model[Model], flag[Flag]) [static]

Description

Unsets a defined flag on all of the IGA Point UVWs in the model.

Arguments

Model (Model)

Model that the defined flag for all IGA Point UVWs will be unset in

flag (Flag)

Flag to unset on the IGA Point UVWs

Returns

No return value

Example

To unset the flag f on all the IGA Point UVWs in model m:

IGAPointUVW.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the IGA Point UVW.

Arguments

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Point UVW is unsketched. If omitted redraw is true. If you want to unsketch several IGA Point UVWs and only redraw after the last one then use false for redraw and call View.Redraw().

Returns

No return value

Example

To unsketch IGA Point UVW igpu:

igpu.Unsketch();

UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]

Description

Unsketches all IGA Point UVWs.

Arguments

Model (Model)

Model that all IGA Point UVWs will be unblanked in

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Point 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().

Returns

No return value

Example

To unsketch all IGA Point UVWs in model m:

IGAPointUVW.UnsketchAll(m);

UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Unsketches all flagged IGA Point UVWs in the model.

Arguments

Model (Model)

Model that all IGA Point UVWs will be unsketched in

flag (Flag)

Flag set on the IGA Point UVWs that you want to unsketch

redraw (optional) (boolean)

Returns

No return value

Example

To unsketch all IGA Point UVWs flagged with flag in model m:

IGAPointUVW.UnsketchAll(m, flag);

ViewParameters()

Description

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. This function temporarily changes the behaviour so that if a property is a parameter the parameter name is returned instead. This can be used with 'method chaining' (see the example below) to make sure a property argument is correct.

Arguments

No arguments

Returns

IGAPointUVW object.

Return type

IGAPointUVW

Example

To check if IGAPointUVW property igpu.example is a parameter by using the IGAPointUVW.GetParameter() method:

if (igpu.ViewParameters().GetParameter(igpu.example) ) do_something...

Warning(message[string], details (optional)[string])

Description

Adds a warning for IGA Point UVW. For more details on checking see the Check class.

Arguments

message (string)

The warning message to give

details (optional) (string)

An optional detailed warning message

Returns

No return value

Example

To add a warning message "My custom warning" for IGA Point UVW igpu:

igpu.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this IGA Point UVW.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for IGA Point UVW igpu:

var xrefs = igpu.Xrefs();

toString()

Description

Creates a string containing the IGA point uvw data in keyword format. Note that this contains the keyword header and the keyword cards. See also IGAPointUVW.Keyword() and IGAPointUVW.KeywordCards().

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for IGA point uvw igpu in keyword format

var s = igpu.toString();