DiscreteSphere class

The DiscreteSphere class gives you access to element discrete sphere 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

DiscreteSphere properties

Name Type Description
colour Colour The colour of the discrete sphere
exists (read only) logical true if discrete sphere exists, false if referred to but not defined.
idist integer Distribution of DES properties.
include integer The Include file number that the discrete sphere is in.
inertia real Mass moment of inertia.
isd_mi real Standard deviation for mass moment of inertia or inertia per unit density(depending on whether the _VOLUME option is set), if idist is -1 or 1. Shape parameter for mass moment of inertia or inertia per unit density(depending on whether the _VOLUME option is set), if idist is -2 or 2.
mass real Mass or volume value (depending on whether the _VOLUME option is set).
model (read only) integer The Model number that the discrete sphere is in.
msd_mm real Standard deviation for mass or volume(depending on whether the _VOLUME option is set), if idist is -1 or 1. Shape parameter for mass or volume(depending on whether the _VOLUME option is set), if idist is -2 or 2.
nid integer Node ID.
pid integer Part ID to which this element belongs.
radius real Particle radius.
rsd_mr real Standard deviation for radius, if idist is -1 or 1. Shape parameter for radius, if idist is -2 or 2.
transparency integer The transparency of the discrete sphere (0-100) 0% is opaque, 100% is transparent.
volume logical Turns _VOLUME on or OFF. Note that this does NOT refer to the data field VOLUME. For the latter see the mass property.

Detailed Description

The DiscreteSphere class allows you to create, modify, edit and manipulate discrete sphere cards. See the documentation below for more details.

Constructor

new DiscreteSphere(Model[Model], nid[integer], pid[integer], mass[real], inertia[real], radius[real])

Description

Create a new DiscreteSphere object.

