FormIt Plugin API  16.0.237
FormIt API

Description

Modules

 FormIt.Layers API
 
 FormIt.Materials API
 
 FormIt.UndoManagement API
 
 FormIt.Utils API
 
 FormIt.Model API
 
 FormIt.GroupEdit API
 
 FormIt.Selection API
 
 FormIt.Clipboard API
 
 FormIt.Collaboration API
 
 FormIt.Cameras API
 
 FormIt.Tools API
 
 FormIt.HUD API
 
 FormIt.Analysis API
 
 FormIt.Scenes API
 
 FormIt.Levels API
 
 FormIt.MaterialProvider API
 
 FormIt.SketchMaterials API
 
 FormIt.UI API
 
 FormIt.Commands API
 
 FormIt.Shortcuts API
 
 FormIt.Messaging API
 
 FormIt.VisualStyles API
 
 FormIt.Statistics API
 
 FormIt.Dynamo API
 
 FormIt.SectionPlanes API
 

Namespaces

 FormIt.Layers
 FormIt.Layers namespace.
 
 FormIt.Materials
 FormIt.Materials namespace.
 
 FormIt.UndoManagement
 FormIt.UndoManagement namespace.
 
 FormIt.Utils
 FormIt.Utils namespace.
 
 FormIt.Model
 FormIt.Model namespace.
 
 FormIt.GroupEdit
 FormIt.GroupEdit namespace.
 
 FormIt.Selection
 FormIt.Selection namespace.
 
 FormIt.Clipboard
 FormIt.Clipboard namespace.
 
 FormIt.Collaboration
 FormIt.Collaboration namespace.
 
 FormIt.Cameras
 FormIt.Cameras namespace.
 
 FormIt.Tools
 FormIt.Tools namespace.
 
 FormIt.HUD
 FormIt.HUD namespace.
 
 FormIt.Analysis
 FormIt.Analysis namespace.
 
 FormIt.Scenes
 FormIt.Scenes namespace.
 
 FormIt.Levels
 FormIt.Levels namespace.
 
 FormIt.MaterialProvider
 FormIt.MaterialProvider namespace.
 
 FormIt.SketchMaterials
 FormIt.SketchMaterials namespace.
 
 FormIt.UI
 FormIt.UI namespace.
 
 FormIt.Commands
 FormIt.Commands namespace.
 
 FormIt.Shortcuts
 FormIt.Shortcuts namespace.
 
 FormIt.Messaging
 FormIt.Messaging namespace.
 
 FormIt.VisualStyles
 FormIt.VisualStyles namespace.
 
 FormIt.Statistics
 FormIt.Statistics namespace.
 
 FormIt.Dynamo
 FormIt.Dynamo namespace.
 
 FormIt.SectionPlanes
 FormIt.SectionPlanes namespace.
 

Functions

json FormIt.GetSnap ()
 Get snapping state. More...
 
json FormIt.SetSnap (bSnap)
 Set snapping state. More...
 
json FormIt.GetTouchEnabled ()
 Are touch interactions enabled? More...
 
json FormIt.SetTouchEnabled (bTouchEnabled)
 Enable touch interactions. More...
 
json FormIt.ImportFile (sFileName, bGroupImport)
 Import the given file. More...
 
json FormIt.OpenFile (sFileName)
 Open the given file. More...
 
json FormIt.SaveFile (sFileName, saveOptions, previewImage)
 Save the current model to the given file name. More...
 
json FormIt.SetGeoLocationData (geodata)
 SetGeoLocationData() function. More...
 
json FormIt.SetRenderData (renderdata)
 SetRenderData() function. More...
 
json FormIt.LinearValueToString (val)
 LinearValueToString converts a double to a string Parameters: In: val Out: { unitValue }. More...
 
json FormIt.GetTimeNow ()
 Get the time. More...
 
json FormIt.UninstallPlugin (pluginURL)
 
json FormIt.InstallPlugin (pluginURL)
 InstallPlugin loads a plugin from the given URL. More...
 
json FormIt.IsWSRAvailable ()
 IsWSRAvailable() function. More...
 

Function Documentation

json FormIt.GetSnap ( )

Get snapping state.

Returns
true if snapping is on.
json FormIt.GetTimeNow ( )

Get the time.

Returns
The current time
json FormIt.GetTouchEnabled ( )

Are touch interactions enabled?

Returns
Returns true if touch interactions are enabled
json FormIt.ImportFile ( sFileName  ,
bGroupImport   
)

Import the given file.

Parameters
[in]sFileNameString
[in]bGroupImportbool Group imported file (OPTIONAL)
Returns
bool Success
json FormIt.InstallPlugin ( pluginURL  )

InstallPlugin loads a plugin from the given URL.

Parameters: In: url Out: JSON_UNDEFINED Example: FormIt.InstallPlugin("");

Parameters
[in]pluginURLString
Returns
JSON_UNDEFINED, i.e. {}
json FormIt.IsWSRAvailable ( )

IsWSRAvailable() function.

Returns
false
json FormIt.LinearValueToString ( val  )

LinearValueToString converts a double to a string Parameters: In: val Out: { unitValue }.

Parameters
[in]valdouble
Returns
unitValue
json FormIt.OpenFile ( sFileName  )

Open the given file.

Parameters
[in]sFileNameString
Returns
bool Success
json FormIt.SaveFile ( sFileName  ,
saveOptions  ,
previewImage   
)

Save the current model to the given file name.

Parameters
[in]sFileNameString
[in]saveOptions(OPTIONAL) FormIt.SaveOptions.AllObjectsWithHistory (default)
FormIt.SaveOptions-
FormIt.SaveOptions.AllObjects
FormIt.SaveOptions.AllObjectsWithHistory
FormIt.SaveOptions.VisibleOnly
FormIt.SaveOptions.SelectedOnly
[in]previewImage(OPTIONAL) Array of char
Returns
bool Success
json FormIt.SetGeoLocationData ( geodata  )

SetGeoLocationData() function.

Parameters
[in]geodataWSM.GeoLocationData
Returns
false
json FormIt.SetRenderData ( renderdata  )

SetRenderData() function.

Parameters
[in]renderdataWSM.RenderData
Returns
false ;
json FormIt.SetSnap ( bSnap  )

Set snapping state.

Parameters
[in]bSnapbool
Returns
JSON_UNDEFINED
json FormIt.SetTouchEnabled ( bTouchEnabled  )

Enable touch interactions.

Parameters
[in]bTouchEnabledbool
Returns
JSON_UNDEFINED
json FormIt.UninstallPlugin ( pluginURL  )