IGAFaceXYZ class

The IGAFaceXYZ class gives you access to IGA face xyz 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()

IGAFaceXYZ constants

Name	Description
IGAFaceXYZ.BASIS_TRANSFORM	BASIS_TRANSFORM is *IGA_FACE_XYZ_BASIS_TRANSFORM.
IGAFaceXYZ.NONE	NONE is *IGA_FACE_XYZ.

IGAFaceXYZ properties

Name	Type	Description
entries (read only)	integer	Number of Boundary representation IDs (brid) or Element IDs (elid) added in IGA_FACE_XYZ. Can be used as index to add a new entry.
esid	integer	Parametric edge set ID. *SET_IGA_EDGE_UVW.
exists (read only)	logical	true if IGA Face XYZ exists, false if referred to but not defined.
fid	integer	IGAFaceXYZ number. Also see the label property which is an alternative name for this.
include	integer	The Include file number that the IGA Face XYZ is in.
label	integer	IGAFaceXYZ number. Also see the fid property which is an alternative name for this.
model (read only)	integer	The Model number that the IGA Face XYZ is in.
option	constant	IGA Face XYZ option. IGAFaceXYZ.NONE or IGAFaceXYZ.BASIS_TRANSFORM
ori	integer	Orientation with respect to the physical bivariate NURBS.
patchid	integer	Physical bivariate NURBS patch ID or a bivariate Basis Transform patch ID.
psid	integer	Parametric point set ID. *SET_IGA_POINT_UVW.

Detailed Description

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

Constructor

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

Description

Create a new IGAFaceXYZ object.

Arguments

Model (Model)

Model that IGA face xyz will be created in

details (object)

Details for creating the IGAFaceXYZ

Object has the following properties:

Name	Type	Description
esid (optional)	integer	Parametric edge set ID. *SET_IGA_EDGE_UVW.
fid	integer	ID of the IGA Face XYZ.
option	constant	IGA Face XYZ option. IGAFaceXYZ.NONE or IGAFaceXYZ.BASIS_TRANSFORM
ori (optional)	integer	Orientation with respect to the physical bivariate NURBS.
patchid (optional)	integer	Physical bivariate NURBS patch ID or a bivariate basis transform patch ID.
psid (optional)	integer	Parametric point set ID. *SET_IGA_POINT_UVW.

Returns

IGAFaceXYZ object

Return type

IGAFaceXYZ

Example

To create a new IGA face xyz in model m using fid 10 with option NONE:

var igfx = new IGAFaceXYZ(m, {option:IGAFaceXYZ.NONE, fid:10});

To create a new IGA face xyz in model m using fid 21 and option BASIS_TRANSFORM with patch 22, ori 23, psid 24 and esid 25:

var igfx = new IGAFaceXYZ(m, {option:IGAFaceXYZ.BASIS_TRANSFORM, fid:21, patchid: 22, ori:23, psid:24, esid:25});

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a IGA Face XYZ.

Arguments

Comment (Comment)

Comment that will be attached to the IGA Face XYZ

Returns

No return value

Example

To associate comment c to the IGA Face XYZ igfx:

igfx.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 XYZ igfx:

igfx.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the IGA Face XYZ.

Arguments

flag (Flag)

Flag to clear on the IGA Face XYZ

Returns

No return value

Example

To clear flag f for IGA Face XYZ igfx:

igfx.ClearFlag(f);

Copy(range (optional)[boolean])

Description

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

IGAFaceXYZ object

Return type

IGAFaceXYZ

Example

To copy IGA Face XYZ igfx into IGA Face XYZ z:

var z = igfx.Copy();

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

Description

Starts an interactive editing panel to create a IGA Face XYZ

Arguments

Model (Model)

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

IGAFaceXYZ object (or null if not made).

Return type

IGAFaceXYZ

Example

To start creating a IGA Face XYZ in model m:

