Adding Your Own Features

Inside the HTML, JavaScript, and CSS Panels

When you click Edit in the Plugin Playground sample plugin, you will see the HTML, JavaScript (JS), and CSS panels. The HTML panel (left) enables you to modify the user interface of your plugin. The JS panel (middle) enables you to write functions that can communicate to FormIt using the FormIt JS Plugin API. Finally, the CSS panel (right) will determine the style of your HTML.

Adding a Function to Create a Cylinder

Let's add a feature to this plugin to create a cylinder.

First, let's configure the input field and UI button in the HTML panel. Copy the following code and paste it after line 23 and before <!-- Do not remove below scripts unless you know what you're doing- - >

This will add some basic UI elements to our plugin.

<p>Cylinder: Create a cylinder at the origin.</p>
<div>
    <input id="Radius" type=number value=2 />
    <label>Radius</label>
</div>
        
<div>
    <input id="CHeight" type=number value =0.5 />
    <label>Height</label>
</div>
        

<input id="CreateCylinderBtn" type=button value="Create Cylinder" />

Next, let's add two functions in our JS panel. Copy the following code and paste it at the end of the file (after line 16).

This will create a cylinder in our FormIt workspace.

// Create cylinder
const createCylinder = async (r,h) =>
{
    const posCenter = await WSM.Geom.Point3d(0,0,0);

    const histID = await FormIt.GroupEdit.GetEditingHistoryID();
    console.log(histID,posCenter,r,h);

    const cyl = await WSM.APICreateCylinder(histID,posCenter,r,h);
}


// Execute function when 'create cylinder' button is clicked
document.getElementById("CreateCylinderBtn").addEventListener("click", ()=>
{
    console.log('create cylinder clicked')

    const r = Number(document.getElementById("Radius").value);
    const h = Number(document.getElementById("CHeight").value);

    createCylinder(r,h);

});

Running and previewing

FormIt plugins API

For complete documentation on the FormIt plugins API, see the useful links section.

PreviousLaunching the Sample Plugin NextSaving Your Work to GitHub

Last updated 2 years ago

<p>Cylinder: Create a cylinder at the origin.</p> <div> <input id="Radius" type=number value=2 /> <label>Radius</label> </div> <div> <input id="CHeight" type=number value =0.5 /> <label>Height</label> </div> <input id="CreateCylinderBtn" type=button value="Create Cylinder" />

// Create cylinder const createCylinder = async (r,h) => { const posCenter = await WSM.Geom.Point3d(0,0,0); const histID = await FormIt.GroupEdit.GetEditingHistoryID(); console.log(histID,posCenter,r,h); const cyl = await WSM.APICreateCylinder(histID,posCenter,r,h); } // Execute function when 'create cylinder' button is clicked document.getElementById("CreateCylinderBtn").addEventListener("click", ()=> { console.log('create cylinder clicked') const r = Number(document.getElementById("Radius").value); const h = Number(document.getElementById("CHeight").value); createCylinder(r,h); });