IGAVolumeXYZ class

The IGAVolumeXYZ class gives you access to IGA volume 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()

IGAVolumeXYZ constants

Name	Description
IGAVolumeXYZ.BASIS_TRANSFORM	BASIS_TRANSFORM is *IGA_VOLUME_XYZ_BASIS_TRANSFORM.
IGAVolumeXYZ.NONE	NONE is *IGA_VOLUME_XYZ.

IGAVolumeXYZ properties

Name	Type	Description
entries (read only)	integer	Number of Boundary representation IDs (brid) added in IGA_VOLUME_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 Volume XYZ exists, false if referred to but not defined.
fsid	integer	Parametric face set ID. *SET_IGA_FACE_UVW.
include	integer	The Include file number that the IGA Volume XYZ is in.
label	integer	IGAVolumeXYZ number. Also see the vid property which is an alternative name for this.
model (read only)	integer	The Model number that the IGA Volume XYZ is in.
option	constant	IGA Volume XYZ option. IGAVolumeXYZ.NONE or IGAVolumeXYZ.BASIS_TRANSFORM
patchid	integer	Physical trivariate NURBS patch ID or a trivariate Basis Transform patch ID.
psid	integer	Parametric point set ID. *SET_IGA_POINT_UVW.
vid	integer	IGAVolumeXYZ number. Also see the label property which is an alternative name for this.

Detailed Description

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

Constructor

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

Description

Create a new IGAVolumeXYZ object.

Arguments

Model (Model)

Model that IGA volume xyz will be created in

details (object)

Details for creating the IGAVolumeXYZ

Object has the following properties:

Name	Type	Description
esid (optional)	integer	Parametric edge set ID. *SET_IGA_EDGE_UVW.
fsid (optional)	integer	Parametric face set ID. *SET_IGA_FACE_UVW.
option	constant	IGA Volume XYZ option. IGAVolumeXYZ.NONE or IGAVolumeXYZ.BASIS_TRANSFORM
patchid (optional)	integer	Physical trivariate NURBS patch ID or a trivariate basis transform patch ID.
psid (optional)	integer	Parametric point set ID. *SET_IGA_POINT_UVW.
vid	integer	ID of the IGA Volume XYZ.

Returns

IGAVolumeXYZ object

Return type

IGAVolumeXYZ

Example

To create a new IGA volume xyz in model m using vid 10 with option NONE:

var igvx = new IGAVolumeXYZ(m, {option:IGAVolumeXYZ.NONE, vid:10});

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

var igvx = new IGAVolumeXYZ(m, {option:IGAVolumeXYZ.BASIS_TRANSFORM, vid:21, patchid: 22, psid:23, esid:24, fsid:25});

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a IGA Volume XYZ.

Arguments

Comment (Comment)

Comment that will be attached to the IGA Volume XYZ

Returns

No return value

Example

To associate comment c to the IGA Volume XYZ igvx:

igvx.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 Volume XYZ igvx:

igvx.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the IGA Volume XYZ.

Arguments

flag (Flag)

Flag to clear on the IGA Volume XYZ

Returns

No return value

Example

To clear flag f for IGA Volume XYZ igvx:

igvx.ClearFlag(f);

Copy(range (optional)[boolean])

Description

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

IGAVolumeXYZ object

Return type

IGAVolumeXYZ

Example

To copy IGA Volume XYZ igvx into IGA Volume XYZ z:

var z = igvx.Copy();

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

Description

Starts an interactive editing panel to create a IGA Volume XYZ

Arguments

Model (Model)

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

IGAVolumeXYZ object (or null if not made).

Return type

IGAVolumeXYZ

Example

To start creating a IGA Volume XYZ in model m:

var igvx = IGAVolumeXYZ.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a IGA Volume XYZ.

Arguments

Comment (Comment)

Comment that will be detached from the IGA Volume XYZ

Returns

No return value

Example

To detach comment c from the IGA Volume XYZ igvx:

igvx.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 Volume XYZ igvx:

igvx.Edit();

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

Description

