IGA3DNurbsXYZ class

The IGA3DNurbsXYZ class gives you access to IGA 3d nurbs 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

IGA3DNurbsXYZ properties

Name Type Description
exists (read only) logical true if IGA 3D Nurbs XYZ exists, false if referred to but not defined.
include integer The Include file number that the IGA 3D Nurbs XYZ is in.
label integer IGA3DNurbsXYZ number. Also see the patchid property which is an alternative name for this.
model (read only) integer The Model number that the IGA 3D Nurbs XYZ is in.
nr integer Number of control points in the local r-direction.
ns integer Number of control points in the local s-direction.
nt integer Number of control points in the local t-direction.
patchid integer IGA3DNurbsXYZ number. Also see the label property which is an alternative name for this.
pr integer Polynomial degree of the basis in the local r-direction.
ps integer Polynomial degree of the basis in the local s-direction.
pt integer Polynomial degree of the basis in the local t-direction.
rfirst real First knot value in the local r-direction.
rlast real Last knot value in the local r-direction.
sfirst real First knot value in the local s-direction.
slast real Last knot value in the local s-direction.
tfirst real First knot value in the local t-direction.
tlast real Last knot value in the local t-direction.
unir integer Knot vector type in the local r-direction.
unis integer Knot vector type in the local s-direction.
unit integer Knot vector type in the local t-direction.

Detailed Description

The IGA3DNurbsXYZ class allows you to create, modify, edit and manipulate IGA 3d nurbs xyz cards. See the documentation below for more details.

Constructor

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

Description

Create a new IGA3DNurbsXYZ object.

