CrossSection class

Returns

CrossSection object

Return type

CrossSection

Example

To create a new Database cross section 500 called "test cross_section" of type _SET in model m with nsid, hsid, bsid, ssid, tsid, dsid, id, itype set to 11, 12, 13, 14, 15, 16, 17, 2 respectively:

var c = new CrossSection(m, CrossSection.SET, 11, 12, 13, 14, 15, 16, 17, 2, 500, "test cross_section");

new CrossSection(Model[Model], option[constant], psid[integer], xct[real], yct[real], zct[real], xch[real], ych[real], zch[real], xhev[real], yhev[real], zhev[real], lenl (optional)[real], lenm (optional)[real], id (optional)[integer], itype (optional)[integer], csid (optional)[integer], heading (optional)[string], autosize (optional)[boolean], autosize_pct (optional)[real])   [deprecated]

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

Description

Create a new CrossSection object for *DATABASE_CROSS_SECTION_PLANE.

Returns

CrossSection object

Return type

CrossSection

Example

To create a new Database cross section 500 called "test cross_section" of type _PLANE in model m with part set ID 100, normal tail (10, 20, 30), normal head (20, 20, 30), head of edge vector (10, 30, 30) and edge lengths 50 and 100:

var c = new CrossSection(m, CrossSection.PLANE, 100, 10, 20, 30, 20, 20, 30, 10, 30, 30, 50, 100, 0, 0, 500, "test cross_section");

new CrossSection(Model[Model], option[constant], settings[object])

Description

Create a new CrossSection object.

Returns

CrossSection object

Return type

CrossSection

Example

To create a new Database cross section 500 called "test cross_section" of type _SET in model m with nsid, hsid, bsid, ssid, tsid, dsid, id, itype set to 11, 12, 13, 14, 15, 16, 17, 2 respectively:

var settings = { nsid: 11, hsid: 12, bsid: 13, ssid: 14, tsid: 15, dsid: 16, id: 17, itype: 2, heading: "test_cross_section" };
var c = new CrossSection(m, CrossSection.SET, settings);

To create a new Database cross section 500 called "test cross_section" of type _PLANE in model m with part set ID 100, normal tail (10, 20, 30), normal head (20, 20, 30), head of edge vector (10, 30, 30) and edge lengths 50 and 100:

var settings = { psid: 100, id: 500, heading: "test cross_section",
                 xct: 10, yct: 20, zct: 30, 
                 xch: 20, ych: 20, zch: 30, 
                 xhev: 10, yhev: 30, zhev: 30, 
                 lenl: 50, lenm: 100 };

var c = new CrossSection(m, CrossSection.PLANE, settings);

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a cross section.

Returns

No return value

Example

To associate comment c to the cross section c:

c.AssociateComment(c);

Autosize(options (optional)[object])

Description

Autosizes a _PLANE cross section such that it cuts through all elements in model/psid along that plane.

Returns

No return value

Example

To autosize a cross section:

var xsec = CrossSection.GetFromID(model, id);

if(xsec.option == CrossSection.PLANE) xsec.Autosize();

To autosize a cross section, scaled by an additional 5 percent, and ignoring element visiblity:

var xsec = CrossSection.GetFromID(model, id);

var options = { percentage: 5.0, vis_only: false };
if(xsec.option == CrossSection.PLANE) xsec.Autosize(options);

Blank()

Description

Blanks the cross section

Returns

No return value

Example

To blank cross section c:

c.Blank();

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

Description

Blanks all of the cross sections in the model.

Returns

No return value

Example

To blank all of the cross sections in model m:

CrossSection.BlankAll(m);

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

Description

Blanks all of the flagged cross sections in the model.

Returns

No return value

Example

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

CrossSection.BlankFlagged(m, f);

Blanked()

Description

Checks if the cross section is blanked or not.

Returns

true if blanked, false if not.

Return type

Boolean

Example

To check if cross section c is blanked:

if (c.Blanked() ) do_something...

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Returns

no return value

Example

To Browse cross section c:

c.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the cross section.

Returns

No return value

Example

To clear flag f for cross section c:

c.ClearFlag(f);

Copy(range (optional)[boolean])

Description

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

Returns

CrossSection object

Return type

CrossSection

Example

To copy cross section c into cross section z:

var z = c.Copy();

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

Description

Starts an interactive editing panel to create a cross section

Returns

CrossSection object (or null if not made).

Return type

CrossSection

Example

To start creating a cross section in model m:

var c = CrossSection.Create(m);

CreateAlongFeatureLine(Model[Model], nid1[integer], options[object]) [static]