Adds an error for IGA Volume 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 Volume XYZ igvx:

igvx.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first IGA Volume XYZ in the model.

Arguments

Model (Model)

Model to get first IGA Volume XYZ in

Returns

IGAVolumeXYZ object (or null if there are no IGA Volume XYZs in the model).

Return type

IGAVolumeXYZ

Example

To get the first IGA Volume XYZ in model m:

var igvx = IGAVolumeXYZ.First(m);

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

Description

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

Arguments

Model (Model)

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

IGAVolumeXYZ label.

Return type

Number

Example

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

var label = IGAVolumeXYZ.FirstFreeLabel(m);

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

Description

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

Arguments

Model (Model)

Model that all IGA Volume XYZs will be flagged in

flag (Flag)

Flag to set on the IGA Volume XYZs

Returns

No return value

Example

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

IGAVolumeXYZ.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the IGA Volume XYZ is flagged or not.

Arguments

flag (Flag)

Flag to test on the IGA Volume XYZ

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if IGA Volume XYZ igvx has flag f set on it:

if (igvx.Flagged(f) ) do_something...

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

Description

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

Arguments

Model (Model)

Model that all IGA Volume XYZs are in

func (function)

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

IGAVolumeXYZ.ForEach(m, test);
function test(igvx)
{
// igvx is IGAVolumeXYZ object
}

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

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

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

Description

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

Arguments

Model (Model)

Model to get IGA Volume XYZs from

property (optional) (string)

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

Returns

Array of IGAVolumeXYZ objects or properties

Return type

Array

Example

To make an array of IGAVolumeXYZ objects for all of the IGA Volume XYZs in model m:

var a = IGAVolumeXYZ.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a IGA Volume 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 Volume XYZ igvx:

var comm_array = igvx.GetComments();

GetData(index[integer])

Description

Returns the data for brid in *IGA_VOLUME_XYZ. Only valid for option IGAVolumeXYZ.NONE.

Arguments

index (integer)

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

Returns

The ID of 2 dimensional boundary representation.

Return type

Number

Example

To get the 3rd data entry in IGA volume xyz igvx:

var data = igvx.GetData(2);

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

Description

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

Arguments

Model (Model)

Model to get IGA Volume XYZs from

flag (Flag)

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

property (optional) (string)

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

Returns

Array of IGAVolumeXYZ objects or properties

Return type

Array

Example

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

var igvx = IGAVolumeXYZ.GetFlagged(m, f);

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

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

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

Description

Returns the IGAVolumeXYZ object for a IGA Volume XYZ ID.

Arguments

Model (Model)

Model to find the IGA Volume XYZ in

number (integer)

number of the IGA Volume XYZ you want the IGAVolumeXYZ object for

Returns

IGAVolumeXYZ object (or null if IGA Volume XYZ does not exist).

Return type

IGAVolumeXYZ

Example

To get the IGAVolumeXYZ object for IGA Volume XYZ 100 in model m

var igvx = IGAVolumeXYZ.GetFromID(m, 100);

GetParameter(prop[string])

Description

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

Arguments

prop (string)

IGA Volume XYZ property to get parameter for

Returns

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

Return type

Parameter

Example

To check if IGAVolumeXYZ property igvx.example is a parameter:

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

To check if IGAVolumeXYZ property igvx.example is a parameter by using the GetParameter method:

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

Keyword()

Description

Returns the keyword for this IGA volume xyz (*IGA_VOLUME_XYZ). Note that a carriage return is not added. See also IGAVolumeXYZ.KeywordCards()

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for IGA volume xyz igvx:

var key = igvx.Keyword();

KeywordCards()

Description

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

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for IGA volume xyz igvx:

var cards = igvx.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last IGA Volume XYZ in the model.

Arguments

Model (Model)

Model to get last IGA Volume XYZ in

Returns

IGAVolumeXYZ object (or null if there are no IGA Volume XYZs in the model).

Return type

IGAVolumeXYZ

Example

To get the last IGA Volume XYZ in model m:

var igvx = IGAVolumeXYZ.Last(m);

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

Description

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

