Retractor class

The Retractor class gives you access to seatbelt retractor 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

Retractor properties

Name Type Description
colour Colour The colour of the retractor
dsid integer Retractor deactivation Sensor
exists (read only) logical true if retractor exists, false if referred to but not defined.
flopt integer limiting force flage
include integer The Include file number that the retractor is in.
label integer Retractor number. Also see the sbrid property which is an alternative name for this.
lcfl integer Loadcurve representing an adaptive multi-level load limiter
lfed real Fed length
llcid integer Loadcurve for loading (pull-out vs force)
model (read only) integer The Model number that the retractor is in.
nsbi integer Number of elements inside the retractor
pull real Amount of pull out between time delay ending and retractor locking
sbid integer Seatbelt1D number (or Set Shell number if sbrnid is negative).
sbrid integer Retractor number. Also see the label property which is an alternative name for this.
sbrnid integer Node number (or Set Node number if negative).
shell_seatbelt (read only) logical true if retractor is used for shell (2D) seatbelt elements.
sid1 integer Sensor number 1
sid2 integer Sensor number 2
sid3 integer Sensor number 3
sid4 integer Sensor number 4
tdel real Time delay after sensor triggers
transparency integer The transparency of the retractor (0-100) 0% is opaque, 100% is transparent.
ulcid integer Loadcurve for unloading (pull-out vs force)

Detailed Description

The Retractor class allows you to create, modify, edit and manipulate seatbelt retractor cards. See the documentation below for more details.

Constructor

new Retractor(Model[Model], sbrid[integer], sbrnid[integer], sbid[integer], llcid[integer], sid1[integer], sid2 (optional)[integer], sid3 (optional)[integer], sid4 (optional)[integer], tdel (optional)[real], pull (optional)[real], ulcid (optional)[integer], lfed (optional)[real], lcfl (optional)[integer], flopt(optional)[integer])

Description

Create a new Seatbelt Retractor object.

