FormIt Plugin API  17.0.1
FormIt API

Description

Modules

 FormIt.Layers API
 
 FormIt.Materials API
 
 FormIt.UndoManagement API
 
 FormIt.Utils API
 
 FormIt.Model API
 
 FormIt.GroupEdit API
 
 FormIt.Image API
 
 FormIt.Selection API
 
 FormIt.Clipboard API
 
 FormIt.Collaboration API
 
 FormIt.Cameras API
 
 FormIt.Tools API
 
 FormIt.Configuration 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
 
 FormIt.SunAndLocation 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.Image
 FormIt.Image 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.Configuration
 FormIt.Configuration 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.
 
 FormIt.SunAndLocation
 FormIt.SunAndLocation namespace.
 

Functions

json FormIt.GetSnap ()
 < EffectCache.EffectType 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, nHistoryID)
 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.StringToLinearValue (val)
 StringToLinearValue converts a string to a double Parameters: In: val Out: { success: result: }. More...
 
json FormIt.GetTimeNow ()
 Get the time. More...
 
json FormIt.SuspendMessaging (bSuppress, nTopLevelHistory)
 SuspendMessaging suspends all update messages from WSM until ResumeMessaging is called. More...
 
json FormIt.ResumeMessaging ()
 Resumes messaging that was suspended by a call to SuspendMessaging. More...
 
json FormIt.FitToModel (aIncludeImage)
 FitToModel() function. More...
 
json FormIt.FitToSelection ()
 FitToSelection() function. More...
 
json FormIt.HomeView3d ()
 HomeView3d() function. More...
 
json FormIt.TopView ()
 TopView() function. More...
 
json FormIt.ProjectionView (type)
 ProjectionView() function. More...
 
json FormIt.StoreAppSettingDefaultUnitType (unitType)
 Store the default unit type for a new project in the app settings. More...
 
json FormIt.SetNewProjectUnitType (unitType)
 Set the unit type for when a new project is created. More...
 
json FormIt.NewFile (forced)
 Run the new file method. More...
 
json FormIt.IsWSRAvailable ()
 IsWSRAvailable() function. More...
 

Function Documentation

json FormIt.FitToModel ( aIncludeImage  )

FitToModel() function.

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

FitToSelection() function.

Returns
JSON_UNDEFINED, i.e. {}
json FormIt.GetSnap ( )

< EffectCache.EffectType

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.HomeView3d ( )

HomeView3d() function.

Returns
JSON_UNDEFINED, i.e. {}
json FormIt.ImportFile ( sFileName  ,
bGroupImport  ,
nHistoryID   
)

Import the given file.

Parameters
[in]sFileNameString
[in]bGroupImportbool Group imported file (OPTIONAL)
[in]nHistoryIDHistory to import into (OPTIONAL)
Returns
bool Success
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.NewFile ( forced  )

Run the new file method.

Parameters
[in]forcedIf its forced (OPTIONAL)
Returns
JSON_UNDEFINED
json FormIt.OpenFile ( sFileName  )

Open the given file.

Parameters
[in]sFileNameString
Returns
bool Success
json FormIt.ProjectionView ( type  )

ProjectionView() function.

Parameters
[in]typeFormIt.CameraProjectionType
Returns
JSON_UNDEFINED, i.e. {}
json FormIt.ResumeMessaging ( )

Resumes messaging that was suspended by a call to SuspendMessaging.

Returns
JSON_UNDEFINED, i.e. {}
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.SetNewProjectUnitType ( unitType  )

Set the unit type for when a new project is created.

Parameters
[in]unitTypeFormIt.UnitType
Returns
JSON_UNDEFINED
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.StoreAppSettingDefaultUnitType ( unitType  )

Store the default unit type for a new project in the app settings.

Parameters
[in]unitTypeFormIt.UnitType
Returns
JSON_UNDEFINED
json FormIt.StringToLinearValue ( val  )

StringToLinearValue converts a string to a double Parameters: In: val Out: { success: result: }.

Parameters
[in]valString
Returns
{...}
json FormIt.SuspendMessaging ( bSuppress  ,
nTopLevelHistory   
)

SuspendMessaging suspends all update messages from WSM until ResumeMessaging is called.

The top level history ID provided is included in the kLoadComplete message sent upon resume. This tells the receiver of the message into which history the load was done. The bSuppress parameter can be set to false to indicate that the object should not take effect. This is used to allow run-time determination. Parameters: In: bSuppress In: nTopLevelHistory (OPTIONAL) Out: JSON_UNDEFINED

Parameters
[in]bSuppressbool
[in]nTopLevelHistory(OPTIONAL, default = WSM.INVALID_ID) int
Returns
JSON_UNDEFINED, i.e. {}
json FormIt.TopView ( )

TopView() function.

Returns
JSON_UNDEFINED, i.e. {}