Arguments

  • Model (Model)

    Model that discrete sphere will be created in

  • nid (integer)

    Node ID and Element ID are the same for discrete spheres.

  • pid (integer)

    Part ID to which this element belongs.

  • mass (real)

    Mass or volume value.

  • inertia (real)

    Mass moment of inertia.

  • radius (real)

    Particle radius.

    Returns

    DiscreteSphere object

    Return type

    DiscreteSphere

    Example

    To create a new discrete sphere in model m with nid = 100, pid = 400, mass = 0.9, inertia = 2.5, radius = 2.0: 

    var dsph = new DiscreteSphere(m, 100, 400, 0.9, 2.5, 2.0);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a discrete sphere.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the discrete sphere

    Returns

    No return value

    Example

    To associate comment c to the discrete sphere dsph: 

    dsph.AssociateComment(c);

    Blank()

    Description

    Blanks the discrete sphere

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank discrete sphere dsph: 

    dsph.Blank();

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

    Description

    Blanks all of the discrete spheres in the model.

    Arguments

  • Model (Model)

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

    DiscreteSphere.BlankAll(m);

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

    Description

    Blanks all of the flagged discrete spheres in the model.

    Arguments

  • Model (Model)

    Model that all the flagged discrete spheres will be blanked in

  • flag (Flag)

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

    DiscreteSphere.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the discrete sphere is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if discrete sphere dsph is blanked: 

    if (dsph.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 discrete sphere dsph: 

    dsph.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the discrete sphere.

    Arguments

  • flag (Flag)

    Flag to clear on the discrete sphere

    Returns

    No return value

    Example

    To clear flag f for discrete sphere dsph: 

    dsph.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    DiscreteSphere object

    Return type

    DiscreteSphere

    Example

    To copy discrete sphere dsph into discrete sphere z: 

    var z = dsph.Copy();

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

    Description

    Starts an interactive editing panel to create a discrete sphere

    Arguments

  • Model (Model)

    Model that the discrete sphere 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

    DiscreteSphere object (or null if not made).

    Return type

    DiscreteSphere

    Example

    To start creating a discrete sphere in model m: 

    var dsph = DiscreteSphere.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a discrete sphere.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the discrete sphere

    Returns

    No return value

    Example

    To detach comment c from the discrete sphere dsph: 

    dsph.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 discrete sphere dsph: 

    dsph.Edit();

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

    Description

    Adds an error for discrete sphere. 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 discrete sphere dsph: 

    dsph.Error("My custom error");

    ExtractColour()

    Description

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

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing discrete sphere dsph: 

    var colour = dsph.ExtractColour();

    First(Model[Model]) [static]

    Description

    Returns the first discrete sphere in the model.

    Arguments

  • Model (Model)

    Model to get first discrete sphere in

    Returns

    DiscreteSphere object (or null if there are no discrete spheres in the model).

    Return type

    DiscreteSphere

    Example

    To get the first discrete sphere in model m: 

    var dsph = DiscreteSphere.First(m);

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

    Description

    Returns the first free discrete sphere label in the model. Also see DiscreteSphere.LastFreeLabel(), DiscreteSphere.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

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

    DiscreteSphere label.

    Return type

    Number

    Example

    To get the first free discrete sphere label in model m: 

    var label = DiscreteSphere.FirstFreeLabel(m);

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

    Description

    Flags all of the discrete spheres in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all discrete spheres will be flagged in

  • flag (Flag)

    Flag to set on the discrete spheres

    Returns

    No return value

    Example

    To flag all of the discrete spheres with flag f in model m: 

    DiscreteSphere.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the discrete sphere is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the discrete sphere

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if discrete sphere dsph has flag f set on it: 

    if (dsph.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all discrete spheres are in

  • func (function)

    Function to call for each discrete sphere

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

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

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get discrete spheres from

  • property (optional) (string)

    Name for property to get for all discrete spheres in the model

    Returns

    Array of DiscreteSphere objects or properties

    Return type

    Array

    Example

    To make an array of DiscreteSphere objects for all of the discrete spheres in model m: 

    var a = DiscreteSphere.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a discrete sphere.

    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 discrete sphere dsph: 

    var comm_array = dsph.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get discrete spheres from

  • flag (Flag)

    Flag set on the discrete spheres that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged discrete spheres in the model

    Returns

    Array of DiscreteSphere objects or properties

    Return type

    Array

    Example

    To make an array of DiscreteSphere objects for all of the discrete spheres in model m flagged with f: 

    var dsph = DiscreteSphere.GetFlagged(m, f);

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

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

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

    Description

    Returns the DiscreteSphere object for a discrete sphere ID.

    Arguments

  • Model (Model)

    Model to find the discrete sphere in

  • number (integer)

    number of the discrete sphere you want the DiscreteSphere object for

    Returns

    DiscreteSphere object (or null if discrete sphere does not exist).

    Return type

    DiscreteSphere

    Example

    To get the DiscreteSphere object for discrete sphere 100 in model m 

    var dsph = DiscreteSphere.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    discrete sphere property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if DiscreteSphere property dsph.example is a parameter: 

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

    To check if DiscreteSphere property dsph.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this discrete sphere (*ELEMENT_DISCRETE_SPHERE or *ELEMENT_DISCRETE_SPHERE_VOLUME). Note that a carriage return is not added. See also DiscreteSphere.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for discrete sphere dsph: 

    var key = dsph.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for discrete sphere dsph: 

    var cards = dsph.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last discrete sphere in the model.

    Arguments

  • Model (Model)

    Model to get last discrete sphere in

    Returns

    DiscreteSphere object (or null if there are no discrete spheres in the model).

    Return type

    DiscreteSphere

    Example

    To get the last discrete sphere in model m: 

    var dsph = DiscreteSphere.Last(m);

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

    Description

    Returns the last free discrete sphere label in the model. Also see DiscreteSphere.FirstFreeLabel(), DiscreteSphere.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

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

    DiscreteSphere label.

    Return type

    Number

    Example

    To get the last free discrete sphere label in model m: 

    var label = DiscreteSphere.LastFreeLabel(m);

    Next()

    Description

    Returns the next discrete sphere in the model.

    Arguments

    No arguments

    Returns

    DiscreteSphere object (or null if there are no more discrete spheres in the model).

    Return type

    DiscreteSphere

    Example

    To get the discrete sphere in model m after discrete sphere dsph: 

    var dsph = dsph.Next();

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

    Description

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

    Arguments

  • Model (Model)

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

    DiscreteSphere label.

    Return type

    Number

    Example

    To get the next free discrete sphere label in model m: 

    var label = DiscreteSphere.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 discrete sphere.

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

    DiscreteSphere object (or null if not picked)

    Return type

    DiscreteSphere

    Example

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

    var dsph = DiscreteSphere.Pick('Pick discrete sphere from screen', m);

    Previous()

    Description

    Returns the previous discrete sphere in the model.

    Arguments

    No arguments

    Returns

    DiscreteSphere object (or null if there are no more discrete spheres in the model).

    Return type

    DiscreteSphere

    Example

    To get the discrete sphere in model m before discrete sphere dsph: 

    var dsph = dsph.Previous();

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

    Description

    Allows the user to select discrete spheres using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting discrete spheres

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    DiscreteSphere.Select(f, 'Select discrete spheres', m);

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

    DiscreteSphere.Select(f, 'Select discrete spheres', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the discrete sphere.

    Arguments

  • flag (Flag)

    Flag to set on the discrete sphere

    Returns

    No return value

    Example

    To set flag f for discrete sphere dsph: 

    dsph.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch discrete sphere dsph: 

    dsph.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged discrete spheres will be sketched in

  • flag (Flag)

    Flag set on the discrete spheres that you want to sketch

  • redraw (optional) (boolean)

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

    DiscreteSphere.SketchFlagged(m, flag);

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

    Description

    Returns the total number of discrete spheres in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of discrete spheres

    Return type

    Number

    Example

    To get the total number of discrete spheres in model m: 

    var total = DiscreteSphere.Total(m);

    Unblank()

    Description

    Unblanks the discrete sphere

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank discrete sphere dsph: 

    dsph.Unblank();

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

    Description

    Unblanks all of the discrete spheres in the model.

    Arguments

  • Model (Model)

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

    DiscreteSphere.UnblankAll(m);

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

    Description

    Unblanks all of the flagged discrete spheres in the model.

    Arguments

  • Model (Model)

    Model that the flagged discrete spheres will be unblanked in

  • flag (Flag)

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

    DiscreteSphere.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the discrete spheres in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all discrete spheres will be unset in

  • flag (Flag)

    Flag to unset on the discrete spheres

    Returns

    No return value

    Example

    To unset the flag f on all the discrete spheres in model m: 

    DiscreteSphere.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the discrete sphere.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch discrete sphere dsph: 

    dsph.Unsketch();

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

    Description

    Unsketches all discrete spheres.

    Arguments

  • Model (Model)

    Model that all discrete spheres will be unblanked in

  • redraw (optional) (boolean)

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

    DiscreteSphere.UnsketchAll(m);

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

    Description

    Unsketches all flagged discrete spheres in the model.

    Arguments

  • Model (Model)

    Model that all discrete spheres will be unsketched in

  • flag (Flag)

    Flag set on the discrete spheres that you want to unsketch

  • redraw (optional) (boolean)

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

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

    DiscreteSphere object.

    Return type

    DiscreteSphere

    Example

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

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

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

    Description

    Adds a warning for discrete sphere. 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 discrete sphere dsph: 

    dsph.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this discrete sphere.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for discrete sphere dsph: 

    var xrefs = dsph.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for discrete sphere dsph in keyword format 

    var s = dsph.toString();