DeformableToRigid class

The DeformableToRigid class gives you access to *DEFORMABLE_TO_RIGID 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

DeformableToRigid constants

Constants for DEFORMABLE_TO_RIGID type

Name Description
DeformableToRigid.AUTOMATIC *DEFORMABLE_TO_RIGID_AUTOMATIC.
DeformableToRigid.INERTIA *DEFORMABLE_TO_RIGID_INERTIA.
DeformableToRigid.SIMPLE *DEFORMABLE_TO_RIGID.

Constants for PID field type

Name Description
DeformableToRigid.PART Identifies the PID type as Part. Used for field ptype. Used only for DeformableToRigid.SIMPLE or DeformableToRigid.INERTIA.
DeformableToRigid.PSET Identifies the PID type as Part Set. Used for field ptype. Used only for DeformableToRigid.SIMPLE or DeformableToRigid.INERTIA.

Constants for automatic types

Name Description
DeformableToRigid.D2R Identifies that card is being written/retreived/removed as D2R card.
Used in methods GetDefToRegAutoCard, SetDefToRegAutoCard and RemoveDefToRegAutoCard.
Used only for DeformableToRigid.AUTOMATIC.
DeformableToRigid.R2D Identifies that card is being written/retreived/removed as R2D card.
Used in methods GetDefToRegAutoCard, SetDefToRegAutoCard and RemoveDefToRegAutoCard.
Used only for DeformableToRigid.AUTOMATIC.

DeformableToRigid properties

Name Type Description
code integer Activation switch code. (Valid values: 0-5). Used only for DeformableToRigid.AUTOMATIC.
d2r integer Number of deformable parts to be switched to rigid plus number of rigid parts for which new lead/constrained rigid body combinations will be defined. Used only for DeformableToRigid.AUTOMATIC.
dtmax real Maximum permitted time step size after switch. Used only for DeformableToRigid.AUTOMATIC.
entno integer Rigid wall/contact surface number for switch codes 1, 2, 3, 4. Used only for DeformableToRigid.AUTOMATIC.
exists (read only) logical true if deformable to rigid exists, false if referred to but not defined.
include integer The Include file number that the deformable to rigid is in.
ixx real The xx component of inertia tensor. Used only for DeformableToRigid.INERTIA.
ixx real The xx component of inertia tensor. Used only for DeformableToRigid.INERTIA.
ixy real The xy component of inertia tensor. Used only for DeformableToRigid.INERTIA.
ixz real The xz component of inertia tensor. Used only for DeformableToRigid.INERTIA.
iyz real The yz component of inertia tensor. Used only for DeformableToRigid.INERTIA.
izz real The zz component of inertia tensor. Used only for DeformableToRigid.INERTIA.
lrb integer Part ID of the lead rigid body to which the part is merged. Used only for DeformableToRigid.SIMPLE.
model (read only) integer The Model number that the deformable to rigid is in.
ncsf integer Nodal constraint body flag. (Valid values : 0, 1, 2). Used only for DeformableToRigid.AUTOMATIC.
nrbf integer Nodal rigid body flag. (Valid values : 0, 1, 2). Used only for DeformableToRigid.AUTOMATIC.
offset real Optional contact thickness for switch to deformable. Used only for DeformableToRigid.AUTOMATIC.
paired integer Define a pair of related switches. (Valid values : -1, 0, 1). Used only for DeformableToRigid.AUTOMATIC.
pid integer Part or Part set ID which is switched to a rigid material. Depends on value of ptype. Used only for DeformableToRigid.SIMPLE or DeformableToRigid.INERTIA.
ptype integer Type of PID. Valid values are: DeformableToRigid.PART or DeformableToRigid.PSET. Used only for DeformableToRigid.SIMPLE.
r2d integer Number of rigid parts to be switched to deformable. Used only for DeformableToRigid.AUTOMATIC.
relsw integer Related switch set. Used only for DeformableToRigid.AUTOMATIC.
rwf integer Flag to delete or activate rigid walls. (Valid values : 0, 1, 2). Used only for DeformableToRigid.AUTOMATIC.
swset (read only) integer Set number for this automatic switch set. Used only for DeformableToRigid.AUTOMATIC.
time1 real Switch will not take place before this time. Used only for DeformableToRigid.AUTOMATIC.
time2 real Switch will not take place after this time. Used only for DeformableToRigid.AUTOMATIC.
time3 real After this part switch has taken place, another automatic switch will not take place for the duration of the delay period. Used only for DeformableToRigid.AUTOMATIC.
tm real Translational mass. Used only for DeformableToRigid.INERTIA.
type (read only) integer Gives the type of DeformableToRigid Object.
xc real x-coordinate of center of mass. Used only for DeformableToRigid.INERTIA.
yc real y-coordinate of center of mass. Used only for DeformableToRigid.INERTIA.
zc real z-coordinate of center of mass. Used only for DeformableToRigid.INERTIA.