Description

Creates a set of cross sections along a feature line and returns them as an array of CrossSection objects. Use Options.edge_angle to control the break angle for the feature line search within this function.

Returns

Array of CrossSection objects (or null if not made). Depending on the geometry of the model and the node provided for nid1, the array may contain less CrossSection objects than requested for the single node method.

Return type

Array

Example

To create 10 autosized cross sections, separated by 15.0, in the positive direction, starting at Node 1:

var options = { num: 10, pitch: 15.0, direction: 1, autosize: true };
      var xsec_array = CrossSection.CreateAlongFeatureLine(model, 1, options);

To create 5 circular cross sections, of radius 25.0, around an entire perimeter edge (starting at Node 2):

var options = { num: 5, nid2: 2, radius: 25.0 };
      var xsec_array = CrossSection.CreateAlongFeatureLine(model, 2, options);

To create a set of cross sections separated by 10.0, of size 50.0 x 50.0, between nodes 3 and 4 (starting at Node 3):

var options = { pitch: 10.0, lenm: 50.0, lenl: 50.0, nid2: 4 };
      var xsec_array = CrossSection.CreateAlongFeatureLine(model, 3, options);

DetachComment(Comment[Comment])

Description

Detaches a comment from a cross section.

Returns

No return value

Example

To detach comment c from the cross section c:

c.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Returns

no return value

Example

To Edit cross section c:

c.Edit();

ElemCut(Shell label[integer])

Description

Returns coordinates of the intersections between a shell and a database cross section. Note, ElemCut on the Shell class may be quicker

Returns

An array containing the x1,y1,z1,x2,y2,z2 coordinates of the cut line, or NULL if it does not cut. Note this function does not check that the shell is in the cross section definition (part set)

Return type

Array

Example

To get the cut line coordinates between database cross section x and shell 300:

var data = x.ElemCut(300)

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

Description

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

Returns

No return value

Example

To add an error message "My custom error" for cross section c:

c.Error("My custom error");

ExtractColour()

Description

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

Returns

colour value (integer)

Return type

Number

Example

To return the colour used for drawing cross section c:

var colour = c.ExtractColour();

First(Model[Model]) [static]

Description

Returns the first cross section in the model.

Returns

CrossSection object (or null if there are no cross sections in the model).

Return type

CrossSection

Example

To get the first cross section in model m:

var c = CrossSection.First(m);

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

Description

Returns the first free cross section label in the model. Also see CrossSection.LastFreeLabel(), CrossSection.NextFreeLabel() and Model.FirstFreeItemLabel().

Returns

CrossSection label.

Return type

Number

Example

To get the first free cross section label in model m:

var label = CrossSection.FirstFreeLabel(m);

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

Description

Flags all of the cross sections in the model with a defined flag.

Returns

No return value

Example

To flag all of the cross sections with flag f in model m:

CrossSection.FlagAll(m, f);

FlagCut(Flag[Flag])

Description

Flags every element (solid,shell,tshell,beam) cut by the cross section. Note this function does not check that the element is in the cross section definition (part set)

Returns

Boolean.

Return type

Boolean

Example

To find elements cut by database cross section x:

x.FlagCut(flag)

Flagged(flag[Flag])

Description

Checks if the cross section is flagged or not.

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if cross section c has flag f set on it:

if (c.Flagged(f) ) do_something...

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

Description

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

Returns

No return value

Example

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

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

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

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

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

Description

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

Returns

Array of CrossSection objects or properties

Return type

Array

Example

To make an array of CrossSection objects for all of the cross sections in model m:

var a = CrossSection.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a cross section.

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 cross section c:

var comm_array = c.GetComments();

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

Description

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

Returns

Array of CrossSection objects or properties

Return type

Array

Example

To make an array of CrossSection objects for all of the cross sections in model m flagged with f:

var c = CrossSection.GetFlagged(m, f);

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

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

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

Description

Returns the CrossSection object for a cross section ID.

Returns

CrossSection object (or null if cross section does not exist).

Return type

CrossSection

Example

To get the CrossSection object for cross section 100 in model m

var c = CrossSection.GetFromID(m, 100);

GetParameter(prop[string])

Description

Checks if a CrossSection 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 CrossSection.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 CrossSection property c.example is a parameter:

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

To check if CrossSection property c.example is a parameter by using the GetParameter method:

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

Keyword()

Description

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

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for cross_section c:

var key = c.Keyword();

KeywordCards()

Description

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

Returns

string containing the cards.

Return type

String

Example

To get the cards for cross_section c:

