IGAFaceUVW class

The IGAFaceUVW class gives you access to IGA face 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()
GetData(index[integer])
GetParameter(prop[string])
Keyword()
KeywordCards()
Next()
Previous()
RemoveData(index[integer])
SetData(index[integer], brid[integer])
SetFlag(flag[Flag])
Sketch(redraw (optional)[boolean])
Unsketch(redraw (optional)[boolean])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

IGAFaceUVW constants

Name	Description
IGAFaceUVW.BASIS_TRANSFORM	BASIS_TRANSFORM is *IGA_FACE_UVW_BASIS_TRANSFORM.
IGAFaceUVW.NONE	NONE is *IGA_FACE_UVW.

IGAFaceUVW properties

Name	Type	Description
elid	integer	Element ID local to a trivariate basis transform. Only for the BASIS_TRANSFORM keyword option.
entries (read only)	integer	Number of Boundary representation IDs (brid) or Element IDs (elid) added in IGA_FACE_UVW. Can be used as index to add a new entry.
exists (read only)	logical	true if IGA Face UVW exists, false if referred to but not defined.
faceid	integer	Face ID. Only for the BASIS_TRANSFORM keyword option.
fid	integer	IGAFaceUVW number. Also see the label property which is an alternative name for this.
fxyzid	integer	Physical face ID. *IGA_FACE_XYZ.
include	integer	The Include file number that the IGA Face UVW is in.
label	integer	IGAFaceUVW number. Also see the fid property which is an alternative name for this.
model (read only)	integer	The Model number that the IGA Face UVW is in.
option	constant	IGA Face UVW option. IGAFaceUVW.NONE or IGAFaceUVW.BASIS_TRANSFORM
patchid	integer	Physical bivariate NURBS patch ID or a bivariate Basis Transform patch ID. Ignored for the BASIS_TRANSFORM keyword option.
sense	integer	Sense of orientation with respect to the physical face. Ignored for the BASIS_TRANSFORM keyword option.

Detailed Description

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

Constructor

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

Description

Create a new IGAFaceUVW object.

Arguments

Model (Model)

Model that IGA face uvw will be created in

details (object)

Details for creating the IGAFaceUVW

Object has the following properties:

Name	Type	Description
elid (optional)	integer	Element ID local to a trivariate basis transform.
faceid (optional)	integer	Face ID.
fid	integer	ID of the IGA Face UVW.
fxyzid (optional)	integer	Physical face ID. *IGA_FACE_XYZ.
option	constant	IGA Face UVW option. IGAFaceUVW.NONE or IGAFaceUVW.BASIS_TRANSFORM
patchid (optional)	integer	Physical bivariate NURBS patch ID.
sense (optional)	integer	Sense of orientation with respect to the physical face.

Returns

IGAFaceUVW object

Return type

IGAFaceUVW

Example

To create a new IGA face uvw in model m using fid 10 and option NONE with fxyzid 11, patchid 12 and sense 1:

var igfu = new IGAFaceUVW(m, {option:IGAFaceUVW.NONE, fid:10, fxyzid:11, patchid:12, sense:1});

To create a new IGA face uvw in model m using fid 21 and option BASIS_TRANSFORM with elid 31, faceid 6:

var igfu = new IGAFaceUVW(m, {option:IGAFaceUVW.BASIS_TRANSFORM, fid:21, elid: 31, faceid:6});

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a IGA Face UVW.

Arguments

Comment (Comment)

Comment that will be attached to the IGA Face UVW

Returns

No return value

Example

To associate comment c to the IGA Face UVW igfu:

igfu.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 Face UVW igfu:

igfu.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the IGA Face UVW.

Arguments

flag (Flag)

Flag to clear on the IGA Face UVW

Returns

No return value

Example

To clear flag f for IGA Face UVW igfu:

igfu.ClearFlag(f);

Copy(range (optional)[boolean])

Description

Copies the IGA Face UVW. The target include of the copied IGA Face 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

IGAFaceUVW object

Return type

IGAFaceUVW

Example

To copy IGA Face UVW igfu into IGA Face UVW z:

var z = igfu.Copy();

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

Description

Starts an interactive editing panel to create a IGA Face UVW

Arguments

Model (Model)

Model that the IGA Face 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

IGAFaceUVW object (or null if not made).

Return type

IGAFaceUVW

Example

To start creating a IGA Face UVW in model m:

var igfu = IGAFaceUVW.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a IGA Face UVW.

Arguments

