Templates and Assemblies

The SkyCiv assembly library provides a series of functions that can be used to quickly model a structure. A multitude of functions are provided and can be sequentially invoked to create custom a structural model template.

Getting Started#

Include the skyciv-parametric-dist.js file on your page to get access to the parametric library. Download the sample file below and open it in a web browser to build a Gable Roof warehouse model using only the assembly library.

Sample Assemblies Functionality

`SKYCIV.structure.parametric.init`#

Pass in an assembly object or a model object and an assembly object into this function to build the overall assembly. This function will return a model object back

SKYCIV.structure.parametric.init({
    "assembly_obj" : assembly_obj,
    "model_data": model_data // optional
})

The Assembly Object#

The functions in this library require a specific input object that will be discussed through out this document. The assembly object is made from three parts, the input structure and requirements are explained in greater detail below. A skeleton assembly object is also provided below.

{
    "title" : "Assembly Title",
    "variables": {
        "variable_1" : {
            "value": , // float or truss_style
            "type": ,
        },
    },
    "steps": [
        {}, // defineCadLine obj, [Cad ID #1]
        {}, // defineCadTruss obj, [Cad ID #2]
        {}, // defineCadLine obj, [Cad ID #3]
        {}, // defineCadRepeat obj, [Cad ID #4]
        {}, // defineCadJoin obj, [Cad ID #5]
    ]
}

Variable Types#

Variable type can be either "float" or "truss_style".

The value of "truss_style" can be "warren", "gambrel" ,"straight" ,"cross" or "pratt"

Steps#

The steps property governs how the model is built. Steps will be execute in the order they are provided. Each cad function generates a cad element.

Cad Line Function#

The Cad Line function allows users to generate a member based on a certain set of inputs. This function can be called three ways and each way requires different set of inputs.

By Vector
By Points
By Angle

cad-line-function.json

const stepCadLine = {
    cad_type: 'cad_line',
    type: 'vector',
    ref_pt: [1, 2, 3], // or {x : 1, y: 1, z: 1} or {cad_id : "2_1", cad_perc: 33},
    vector: [0, 1, 0], // or {x : 0, y: 1, z: 0},
    supports: ['0', 'FFFFFF'], // or ["100", "FFFFFF"] or ["all", "FFFFFF"]
    segments: 3,
    length: 4,
    section_id: 1,
};

Cad Plate Function#

Users can add parametric plates that are dynamic and move with the rest of the structure. Cad Plates are built on points only.

cad-plate-function.json

const stepCadPlate = {
    cad_type: 'cad_plate',
    type: 'points',
    points: [
        [0, 0, 0], // or {x : 0, y: 0, z: 0} or {cad_id : "2_1", cad_perc: 33},
        [0, 1, 0], // or {x : 0, y: 1, z: 0} or {cad_id : "2_1", cad_perc: 33},
        [1, 1, 0], // or {x : 1, y: 1, z: 0} or {cad_id : "2_1", cad_perc: 33},
        [1, 0, 0], // or {x : 1, y: 0, z: 0} or {cad_id : "2_1", cad_perc: 33},
    ],
    thickness: 3,
};

Cad Repeat Function#

The Cad Repeat function allows users to repeat existing cad elements in a certain direction or based on the points given. Cad functions to be repeated must be set before this function in the array of steps.

By Vector
By Points

cad-repeat-function.json

const stepCadRepeat = {
    cad_type: 'cad_repeat',
    type: 'vector',
    repetitions: 3,
    ref_ids: ['1', '1_1'],
    vector: [0, 1, 0], // or {x: 1, y: 2, z: 1},
    length: 2,
};

Cad Rotate Function#

The Cad Rotate function allows users to rotate existing cad elements. Similar to cad repeat, cad functions to be rotated must be set before this function in the array of steps.

cad-rotate-function.json

const stepCadRotate = {
    cad_type: 'cad_rotate',
    axis: 'y',
    angle: '180',
    repetitions: 1,
    ref_ids: ['1', '1_1'],
};

Cad Curve Function#

The Cad Curve function allows users to generate curve members when given a certain inputs. This function can be called by specifying the arc to rotate about or the start and end points of the curve.

By CenterArc
By StartEnd

cad-curve-function.json

const stepCadCurve = {
    cad_type: 'cad_curve',
    type: 'centerarc',
    center_pt: [0, 1, 0], // or {x: 1, y: 2, z: 1} or {cad_id : "2_1", cad_perc: 33},
    radius: 10,
    directions: ['x', 'y'], // Length then height direction
    angle: 360,
    segments: 3,
    section_id: 1,
};

Cad Join Function#

The Cad Join function allows users to join nodes and nodes of any existing cad elements to another set of nodes.

cad-join-function.json

const stepCadJoin = {
    cad_type: 'cad_join',
    style: 'straight',
    segments: 1,
    set_1: [
        [0, 0, 1], // or { x: 1, y: 2, z: 3 },
        [0, 0, 1], // or { x: 1, y: 2, z: 3 },
        [0, 0, 1], // or { x: 1, y: 2, z: 3 },
    ],
    // or
    set_1: { cad_id: '1' },
    // or
    set_2: [
        [0, 0, 1], // or { x: 1, y: 2, z: 3 },
        [0, 0, 1], // or { x: 1, y: 2, z: 3 },
        [0, 0, 1], // or { x: 1, y: 2, z: 3 },
    ],
    //or
    set_2: {
        cad_id: '2',
    },
    reverse: true,
    section_id: 1,
};

Cad Truss Function#

The Cad Truss function allows users to create trusses based on given input. It can generate 3D trusses when given nodes or 2D trusses when given parameters.

By Nodes
By 2D

cad-truss-function.json

const stepCadTruss = {
    cad_type: 'cad_truss',
    type: 'nodes',
    start_pts: [
        [0, 1, 0], // or {x: 1, y: 2, z: 1} or {cad_id : "2_1", cad_perc: 33},
        [0, 1, 0], // or {x: 1, y: 2, z: 1} or {cad_id : "2_1", cad_perc: 33},
    ],
    end_pts: [
        [0, 1, 0], // or {x: 1, y: 2, z: 1} or {cad_id : "2_1", cad_perc: 33},
        [0, 1, 0], // or {x: 1, y: 2, z: 1} or {cad_id : "2_1", cad_perc: 33},
    ],
    bays: 3,
    web_section_id: 1,
    chord_section_id: 2,
    style: 'straight',
};