FormIt Namespace Reference

Description

FormIt namespace.

Namespaces
	Analysis
	FormIt.Analysis namespace.
	AutoSave
	FormIt.AutoSave namespace.
	Cameras
	FormIt.Cameras namespace.
	Clipboard
	FormIt.Clipboard namespace.
	Collaboration
	FormIt.Collaboration namespace.
	Commands
	FormIt.Commands namespace.
	Configuration
	FormIt.Configuration namespace.
	Dynamo
	FormIt.Dynamo namespace.
	Files
	FormIt.Files namespace.
	FileSystem
	FormIt.FileSystem namespace.
	Forge
	FormIt.Forge namespace.
	GroupEdit
	FormIt.GroupEdit namespace.
	HUDManager
	FormIt.HUDManager namespace.
	ImageManager
	FormIt.ImageManager namespace.
	Layers
	FormIt.Layers namespace.
	Levels
	FormIt.Levels namespace.
	MaterialProvider
	FormIt.MaterialProvider namespace.
	Materials
	FormIt.Materials namespace.
	Messaging
	FormIt.Messaging namespace.
	Model
	FormIt.Model namespace.
	Scenes
	FormIt.Scenes namespace.
	SectionPlanes
	FormIt.SectionPlanes namespace.
	Selection
	FormIt.Selection namespace.
	Shortcuts
	FormIt.Shortcuts namespace.
	SketchMaterials
	FormIt.SketchMaterials namespace.
	Statistics
	FormIt.Statistics namespace.
	StringConversion
	FormIt.StringConversion namespace.
	SunAndLocation
	FormIt.SunAndLocation namespace.
	Tools
	FormIt.Tools namespace.
	UI
	FormIt.UI namespace.
	UndoManagement
	FormIt.UndoManagement namespace.
	Utils
	FormIt.Utils namespace.
	View
	FormIt.View namespace.
	VisualStyles
	FormIt.VisualStyles namespace.

Functions
json	GetSnap ()
	Get snapping state. More...
json	SetSnap (bSnap)
	Set snapping state. More...
json	GetTouchEnabled ()
	Are touch interactions enabled? More...
json	SetTouchEnabled (bTouchEnabled)
	Enable touch interactions. More...
json	ImportFile (sFileName, bGroupImport, nHistoryID, bKeepLevelsWhenGrouping)
	Imports the content of the given file. More...
json	OpenFile (sFileName)
	Open the given file. More...
json	LoadPreviewImage (sFileName)
	Load preview image of the given file. More...
json	SaveFile (sFileName, saveOptions, previewImage, forSave)
	Save the current model to the given file name. More...
json	SaveFileForEnergyAnalysis (sFileName)
	Save the current model to the given file name for energy analysis. More...
json	SetGeoLocationData (geodata)
	SetGeoLocationData() function. More...
json	SetRenderData (renderdata)
	SetRenderData() function. More...
json	GetTimeNow ()
	Get the time. More...
json	NewFile (forced)
	Run the new file method. More...
json	Version ()
	Get the version of FormIt. More...
json	SetCurveAccuracyOrCountDefault (accuracyORcount)
	Set the curve accuracy for the application. More...
json	GetCurveAccuracyOrCountDefault ()
	Get the curve accuracy for the application. More...
json	SetSurfaceAccuracyOrCountDefault (accuracyORcount)
	Set the surface accuracy for the application. More...
json	GetSurfaceAccuracyOrCountDefault ()
	Get the surface accuracy for the application. More...
json	GetAccuracyForQuarterCircle (accuracy)
	Get the accuracy for a quarter circle to be used to call SetCurveAccuracyOrCountDefault/SetSurfaceAccuracyOrCountDefault. More...
json	GetUnitTypeDefault ()
	Get the Application (as opposed to Model) UnitType. More...
json	SetUnitTypeDefault (unitType)
	Set the Application (as opposed to Model) UnitType. More...
json	IsWSRAvailable ()
	IsWSRAvailable() function. More...
json	SuspendMessaging (bSuppress, nTopLevelHistory, bFullUpdate)
	SuspendMessaging suspends all update messages from WSM until ResumeMessaging is called. More...
json	ResumeMessaging ()
	Resumes messaging that was suspended by a call to SuspendMessaging. More...
json	ChangeTargetBuildableArea (value)
	ChangeTargetBuildableArea() function. More...
json	GetBuildingType ()
	GetBuildingType() function. More...
json	SetBuildingType (value)
	SetBuildingType() function. More...
json	WriteAppDefaultContentToFile (id, path)
	WriteAppDefaultContentToFile() function. More...
json	DeleteImage (nHistoryID, imageID)
	DeleteImage() function. More...
json	HandleHUDTextInput (dimensionID, inputText)
	HandleHUDTextInput will handle the HUD input values Parameters: In: dimensionID Out: Boolean. More...
json	GetAppDefaultContentsWithoutAXM ()
	GetAppDefaultContentsWithoutAXM() function. More...
json	SetKeyboardShortcutsEnabled (enabled)
	SetKeyboardShortcutsEnabled Enables/Disables Keyboard Shortcuts Parameters: In: enabled Out: JSON_UNDEFINED. More...
json	GetShowEditableDimensions ()
	GetShowEditableDimensions returns true if editable dimensions are being displayed. More...
json	SetShowEditableDimensions (show)
	SetShowEditableDimensions sets if editable dimensions are being displayed. More...
json	GetVersion ()
	Retrieve the FormIt version number Parameters Out: FormIt.Version. More...
json	FindLatestVersion (versionJsonString, testVersion)
	Retrieve the latest version string from a plugin versions.json file passed as a string Parameters In: versionJsonString Out: The version json obj of the plugin to load. More...
json	ImportToGroup (sFileType, sFilePath)
	Import to a Group Parameters: In: string In: string Out: HistoryID. More...
json	CallJS (funcName, paramsJSON)
	Execute the given function with the given params Parameters function, params (json) Out: string. More...
json	SetLocaleForWeb (nameCode)
	Set the Locale for web client given locale type Parameters In string localType Out: undefined. More...
json	ConsoleLog (msg)
	Log the given msg to the FormIt console. More...
json	SetSendToRevitPreview (enabled)
	Set the Send to Revit preview mode state. More...
json	GetSendToRevitPreview ()
	Get the Send to Revit preview mode state. More...
json	SetNoInferenceSmoothEdgesAndPoints (enabled)
	Set the "No inferencing smooth edges and vertices" mode. More...
json	GetNoInferenceSmoothEdgesAndPoints ()
	Get the "No inferencing smooth edges and vertices" mode. More...
json	GetAsyncAPI ()
	Get the FormItAsync API. More...
json	RegisterAsyncAPI (NameSpace, APIName, Params)
	Register the given function for the async API For example: FormIt.RegisterAsyncAPI("HelloBlockAsync", "CreateBlock", "l, w, h"); This will expose an async API on the web side that can be called like: var result = await HelloBlockAsync.CreateBlock(l, w, h);. More...