Detailed Description

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

Constructor

new DeformableToRigid(Model[Model], Type[constant], pid (optional) [integer], lrb (optional)[integer], ptype (optional)[integer])

Description

Create a new DeformableToRigid object.

Arguments

  • Model (Model)

    Model that deformable to rigid will be created in

  • Type (constant)

    Specify the type of DeformableToRigid (Can be DeformableToRigid.SIMPLE or DeformableToRigid.AUTOMATIC or DeformableToRigid.INERTIA )

  • pid (optional) (integer)

    Part or Part set ID which is switched to a rigid material. Depends on value of ptype. Used only for DeformableToRigid.SIMPLE or DeformableToRigid.INERTIA.

  • lrb (optional) (integer)

    Part ID of the lead rigid body to which the part is merged. Used only for DeformableToRigid.SIMPLE.

  • ptype (optional) (integer)

    Type of PID. Valid values are: DeformableToRigid.PART or DeformableToRigid.PSET. Used only for DeformableToRigid.SIMPLE.

    Returns

    DeformableToRigid object

    Return type

    DeformableToRigid

    Example

    To create a new deformable to rigid in model m, type SIMPLE, part id 100: 

    var dtor = new DeformableToRigid(m, DeformableToRigid.SIMPLE, 100);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a deformable to rigid.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the deformable to rigid

    Returns

    No return value

    Example

    To associate comment c to the deformable to rigid dtor: 

    dtor.AssociateComment(c);

    Blank()

    Description

    Blanks the deformable to rigid

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank deformable to rigid dtor: 

    dtor.Blank();

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

    Description

    Blanks all of the deformable to rigids in the model.

    Arguments

  • Model (Model)

    Model that all deformable to rigids 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 deformable to rigids in model m: 

    DeformableToRigid.BlankAll(m);

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

    Description

    Blanks all of the flagged deformable to rigids in the model.

    Arguments

  • Model (Model)

    Model that all the flagged deformable to rigids will be blanked in

  • flag (Flag)

    Flag set on the deformable to rigids 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 deformable to rigids in model m flagged with f: 

    DeformableToRigid.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the deformable to rigid is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if deformable to rigid dtor is blanked: 

    if (dtor.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 deformable to rigid dtor: 

    dtor.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the deformable to rigid.

    Arguments

  • flag (Flag)

    Flag to clear on the deformable to rigid

    Returns

    No return value

    Example

    To clear flag f for deformable to rigid dtor: 

    dtor.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    DeformableToRigid object

    Return type

    DeformableToRigid

    Example

    To copy deformable to rigid dtor into deformable to rigid z: 

    var z = dtor.Copy();

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

    Description

    Starts an interactive editing panel to create a deformable to rigid

    Arguments

  • Model (Model)

    Model that the deformable to rigid 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

    DeformableToRigid object (or null if not made).

    Return type

    DeformableToRigid

    Example

    To start creating a deformable to rigid in model m: 

    var dtor = DeformableToRigid.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a deformable to rigid.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the deformable to rigid

    Returns

    No return value

    Example

    To detach comment c from the deformable to rigid dtor: 

    dtor.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 deformable to rigid dtor: 

    dtor.Edit();

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

    Description

    Adds an error for deformable to rigid. 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 deformable to rigid dtor: 

    dtor.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first deformable to rigid in the model.

    Arguments

  • Model (Model)

    Model to get first deformable to rigid in

    Returns

    DeformableToRigid object (or null if there are no deformable to rigids in the model).

    Return type

    DeformableToRigid

    Example

    To get the first deformable to rigid in model m: 

    var dtor = DeformableToRigid.First(m);

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

    Description

    Returns the first free deformable to rigid label in the model. Also see DeformableToRigid.LastFreeLabel(), DeformableToRigid.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    DeformableToRigid label.

    Return type

    Number

    Example

    To get the first free deformable to rigid label in model m: 

    var label = DeformableToRigid.FirstFreeLabel(m);

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

    Description

    Flags all of the deformable to rigids in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all deformable to rigids will be flagged in

  • flag (Flag)

    Flag to set on the deformable to rigids

    Returns

    No return value

    Example

    To flag all of the deformable to rigids with flag f in model m: 

    DeformableToRigid.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the deformable to rigid is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the deformable to rigid

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if deformable to rigid dtor has flag f set on it: 

    if (dtor.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all deformable to rigids are in

  • func (function)

    Function to call for each deformable to rigid

  • 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 deformable to rigids in model m: 

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

    To call function test for all of the deformable to rigids in model m with optional object: 

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

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

    Description

    Returns an array of DeformableToRigid objects or properties for all of the deformable to rigids in a model in PRIMER. If the optional property argument is not given then an array of DeformableToRigid objects is returned. If the property argument is given, that property value for each deformable to rigid is returned in the array instead of a DeformableToRigid object

    Arguments

  • Model (Model)

    Model to get deformable to rigids from

  • property (optional) (string)

    Name for property to get for all deformable to rigids in the model

    Returns

    Array of DeformableToRigid objects or properties

    Return type

    Array

    Example

    To make an array of DeformableToRigid objects for all of the deformable to rigids in model m: 

    var a = DeformableToRigid.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a deformable to rigid.

    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 deformable to rigid dtor: 

    var comm_array = dtor.GetComments();

    GetDefToRegAutoCard(ctype[integer], index[integer])

    Description

    Returns the D2R or R2D cards for *DEFORMABLE_TO_RIGID_AUTOMATC.

    Arguments

  • ctype (integer)

    The card type you want the data for. Can be D2R or R2D.

  • index (integer)

    The card index you want the data for. Note that card indices start at 0, not 1.

    Returns

    An array of numbers containing the 2 or 3 member (depending on Card type): Part or Part Set ID, LRB Part ID (only for card type D2R), and part type (PTYPE - Can be DeformableToRigid.PART or DeformableToRigid.PSET).

    Return type

    Number

    Example

    To get the D2R card data for the 3rd D2R card for Deformable to Rigid dtor: 

    if (dtor.d2r >= 3)
{
    var dtor_data = dtor.GetDefToRegAutoCard(DeformableToRigid.D2R, 2);
}

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

    Description

    Returns an array of DeformableToRigid objects for all of the flagged deformable to rigids in a model in PRIMER If the optional property argument is not given then an array of DeformableToRigid objects is returned. If the property argument is given, then that property value for each deformable to rigid is returned in the array instead of a DeformableToRigid object

    Arguments

  • Model (Model)

    Model to get deformable to rigids from

  • flag (Flag)

    Flag set on the deformable to rigids that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged deformable to rigids in the model

    Returns

    Array of DeformableToRigid objects or properties

    Return type

    Array

    Example

    To make an array of DeformableToRigid objects for all of the deformable to rigids in model m flagged with f: 

    var dtor = DeformableToRigid.GetFlagged(m, f);

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

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

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

    Description

    Returns the DeformableToRigid object for a deformable to rigid ID.

    Arguments

  • Model (Model)

    Model to find the deformable to rigid in

  • number (integer)

    number of the deformable to rigid you want the DeformableToRigid object for

    Returns

    DeformableToRigid object (or null if deformable to rigid does not exist).

    Return type

    DeformableToRigid

    Example

    To get the DeformableToRigid object for deformable to rigid 100 in model m 

    var dtor = DeformableToRigid.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    deformable to rigid property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if DeformableToRigid property dtor.example is a parameter: 

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

    To check if DeformableToRigid property dtor.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for DeformableToRigid dtor: 

    var key = dtor.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for DeformableToRigid dtor: 

    var cards = dtor.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last deformable to rigid in the model.

    Arguments

  • Model (Model)

    Model to get last deformable to rigid in

    Returns

    DeformableToRigid object (or null if there are no deformable to rigids in the model).

    Return type

    DeformableToRigid

    Example

    To get the last deformable to rigid in model m: 

    var dtor = DeformableToRigid.Last(m);

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

    Description

    Returns the last free deformable to rigid label in the model. Also see DeformableToRigid.FirstFreeLabel(), DeformableToRigid.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    DeformableToRigid label.

    Return type

    Number

    Example

    To get the last free deformable to rigid label in model m: 

    var label = DeformableToRigid.LastFreeLabel(m);

    Next()

    Description

    Returns the next deformable to rigid in the model.

    Arguments

    No arguments

    Returns

    DeformableToRigid object (or null if there are no more deformable to rigids in the model).

    Return type

    DeformableToRigid

    Example

    To get the deformable to rigid in model m after deformable to rigid dtor: 

    var dtor = dtor.Next();

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

    Description

    Returns the next free (highest+1) deformable to rigid label in the model. Also see DeformableToRigid.FirstFreeLabel(), DeformableToRigid.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

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

    DeformableToRigid label.

    Return type

    Number

    Example

    To get the next free deformable to rigid label in model m: 

    var label = DeformableToRigid.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 deformable to rigid.

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

    DeformableToRigid object (or null if not picked)

    Return type

    DeformableToRigid

    Example

    To pick a deformable to rigid from model m giving the prompt 'Pick deformable to rigid from screen': 

    var dtor = DeformableToRigid.Pick('Pick deformable to rigid from screen', m);

    Previous()

    Description

    Returns the previous deformable to rigid in the model.

    Arguments

    No arguments

    Returns

    DeformableToRigid object (or null if there are no more deformable to rigids in the model).

    Return type

    DeformableToRigid

    Example

    To get the deformable to rigid in model m before deformable to rigid dtor: 

    var dtor = dtor.Previous();

    RemoveDefToRegAutoCard(ctype[integer], index[integer])

    Description

    Removes the D2R or R2D cards for *DEFORMABLE_TO_RIGID_AUTOMATC.

    Arguments

  • ctype (integer)

    The card type you want removed. Can be D2R or R2D.

  • index (integer)

    The card index you want removed. Note that card indices start at 0, not 1.

    Returns

    No return value.

    Example

    To remove the D2R card data for the 3rd D2R card from Deformable to Rigid dtor: 

    if (dtor.d2r >= 3)
{
    var dtor_data = dtor.RemoveDefToRegAutoCard(DeformableToRigid.D2R, 2);
}

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

    Description

    Renumbers all of the deformable to rigids in the model.

    Arguments

  • Model (Model)

    Model that all deformable to rigids will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the deformable to rigids in model m, from 1000000: 

    DeformableToRigid.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged deformable to rigids in the model.

    Arguments

  • Model (Model)

    Model that all the flagged deformable to rigids will be renumbered in

  • flag (Flag)

    Flag set on the deformable to rigids that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the deformable to rigids in model m flagged with f, from 1000000: 

    DeformableToRigid.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select deformable to rigids using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting deformable to rigids

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

    To select deformable to rigids from model m, flagging those selected with flag f, giving the prompt 'Select deformable to rigids': 

    DeformableToRigid.Select(f, 'Select deformable to rigids', m);

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

    DeformableToRigid.Select(f, 'Select deformable to rigids', l);

    SetDefToRegAutoCard(ctype[integer], index[integer], ptype[integer], pid[integer], lrb (optional)[integer])

    Description

    Sets the D2r or R2D card data f*DEFORMABLE_TO_RIGID_AUTOMATIC.

    Arguments

  • ctype (integer)

    The card type you want to set. Can be D2R or R2D.

  • index (integer)

    The D2R or R2D card index you want to set. Note that cards start at 0, not 1.

  • ptype (integer)

    Part type (PTYPE). Can be DeformableToRigid.PART or DeformableToRigid.PSET.

  • pid (integer)

    Part or Part Set ID.

  • lrb (optional) (integer)

    LRB Part ID (only for card type D2R)

    Returns

    No return value.

    Example

    To set the 3rd D2R card to ptype DeformabletoRigid.PART, pid 100 and lrb 200, for DeformableToRigid dtor: 

    dtor.SetDefToRegAutoCard(DeformabletoRigid.D2R, 2, DeformabletoRigid.PART, 100, 200);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the deformable to rigid.

    Arguments

  • flag (Flag)

    Flag to set on the deformable to rigid

    Returns

    No return value

    Example

    To set flag f for deformable to rigid dtor: 

    dtor.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the deformable to rigid. The deformable to rigid will be sketched until you either call DeformableToRigid.Unsketch(), DeformableToRigid.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch deformable to rigid dtor: 

    dtor.Sketch();

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

    Description

    Sketches all of the flagged deformable to rigids in the model. The deformable to rigids will be sketched until you either call DeformableToRigid.Unsketch(), DeformableToRigid.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged deformable to rigids will be sketched in

  • flag (Flag)

    Flag set on the deformable to rigids that you want to sketch

  • redraw (optional) (boolean)

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

    DeformableToRigid.SketchFlagged(m, flag);

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

    Description

    Returns the total number of deformable to rigids in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

    true if only existing deformable to rigids should be counted. If false or omitted referenced but undefined deformable to rigids will also be included in the total.

    Returns

    number of deformable to rigids

    Return type

    Number

    Example

    To get the total number of deformable to rigids in model m: 

    var total = DeformableToRigid.Total(m);

    Unblank()

    Description

    Unblanks the deformable to rigid

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank deformable to rigid dtor: 

    dtor.Unblank();

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

    Description

    Unblanks all of the deformable to rigids in the model.

    Arguments

  • Model (Model)

    Model that all deformable to rigids 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 deformable to rigids in model m: 

    DeformableToRigid.UnblankAll(m);

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

    Description

    Unblanks all of the flagged deformable to rigids in the model.

    Arguments

  • Model (Model)

    Model that the flagged deformable to rigids will be unblanked in

  • flag (Flag)

    Flag set on the deformable to rigids 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 deformable to rigids in model m flagged with f: 

    DeformableToRigid.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the deformable to rigids in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all deformable to rigids will be unset in

  • flag (Flag)

    Flag to unset on the deformable to rigids

    Returns

    No return value

    Example

    To unset the flag f on all the deformable to rigids in model m: 

    DeformableToRigid.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the deformable to rigid.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch deformable to rigid dtor: 

    dtor.Unsketch();

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

    Description

    Unsketches all deformable to rigids.

    Arguments

  • Model (Model)

    Model that all deformable to rigids will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the deformable to rigids 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 deformable to rigids in model m: 

    DeformableToRigid.UnsketchAll(m);

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

    Description

    Unsketches all flagged deformable to rigids in the model.

    Arguments

  • Model (Model)

    Model that all deformable to rigids will be unsketched in

  • flag (Flag)

    Flag set on the deformable to rigids that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the deformable to rigids 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 deformable to rigids flagged with flag in model m: 

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

    DeformableToRigid object.

    Return type

    DeformableToRigid

    Example

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

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

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

    Description

    Adds a warning for deformable to rigid. 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 deformable to rigid dtor: 

    dtor.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this deformable to rigid.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for deformable to rigid dtor: 

    var xrefs = dtor.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for DeformableToRigid dtor in keyword format 

    var i_str = dtor.toString();