IGA2DBasisTransformXYZ class

The IGA2DBasisTransformXYZ class gives you access to IGA 2d basis transform 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:

Class functions

Member functions

IGA2DBasisTransformXYZ properties

Name Type Description
exists (read only) logical true if IGA 2D Basis Transform XYZ exists, false if referred to but not defined.
filename string Number of control points in the local r-direction.
include integer The Include file number that the IGA 2D Basis Transform XYZ is in.
label integer IGA2DBasisTransformXYZ number. Also see the patchid property which is an alternative name for this.
model (read only) integer The Model number that the IGA 2D Basis Transform XYZ is in.
patchid integer IGA2DBasisTransformXYZ number. Also see the label property which is an alternative name for this.

Detailed Description

The IGA2DBasisTransformXYZ class allows you to create, modify, edit and manipulate IGA 2d basis transform xyz cards. See the documentation below for more details.

Constructor

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

Description

Create a new IGA2DBasisTransformXYZ object.

Arguments

  • Model (Model)

    Model that IGA 2d basis transform xyz will be created in

  • details (object)

    Details for creating the IGA2DBasisTransformXYZ

    Object has the following properties:

    Name Type Description
    filename (optional) string Name of file containing patch data.
    patchid integer ID of the IGA 2D Basis Transform XYZ.

    Returns

    IGA2DBasisTransformXYZ object

    Return type

    IGA2DBasisTransformXYZ

    Example

    To create a new IGA 2d basis transform xyz in model m of id 10: 

    var ig2bt = new IGA2DBasisTransformXYZ(m, {patchid:10});

    To create a new IGA 2d basis transform xyz in model m of id 10 with a filename: 

    var ig2bt = new IGA2DBasisTransformXYZ(m, {patchid:10, filename:"Filename\\with\\path.extension"});

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a IGA 2D Basis Transform XYZ.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the IGA 2D Basis Transform XYZ

    Returns

    No return value

    Example

    To associate comment c to the IGA 2D Basis Transform XYZ ig2bt: 

    ig2bt.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 2D Basis Transform XYZ ig2bt: 

    ig2bt.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the IGA 2D Basis Transform XYZ.

    Arguments

  • flag (Flag)

    Flag to clear on the IGA 2D Basis Transform XYZ

    Returns

    No return value

    Example

    To clear flag f for IGA 2D Basis Transform XYZ ig2bt: 

    ig2bt.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the IGA 2D Basis Transform XYZ. The target include of the copied IGA 2D Basis Transform 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

    IGA2DBasisTransformXYZ object

    Return type

    IGA2DBasisTransformXYZ

    Example

    To copy IGA 2D Basis Transform XYZ ig2bt into IGA 2D Basis Transform XYZ z: 

    var z = ig2bt.Copy();

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

    Description

    Starts an interactive editing panel to create a IGA 2D Basis Transform XYZ

    Arguments

  • Model (Model)

    Model that the IGA 2D Basis Transform 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

    IGA2DBasisTransformXYZ object (or null if not made).

    Return type

    IGA2DBasisTransformXYZ

    Example

    To start creating a IGA 2D Basis Transform XYZ in model m: 

    var ig2bt = IGA2DBasisTransformXYZ.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a IGA 2D Basis Transform XYZ.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the IGA 2D Basis Transform XYZ

    Returns

    No return value

    Example

    To detach comment c from the IGA 2D Basis Transform XYZ ig2bt: 

    ig2bt.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 2D Basis Transform XYZ ig2bt: 

    ig2bt.Edit();

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

    Description

    Adds an error for IGA 2D Basis Transform 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 2D Basis Transform XYZ ig2bt: 

    ig2bt.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first IGA 2D Basis Transform XYZ in the model.

    Arguments

  • Model (Model)

    Model to get first IGA 2D Basis Transform XYZ in

    Returns

    IGA2DBasisTransformXYZ object (or null if there are no IGA 2D Basis Transform XYZs in the model).

    Return type

    IGA2DBasisTransformXYZ

    Example

    To get the first IGA 2D Basis Transform XYZ in model m: 

    var ig2bt = IGA2DBasisTransformXYZ.First(m);

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

    Description

    Returns the first free IGA 2D Basis Transform XYZ label in the model. Also see IGA2DBasisTransformXYZ.LastFreeLabel(), IGA2DBasisTransformXYZ.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

    Model to get first free IGA 2D Basis Transform 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

    IGA2DBasisTransformXYZ label.

    Return type

    Number

    Example

    To get the first free IGA 2D Basis Transform XYZ label in model m: 

    var label = IGA2DBasisTransformXYZ.FirstFreeLabel(m);

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

    Description

    Flags all of the IGA 2D Basis Transform XYZs in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all IGA 2D Basis Transform XYZs will be flagged in

  • flag (Flag)

    Flag to set on the IGA 2D Basis Transform XYZs

    Returns

    No return value

    Example

    To flag all of the IGA 2D Basis Transform XYZs with flag f in model m: 

    IGA2DBasisTransformXYZ.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the IGA 2D Basis Transform XYZ is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the IGA 2D Basis Transform XYZ

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if IGA 2D Basis Transform XYZ ig2bt has flag f set on it: 

    if (ig2bt.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all IGA 2D Basis Transform XYZs are in

  • func (function)

    Function to call for each IGA 2D Basis Transform 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 2D Basis Transform XYZs in model m: 

    IGA2DBasisTransformXYZ.ForEach(m, test);
function test(ig2bt)
{
// ig2bt is IGA2DBasisTransformXYZ object
}

    To call function test for all of the IGA 2D Basis Transform XYZs in model m with optional object: 

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA 2D Basis Transform XYZs from

  • property (optional) (string)

    Name for property to get for all IGA 2D Basis Transform XYZs in the model

    Returns

    Array of IGA2DBasisTransformXYZ objects or properties

    Return type

    Array

    Example

    To make an array of IGA2DBasisTransformXYZ objects for all of the IGA 2D Basis Transform XYZs in model m: 

    var a = IGA2DBasisTransformXYZ.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a IGA 2D Basis Transform 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 2D Basis Transform XYZ ig2bt: 

    var comm_array = ig2bt.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA 2D Basis Transform XYZs from

  • flag (Flag)

    Flag set on the IGA 2D Basis Transform XYZs that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged IGA 2D Basis Transform XYZs in the model

    Returns

    Array of IGA2DBasisTransformXYZ objects or properties

    Return type

    Array

    Example

    To make an array of IGA2DBasisTransformXYZ objects for all of the IGA 2D Basis Transform XYZs in model m flagged with f: 

    var ig2bt = IGA2DBasisTransformXYZ.GetFlagged(m, f);

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

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

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

    Description

    Returns the IGA2DBasisTransformXYZ object for a IGA 2D Basis Transform XYZ ID.

    Arguments

  • Model (Model)

    Model to find the IGA 2D Basis Transform XYZ in

  • number (integer)

    number of the IGA 2D Basis Transform XYZ you want the IGA2DBasisTransformXYZ object for

    Returns

    IGA2DBasisTransformXYZ object (or null if IGA 2D Basis Transform XYZ does not exist).

    Return type

    IGA2DBasisTransformXYZ

    Example

    To get the IGA2DBasisTransformXYZ object for IGA 2D Basis Transform XYZ 100 in model m 

    var ig2bt = IGA2DBasisTransformXYZ.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    IGA 2D Basis Transform XYZ property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if IGA2DBasisTransformXYZ property ig2bt.example is a parameter: 

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

    To check if IGA2DBasisTransformXYZ property ig2bt.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this IGA 2d basis transform xyz (*IGA_2D_BASIS_TRANSFORM_XYZ). Note that a carriage return is not added. See also IGA2DBasisTransformXYZ.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for IGA 2d basis transform xyz ig2bt: 

    var key = ig2bt.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the IGA 2d basis transform xyz. Note that a carriage return is not added. See also IGA2DBasisTransformXYZ.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for IGA 2d basis transform xyz ig2bt: 

    var cards = ig2bt.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last IGA 2D Basis Transform XYZ in the model.

    Arguments

  • Model (Model)

    Model to get last IGA 2D Basis Transform XYZ in

    Returns

    IGA2DBasisTransformXYZ object (or null if there are no IGA 2D Basis Transform XYZs in the model).

    Return type

    IGA2DBasisTransformXYZ

    Example

    To get the last IGA 2D Basis Transform XYZ in model m: 

    var ig2bt = IGA2DBasisTransformXYZ.Last(m);

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

    Description

    Returns the last free IGA 2D Basis Transform XYZ label in the model. Also see IGA2DBasisTransformXYZ.FirstFreeLabel(), IGA2DBasisTransformXYZ.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get last free IGA 2D Basis Transform 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

    IGA2DBasisTransformXYZ label.

    Return type

    Number

    Example

    To get the last free IGA 2D Basis Transform XYZ label in model m: 

    var label = IGA2DBasisTransformXYZ.LastFreeLabel(m);

    Next()

    Description

    Returns the next IGA 2D Basis Transform XYZ in the model.

    Arguments

    No arguments

    Returns

    IGA2DBasisTransformXYZ object (or null if there are no more IGA 2D Basis Transform XYZs in the model).

    Return type

    IGA2DBasisTransformXYZ

    Example

    To get the IGA 2D Basis Transform XYZ in model m after IGA 2D Basis Transform XYZ ig2bt: 

    var ig2bt = ig2bt.Next();

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

    Description

    Returns the next free (highest+1) IGA 2D Basis Transform XYZ label in the model. Also see IGA2DBasisTransformXYZ.FirstFreeLabel(), IGA2DBasisTransformXYZ.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get next free IGA 2D Basis Transform 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

    IGA2DBasisTransformXYZ label.

    Return type

    Number

    Example

    To get the next free IGA 2D Basis Transform XYZ label in model m: 

    var label = IGA2DBasisTransformXYZ.NextFreeLabel(m);

    Previous()

    Description

    Returns the previous IGA 2D Basis Transform XYZ in the model.

    Arguments

    No arguments

    Returns

    IGA2DBasisTransformXYZ object (or null if there are no more IGA 2D Basis Transform XYZs in the model).

    Return type

    IGA2DBasisTransformXYZ

    Example

    To get the IGA 2D Basis Transform XYZ in model m before IGA 2D Basis Transform XYZ ig2bt: 

    var ig2bt = ig2bt.Previous();

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

    Description

    Renumbers all of the IGA 2D Basis Transform XYZs in the model.

    Arguments

  • Model (Model)

    Model that all IGA 2D Basis Transform XYZs will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the IGA 2D Basis Transform XYZs in model m, from 1000000: 

    IGA2DBasisTransformXYZ.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged IGA 2D Basis Transform XYZs in the model.

    Arguments

  • Model (Model)

    Model that all the flagged IGA 2D Basis Transform XYZs will be renumbered in

  • flag (Flag)

    Flag set on the IGA 2D Basis Transform XYZs that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the IGA 2D Basis Transform XYZs in model m flagged with f, from 1000000: 

    IGA2DBasisTransformXYZ.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 2D Basis Transform XYZs using standard PRIMER object menus.

    Arguments

  • flag (Flag)

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

    Return type

    Number

    Example

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

    IGA2DBasisTransformXYZ.Select(f, 'Select IGA 2D Basis Transform XYZs', m);

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

    IGA2DBasisTransformXYZ.Select(f, 'Select IGA 2D Basis Transform XYZs', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the IGA 2D Basis Transform XYZ.

    Arguments

  • flag (Flag)

    Flag to set on the IGA 2D Basis Transform XYZ

    Returns

    No return value

    Example

    To set flag f for IGA 2D Basis Transform XYZ ig2bt: 

    ig2bt.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the IGA 2D Basis Transform XYZ. The IGA 2D Basis Transform XYZ will be sketched until you either call IGA2DBasisTransformXYZ.Unsketch(), IGA2DBasisTransformXYZ.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    ig2bt.Sketch();

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

    Description

    Sketches all of the flagged IGA 2D Basis Transform XYZs in the model. The IGA 2D Basis Transform XYZs will be sketched until you either call IGA2DBasisTransformXYZ.Unsketch(), IGA2DBasisTransformXYZ.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged IGA 2D Basis Transform XYZs will be sketched in

  • flag (Flag)

    Flag set on the IGA 2D Basis Transform XYZs that you want to sketch

  • redraw (optional) (boolean)

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

    IGA2DBasisTransformXYZ.SketchFlagged(m, flag);

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

    Description

    Returns the total number of IGA 2D Basis Transform XYZs in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of IGA 2D Basis Transform XYZs

    Return type

    Number

    Example

    To get the total number of IGA 2D Basis Transform XYZs in model m: 

    var total = IGA2DBasisTransformXYZ.Total(m);

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

    Description

    Unsets a defined flag on all of the IGA 2D Basis Transform XYZs in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all IGA 2D Basis Transform XYZs will be unset in

  • flag (Flag)

    Flag to unset on the IGA 2D Basis Transform XYZs

    Returns

    No return value

    Example

    To unset the flag f on all the IGA 2D Basis Transform XYZs in model m: 

    IGA2DBasisTransformXYZ.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the IGA 2D Basis Transform XYZ.

    Arguments

  • redraw (optional) (boolean)

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

    ig2bt.Unsketch();

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

    Description

    Unsketches all IGA 2D Basis Transform XYZs.

    Arguments

  • Model (Model)

    Model that all IGA 2D Basis Transform XYZs will be unblanked in

  • redraw (optional) (boolean)

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

    IGA2DBasisTransformXYZ.UnsketchAll(m);

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

    Description

    Unsketches all flagged IGA 2D Basis Transform XYZs in the model.

    Arguments

  • Model (Model)

    Model that all IGA 2D Basis Transform XYZs will be unsketched in

  • flag (Flag)

    Flag set on the IGA 2D Basis Transform XYZs that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the IGA 2D Basis Transform 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 2D Basis Transform XYZs flagged with flag in model m: 

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

    IGA2DBasisTransformXYZ object.

    Return type

    IGA2DBasisTransformXYZ

    Example

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

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

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

    Description

    Adds a warning for IGA 2D Basis Transform 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 2D Basis Transform XYZ ig2bt: 

    ig2bt.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this IGA 2D Basis Transform XYZ.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for IGA 2D Basis Transform XYZ ig2bt: 

    var xrefs = ig2bt.Xrefs();

    toString()

    Description

    Creates a string containing the IGA 2d basis transform xyz data in keyword format. Note that this contains the keyword header and the keyword cards. See also IGA2DBasisTransformXYZ.Keyword() and IGA2DBasisTransformXYZ.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for IGA 2d basis transform xyz ig2bt in keyword format 

    var s = ig2bt.toString();