Comment (Comment)

Comment that will be detached from the IGA Face UVW

Returns

No return value

Example

To detach comment c from the IGA Face UVW igfu:

igfu.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 Face UVW igfu:

igfu.Edit();

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

Description

Adds an error for IGA Face 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 Face UVW igfu:

igfu.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first IGA Face UVW in the model.

Arguments

Model (Model)

Model to get first IGA Face UVW in

Returns

IGAFaceUVW object (or null if there are no IGA Face UVWs in the model).

Return type

IGAFaceUVW

Example

To get the first IGA Face UVW in model m:

var igfu = IGAFaceUVW.First(m);

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

Description

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

Arguments

Model (Model)

Model to get first free IGA Face 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

IGAFaceUVW label.

Return type

Number

Example

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

var label = IGAFaceUVW.FirstFreeLabel(m);

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

Description

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

Arguments

Model (Model)

Model that all IGA Face UVWs will be flagged in

flag (Flag)

Flag to set on the IGA Face UVWs

Returns

No return value

Example

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

IGAFaceUVW.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the IGA Face UVW is flagged or not.

Arguments

flag (Flag)

Flag to test on the IGA Face UVW

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if IGA Face UVW igfu has flag f set on it:

if (igfu.Flagged(f) ) do_something...

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

Description

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

Arguments

Model (Model)

Model that all IGA Face UVWs are in

func (function)

Function to call for each IGA Face 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 Face UVWs in model m:

IGAFaceUVW.ForEach(m, test);
function test(igfu)
{
// igfu is IGAFaceUVW object
}

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

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

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

Description

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

Arguments

Model (Model)

Model to get IGA Face UVWs from

property (optional) (string)

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

Returns

Array of IGAFaceUVW objects or properties

Return type

Array

Example

To make an array of IGAFaceUVW objects for all of the IGA Face UVWs in model m:

var a = IGAFaceUVW.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a IGA Face 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 Face UVW igfu:

var comm_array = igfu.GetComments();

GetData(index[integer])

Description

Returns the data for brid in *IGA_FACE_UVW. Only valid for option IGAFaceUVW.NONE.

Arguments

index (integer)

Index you want the data for. Note that indices start at 0.

Returns

The ID of boundary representation or basis transform element depending on option.

Return type

Number

Example

To get the 3rd data entry in IGA face uvw igfu:

var data = igfu.GetData(2);

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

Description

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

Arguments

Model (Model)

Model to get IGA Face UVWs from

flag (Flag)

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

property (optional) (string)

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

Returns

Array of IGAFaceUVW objects or properties

Return type

Array

Example

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

var igfu = IGAFaceUVW.GetFlagged(m, f);

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

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

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

Description

Returns the IGAFaceUVW object for a IGA Face UVW ID.

Arguments

Model (Model)

Model to find the IGA Face UVW in

number (integer)

number of the IGA Face UVW you want the IGAFaceUVW object for

Returns

IGAFaceUVW object (or null if IGA Face UVW does not exist).

Return type

IGAFaceUVW

Example

To get the IGAFaceUVW object for IGA Face UVW 100 in model m

var igfu = IGAFaceUVW.GetFromID(m, 100);

GetParameter(prop[string])

Description

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

Arguments

prop (string)

IGA Face UVW property to get parameter for

Returns

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

Return type

Parameter

Example

To check if IGAFaceUVW property igfu.example is a parameter:

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

To check if IGAFaceUVW property igfu.example is a parameter by using the GetParameter method:

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

Keyword()

Description

Returns the keyword for this IGA face uvw (*IGA_FACE_UVW). Note that a carriage return is not added. See also IGAFaceUVW.KeywordCards()

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for IGA face uvw igfu:

var key = igfu.Keyword();

KeywordCards()

Description

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

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for IGA face uvw igfu:

var cards = igfu.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last IGA Face UVW in the model.

Arguments

Model (Model)

Model to get last IGA Face UVW in

Returns

IGAFaceUVW object (or null if there are no IGA Face UVWs in the model).

Return type

IGAFaceUVW

Example

To get the last IGA Face UVW in model m:

var igfu = IGAFaceUVW.Last(m);

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

Description

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

Arguments

Model (Model)

Model to get last free IGA Face 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

IGAFaceUVW label.

Return type

Number

Example

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

var label = IGAFaceUVW.LastFreeLabel(m);

Next()

Description

Returns the next IGA Face UVW in the model.

Arguments

No arguments

Returns

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

Return type