Arguments

  • Model (Model)

    Model that IGA 3d nurbs xyz will be created in

  • details (object)

    Details for creating the IGA3DNurbsXYZ

    Object has the following properties:

    Name Type Description
    nr (optional) integer Number of control points in the local r-direction.
    ns (optional) integer Number of control points in the local s-direction.
    nt (optional) integer Number of control points in the local t-direction.
    patchid integer ID of the IGA 3D Nurbs XYZ.
    pr (optional) integer Polynomial degree of the basis in the local r-direction.
    ps (optional) integer Polynomial degree of the basis in the local s-direction.
    pt (optional) integer Polynomial degree of the basis in the local t-direction.
    unir (optional) integer Knot vector type in the local r-direction.
    unis (optional) integer Knot vector type in the local s-direction.
    unit (optional) integer Knot vector type in the local t-direction.

    Returns

    IGA3DNurbsXYZ object

    Return type

    IGA3DNurbsXYZ

    Example

    To create a new IGA 3d nurbs xyz in model m of id 10: 

    var ig3x = new IGA3DNurbsXYZ(m, {patchid:10});

    To create a new IGA 3d nurbs xyz in model m of id 11 with nr, ns, nt, pr, ps, pt, unir, unis, unit as 12, 13, 14, 15, 16, 17, 21, 22, 23 respectively: 

    var ig3x = new IGA3DNurbsXYZ(m, {patchid:11, nr:12, ns:13, nt:14, pr:15, ps:16, pt:17, unir:21, unis:22, unit:23});

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a IGA 3D Nurbs XYZ.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the IGA 3D Nurbs XYZ

    Returns

    No return value

    Example

    To associate comment c to the IGA 3D Nurbs XYZ ig3x: 

    ig3x.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 3D Nurbs XYZ ig3x: 

    ig3x.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the IGA 3D Nurbs XYZ.

    Arguments

  • flag (Flag)

    Flag to clear on the IGA 3D Nurbs XYZ

    Returns

    No return value

    Example

    To clear flag f for IGA 3D Nurbs XYZ ig3x: 

    ig3x.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    IGA3DNurbsXYZ object

    Return type

    IGA3DNurbsXYZ

    Example

    To copy IGA 3D Nurbs XYZ ig3x into IGA 3D Nurbs XYZ z: 

    var z = ig3x.Copy();

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

    Description

    Starts an interactive editing panel to create a IGA 3D Nurbs XYZ

    Arguments

  • Model (Model)

    Model that the IGA 3D Nurbs 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

    IGA3DNurbsXYZ object (or null if not made).

    Return type

    IGA3DNurbsXYZ

    Example

    To start creating a IGA 3D Nurbs XYZ in model m: 

    var ig3x = IGA3DNurbsXYZ.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a IGA 3D Nurbs XYZ.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the IGA 3D Nurbs XYZ

    Returns

    No return value

    Example

    To detach comment c from the IGA 3D Nurbs XYZ ig3x: 

    ig3x.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 3D Nurbs XYZ ig3x: 

    ig3x.Edit();

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

    Description

    Adds an error for IGA 3D Nurbs 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 3D Nurbs XYZ ig3x: 

    ig3x.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first IGA 3D Nurbs XYZ in the model.

    Arguments

  • Model (Model)

    Model to get first IGA 3D Nurbs XYZ in

    Returns

    IGA3DNurbsXYZ object (or null if there are no IGA 3D Nurbs XYZs in the model).

    Return type

    IGA3DNurbsXYZ

    Example

    To get the first IGA 3D Nurbs XYZ in model m: 

    var ig3x = IGA3DNurbsXYZ.First(m);

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

    Description

    Returns the first free IGA 3D Nurbs XYZ label in the model. Also see IGA3DNurbsXYZ.LastFreeLabel(), IGA3DNurbsXYZ.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

    Model to get first free IGA 3D Nurbs 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

    IGA3DNurbsXYZ label.

    Return type

    Number

    Example

    To get the first free IGA 3D Nurbs XYZ label in model m: 

    var label = IGA3DNurbsXYZ.FirstFreeLabel(m);

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

    Description

    Flags all of the IGA 3D Nurbs XYZs in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all IGA 3D Nurbs XYZs will be flagged in

  • flag (Flag)

    Flag to set on the IGA 3D Nurbs XYZs

    Returns

    No return value

    Example

    To flag all of the IGA 3D Nurbs XYZs with flag f in model m: 

    IGA3DNurbsXYZ.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the IGA 3D Nurbs XYZ is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the IGA 3D Nurbs XYZ

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if IGA 3D Nurbs XYZ ig3x has flag f set on it: 

    if (ig3x.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all IGA 3D Nurbs XYZs are in

  • func (function)

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

    IGA3DNurbsXYZ.ForEach(m, test);
function test(ig3x)
{
// ig3x is IGA3DNurbsXYZ object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA 3D Nurbs XYZs from

  • property (optional) (string)

    Name for property to get for all IGA 3D Nurbs XYZs in the model

    Returns

    Array of IGA3DNurbsXYZ objects or properties

    Return type

    Array

    Example

    To make an array of IGA3DNurbsXYZ objects for all of the IGA 3D Nurbs XYZs in model m: 

    var a = IGA3DNurbsXYZ.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a IGA 3D Nurbs 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 3D Nurbs XYZ ig3x: 

    var comm_array = ig3x.GetComments();

    GetControlPoint(index[integer])

    Description

    Returns the data for a specific control point an an array. There are nr x ns x nt control points.

    Arguments

  • index (integer)

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

    Returns

    An array containing the control point data.

    Return type

    Array

    Example

    To get the data for the 3rd control point in IGA 3d nurbs xyz ig3x: 

    var data = ig3x.GetControlPoint(2);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA 3D Nurbs XYZs from

  • flag (Flag)

    Flag set on the IGA 3D Nurbs XYZs that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged IGA 3D Nurbs XYZs in the model

    Returns

    Array of IGA3DNurbsXYZ objects or properties

    Return type

    Array

    Example

    To make an array of IGA3DNurbsXYZ objects for all of the IGA 3D Nurbs XYZs in model m flagged with f: 

    var ig3x = IGA3DNurbsXYZ.GetFlagged(m, f);

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

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

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

    Description

    Returns the IGA3DNurbsXYZ object for a IGA 3D Nurbs XYZ ID.

    Arguments

  • Model (Model)

    Model to find the IGA 3D Nurbs XYZ in

  • number (integer)

    number of the IGA 3D Nurbs XYZ you want the IGA3DNurbsXYZ object for

    Returns

    IGA3DNurbsXYZ object (or null if IGA 3D Nurbs XYZ does not exist).

    Return type

    IGA3DNurbsXYZ

    Example

    To get the IGA3DNurbsXYZ object for IGA 3D Nurbs XYZ 100 in model m 

    var ig3x = IGA3DNurbsXYZ.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    IGA 3D Nurbs XYZ property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if IGA3DNurbsXYZ property ig3x.example is a parameter: 

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

    To check if IGA3DNurbsXYZ property ig3x.example is a parameter by using the GetParameter method: 

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

    GetRKnotVector(index[integer])

    Description

    The data for Knot values in the local r-direction.

    Arguments

  • index (integer)

    Index you want the r-knot value for. Note that indices start at 0.

    Returns

    Knot values in the local r-direction.

    Return type

    Number

    Example

    To get the 3rd r-knot value in IGA 3d nurbs xyz ig3x: 

    var data = ig3x.GetRKnotVector(2);

    GetSKnotVector(index[integer])

    Description

    The data for Knot values in the local s-direction.

    Arguments

  • index (integer)

    Index you want the s-knot value for. Note that indices start at 0.

    Returns

    Knot values in the local s-direction.

    Return type

    Number

    Example

    To get the 3rd s-knot value in IGA 3d nurbs xyz ig3x: 

    var data = ig3x.GetSKnotVector(2);

    GetTKnotVector(index[integer])

    Description

    The data for Knot values in the local t-direction.

    Arguments

  • index (integer)

    Index you want the t-knot value for. Note that indices start at 0.

    Returns

    Knot values in the local t-direction.

    Return type

    Number

    Example

    To get the 3rd t-knot value in IGA 3d nurbs xyz ig3x: 

    var data = ig3x.GetTKnotVector(2);

    Keyword()

    Description

    Returns the keyword for this IGA 3d nurbs xyz (*IGA_3D_NURBS_XYZ). Note that a carriage return is not added. See also IGA3DNurbsXYZ.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for IGA 3d nurbs xyz ig3x: 

    var key = ig3x.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the IGA 3d nurbs xyz. Note that a carriage return is not added. See also IGA3DNurbsXYZ.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for IGA 3d nurbs xyz ig3x: 

    var cards = ig3x.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last IGA 3D Nurbs XYZ in the model.

    Arguments

  • Model (Model)

    Model to get last IGA 3D Nurbs XYZ in

    Returns

    IGA3DNurbsXYZ object (or null if there are no IGA 3D Nurbs XYZs in the model).

    Return type

    IGA3DNurbsXYZ

    Example

    To get the last IGA 3D Nurbs XYZ in model m: 

    var ig3x = IGA3DNurbsXYZ.Last(m);

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

    Description

    Returns the last free IGA 3D Nurbs XYZ label in the model. Also see IGA3DNurbsXYZ.FirstFreeLabel(), IGA3DNurbsXYZ.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get last free IGA 3D Nurbs 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

    IGA3DNurbsXYZ label.

    Return type

    Number

    Example

    To get the last free IGA 3D Nurbs XYZ label in model m: 

    var label = IGA3DNurbsXYZ.LastFreeLabel(m);

    Next()

    Description

    Returns the next IGA 3D Nurbs XYZ in the model.

    Arguments

    No arguments

    Returns

    IGA3DNurbsXYZ object (or null if there are no more IGA 3D Nurbs XYZs in the model).

    Return type

    IGA3DNurbsXYZ

    Example

    To get the IGA 3D Nurbs XYZ in model m after IGA 3D Nurbs XYZ ig3x: 

    var ig3x = ig3x.Next();

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

    Description

    Returns the next free (highest+1) IGA 3D Nurbs XYZ label in the model. Also see IGA3DNurbsXYZ.FirstFreeLabel(), IGA3DNurbsXYZ.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get next free IGA 3D Nurbs 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

    IGA3DNurbsXYZ label.

    Return type

    Number

    Example

    To get the next free IGA 3D Nurbs XYZ label in model m: 

    var label = IGA3DNurbsXYZ.NextFreeLabel(m);

    Previous()

    Description

    Returns the previous IGA 3D Nurbs XYZ in the model.

    Arguments

    No arguments

    Returns

    IGA3DNurbsXYZ object (or null if there are no more IGA 3D Nurbs XYZs in the model).

    Return type

    IGA3DNurbsXYZ

    Example

    To get the IGA 3D Nurbs XYZ in model m before IGA 3D Nurbs XYZ ig3x: 

    var ig3x = ig3x.Previous();

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

    Description

    Renumbers all of the IGA 3D Nurbs XYZs in the model.

    Arguments

  • Model (Model)

    Model that all IGA 3D Nurbs XYZs will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the IGA 3D Nurbs XYZs in model m, from 1000000: 

    IGA3DNurbsXYZ.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged IGA 3D Nurbs XYZs in the model.

    Arguments

  • Model (Model)

    Model that all the flagged IGA 3D Nurbs XYZs will be renumbered in

  • flag (Flag)

    Flag set on the IGA 3D Nurbs XYZs that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    IGA3DNurbsXYZ.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 3D Nurbs XYZs using standard PRIMER object menus.

    Arguments

  • flag (Flag)

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

    Return type

    Number

    Example

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

    IGA3DNurbsXYZ.Select(f, 'Select IGA 3D Nurbs XYZs', m);

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

    IGA3DNurbsXYZ.Select(f, 'Select IGA 3D Nurbs XYZs', l);

    SetControlPoint(index[integer], data[Array of data])

    Description

    Set the data for a specific control point. For each control point there will be control point X, Y, Z and control weight WGT. There are nr x ns x nt control points.

    Arguments

  • index (integer)

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

  • data (Array of data)

    Array containing the control point data. The array length should be 4.

    Returns

    No return value.

    Example

    To set the 3rd control point data for IGA 3d nurbs xyz ig3x to the values in array data: 

    ig3x.SetControlPoint(2, data);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the IGA 3D Nurbs XYZ.

    Arguments

  • flag (Flag)

    Flag to set on the IGA 3D Nurbs XYZ

    Returns

    No return value

    Example

    To set flag f for IGA 3D Nurbs XYZ ig3x: 

    ig3x.SetFlag(f);

    SetRKnotVector(index[integer], r[real])

    Description

    Sets knot value, r in *IGA_3D_NURBS_XYZ. There are [nr + pr + 1] knot values.

    Arguments

  • index (integer)

    Index you want to set the r knot vector for. Note that indices start at 0.

  • r (real)

    Knot values in the local r-direction

    Returns

    No return value.

    Example

    To set the 3rd knot value for IGA 3d nurbs xyz ig3x as 13.5: 

    ig3x.SetRKnotVector(2, 13.5);

    SetSKnotVector(index[integer], r[real])

    Description

    Sets knot value, s in *IGA_3D_NURBS_XYZ. There are [ns + ps + 1] knot values.

    Arguments

  • index (integer)

    Index you want to set the s knot vector for. Note that indices start at 0.

  • r (real)

    Knot values in the local s-direction

    Returns

    No return value.

    Example

    To set the 2rd knot value for IGA 3d nurbs xyz ig3x as 24.5: 

    ig3x.SetSKnotVector(1, 24.5);

    SetTKnotVector(index[integer], r[real])

    Description

    Sets knot value, t in *IGA_3D_NURBS_XYZ. There are [nt + pt + 1] knot values.

    Arguments

  • index (integer)

    Index you want to set the t knot vector for. Note that indices start at 0.

  • r (real)

    Knot values in the local t-direction

    Returns

    No return value.

    Example

    To set the 2rd knot value for IGA 3d nurbs xyz ig3x as 24.5: 

    ig3x.SetTKnotVector(1, 24.5);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the IGA 3D Nurbs XYZ. The IGA 3D Nurbs XYZ will be sketched until you either call IGA3DNurbsXYZ.Unsketch(), IGA3DNurbsXYZ.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    ig3x.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged IGA 3D Nurbs XYZs will be sketched in

  • flag (Flag)

    Flag set on the IGA 3D Nurbs XYZs that you want to sketch

  • redraw (optional) (boolean)

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

    IGA3DNurbsXYZ.SketchFlagged(m, flag);

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

    Description

    Returns the total number of IGA 3D Nurbs XYZs in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of IGA 3D Nurbs XYZs

    Return type

    Number

    Example

    To get the total number of IGA 3D Nurbs XYZs in model m: 

    var total = IGA3DNurbsXYZ.Total(m);

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

    Description

    Unsets a defined flag on all of the IGA 3D Nurbs XYZs in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all IGA 3D Nurbs XYZs will be unset in

  • flag (Flag)

    Flag to unset on the IGA 3D Nurbs XYZs

    Returns

    No return value

    Example

    To unset the flag f on all the IGA 3D Nurbs XYZs in model m: 

    IGA3DNurbsXYZ.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the IGA 3D Nurbs XYZ.

    Arguments

  • redraw (optional) (boolean)

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

    ig3x.Unsketch();

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

    Description

    Unsketches all IGA 3D Nurbs XYZs.

    Arguments

  • Model (Model)

    Model that all IGA 3D Nurbs XYZs will be unblanked in

  • redraw (optional) (boolean)

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

    IGA3DNurbsXYZ.UnsketchAll(m);

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

    Description

    Unsketches all flagged IGA 3D Nurbs XYZs in the model.

    Arguments

  • Model (Model)

    Model that all IGA 3D Nurbs XYZs will be unsketched in

  • flag (Flag)

    Flag set on the IGA 3D Nurbs XYZs that you want to unsketch

  • redraw (optional) (boolean)

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

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

    IGA3DNurbsXYZ object.

    Return type

    IGA3DNurbsXYZ

    Example

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

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

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

    Description

    Adds a warning for IGA 3D Nurbs 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 3D Nurbs XYZ ig3x: 

    ig3x.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this IGA 3D Nurbs XYZ.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for IGA 3D Nurbs XYZ ig3x: 

    var xrefs = ig3x.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for IGA 3d nurbs xyz ig3x in keyword format 

    var s = ig3x.toString();