NodalRigidBody (Nrb) class

The NodalRigidBody class gives you access to define nodal rigid body 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

NodalRigidBody properties

Name Type Description
cid integer Coordinate system ID
cmo integer Centre of mass option
colour Colour The colour of the nrb
con1 integer First retraint parameter
con2 integer Second retraint parameter
drflag integer Displacement release flag
exists (read only) logical true if nodal rigid body exists, false if referred to but not defined.
idthrm integer Flag for the thermal constraint
include integer The Include file number that the nodal rigid body is in.
inertia logical Flag to turn on or off _INERTIA option
iprt integer Print flag
ixx real Ixx component of inertia tensor
ixy real Ixy component of inertia tensor
ixz real Ixz component of inertia tensor
iyy real Iyy component of inertia tensor
iyz real Iyz component of inertia tensor
izz real Izz component of inertia tensor
label integer NodalRigidBody ID of the NRB. Also see the pid property which is an alternative name for this.
model (read only) integer The Model number that the nodal rigid body is in.
nodeid integer Optional node point
nsid integer Nodal set ID
override logical Flag to turn on or off _OVERRIDE option
pid integer NodalRigidBody ID of the NRB. Also see the label property which is an alternative name for this.
pnode integer Optional nodal point
rrflag integer Rotation release flag
spc logical Flag to turn on or off _SPC option
thermal logical Flag to turn on or off _THERMAL option
tm real Translational mass
vrx real X rigid body rotational velocity
vry real Y rigid body rotational velocity
vrz real Z rigid body rotational velocity
vtx real X rigid body translational velocity
vty real Y rigid body translational velocity
vtz real Z rigid body translational velocity
xc real X coordinate centre of mass
xl real X coordinate of local x axis
xlip real X coordinate of local in plane vector
yc real Y coordinate centre of mass
yl real Y coordinate of local x axis
ylip real Y coordinate of local in plane vector
zc real Z coordinate centre of mass
zl real Z coordinate of local x axis
zlip real Z coordinate of local in plane vector

Detailed Description

The NodalRigidBody class allows you to create, modify, edit and manipulate nodal rigid body cards. See the documentation below for more details.

For convenience "Nrb" can also be used as the class name instead of "NodalRigidBody".

Constructor

new NodalRigidBody(Model[Model], nsid[integer], pid (optional)[integer], cid (optional)[integer], pnode (optional)[integer], iprt (optional)[integer], drflag (optional)[integer], rrflag (optional)[integer])

Description

Create a new NodalRigidBody object.