IGAFaceUVW

Example

To get the IGA Face UVW in model m after IGA Face UVW igfu:

var igfu = igfu.Next();

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

Description

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

Arguments

Model (Model)

Model to get next free IGA Face 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

IGAFaceUVW label.

Return type

Number

Example

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

var label = IGAFaceUVW.NextFreeLabel(m);

Previous()

Description

Returns the previous IGA Face UVW in the model.

Arguments

No arguments

Returns

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

Return type

IGAFaceUVW

Example

To get the IGA Face UVW in model m before IGA Face UVW igfu:

var igfu = igfu.Previous();

RemoveData(index[integer])

Description

Removes brid/elid for an index in *IGA_FACE_UVW. Only valid for option IGAFaceUVW.NONE.

Arguments

index (integer)

The index you want to delete brid/elid for. Note that indices start at 0, not 1.

Returns

No return value.

Example

To delete the brid/elid for the 3rd index for *IGA_FACE_UVW in model m:

if (igfu.entries >= 3)
{
    igfu.RemoveData(2);
}

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

Description

Renumbers all of the IGA Face UVWs in the model.

Arguments

Model (Model)

Model that all IGA Face UVWs will be renumbered in

start (integer)

Start point for renumbering

Returns

No return value

Example

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

IGAFaceUVW.RenumberAll(m, 1000000);

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

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

start (integer)

Start point for renumbering

Returns

No return value

Example

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

IGAFaceUVW.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 Face UVWs using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting IGA Face 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 Face UVWs from that model can be selected. If the argument is a Flag then only IGA Face UVWs that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any IGA Face 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 Face UVWs selected or null if menu cancelled

Return type

Number

Example

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

IGAFaceUVW.Select(f, 'Select IGA Face UVWs', m);

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

IGAFaceUVW.Select(f, 'Select IGA Face UVWs', l);

SetData(index[integer], brid[integer])

Description

Sets brid for *IGA_FACE_UVW. Only valid for option IGAFaceUVW.NONE.

Arguments

index (integer)

Index you want to set the brid/elid for. Note that indices start at 0.

brid (integer)

The ID of 1 dimensional boundary representation.

Returns

No return value.

Example

To add an entry to the *IGA_FACE_UVW igfu with id 10 by using "entries" property to get the next available index:

var i = igfu.entries;
igfu.SetData(i, 10);

To change an entry in 3rd field for *IGA_FACE_UVW igfu with id 30:

igfu.SetData(2, 30);

SetFlag(flag[Flag])

Description

Sets a flag on the IGA Face UVW.

Arguments

flag (Flag)

Flag to set on the IGA Face UVW

Returns

No return value

Example

To set flag f for IGA Face UVW igfu:

igfu.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

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

Arguments

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Face UVW is sketched. If omitted redraw is true. If you want to sketch several IGA Face 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 Face UVW igfu:

igfu.Sketch();

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

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

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Face UVWs are sketched. If omitted redraw is true. If you want to sketch flagged IGA Face 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 Face UVWs flagged with flag in model m:

IGAFaceUVW.SketchFlagged(m, flag);

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

Description

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

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

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

Returns

number of IGA Face UVWs

Return type

Number

Example

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

var total = IGAFaceUVW.Total(m);

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

Flag to unset on the IGA Face UVWs

Returns

No return value

Example

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

IGAFaceUVW.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the IGA Face UVW.

Arguments

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Face UVW is unsketched. If omitted redraw is true. If you want to unsketch several IGA Face 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 Face UVW igfu:

igfu.Unsketch();

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

Description

Unsketches all IGA Face UVWs.

Arguments

Model (Model)

Model that all IGA Face UVWs will be unblanked in

redraw (optional) (boolean)

If model should be redrawn or not after the IGA Face 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 Face UVWs in model m:

IGAFaceUVW.UnsketchAll(m);

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

Description

Unsketches all flagged IGA Face UVWs in the model.

Arguments

Model (Model)

Model that all IGA Face UVWs will be unsketched in

flag (Flag)

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

redraw (optional) (boolean)

Returns

No return value

Example

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

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

IGAFaceUVW object.

Return type

IGAFaceUVW

Example

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

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

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

Description

Adds a warning for IGA Face 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 Face UVW igfu:

igfu.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this IGA Face UVW.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for IGA Face UVW igfu:

var xrefs = igfu.Xrefs();

toString()

Description

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

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for IGA face uvw igfu in keyword format

var s = igfu.toString();