RigidBodies class

The RigidBodies class gives you access to constrained rigid bodies 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

RigidBodies constants

Name Description
RigidBodies.PART RigidBodies is *CONSTRAINED_RIGID_BODIES.
RigidBodies.SET RigidBodies is *CONSTRAINED_RIGID_BODIES_SET.

RigidBodies properties

Name Type Description
colour Colour The colour of the rigid body
exists (read only) logical true if rigid body merge exists, false if referred to but not defined.
iflag integer Flag for adding coonstrained mass properties to part inertia.
include integer The Include file number that the rigid body merge is in.
label (read only) integer The label the constrained rigid bodies has in PRIMER
model (read only) integer The Model number that the rigid body merge is in.
option constant The Constrained Rigid Bodies option. Can be RigidBodies.PART or RigidBodies.SET.
pidc integer Constrained rigid body part ID.
pidl integer Lead rigid body part ID.

Detailed Description

The RigidBodies class allows you to create, modify, edit and manipulate constrained rigid bodies cards. See the documentation below for more details.

Constructor

new RigidBodies(Model[Model], options [object])

Description

Create a new RigidBodies object.

Arguments

  • Model (Model)

    Model that constrained rigid bodies will be created in

  • options (object)

    Options specifying which properties would be used to create the keyword. If optional values are not used, then the default values below will be used.

    Object has the following properties:

    Name Type Description
    iflag (optional) integer Flag for adding constrained mass properties to part inertia. (Default value 0)
    option (optional) constant Specify the type of constrained rigid bodies. Can be RigidBodies.PART(default) or RigidBodies.SET
    pidc integer Constrained rigid body part ID.
    pidl integer Lead rigid body part ID.

    Returns

    RigidBodies object

    Return type

    RigidBodies

    Example

    To create a new constrained rigid bodies in model m with lead part 6 and constrained SET_PART 8 

     
    var output_obj    = new Object();
    output_obj.pidl   = 6;
    output_obj.pidc   = 8;
    output_obj.iflag  = 1;
    output_obj.option = RigidBodies.SET;
        
    var cnst = new RigidBodies(m, output_obj);

    new RigidBodies(Model[Model], pidl[integer], pidc[integer], iflag (optional)[integer], option (optional)[constant])   [deprecated]

    This function is deprecated in version 20.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Create a new RigidBodies object.

    Arguments

  • Model (Model)

    Model that constrained rigid bodies will be created in

  • pidl (integer)

    Lead rigid body part ID.

  • pidc (integer)

    Constrained rigid body part ID.

  • iflag (optional) (integer)

    Flag for adding constrained mass properties to part inertia. (Default value 0)

  • option (optional) (constant)

    Specify the type of constrained rigid bodies. Can be RigidBodies.PART(default) or RigidBodies.SET

    Returns

    RigidBodies object

    Return type

    RigidBodies

    Example

    To create a new constrained rigid bodies in model m with lead part 5 and constrained part 10 

    var r = new RigidBodies(m, 5, 10, 0 , 1);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a rigid body merge.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the rigid body merge

    Returns

    No return value

    Example

    To associate comment c to the rigid body merge m: 

    m.AssociateComment(c);

    Blank()

    Description

    Blanks the rigid body merge

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank rigid body merge m: 

    m.Blank();

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

    Description

    Blanks all of the rigid body merges in the model.

    Arguments

  • Model (Model)

    Model that all rigid body merges 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 rigid body merges in model m: 

    RigidBodies.BlankAll(m);

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

    Description

    Blanks all of the flagged rigid body merges in the model.

    Arguments

  • Model (Model)

    Model that all the flagged rigid body merges will be blanked in

  • flag (Flag)

    Flag set on the rigid body merges 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 rigid body merges in model m flagged with f: 

    RigidBodies.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the rigid body merge is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if rigid body merge m is blanked: 

    if (m.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 rigid body merge m: 

    m.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the rigid body merge.

    Arguments

  • flag (Flag)

    Flag to clear on the rigid body merge

    Returns

    No return value

    Example

    To clear flag f for rigid body merge m: 

    m.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    RigidBodies object

    Return type

    RigidBodies

    Example

    To copy rigid body merge m into rigid body merge z: 

    var z = m.Copy();

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

    Description

    Starts an interactive editing panel to create a rigid body merge

    Arguments

  • Model (Model)

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

    RigidBodies object (or null if not made).

    Return type

    RigidBodies

    Example

    To start creating a rigid body merge in model m: 

    var m = RigidBodies.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a rigid body merge.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the rigid body merge

    Returns

    No return value

    Example

    To detach comment c from the rigid body merge m: 

    m.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 rigid body merge m: 

    m.Edit();

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

    Description

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

    m.Error("My custom error");

    ExtractColour()

    Description

    Extracts the actual colour used for rigid body merge.
    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 rigid body merge 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 rigid body merge.

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing rigid body merge m: 

    var colour = m.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first rigid body merge in the model.

    Arguments

  • Model (Model)

    Model to get first rigid body merge in

    Returns

    RigidBodies object (or null if there are no rigid body merges in the model).

    Return type

    RigidBodies

    Example

    To get the first rigid body merge in model m: 

    var m = RigidBodies.First(m);

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

    Description

    Flags all of the rigid body merges in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all rigid body merges will be flagged in

  • flag (Flag)

    Flag to set on the rigid body merges

    Returns

    No return value

    Example

    To flag all of the rigid body merges with flag f in model m: 

    RigidBodies.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the rigid body merge is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the rigid body merge

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if rigid body merge m has flag f set on it: 

    if (m.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all rigid body merges are in

  • func (function)

    Function to call for each rigid body merge

  • 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 rigid body merges in model m: 

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

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get rigid body merges from

  • property (optional) (string)

    Name for property to get for all rigid body merges in the model

    Returns

    Array of RigidBodies objects or properties

    Return type

    Array

    Example

    To make an array of RigidBodies objects for all of the rigid body merges in model m: 

    var a = RigidBodies.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a rigid body merge.

    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 rigid body merge m: 

    var comm_array = m.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get rigid body merges from

  • flag (Flag)

    Flag set on the rigid body merges that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged rigid body merges in the model

    Returns

    Array of RigidBodies objects or properties

    Return type

    Array

    Example

    To make an array of RigidBodies objects for all of the rigid body merges in model m flagged with f: 

    var m = RigidBodies.GetFlagged(m, f);

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

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

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

    Description

    Returns the RigidBodies object for a rigid body merge ID.

    Arguments

  • Model (Model)

    Model to find the rigid body merge in

  • number (integer)

    number of the rigid body merge you want the RigidBodies object for

    Returns

    RigidBodies object (or null if rigid body merge does not exist).

    Return type

    RigidBodies

    Example

    To get the RigidBodies object for rigid body merge 100 in model m 

    var m = RigidBodies.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    rigid body merge property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if RigidBodies property m.example is a parameter: 

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

    To check if RigidBodies property m.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this constrained rigid bodies (*CONSTRAINED_RIGID_BODIES). Note that a carriage return is not added. See also RigidBodies.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for constrained rigid bodies r: 

    var key = r.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the constrained rigid bodies. Note that a carriage return is not added. See also RigidBodies.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for constrained rigid bodies r: 

    var cards = r.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last rigid body merge in the model.

    Arguments

  • Model (Model)

    Model to get last rigid body merge in

    Returns

    RigidBodies object (or null if there are no rigid body merges in the model).

    Return type

    RigidBodies

    Example

    To get the last rigid body merge in model m: 

    var m = RigidBodies.Last(m);

    Next()

    Description

    Returns the next rigid body merge in the model.

    Arguments

    No arguments

    Returns

    RigidBodies object (or null if there are no more rigid body merges in the model).

    Return type

    RigidBodies

    Example

    To get the rigid body merge in model m after rigid body merge m: 

    var m = m.Next();

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

    Description

    Allows the user to pick a rigid body merge.

    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 rigid body merges from that model can be picked. If the argument is a Flag then only rigid body merges that are flagged with limit can be selected. If omitted, or null, any rigid body merges 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

    RigidBodies object (or null if not picked)

    Return type

    RigidBodies

    Example

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

    var m = RigidBodies.Pick('Pick rigid body merge from screen', m);

    Previous()

    Description

    Returns the previous rigid body merge in the model.

    Arguments

    No arguments

    Returns

    RigidBodies object (or null if there are no more rigid body merges in the model).

    Return type

    RigidBodies

    Example

    To get the rigid body merge in model m before rigid body merge m: 

    var m = m.Previous();

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

    Description

    Allows the user to select rigid body merges using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting rigid body merges

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    RigidBodies.Select(f, 'Select rigid body merges', m);

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

    RigidBodies.Select(f, 'Select rigid body merges', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the rigid body merge.

    Arguments

  • flag (Flag)

    Flag to set on the rigid body merge

    Returns

    No return value

    Example

    To set flag f for rigid body merge m: 

    m.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch rigid body merge m: 

    m.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged rigid body merges will be sketched in

  • flag (Flag)

    Flag set on the rigid body merges that you want to sketch

  • redraw (optional) (boolean)

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

    RigidBodies.SketchFlagged(m, flag);

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

    Description

    Returns the total number of rigid body merges in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of rigid body merges

    Return type

    Number

    Example

    To get the total number of rigid body merges in model m: 

    var total = RigidBodies.Total(m);

    Unblank()

    Description

    Unblanks the rigid body merge

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank rigid body merge m: 

    m.Unblank();

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

    Description

    Unblanks all of the rigid body merges in the model.

    Arguments

  • Model (Model)

    Model that all rigid body merges 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 rigid body merges in model m: 

    RigidBodies.UnblankAll(m);

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

    Description

    Unblanks all of the flagged rigid body merges in the model.

    Arguments

  • Model (Model)

    Model that the flagged rigid body merges will be unblanked in

  • flag (Flag)

    Flag set on the rigid body merges 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 rigid body merges in model m flagged with f: 

    RigidBodies.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the rigid body merges in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all rigid body merges will be unset in

  • flag (Flag)

    Flag to unset on the rigid body merges

    Returns

    No return value

    Example

    To unset the flag f on all the rigid body merges in model m: 

    RigidBodies.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the rigid body merge.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch rigid body merge m: 

    m.Unsketch();

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

    Description

    Unsketches all rigid body merges.

    Arguments

  • Model (Model)

    Model that all rigid body merges will be unblanked in

  • redraw (optional) (boolean)

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

    RigidBodies.UnsketchAll(m);

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

    Description

    Unsketches all flagged rigid body merges in the model.

    Arguments

  • Model (Model)

    Model that all rigid body merges will be unsketched in

  • flag (Flag)

    Flag set on the rigid body merges that you want to unsketch

  • redraw (optional) (boolean)

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

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

    RigidBodies object.

    Return type

    RigidBodies

    Example

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

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

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

    Description

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

    m.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this rigid body merge.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for rigid body merge m: 

    var xrefs = m.Xrefs();

    toString()

    Description

    Creates a string containing the constrained rigid bodies data in keyword format. Note that this contains the keyword header and the keyword cards. See also RigidBodies.Keyword() and RigidBodies.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for constrained rigid bodies r in keyword format 

    var s = r.toString();