Part class

Returns

Part object

Return type

Part

Example

To create a new part called 'Example' in model m with label 100, section 1, material 10:

var p = new Part(m, 100, 1, 10, 'Example');

Details of functions

AllTableProperties(Model[Model]) [static]

Description

Returns all of the properties available in the part table for the parts. The table values are returned in an array of objects (an object for each part). The object property names are the same as the table headers but spaces are replaced with underscore characters and characters other than 0-9, a-z and A-Z are removed to ensure that the property name is valid in JavaScript. If a table value is undefined the property value will be the JavaScript undefined value. If the table value is a valid number it will be a number, otherwise the value will returned as a string.

Returns

Array of objects

Return type

Array

Example

To get all of the properties for parts in model m:

var properties = Part.AllTableProperties(m);
for (var p=0; p<properties.length; p++)
{
    for (var x in properties[p])
    {
        Message(x+"="+properties[p][x]);
    }
}

AssociateComment(Comment[Comment])

Description

Associates a comment with a part.

Returns

No return value

Example

To associate comment c to the part p:

p.AssociateComment(c);

Blank()

Description

Blanks the part

Returns

No return value

Example

To blank part p:

p.Blank();

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

Description

Blanks all of the parts in the model.

Returns

No return value

Example

To blank all of the parts in model m:

Part.BlankAll(m);

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

Description

Blanks all of the flagged parts in the model.

Returns

No return value

Example

To blank all of the parts in model m flagged with f:

Part.BlankFlagged(m, f);

Blanked()

Description

Checks if the part is blanked or not.

Returns

true if blanked, false if not.

Return type

Boolean

Example

To check if part p is blanked:

if (p.Blanked() ) do_something...

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Returns

no return value

Example

To Browse part p:

p.Browse();

CentreOfGravity(options (optional)[object])

Description

Returns the centre of gravity for a part.

Returns

An array containing the x, y and z coordinates for the CofG.

Return type

Array

Example

To get the centre of gravity for part p with options configured:

var cofg = p.CentreOfGravity({constrainedparts:false, transfermass:true, lumpedmass:false, nrbmass:true, timestepmass:false, plot:true});
var x = cofg[0];
var y = cofg[1];
var z = cofg[2];
      

CentreOfGravity(option (optional)[boolean])   [deprecated]

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

Description

Returns the centre of gravity for a part. Rigid parts will always include mass of constrained parts.
Mass is transferred from deformable to rigid when nodes attach.

Returns

An array containing the x, y and z coordinates for the CofG.

Return type

Array

Example

To get the centre of gravity for part p:

var cofg = p.CentreOfGravity();
            var x = cofg[0];
            var y = cofg[1];
            var z = cofg[2];
      

ClearFlag(flag[Flag])

Description

Clears a flag on the part.

Returns

No return value

Example

To clear flag f for part p:

p.ClearFlag(f);

ClosestNode(x[real], y[real], z[real])

Description

Finds the Node on the part closest to a coordinate.

Returns

ID of Node or null if part has no nodes

Return type

Number

Example

To find the node on part p closest to point (1, 2, 3):

var n = p.ClosestNode(1, 2, 3);

Copy(range (optional)[boolean])

Description

Copies the part. The target include of the copied part can be set using Options.copy_target_include.

Returns

Part object

Return type

Part

Example

To copy part p into part z:

var z = p.Copy();

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

Description

Starts an interactive editing panel to create a part

Returns

Part object (or null if not made).

Return type

Part

Example

To start creating a part in model m:

var p = Part.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a part.

Returns

No return value

Example

To detach comment c from the part p:

p.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Returns

no return value

Example

To Edit part p:

p.Edit();

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

Description

Adds an error for part. For more details on checking see the Check class.

Returns

No return value

Example

To add an error message "My custom error" for part p:

p.Error("My custom error");

ExtractColour()

Description

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

Returns

colour value (integer)

Return type

Number

Example

To return the colour used for drawing part p:

var colour = p.ExtractColour();

First(Model[Model]) [static]

Description

Returns the first part in the model.

Returns

Part object (or null if there are no parts in the model).

Return type

Part

Example

To get the first part in model m:

var p = Part.First(m);

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

