Model

Model

new Model(unit_system, vertical_axis)

Create an s3d_model object.

Parameters:
Name Type Default Description
unit_system 'metric' | 'imperial'
vertical_axis "Y" | "Z" Y

Defaults to Y
Source:
Example
// Default for: metric | imperial:
{
 "length": "m" | 'ft',
 "section_length": "mm" | 'in',
 "material_strength": "mpa" | 'ksi',
 "density": "kg/m3" | 'lb/ft3',
 "force": "kn" | 'kip',
 "moment": "kn-m" | 'kip-ft',
 "pressure": "kpa" | 'ksf',
 "mass": "kg" | 'kip',
 "translation": "mm" | 'in',
 "stress": "mpa" | 'ksi'
}

Methods

(static) get()

Get the model in the format required by the SkyCiv API.

Source:

(static) set(model_object)

Set individual properties of the model object.

Parameters:
Name Type Description
model_object SkyCivModelObject

An object of key value pairs
Source:
Example
const model = new Model()
model.set({
 nodes: SkyCivNodesObject,
 members: "SkyCivMembersObject"
})

Type Definitions

SkyCivModelObject :Object

Properties:
Name Type Description
settings SettingsObject
nodes Object
members Object
plates Object
meshed_plates Object
sections Object
materials Object
supports Object
settlements Object
point_loads Object
moments Object
distributed_loads Object
pressures Object
area_loads Object
member_prestress_loads Object
self_weight Object
load_combinations Object
load_cases Object
nodal_masses Object
nodal_masses_conversion_map Object
spectral_loads Object
groups Object
Source: