FormIt Namespace Reference

Description

FormIt namespace.

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

Functions
json	SetFeatureFlag (featureName, enabled)
	Set a tool feature flag
json	HaveFeatureFlag (flag)
	Check if a feature flag exists
json	GetSnap ()
	Get snapping state.
json	SetSnap (bSnap)
	Set snapping state.
json	GetTouchEnabled ()
	Are touch interactions enabled?
json	SetTouchEnabled (bTouchEnabled)
	Enable touch interactions
json	ImportFile (sFileName, bGroupImport, nHistoryID, bKeepLevelsWhenGrouping)
	Imports the content of the given file.
json	OpenFile (sFileName)
	Open the given file.
json	LoadPreviewImage (sFileName)
	Load preview image of the given file.
json	SaveFile (sFileName, saveOptions, previewImage, forSave)
	Save the current model to the given file name.
json	SaveFileForEnergyAnalysis (sFileName)
	Save the current model to the given file name for energy analysis.
json	SetGeoLocationData (geodata)
	SetGeoLocationData() function.
json	SetRenderData (renderdata)
	SetRenderData() function.
json	GetTimeNow ()
	Get the time
json	NewFile (forced)
	Run the new file method
json	Version ()
	Get the version of FormIt.
json	SetCurveAccuracyOrCountDefault (accuracyORcount)
	Set the curve accuracy for the application.
json	GetCurveAccuracyOrCountDefault ()
	Get the curve accuracy for the application.
json	SetSurfaceAccuracyOrCountDefault (accuracyORcount)
	Set the surface accuracy for the application.
json	GetSurfaceAccuracyOrCountDefault ()
	Get the surface accuracy for the application.
json	GetAccuracyForQuarterCircle (accuracy)
	Get the accuracy for a quarter circle to be used to call SetCurveAccuracyOrCountDefault/SetSurfaceAccuracyOrCountDefault.
json	GetUnitTypeDefault ()
	Get the Application (as opposed to Model) UnitType.
json	SetUnitTypeDefault (unitType)
	Set the Application (as opposed to Model) UnitType.
json	IsWSRAvailable ()
	IsWSRAvailable() function.
json	SuspendMessaging (bSuppress, nTopLevelHistory, bFullUpdate)
	SuspendMessaging suspends all update messages from WSM until ResumeMessaging is called.
json	ResumeMessaging ()
	Resumes messaging that was suspended by a call to SuspendMessaging.
json	ChangeTargetBuildableArea (value)
	ChangeTargetBuildableArea() function.
json	GetBuildingType ()
	GetBuildingType() function.
json	SetBuildingType (value)
	SetBuildingType() function.
json	WriteAppDefaultContentToFile (id, path)
	WriteAppDefaultContentToFile() function.
json	DeleteImage (nHistoryID, imageID)
	DeleteImage() function.
json	HandleHUDTextInput (dimensionID, inputText)
	HandleHUDTextInput will handle the HUD input values Parameters: In: dimensionID Out: Boolean
json	GetAppDefaultContentsWithoutAXM ()
	GetAppDefaultContentsWithoutAXM() function.
json	SetKeyboardShortcutsEnabled (enabled)
	SetKeyboardShortcutsEnabled Enables/Disables Keyboard Shortcuts Parameters: In: enabled Out: JSON_UNDEFINED
json	GetShowEditableDimensions ()
	GetShowEditableDimensions returns true if editable dimensions are being displayed.
json	SetShowEditableDimensions (show)
	SetShowEditableDimensions sets if editable dimensions are being displayed.
json	GetVersion ()
	Retrieve the FormIt version number Parameters Out: FormIt.Version
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
json	ImportToGroup (sFileType, sFilePath)
	Import to a Group Parameters: In: string In: string Out: HistoryID
json	CallJS (funcName, paramsJSON)
	Execute the given function with the given params Parameters function, params (json) Out: string
json	SetLocaleForWeb (nameCode)
	Set the Locale for web client given locale type Parameters In string localType Out: undefined
json	CreateTextureFromPath (nHistoryID, sPath, bUseBitmapAlpha)
json	ConsoleLog (msg)
	Log the given msg to the FormIt console.
json	HandleTimerTick (fTime)
	Run a timer tick Out: JSON_UNDEFINED
json	HandleTimerTickSimple ()
	Run a timer tick Out: JSON_UNDEFINED
json	SetSendToRevitPreview (enabled)
	Set the Send to Revit preview mode state
json	GetSendToRevitPreview ()
	Get the Send to Revit preview mode state
json	SetNoInferenceSmoothEdgesAndPoints (enabled)
	Set the "No inferencing smooth edges and vertices" mode
json	GetNoInferenceSmoothEdgesAndPoints ()
	Get the "No inferencing smooth edges and vertices" mode
json	GetAsyncAPI ()
	Get the FormItAsync API
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);
json	SetPickrayApertureScale (scaleFactor)
	Set the pickray aperture scale factor.
json	GetPickrayApertureScale ()
	Get the pickray aperture scale factor.