Description

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

Returns

Part label.

Return type

Number

Example

To get the first free part label in model m:

var label = Part.FirstFreeLabel(m);

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

Description

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

Returns

No return value

Example

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

Part.FlagAll(m, f);

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

Description

Flags all the unblanked parts in the model.

Returns

No return value

Example

To flag all unblanked parts in model m with flag f:

Part.FlagVisible(m, f);

Flagged(flag[Flag])

Description

Checks if the part is flagged or not.

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if part p has flag f set on it:

if (p.Flagged(f) ) do_something...

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

Description

Returns all of the properties available in the part table for the flagged parts. The table values are returned in an array of objects (an object for each part). The object property names are the same as the table headers but spaces are replaced with underscore characters and characters other than 0-9, a-z and A-Z are removed to ensure that the property name is valid in JavaScript. If a table value is undefined the property value will be the JavaScript undefined value. If the table value is a valid number it will be a number, otherwise the value will returned as a string.

Returns

Array of objects

Return type

Array

Example

To get all of the properties for parts in model m flagged with f:

var properties = Part.FlaggedTableProperties(m, f);
for (var p=0; p<properties.length; p++)
{
    for (var x in properties[p])
    {
        Message(x+"="+properties[p][x]);
    }
}

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

Description

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

Returns

No return value

Example

To call function test for all of the parts in model m:

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

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

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

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

Description

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

Returns

Array of Part objects or properties

Return type

Array

Example

To make an array of Part objects for all of the parts in model m:

var a = Part.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a part.

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 part p:

var comm_array = p.GetComments();

GetCompositeData(ipt[integer])

Description

Returns the composite data for an integration point in *PART_COMPOSITE.

Returns

An array containing the material id, thickness, beta angle and thermal material values. If the _COMPOSITE_LONG option is set, then the array returned will also contain the ply ID.

Return type

Array

Example

To get the composite data for the 3rd integration point for part p:

if (p.composite && p.nip >= 3)
{
    var ipt_data = p.GetCompositeData(2);
}

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

Description

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

Returns

Array of Part objects or properties

Return type

Array

Example

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

var p = Part.GetFlagged(m, f);

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

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

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

Description

Returns the Part object for a part ID.

Returns

Part object (or null if part does not exist).

Return type

Part

Example

To get the Part object for part 100 in model m

var p = Part.GetFromID(m, 100);

GetParameter(prop[string])

Description

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

Returns

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

Return type

Parameter

Example

To check if Part property p.example is a parameter:

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

To check if Part property p.example is a parameter by using the GetParameter method:

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

Keyword()

Description

Returns the keyword for this part (*PART, *PART_SCALAR or *PART_SCALAR_VALUE). Note that a carriage return is not added. See also Part.KeywordCards()

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for part p:

var key = p.Keyword();

KeywordCards()

Description

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

Returns

string containing the cards.

Return type

String

Example

To get the cards for part p:

var cards = p.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last part in the model.

Returns

Part object (or null if there are no parts in the model).

Return type

Part

Example

To get the last part in model m:

var p = Part.Last(m);

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

Description

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

Returns

Part label.

Return type

Number

Example

To get the last free part label in model m:

var label = Part.LastFreeLabel(m);

Mass()

Description

Returns the mass properties for a part.

Returns

Example

To get the structural mass for part p:

var mprops = p.Mass();
                        var struct_mass = mprops.Struct_Mass;

MaxMin()

Description

Returns the max and min bounds of a part

Returns

An array containing the xMin, xMax, yMin, yMax, zMin and zMax coordinates for a box bounding the part, or null if the bounds cannot be calculated (e.g. the part has no structural elements)

Return type

array

Example

To get the bounds for part p:

var bounds = p.MaxMin();
if (bounds) {
    xMin = bounds[0];
    xMax = bounds[1];
    yMin = bounds[2];
    yMax = bounds[3];
    zMin = bounds[4];
    zMax = bounds[5];
}

MeasurePartToPart(part1[Part], part2[Part]) [static]

Description

This static method measures the distance between two part objects contained in the same model or in two different models

Returns

Example

To measure the distance between part object p1 and part object p2:

var m = Part.MeasurePartToPart(p1, p2);
var d = m.distance;
var XComp = m.vector[0];
var YComp = m.vector[1];
var ZComp = m.vector[2];

Next()

Description

Returns the next part in the model.

Returns

Part object (or null if there are no more parts in the model).

Return type

Part

Example

To get the part in model m after part p:

var p = p.Next();

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

Description

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

Returns

Part label.

Return type

Number

Example

To get the next free part label in model m:

var label = Part.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 part.

Returns

Part object (or null if not picked)

Return type

Part

Example

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

var p = Part.Pick('Pick part from screen', m);

Previous()

Description

Returns the previous part in the model.

Returns

Part object (or null if there are no more parts in the model).

Return type

Part

Example

To get the part in model m before part p:

var p = p.Previous();

RemoveCompositeData(ipt[integer])

Description

Removes the composite data for an integration point in *PART_COMPOSITE.

Returns

No return value.

Example

To remove the composite data for the 3rd integration point for part p:

p.RemoveCompositeData(2);

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

Description

Renumbers all of the parts in the model.

Returns

No return value

Example

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

Part.RenumberAll(m, 1000000);

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

Description

Renumbers all of the flagged parts in the model.

Returns

No return value

Example

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

Part.RenumberFlagged(m, f, 1000000);

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

Description

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

Returns

Number of parts selected or null if menu cancelled

Return type

Number

Example

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

Part.Select(f, 'Select parts', m);

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

Part.Select(f, 'Select parts', l);

SetCompositeData(ipt[integer], mid[integer], thick[real], beta[real], tmid (optinal)[integer], plyid (optional)[integer], shrfac (optional)[real])

Description

Sets the composite data for an integration point in *PART_COMPOSITE.

Returns

No return value.

Example

To set the composite data for the 3rd integration point to mat 1, thickness 0.5 and angle 45, for part p:

p.SetCompositeData(2, 1, 0.5, 45);

SetFlag(flag[Flag])

Description

Sets a flag on the part.

Returns

No return value

Example

To set flag f for part p:

p.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

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

Returns

No return value

Example

To sketch part p:

p.Sketch();

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

Description

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

Returns

No return value

Example

To sketch all parts flagged with flag in model m:

Part.SketchFlagged(m, flag);

TableProperties()

Description

Returns all of the properties available for the part in the part table. The table values are returned in an object. The object property names are the same as the table headers but spaces are replaced with underscore characters and characters other than 0-9, a-z and A-Z are removed to ensure that the property name is valid in JavaScript. If a table value is undefined the property value will be the JavaScript undefined value. If the table value is a valid number it will be a number, otherwise the value will returned as a string.

Returns

object.

Return type

Object

Example

To get all of the properties for part p:

var properties = p.TableProperties();
for (var x in properties)
{
    Message(x+"="+properties[x]);
}

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

Description

Returns the total number of parts in the model.

Returns

number of parts

Return type

Number

Example

To get the total number of parts in model m:

var total = Part.Total(m);

Unblank()

Description

Unblanks the part

Returns

No return value

Example

To unblank part p:

p.Unblank();

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

Description

Unblanks all of the parts in the model.

Returns

No return value

Example

To unblank all of the parts in model m:

Part.UnblankAll(m);

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

Description

Unblanks all of the flagged parts in the model.

Returns

No return value

Example

To unblank all of the parts in model m flagged with f:

Part.UnblankFlagged(m, f);

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

Description

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

Returns

No return value

Example

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

Part.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the part.

Returns

No return value

Example

To unsketch part p:

p.Unsketch();

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

Description

Unsketches all parts.

Returns

No return value

Example

To unsketch all parts in model m:

Part.UnsketchAll(m);

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

Description

Unsketches all flagged parts in the model.

Returns

No return value

Example

To unsketch all parts flagged with flag in model m:

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

Returns

Part object.

Return type

Part

Example

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

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

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

Description

Adds a warning for part. For more details on checking see the Check class.

Returns

No return value

Example

To add a warning message "My custom warning" for part p:

p.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this part.

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for part p:

var xrefs = p.Xrefs();

toString()

Description

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

Returns

string

Return type

String

Example

To get data for part p in keyword format

var str = p.toString();