Arguments

  • Model (Model)

    Model that nrb will be created in

  • nsid (integer)

    Nodal set ID

  • pid (optional) (integer)

    NodalRigidBody ID of the NRB. Also see the label property which is an alternative name for this.

  • cid (optional) (integer)

    Coordinate system ID

  • pnode (optional) (integer)

    Optional nodal point

  • iprt (optional) (integer)

    Print flag

  • drflag (optional) (integer)

    Displacement release flag

  • rrflag (optional) (integer)

    Rotation release flag

    Returns

    NodalRigidBody object

    Return type

    NodalRigidBody

    Example

    To create a new nrb in model m with label 200, using node set 50 

    var v = new NodalRigidBody(m, 50, 200);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a nodal rigid body.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the nodal rigid body

    Returns

    No return value

    Example

    To associate comment c to the nodal rigid body nrb: 

    nrb.AssociateComment(c);

    Blank()

    Description

    Blanks the nodal rigid body

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank nodal rigid body nrb: 

    nrb.Blank();

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

    Description

    Blanks all of the nodal rigid bodies in the model.

    Arguments

  • Model (Model)

    Model that all nodal rigid bodies will be blanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the nodal rigid bodies in model m: 

    NodalRigidBody.BlankAll(m);

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

    Description

    Blanks all of the flagged nodal rigid bodies in the model.

    Arguments

  • Model (Model)

    Model that all the flagged nodal rigid bodies will be blanked in

  • flag (Flag)

    Flag set on the nodal rigid bodies that you want to blank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the nodal rigid bodies in model m flagged with f: 

    NodalRigidBody.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the nodal rigid body is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if nodal rigid body nrb is blanked: 

    if (nrb.Blanked() ) do_something...

    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 nodal rigid body nrb: 

    nrb.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the nodal rigid body.

    Arguments

  • flag (Flag)

    Flag to clear on the nodal rigid body

    Returns

    No return value

    Example

    To clear flag f for nodal rigid body nrb: 

    nrb.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the nodal rigid body. The target include of the copied nodal rigid body 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

    NodalRigidBody object

    Return type

    NodalRigidBody

    Example

    To copy nodal rigid body nrb into nodal rigid body z: 

    var z = nrb.Copy();

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

    Description

    Starts an interactive editing panel to create a nodal rigid body

    Arguments

  • Model (Model)

    Model that the nodal rigid body 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

    NodalRigidBody object (or null if not made).

    Return type

    NodalRigidBody

    Example

    To start creating a nodal rigid body in model m: 

    var nrb = NodalRigidBody.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a nodal rigid body.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the nodal rigid body

    Returns

    No return value

    Example

    To detach comment c from the nodal rigid body nrb: 

    nrb.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 nodal rigid body nrb: 

    nrb.Edit();

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

    Description

    Adds an error for nodal rigid body. 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 nodal rigid body nrb: 

    nrb.Error("My custom error");

    ExtractColour()

    Description

    Extracts the actual colour used for nodal rigid body.
    By default in PRIMER many entities such as elements get their colour automatically from the part that they are in. PRIMER cycles through 13 default colours based on the label of the entity. In this case the nodal rigid body colour property will return the value Colour.PART instead of the actual colour. This method will return the actual colour which is used for drawing the nodal rigid body.

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing nodal rigid body nrb: 

    var colour = nrb.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first nodal rigid body in the model.

    Arguments

  • Model (Model)

    Model to get first nodal rigid body in

    Returns

    NodalRigidBody object (or null if there are no nodal rigid bodies in the model).

    Return type

    NodalRigidBody

    Example

    To get the first nodal rigid body in model m: 

    var nrb = NodalRigidBody.First(m);

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

    Description

    Returns the first free nodal rigid body label in the model. Also see NodalRigidBody.LastFreeLabel(), NodalRigidBody.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

    Model to get first free nodal rigid body 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

    NodalRigidBody label.

    Return type

    Number

    Example

    To get the first free nodal rigid body label in model m: 

    var label = NodalRigidBody.FirstFreeLabel(m);

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

    Description

    Flags all of the nodal rigid bodies in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all nodal rigid bodies will be flagged in

  • flag (Flag)

    Flag to set on the nodal rigid bodies

    Returns

    No return value

    Example

    To flag all of the nodal rigid bodies with flag f in model m: 

    NodalRigidBody.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the nodal rigid body is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the nodal rigid body

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if nodal rigid body nrb has flag f set on it: 

    if (nrb.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all nodal rigid bodies are in

  • func (function)

    Function to call for each nodal rigid body

  • 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 nodal rigid bodies in model m: 

    NodalRigidBody.ForEach(m, test);
function test(nrb)
{
// nrb is NodalRigidBody object
}

    To call function test for all of the nodal rigid bodies in model m with optional object: 

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

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

    Description

    Returns an array of NodalRigidBody objects or properties for all of the nodal rigid bodies in a model in PRIMER. If the optional property argument is not given then an array of NodalRigidBody objects is returned. If the property argument is given, that property value for each nodal rigid body is returned in the array instead of a NodalRigidBody object

    Arguments

  • Model (Model)

    Model to get nodal rigid bodies from

  • property (optional) (string)

    Name for property to get for all nodal rigid bodies in the model

    Returns

    Array of NodalRigidBody objects or properties

    Return type

    Array

    Example

    To make an array of NodalRigidBody objects for all of the nodal rigid bodies in model m: 

    var a = NodalRigidBody.GetAll(m);

    To return an array containing the value of property 'foo' (for example 'x' for a node) for each nodal rigid body in model m: 

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

    GetComments()

    Description

    Extracts the comments associated to a nodal rigid body.

    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 nodal rigid body nrb: 

    var comm_array = nrb.GetComments();

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

    Description

    Returns an array of NodalRigidBody objects for all of the flagged nodal rigid bodies in a model in PRIMER If the optional property argument is not given then an array of NodalRigidBody objects is returned. If the property argument is given, then that property value for each nodal rigid body is returned in the array instead of a NodalRigidBody object

    Arguments

  • Model (Model)

    Model to get nodal rigid bodies from

  • flag (Flag)

    Flag set on the nodal rigid bodies that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged nodal rigid bodies in the model

    Returns

    Array of NodalRigidBody objects or properties

    Return type

    Array

    Example

    To make an array of NodalRigidBody objects for all of the nodal rigid bodies in model m flagged with f: 

    var nrb = NodalRigidBody.GetFlagged(m, f);

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

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

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

    Description

    Returns the NodalRigidBody object for a nodal rigid body ID.

    Arguments

  • Model (Model)

    Model to find the nodal rigid body in

  • number (integer)

    number of the nodal rigid body you want the NodalRigidBody object for

    Returns

    NodalRigidBody object (or null if nodal rigid body does not exist).

    Return type

    NodalRigidBody

    Example

    To get the NodalRigidBody object for nodal rigid body 100 in model m 

    var nrb = NodalRigidBody.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    nodal rigid body property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if NodalRigidBody property nrb.example is a parameter: 

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

    To check if NodalRigidBody property nrb.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this nrb (*CONSTRAINED_NODAL_RIGID_BODY_xxxx). Note that a carriage return is not added. See also NodalRigidBody.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for nrb n: 

    var key = n.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the nrb. Note that a carriage return is not added. See also NodalRigidBody.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for nrb n: 

    var cards = n.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last nodal rigid body in the model.

    Arguments

  • Model (Model)

    Model to get last nodal rigid body in

    Returns

    NodalRigidBody object (or null if there are no nodal rigid bodies in the model).

    Return type

    NodalRigidBody

    Example

    To get the last nodal rigid body in model m: 

    var nrb = NodalRigidBody.Last(m);

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

    Description

    Returns the last free nodal rigid body label in the model. Also see NodalRigidBody.FirstFreeLabel(), NodalRigidBody.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get last free nodal rigid body 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

    NodalRigidBody label.

    Return type

    Number

    Example

    To get the last free nodal rigid body label in model m: 

    var label = NodalRigidBody.LastFreeLabel(m);

    Next()

    Description

    Returns the next nodal rigid body in the model.

    Arguments

    No arguments

    Returns

    NodalRigidBody object (or null if there are no more nodal rigid bodies in the model).

    Return type

    NodalRigidBody

    Example

    To get the nodal rigid body in model m after nodal rigid body nrb: 

    var nrb = nrb.Next();

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

    Description

    Returns the next free (highest+1) nodal rigid body label in the model. Also see NodalRigidBody.FirstFreeLabel(), NodalRigidBody.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get next free nodal rigid body 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

    NodalRigidBody label.

    Return type

    Number

    Example

    To get the next free nodal rigid body label in model m: 

    var label = NodalRigidBody.NextFreeLabel(m);

    Pick(prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean], button text (optional)[string]) [static]

    Description

    Allows the user to pick a nodal rigid body.

    Arguments

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only nodal rigid bodies from that model can be picked. If the argument is a Flag then only nodal rigid bodies that are flagged with limit can be selected. If omitted, or null, any nodal rigid bodies from any model can be selected. from any model.

  • modal (optional) (boolean)

    If picking is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the pick will be modal.

  • button text (optional) (string)

    By default the window with the prompt will have a button labelled 'Cancel' which if pressed will cancel the pick and return null. If you want to change the text on the button use this argument. If omitted 'Cancel' will be used.

    Returns

    NodalRigidBody object (or null if not picked)

    Return type

    NodalRigidBody

    Example

    To pick a nodal rigid body from model m giving the prompt 'Pick nodal rigid body from screen': 

    var nrb = NodalRigidBody.Pick('Pick nodal rigid body from screen', m);

    Previous()

    Description

    Returns the previous nodal rigid body in the model.

    Arguments

    No arguments

    Returns

    NodalRigidBody object (or null if there are no more nodal rigid bodies in the model).

    Return type

    NodalRigidBody

    Example

    To get the nodal rigid body in model m before nodal rigid body nrb: 

    var nrb = nrb.Previous();

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

    Description

    Renumbers all of the nodal rigid bodies in the model.

    Arguments

  • Model (Model)

    Model that all nodal rigid bodies will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the nodal rigid bodies in model m, from 1000000: 

    NodalRigidBody.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged nodal rigid bodies in the model.

    Arguments

  • Model (Model)

    Model that all the flagged nodal rigid bodies will be renumbered in

  • flag (Flag)

    Flag set on the nodal rigid bodies that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the nodal rigid bodies in model m flagged with f, from 1000000: 

    NodalRigidBody.RenumberFlagged(m, f, 1000000);

    Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]

    Description

    Allows the user to select nodal rigid bodies using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting nodal rigid bodies

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

    To select nodal rigid bodies from model m, flagging those selected with flag f, giving the prompt 'Select nodal rigid bodies': 

    NodalRigidBody.Select(f, 'Select nodal rigid bodies', m);

    To select nodal rigid bodies, flagging those selected with flag f but limiting selection to nodal rigid bodies flagged with flag l, giving the prompt 'Select nodal rigid bodies': 

    NodalRigidBody.Select(f, 'Select nodal rigid bodies', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the nodal rigid body.

    Arguments

  • flag (Flag)

    Flag to set on the nodal rigid body

    Returns

    No return value

    Example

    To set flag f for nodal rigid body nrb: 

    nrb.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the nodal rigid body. The nodal rigid body will be sketched until you either call NodalRigidBody.Unsketch(), NodalRigidBody.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the nodal rigid body is sketched. If omitted redraw is true. If you want to sketch several nodal rigid bodies and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To sketch nodal rigid body nrb: 

    nrb.Sketch();

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

    Description

    Sketches all of the flagged nodal rigid bodies in the model. The nodal rigid bodies will be sketched until you either call NodalRigidBody.Unsketch(), NodalRigidBody.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged nodal rigid bodies will be sketched in

  • flag (Flag)

    Flag set on the nodal rigid bodies that you want to sketch

  • redraw (optional) (boolean)

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

    NodalRigidBody.SketchFlagged(m, flag);

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

    Description

    Returns the total number of nodal rigid bodies in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

    true if only existing nodal rigid bodies should be counted. If false or omitted referenced but undefined nodal rigid bodies will also be included in the total.

    Returns

    number of nodal rigid bodies

    Return type

    Number

    Example

    To get the total number of nodal rigid bodies in model m: 

    var total = NodalRigidBody.Total(m);

    Unblank()

    Description

    Unblanks the nodal rigid body

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank nodal rigid body nrb: 

    nrb.Unblank();

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

    Description

    Unblanks all of the nodal rigid bodies in the model.

    Arguments

  • Model (Model)

    Model that all nodal rigid bodies will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the nodal rigid bodies in model m: 

    NodalRigidBody.UnblankAll(m);

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

    Description

    Unblanks all of the flagged nodal rigid bodies in the model.

    Arguments

  • Model (Model)

    Model that the flagged nodal rigid bodies will be unblanked in

  • flag (Flag)

    Flag set on the nodal rigid bodies that you want to unblank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the nodal rigid bodies in model m flagged with f: 

    NodalRigidBody.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the nodal rigid bodies in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all nodal rigid bodies will be unset in

  • flag (Flag)

    Flag to unset on the nodal rigid bodies

    Returns

    No return value

    Example

    To unset the flag f on all the nodal rigid bodies in model m: 

    NodalRigidBody.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the nodal rigid body.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the nodal rigid body is unsketched. If omitted redraw is true. If you want to unsketch several nodal rigid bodies and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch nodal rigid body nrb: 

    nrb.Unsketch();

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

    Description

    Unsketches all nodal rigid bodies.

    Arguments

  • Model (Model)

    Model that all nodal rigid bodies will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the nodal rigid bodies 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 nodal rigid bodies in model m: 

    NodalRigidBody.UnsketchAll(m);

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

    Description

    Unsketches all flagged nodal rigid bodies in the model.

    Arguments

  • Model (Model)

    Model that all nodal rigid bodies will be unsketched in

  • flag (Flag)

    Flag set on the nodal rigid bodies that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the nodal rigid bodies 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 nodal rigid bodies flagged with flag in model m: 

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

    NodalRigidBody object.

    Return type

    NodalRigidBody

    Example

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

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

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

    Description

    Adds a warning for nodal rigid body. 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 nodal rigid body nrb: 

    nrb.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this nodal rigid body.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for nodal rigid body nrb: 

    var xrefs = nrb.Xrefs();

    toString()

    Description

    Creates a string containing the nrb data in keyword format. Note that this contains the keyword header and the keyword cards. See also NodalRigidBody.Keyword() and NodalRigidBody.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for nrb n in keyword format 

    var s = n.toString();