var igfx = IGAFaceXYZ.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a IGA Face XYZ.

Arguments

Comment (Comment)

Comment that will be detached from the IGA Face XYZ

Returns

No return value

Example

To detach comment c from the IGA Face XYZ igfx:

igfx.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 XYZ igfx:

igfx.Edit();

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

Description

Adds an error for IGA Face XYZ. 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 XYZ igfx:

igfx.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first IGA Face XYZ in the model.

Arguments

Model (Model)

Model to get first IGA Face XYZ in

Returns

IGAFaceXYZ object (or null if there are no IGA Face XYZs in the model).

Return type

IGAFaceXYZ

Example

To get the first IGA Face XYZ in model m:

var igfx = IGAFaceXYZ.First(m);

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

Description

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

Arguments

Model (Model)

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

IGAFaceXYZ label.

Return type

Number

Example

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

var label = IGAFaceXYZ.FirstFreeLabel(m);

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

Description

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

Arguments

Model (Model)

Model that all IGA Face XYZs will be flagged in

flag (Flag)

Flag to set on the IGA Face XYZs

Returns

No return value

Example

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

IGAFaceXYZ.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the IGA Face XYZ is flagged or not.

Arguments

flag (Flag)

Flag to test on the IGA Face XYZ

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if IGA Face XYZ igfx has flag f set on it:

if (igfx.Flagged(f) ) do_something...

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

Description

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

Arguments

Model (Model)

Model that all IGA Face XYZs are in

func (function)

Function to call for each IGA Face XYZ

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 XYZs in model m:

IGAFaceXYZ.ForEach(m, test);
function test(igfx)
{
// igfx is IGAFaceXYZ object
}

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

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

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

Description

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

Arguments

Model (Model)

Model to get IGA Face XYZs from

property (optional) (string)

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

Returns

Array of IGAFaceXYZ objects or properties

Return type

Array

Example

To make an array of IGAFaceXYZ objects for all of the IGA Face XYZs in model m:

var a = IGAFaceXYZ.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a IGA Face XYZ.

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 XYZ igfx:

var comm_array = igfx.GetComments();

GetData(index[integer])

Description

Returns the data for brid/elid based on option in *IGA_FACE_XYZ.

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 xyz igfx:

var data = igfx.GetData(2);

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

Description

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

Arguments

Model (Model)

Model to get IGA Face XYZs from

flag (Flag)

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

property (optional) (string)

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

Returns

Array of IGAFaceXYZ objects or properties

Return type

Array

Example

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

var igfx = IGAFaceXYZ.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 XYZs in model m flagged with f:

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

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

Description

Returns the IGAFaceXYZ object for a IGA Face XYZ ID.

Arguments

Model (Model)

Model to find the IGA Face XYZ in

number (integer)

number of the IGA Face XYZ you want the IGAFaceXYZ object for

Returns

IGAFaceXYZ object (or null if IGA Face XYZ does not exist).

Return type

IGAFaceXYZ

Example

To get the IGAFaceXYZ object for IGA Face XYZ 100 in model m

var igfx = IGAFaceXYZ.GetFromID(m, 100);

GetParameter(prop[string])

Description

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

Arguments

prop (string)

IGA Face XYZ property to get parameter for

Returns

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

Return type

Parameter

Example

To check if IGAFaceXYZ property igfx.example is a parameter:

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

To check if IGAFaceXYZ property igfx.example is a parameter by using the GetParameter method:

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

Keyword()

Description

Returns the keyword for this IGA face xyz (*IGA_FACE_XYZ). Note that a carriage return is not added. See also IGAFaceXYZ.KeywordCards()

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for IGA face xyz igfx:

var key = igfx.Keyword();

KeywordCards()

Description

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

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for IGA face xyz igfx:

var cards = igfx.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last IGA Face XYZ in the model.

Arguments

Model (Model)

Model to get last IGA Face XYZ in

Returns