Arguments

  • Model (Model)

    Model that retractor will be created in

  • sbrid (integer)

    Retractor number.

  • sbrnid (integer)

    Node number (or Set Node number if negative).

  • sbid (integer)

    Seatbelt number. (or Set Shell number if sbrnid is negative)

  • llcid (integer)

    Loadcurve for loading (pull-out vs force)

  • sid1 (integer)

    Sensor number 1

  • sid2 (optional) (integer)

    Sensor number 2

  • sid3 (optional) (integer)

    Sensor number 3

  • sid4 (optional) (integer)

    Sensor number 4

  • tdel (optional) (real)

    Time delay after sensor triggers.

  • pull (optional) (real)

    Amount of pull out between time delay ending and retractor locking.

  • ulcid (optional) (integer)

    Loadcurve for unloading (pull-out vs force)

  • lfed (optional) (real)

    Fed length

  • lcfl (optional) (integer)

    Loadcurve representing an adaptive multi-level load limiter

  • flopt(optional) (integer)

    limiting force flage

    Returns

    Retractor object

    Return type

    Retractor

    Example

    To create a new seatbelt retractor in model m with label 100, retractor Node 10, Seatbelt 20, Loading curve 30 and Sensor 40: 

    var a = new Retractor(m, 100, 10, 20, 30, 40);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a retractor.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the retractor

    Returns

    No return value

    Example

    To associate comment c to the retractor r: 

    r.AssociateComment(c);

    Blank()

    Description

    Blanks the retractor

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank retractor r: 

    r.Blank();

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

    Description

    Blanks all of the retractors in the model.

    Arguments

  • Model (Model)

    Model that all retractors 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 retractors in model m: 

    Retractor.BlankAll(m);

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

    Description

    Blanks all of the flagged retractors in the model.

    Arguments

  • Model (Model)

    Model that all the flagged retractors will be blanked in

  • flag (Flag)

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

    Retractor.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the retractor is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if retractor r is blanked: 

    if (r.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 retractor r: 

    r.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the retractor.

    Arguments

  • flag (Flag)

    Flag to clear on the retractor

    Returns

    No return value

    Example

    To clear flag f for retractor r: 

    r.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    Retractor object

    Return type

    Retractor

    Example

    To copy retractor r into retractor z: 

    var z = r.Copy();

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

    Description

    Starts an interactive editing panel to create a retractor

    Arguments

  • Model (Model)

    Model that the retractor 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

    Retractor object (or null if not made).

    Return type

    Retractor

    Example

    To start creating a retractor in model m: 

    var r = Retractor.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a retractor.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the retractor

    Returns

    No return value

    Example

    To detach comment c from the retractor r: 

    r.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 retractor r: 

    r.Edit();

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

    Description

    Adds an error for retractor. 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 retractor r: 

    r.Error("My custom error");

    ExtractColour()

    Description

    Extracts the actual colour used for retractor.
    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 retractor 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 retractor.

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing retractor r: 

    var colour = r.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first retractor in the model.

    Arguments

  • Model (Model)

    Model to get first retractor in

    Returns

    Retractor object (or null if there are no retractors in the model).

    Return type

    Retractor

    Example

    To get the first retractor in model m: 

    var r = Retractor.First(m);

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

    Description

    Returns the first free retractor label in the model. Also see Retractor.LastFreeLabel(), Retractor.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    Retractor label.

    Return type

    Number

    Example

    To get the first free retractor label in model m: 

    var label = Retractor.FirstFreeLabel(m);

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

    Description

    Flags all of the retractors in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all retractors will be flagged in

  • flag (Flag)

    Flag to set on the retractors

    Returns

    No return value

    Example

    To flag all of the retractors with flag f in model m: 

    Retractor.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the retractor is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the retractor

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if retractor r has flag f set on it: 

    if (r.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all retractors are in

  • func (function)

    Function to call for each retractor

  • 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 retractors in model m: 

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

    To call function test for all of the retractors in model m with optional object: 

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

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

    Description

    Returns an array of Retractor objects or properties for all of the retractors in a model in PRIMER. If the optional property argument is not given then an array of Retractor objects is returned. If the property argument is given, that property value for each retractor is returned in the array instead of a Retractor object

    Arguments

  • Model (Model)

    Model to get retractors from

  • property (optional) (string)

    Name for property to get for all retractors in the model

    Returns

    Array of Retractor objects or properties

    Return type

    Array

    Example

    To make an array of Retractor objects for all of the retractors in model m: 

    var a = Retractor.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a retractor.

    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 retractor r: 

    var comm_array = r.GetComments();

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

    Description

    Returns an array of Retractor objects for all of the flagged retractors in a model in PRIMER If the optional property argument is not given then an array of Retractor objects is returned. If the property argument is given, then that property value for each retractor is returned in the array instead of a Retractor object

    Arguments

  • Model (Model)

    Model to get retractors from

  • flag (Flag)

    Flag set on the retractors that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged retractors in the model

    Returns

    Array of Retractor objects or properties

    Return type

    Array

    Example

    To make an array of Retractor objects for all of the retractors in model m flagged with f: 

    var r = Retractor.GetFlagged(m, f);

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

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

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

    Description

    Returns the Retractor object for a retractor ID.

    Arguments

  • Model (Model)

    Model to find the retractor in

  • number (integer)

    number of the retractor you want the Retractor object for

    Returns

    Retractor object (or null if retractor does not exist).

    Return type

    Retractor

    Example

    To get the Retractor object for retractor 100 in model m 

    var r = Retractor.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    retractor property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Retractor property r.example is a parameter: 

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

    To check if Retractor property r.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for retractor r: 

    var key = r.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for retractor r: 

    var cards = r.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last retractor in the model.

    Arguments

  • Model (Model)

    Model to get last retractor in

    Returns

    Retractor object (or null if there are no retractors in the model).

    Return type

    Retractor

    Example

    To get the last retractor in model m: 

    var r = Retractor.Last(m);

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

    Description

    Returns the last free retractor label in the model. Also see Retractor.FirstFreeLabel(), Retractor.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    Retractor label.

    Return type

    Number

    Example

    To get the last free retractor label in model m: 

    var label = Retractor.LastFreeLabel(m);

    Next()

    Description

    Returns the next retractor in the model.

    Arguments

    No arguments

    Returns

    Retractor object (or null if there are no more retractors in the model).

    Return type

    Retractor

    Example

    To get the retractor in model m after retractor r: 

    var r = r.Next();

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

    Description

    Returns the next free (highest+1) retractor label in the model. Also see Retractor.FirstFreeLabel(), Retractor.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

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

    Retractor label.

    Return type

    Number

    Example

    To get the next free retractor label in model m: 

    var label = Retractor.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 retractor.

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

    Retractor object (or null if not picked)

    Return type

    Retractor

    Example

    To pick a retractor from model m giving the prompt 'Pick retractor from screen': 

    var r = Retractor.Pick('Pick retractor from screen', m);

    Previous()

    Description

    Returns the previous retractor in the model.

    Arguments

    No arguments

    Returns

    Retractor object (or null if there are no more retractors in the model).

    Return type

    Retractor

    Example

    To get the retractor in model m before retractor r: 

    var r = r.Previous();

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

    Description

    Renumbers all of the retractors in the model.

    Arguments

  • Model (Model)

    Model that all retractors will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the retractors in model m, from 1000000: 

    Retractor.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged retractors in the model.

    Arguments

  • Model (Model)

    Model that all the flagged retractors will be renumbered in

  • flag (Flag)

    Flag set on the retractors that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the retractors in model m flagged with f, from 1000000: 

    Retractor.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select retractors using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting retractors

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    Retractor.Select(f, 'Select retractors', m);

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

    Retractor.Select(f, 'Select retractors', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the retractor.

    Arguments

  • flag (Flag)

    Flag to set on the retractor

    Returns

    No return value

    Example

    To set flag f for retractor r: 

    r.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the retractor. The retractor will be sketched until you either call Retractor.Unsketch(), Retractor.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch retractor r: 

    r.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged retractors will be sketched in

  • flag (Flag)

    Flag set on the retractors that you want to sketch

  • redraw (optional) (boolean)

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

    Retractor.SketchFlagged(m, flag);

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

    Description

    Returns the total number of retractors in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of retractors

    Return type

    Number

    Example

    To get the total number of retractors in model m: 

    var total = Retractor.Total(m);

    Unblank()

    Description

    Unblanks the retractor

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank retractor r: 

    r.Unblank();

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

    Description

    Unblanks all of the retractors in the model.

    Arguments

  • Model (Model)

    Model that all retractors 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 retractors in model m: 

    Retractor.UnblankAll(m);

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

    Description

    Unblanks all of the flagged retractors in the model.

    Arguments

  • Model (Model)

    Model that the flagged retractors will be unblanked in

  • flag (Flag)

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

    Retractor.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the retractors in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all retractors will be unset in

  • flag (Flag)

    Flag to unset on the retractors

    Returns

    No return value

    Example

    To unset the flag f on all the retractors in model m: 

    Retractor.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the retractor.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch retractor r: 

    r.Unsketch();

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

    Description

    Unsketches all retractors.

    Arguments

  • Model (Model)

    Model that all retractors will be unblanked in

  • redraw (optional) (boolean)

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

    Retractor.UnsketchAll(m);

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

    Description

    Unsketches all flagged retractors in the model.

    Arguments

  • Model (Model)

    Model that all retractors will be unsketched in

  • flag (Flag)

    Flag set on the retractors that you want to unsketch

  • redraw (optional) (boolean)

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

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

    Retractor object.

    Return type

    Retractor

    Example

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

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

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

    Description

    Adds a warning for retractor. 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 retractor r: 

    r.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this retractor.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for retractor r: 

    var xrefs = r.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for retractor r in keyword format 

    var str = r.toString();