Arguments

Model (Model)

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

IGAVolumeXYZ label.

Return type

Number

Example

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

var label = IGAVolumeXYZ.LastFreeLabel(m);

Next()

Description

Returns the next IGA Volume XYZ in the model.

Arguments

No arguments

Returns

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

Return type

IGAVolumeXYZ

Example

To get the IGA Volume XYZ in model m after IGA Volume XYZ igvx:

var igvx = igvx.Next();

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

Description

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

Arguments

Model (Model)

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

IGAVolumeXYZ label.

Return type

Number

Example

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

var label = IGAVolumeXYZ.NextFreeLabel(m);

Previous()

Description

Returns the previous IGA Volume XYZ in the model.

Arguments

No arguments

Returns

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

Return type

IGAVolumeXYZ

Example

To get the IGA Volume XYZ in model m before IGA Volume XYZ igvx:

var igvx = igvx.Previous();

RemoveData(index[integer])

Description

Removes brid for an index in *IGA_VOLUME_XYZ. Only valid for option IGAVolumeXYZ.NONE.

Arguments

index (integer)

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

Returns

No return value.

Example

To delete the brid for the 3rd index for *IGA_VOLUME_XYZ in model m:

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

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

Description

Renumbers all of the IGA Volume XYZs in the model.

Arguments

Model (Model)

Model that all IGA Volume XYZs will be renumbered in

start (integer)

Start point for renumbering

Returns

No return value

Example

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

IGAVolumeXYZ.RenumberAll(m, 1000000);

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

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

start (integer)

Start point for renumbering

Returns

No return value

Example

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

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

Arguments

flag (Flag)

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

Return type

Number

Example

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

IGAVolumeXYZ.Select(f, 'Select IGA Volume XYZs', m);

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

IGAVolumeXYZ.Select(f, 'Select IGA Volume XYZs', l);

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

Description

Sets brid for *IGA_VOLUME_XYZ. Only valid for option IGAVolumeXYZ.NONE.

Arguments

index (integer)

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

brid (integer)

The ID of 2 dimensional boundary representation.

Returns

No return value.

Example

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

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

To change an entry in 3rd field for *IGA_VOLUME_XYZ igvx with id 30:

igvx.SetData(2, 30);

SetFlag(flag[Flag])

Description

Sets a flag on the IGA Volume XYZ.

Arguments

flag (Flag)

Flag to set on the IGA Volume XYZ

Returns

No return value

Example

To set flag f for IGA Volume XYZ igvx:

igvx.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

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

Arguments

redraw (optional) (boolean)

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

igvx.Sketch();

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

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

redraw (optional) (boolean)

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

IGAVolumeXYZ.SketchFlagged(m, flag);

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

Description

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

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

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

Returns

number of IGA Volume XYZs

Return type

Number

Example

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

var total = IGAVolumeXYZ.Total(m);

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

Description

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

Arguments

Model (Model)

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

flag (Flag)

Flag to unset on the IGA Volume XYZs

Returns

No return value

Example

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

IGAVolumeXYZ.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the IGA Volume XYZ.

Arguments

redraw (optional) (boolean)

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

igvx.Unsketch();

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

Description

Unsketches all IGA Volume XYZs.

Arguments

Model (Model)

Model that all IGA Volume XYZs will be unblanked in

redraw (optional) (boolean)

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

IGAVolumeXYZ.UnsketchAll(m);

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

Description

Unsketches all flagged IGA Volume XYZs in the model.

Arguments

Model (Model)

Model that all IGA Volume XYZs will be unsketched in

flag (Flag)

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

redraw (optional) (boolean)

Returns

No return value

Example

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

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

IGAVolumeXYZ object.

Return type

IGAVolumeXYZ

Example

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

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

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

Description

Adds a warning for IGA Volume 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 Volume XYZ igvx:

igvx.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this IGA Volume XYZ.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for IGA Volume XYZ igvx:

var xrefs = igvx.Xrefs();

toString()

Description

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

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for IGA volume xyz igvx in keyword format

var s = igvx.toString();