IGAFaceXYZ object (or null if there are no IGA Face XYZs in the model).

Return type

IGAFaceXYZ

Example

To get the last IGA Face XYZ in model m:

var igfx = IGAFaceXYZ.Last(m);

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

Description

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

Arguments

Model (Model)

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

IGAFaceXYZ label.

Return type

Number

Example

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

var label = IGAFaceXYZ.LastFreeLabel(m);

Next()

Description

Returns the next IGA Face XYZ in the model.

Arguments

No arguments

Returns

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

Return type

IGAFaceXYZ

Example

To get the IGA Face XYZ in model m after IGA Face XYZ igfx:

var igfx = igfx.Next();

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

Description

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

Arguments

Model (Model)

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

IGAFaceXYZ label.

Return type

Number

Example

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

var label = IGAFaceXYZ.NextFreeLabel(m);

Previous()

Description

Returns the previous IGA Face XYZ in the model.

Arguments

No arguments

Returns

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

Return type

IGAFaceXYZ

Example

To get the IGA Face XYZ in model m before IGA Face XYZ igfx:

var igfx = igfx.Previous();

RemoveData(index[integer])

Description

Removes brid/elid for an index in *IGA_FACE_XYZ.

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_XYZ in model m:

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

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

Description

Renumbers all of the IGA Face XYZs in the model.

Arguments

Model (Model)

Model that all IGA Face XYZs will be renumbered in

start (integer)

Start point for renumbering

Returns

No return value

Example

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

IGAFaceXYZ.RenumberAll(m, 1000000);

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

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

start (integer)

Start point for renumbering

Returns

No return value

Example

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

IGAFaceXYZ.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 XYZs using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting IGA Face XYZs

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

Return type

Number

Example

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

IGAFaceXYZ.Select(f, 'Select IGA Face XYZs', m);

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

IGAFaceXYZ.Select(f, 'Select IGA Face XYZs', l);

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

Description

Sets brid/elid based on option for an *IGA_FACE_XYZ.

Arguments

index (integer)

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

brid (integer)

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

Returns

No return value.

Example

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

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

To change an entry in 3rd field for *IGA_FACE_XYZ igfx with id 30:

igfx.SetData(2, 30);

SetFlag(flag[Flag])

Description

Sets a flag on the IGA Face XYZ.

Arguments

flag (Flag)

Flag to set on the IGA Face XYZ

Returns

No return value

Example

To set flag f for IGA Face XYZ igfx:

igfx.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

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

Arguments

redraw (optional) (boolean)

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

igfx.Sketch();

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

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

redraw (optional) (boolean)

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

IGAFaceXYZ.SketchFlagged(m, flag);

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

Description

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

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

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

Returns

number of IGA Face XYZs

Return type

Number

Example

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

var total = IGAFaceXYZ.Total(m);

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

Flag to unset on the IGA Face XYZs

Returns

No return value

Example

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

IGAFaceXYZ.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the IGA Face XYZ.

Arguments

redraw (optional) (boolean)

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

igfx.Unsketch();

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

Description

Unsketches all IGA Face XYZs.

Arguments

Model (Model)

Model that all IGA Face XYZs will be unblanked in

redraw (optional) (boolean)

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

IGAFaceXYZ.UnsketchAll(m);

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

Description

Unsketches all flagged IGA Face XYZs in the model.

Arguments

Model (Model)

Model that all IGA Face XYZs will be unsketched in

flag (Flag)

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

redraw (optional) (boolean)

Returns

No return value

Example

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

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

IGAFaceXYZ object.

Return type

IGAFaceXYZ

Example

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

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

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

Description

Adds a warning for IGA Face XYZ. 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 XYZ igfx:

igfx.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this IGA Face XYZ.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for IGA Face XYZ igfx:

var xrefs = igfx.Xrefs();

toString()

Description

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

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for IGA face xyz igfx in keyword format

var s = igfx.toString();