FormIt Plugin API
v23.0.0 (2023.0.0)
|
Functions | |
json | FormIt.Layers.GetAllLayers () |
json | FormIt.Layers.GetLayerData (layerID) |
GetLayerData gets the data for a single layer. More... | |
json | FormIt.Layers.GetAllLayerData () |
GetAllLayerData gets the data for all layers. More... | |
json | FormIt.Layers.AddLayer (historyID, layerName, visible) |
AddLayer creates a new layer in the given history. More... | |
json | FormIt.Layers.IsValid (layerID) |
IsValid returns whether a layer id is valid. More... | |
json | FormIt.Layers.SetLayersVisibility (aLayersVisibility) |
SetLayersVisibility sets the visibility of a vector of layers. More... | |
json | FormIt.Layers.SetLayerVisibility (layerName, visibility) |
SetLayerVisibility sets the visibility of layer with a given name and visibility toggle. More... | |
json | FormIt.Layers.LayerExists (layerName) |
LayerExists returns true if a layer with the given name exists. More... | |
json | FormIt.Layers.DeleteLayers (aLayerIDs) |
DeleteLayers deletes a list of layers. More... | |
json | FormIt.Layers.IsValidLayerName (layerID, newLayerName) |
IsValidLayerName checks whether the name is valid for a layer. More... | |
json | FormIt.Layers.SetLayerName (layerID, newLayerName) |
SetLayerName set a new name for the given layer. More... | |
json | FormIt.Layers.AssignLayerToObjects (layerID, aObjects) |
AssignLayerToObjects assigns a layer to a list of objects. More... | |
json | FormIt.Layers.RemoveLayersFromObjects (layerIDs, aObjects) |
RemoveLayersFromObjects removes all the layers in a vector from a vector of objects, regardless of whether any of the objects actually are assigned any of the layers. More... | |
json | FormIt.Layers.GetAllObjectsOnLayers (layerIDs, allHistories) |
GetAllObjectsOnLayers gets all objects that are on the given layers. More... | |
json | FormIt.Layers.ChangeLayerOrder (layerID, newPosition) |
ChangeLayerOrder gives a layer a new position in the list. More... | |
json | FormIt.Layers.GetObjectLayerID (nHistoryID, nObjectID) |
GetObjectLayerID returns the layer id for the object. More... | |
json | FormIt.Layers.IsValidObjectForLayerAssignment (nHistoryID, nObjectID) |
IsValidObjectForLayerAssignment returns whether the given object can be assigned a layer object must be top level (non owned) or a group instance. More... | |
json | FormIt.Layers.GetLayerList () |
GetLayerList gets a list of all layers as LayerData. More... | |
json | FormIt.Layers.GetObjectsLayerList (groupInstacePathArray, bIncludeNoLayer) |
GetObjectsLayerList returns the set of layers the given Objects are on. More... | |
json | FormIt.Layers.GetLayerID (layerName) |
GetLayerID returns the formit layer id from a layer name or WSM.INVALID_ID if a layer with that name does not exist. More... | |
json | FormIt.Layers.SetLayerPickable (layerID, pickable) |
Set the pickable status of a layer. More... | |
json | FormIt.Layers.SetLoadInRevit (layerID, load) |
Set the load in Revit status of a layer. More... | |
json | FormIt.Layers.IsSectionPlaneOrIndicatorLayer (layerID) |
Check whether the layer is either a section indicator or section plane layer. More... | |
json | FormIt.Layers.CountObjectsOnLayer (aObjects, layerID) |
Returns how many of the objects in objectPaths, or their owners are on the given layer If layerId is passed as WSM.INVALID_ID, it counts how many objects are not on any layer. More... | |
json FormIt.Layers.AddLayer | ( | historyID | , |
layerName | , | ||
visible | |||
) |
AddLayer creates a new layer in the given history.
[in] | historyID | int |
[in] | layerName | String |
[in] | visible | bool |
json FormIt.Layers.AssignLayerToObjects | ( | layerID | , |
aObjects | |||
) |
AssignLayerToObjects assigns a layer to a list of objects.
[in] | layerID | int |
[in] | aObjects | Array of objects (WSM.GroupInstancePath) |
json FormIt.Layers.ChangeLayerOrder | ( | layerID | , |
newPosition | |||
) |
ChangeLayerOrder gives a layer a new position in the list.
[in] | layerID | int |
[in] | newPosition | int |
json FormIt.Layers.CountObjectsOnLayer | ( | aObjects | , |
layerID | |||
) |
Returns how many of the objects in objectPaths, or their owners are on the given layer If layerId is passed as WSM.INVALID_ID, it counts how many objects are not on any layer.
[in] | aObjects | Array of WSM.GroupInstancePath |
[in] | layerID | int Id of the layer |
json FormIt.Layers.DeleteLayers | ( | aLayerIDs | ) |
DeleteLayers deletes a list of layers.
[in] | aLayerIDs | Array of layer ids |
json FormIt.Layers.GetAllLayerData | ( | ) |
GetAllLayerData gets the data for all layers.
json FormIt.Layers.GetAllLayers | ( | ) |
json FormIt.Layers.GetAllObjectsOnLayers | ( | layerIDs | , |
allHistories | |||
) |
GetAllObjectsOnLayers gets all objects that are on the given layers.
[in] | layerIDs | Array of layer ids |
[in] | allHistories | (optional) Include all Historys |
json FormIt.Layers.GetLayerData | ( | layerID | ) |
GetLayerData gets the data for a single layer.
[in] | layerID |
json FormIt.Layers.GetLayerID | ( | layerName | ) |
GetLayerID returns the formit layer id from a layer name or WSM.INVALID_ID if a layer with that name does not exist.
[in] | layerName | String |
json FormIt.Layers.GetLayerList | ( | ) |
GetLayerList gets a list of all layers as LayerData.
json FormIt.Layers.GetObjectLayerID | ( | nHistoryID | , |
nObjectID | |||
) |
GetObjectLayerID returns the layer id for the object.
Returns WSM.INVALID_ID if the object does not have a layer.
[in] | nHistoryID | int |
[in] | nObjectID | int |
json FormIt.Layers.GetObjectsLayerList | ( | groupInstacePathArray | , |
bIncludeNoLayer | |||
) |
GetObjectsLayerList returns the set of layers the given Objects are on.
If bIncludeNoLayer is true, an uninitialized LayerData will be added to the set.
[in] | bIncludeNoLayer | bool (optional) |
[in] | groupInstacePathArray | WSM.GroupInstancePathArray |
json FormIt.Layers.IsSectionPlaneOrIndicatorLayer | ( | layerID | ) |
Check whether the layer is either a section indicator or section plane layer.
[in] | layerID | int Id of the layer |
json FormIt.Layers.IsValid | ( | layerID | ) |
IsValid returns whether a layer id is valid.
[in] | layerID | int |
json FormIt.Layers.IsValidLayerName | ( | layerID | , |
newLayerName | |||
) |
IsValidLayerName checks whether the name is valid for a layer.
Returns success. Also returns an error string that can be posted in the UI, if the name is not valid.
[in] | layerID | int |
[in] | newLayerName | String |
json FormIt.Layers.IsValidObjectForLayerAssignment | ( | nHistoryID | , |
nObjectID | |||
) |
IsValidObjectForLayerAssignment returns whether the given object can be assigned a layer object must be top level (non owned) or a group instance.
[in] | nHistoryID | int |
[in] | nObjectID | int |
json FormIt.Layers.LayerExists | ( | layerName | ) |
LayerExists returns true if a layer with the given name exists.
[in] | layerName | String |
json FormIt.Layers.RemoveLayersFromObjects | ( | layerIDs | , |
aObjects | |||
) |
RemoveLayersFromObjects removes all the layers in a vector from a vector of objects, regardless of whether any of the objects actually are assigned any of the layers.
[in] | layerIDs | Array of layer ids |
[in] | aObjects | Array of WSM.GroupInstancePath |
json FormIt.Layers.SetLayerName | ( | layerID | , |
newLayerName | |||
) |
SetLayerName set a new name for the given layer.
[in] | layerID | int |
[in] | newLayerName | String |
json FormIt.Layers.SetLayerPickable | ( | layerID | , |
pickable | |||
) |
Set the pickable status of a layer.
[in] | layerID | int Id of the layer |
[in] | pickable | bool true to set the layer pickable, false to lock it |
json FormIt.Layers.SetLayersVisibility | ( | aLayersVisibility | ) |
SetLayersVisibility sets the visibility of a vector of layers.
[in] | aLayersVisibility | Array of layer data (see GetLayerData) |
json FormIt.Layers.SetLayerVisibility | ( | layerName | , |
visibility | |||
) |
SetLayerVisibility sets the visibility of layer with a given name and visibility toggle.
[in] | layerName | is string containing the layer name |
[in] | visibility | is a boolean specifying whether to turn layer on or off |
json FormIt.Layers.SetLoadInRevit | ( | layerID | , |
load | |||
) |
Set the load in Revit status of a layer.
[in] | layerID | int Id of the layer |
[in] | load | bool true to set the layer to load in Revit |