var cards = c.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last cross section in the model.

Returns

CrossSection object (or null if there are no cross sections in the model).

Return type

CrossSection

Example

To get the last cross section in model m:

var c = CrossSection.Last(m);

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

Description

Returns the last free cross section label in the model. Also see CrossSection.FirstFreeLabel(), CrossSection.NextFreeLabel() and see Model.LastFreeItemLabel()

Returns

CrossSection label.

Return type

Number

Example

To get the last free cross section label in model m:

var label = CrossSection.LastFreeLabel(m);

Next()

Description

Returns the next cross section in the model.

Returns

CrossSection object (or null if there are no more cross sections in the model).

Return type

CrossSection

Example

To get the cross section in model m after cross section c:

var c = c.Next();

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

Description

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

Returns

CrossSection label.

Return type

Number

Example

To get the next free cross section label in model m:

var label = CrossSection.NextFreeLabel(m);

PartCut(Part label[integer], Flag (optional)[Flag])

Description

Returns true if cross section is cutting the part, false otherwise. If option flag is active, will flag every element of the part cut by the cross section. Note this function does not check that the part is in the cross section definition (part set)

Returns

Boolean.

Return type

Boolean

Example

To know if a database cross section x cuts part 300:

x.PartCut(300)

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

Description

Allows the user to pick a cross section.

Returns

CrossSection object (or null if not picked)

Return type

CrossSection

Example

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

var c = CrossSection.Pick('Pick cross section from screen', m);

Previous()

Description

Returns the previous cross section in the model.

Returns

CrossSection object (or null if there are no more cross sections in the model).

Return type

CrossSection

Example

To get the cross section in model m before cross section c:

var c = c.Previous();

Properties()

Description

Returns an object which describe various cross section properties

Returns

Example

To get the cross section properties for section c:

var properties = c.Properties();
    var originX  = properties.origin_x;	
    var originY  = properties.origin_y;
    var Xc = properties.xc;
    var Ixx = properties.ixx;
    var Iuu = properties.iuu;
    var Theta = properties.theta;
    var plastic_Mxx = properties.fully_plastic_mxx;

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

Description

Renumbers all of the cross sections in the model.

Returns

No return value

Example

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

CrossSection.RenumberAll(m, 1000000);

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

Description

Renumbers all of the flagged cross sections in the model.

Returns

No return value

Example

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

CrossSection.RenumberFlagged(m, f, 1000000);

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

Description

Allows the user to select cross sections using standard PRIMER object menus.

Returns

Number of cross sections selected or null if menu cancelled

Return type

Number

Example

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

CrossSection.Select(f, 'Select cross sections', m);

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

CrossSection.Select(f, 'Select cross sections', l);

SetFlag(flag[Flag])

Description

Sets a flag on the cross section.

Returns

No return value

Example

To set flag f for cross section c:

c.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

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

Returns

No return value

Example

To sketch cross section c:

c.Sketch();

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

Description

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

Returns

No return value

Example

To sketch all cross sections flagged with flag in model m:

CrossSection.SketchFlagged(m, flag);

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

Description

Returns the total number of cross sections in the model.

Returns

number of cross sections

Return type

Number

Example

To get the total number of cross sections in model m:

var total = CrossSection.Total(m);

Unblank()

Description

Unblanks the cross section

Returns

No return value

Example

To unblank cross section c:

c.Unblank();

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

Description

Unblanks all of the cross sections in the model.

Returns

No return value

Example

To unblank all of the cross sections in model m:

CrossSection.UnblankAll(m);

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

Description

Unblanks all of the flagged cross sections in the model.

Returns

No return value

Example

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

CrossSection.UnblankFlagged(m, f);

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

Description

Unsets a defined flag on all of the cross sections in the model.

Returns

No return value

Example

To unset the flag f on all the cross sections in model m:

CrossSection.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the cross section.

Returns

No return value

Example

To unsketch cross section c:

c.Unsketch();

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

Description

Unsketches all cross sections.

Returns

No return value

Example

To unsketch all cross sections in model m:

CrossSection.UnsketchAll(m);

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

Description

Unsketches all flagged cross sections in the model.

Returns

No return value

Example

To unsketch all cross sections flagged with flag in model m:

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

CrossSection object.

Return type

CrossSection

Example

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

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

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

Description

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

Returns

No return value

Example

To add a warning message "My custom warning" for cross section c:

c.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this cross section.

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for cross section c:

var xrefs = c.Xrefs();

toString()

Description

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

Returns

string

Return type

String

Example

To get data for cross_section c in keyword format

var s = c.toString();