FormIt Plugin API  16.0.237
WSM API

Description

Modules

 WSM.Geom API
 
 WSM.Test API
 
 WSM.Utils API
 

Namespaces

 WSM.Geom
 WSM.Geom namespace.
 
 WSM.Test
 WSM.Test namespace.
 
 WSM.Utils
 WSM.Utils namespace.
 

Functions

json WSM.APIAddFaceComponentToBody (nHistoryID, nFaceID, nBodyID)
 APIAddFaceComponentToBody adds a Face and all connected Faces to a Body. More...
 
json WSM.APIAddInstancesToGroup (nHistoryID, nGroupID, aTransforms)
 Creates new instances in the specified group and returns their IDs. More...
 
json WSM.APIAddObjectsLayers (nHistoryID, aLayerIDs, aObjectIDs)
 
json WSM.APIAddRemoveObjectsLayers (nHistoryID, aAddLayerIDs, aRemoveLayerIDs, aObjectIDs)
 
json WSM.APIBlend (nHistoryID, dRadius, aPathIDs)
 APIBlend creates a blend surface using the specified path. More...
 
json WSM.APICanRedoHistoryReadOnly (nHistoryID)
 APICanRedoHistoryReadOnly true if redo is possible. More...
 
json WSM.APICanRedoHistoryToDeltaReadOnly (nHistoryID, nDeltaID)
 APICanRedoHistoryToDeltaReadOnly true if redo is possible. More...
 
json WSM.APICanUndoHistoryReadOnly (nHistoryID)
 APICanUndoHistoryReadOnly true if undo is possible. More...
 
json WSM.APICanUndoHistoryToDeltaReadOnly (nHistoryID, nDeltaID)
 APICanUndoHistoryToDeltaReadOnly true if undo is possible. More...
 
json WSM.APIChangeHistoryID (nHistoryID)
 APIChangeHistoryID() function. More...
 
json WSM.APICheckHistoryValidityReadOnly (nHistoryID)
 Finds all errors in the History (including on every live Object in the History). More...
 
json WSM.APICheckValidityReadOnly (nHistoryID, nObjectID)
 APICheckValidityReadOnly Parameters: In: nHistoryID, nObjectID Out: JSON_UNDEFINED;. More...
 
json WSM.APICleanModel (nHistoryID, dEdgeTol)
 Changes the model fixing errors and getting rid of undesired features. More...
 
json WSM.APIClearResults ()
 Clear the list of Results managed by ScriptInstance. More...
 
json WSM.APIComputeAreaReadOnly (nHistoryID, nObjectID, transf)
 APIComputeAreaReadOnly Parameters: In: nHistoryID, nObjectID, transf Out: nArea. More...
 
json WSM.APIComputeVolumeReadOnly (nHistoryID, nObjectID, transf)
 APIComputeVolumeReadOnly Parameters: In: nHistoryID, nObjectID Out: nVolume. More...
 
json WSM.APIConnectPoint3ds (nHistoryID, point3d1, point3d2)
 APIConnectPoint3ds Parameters: In: nHistoryID, point3d1, point3d2 Out: JSON_UNDEFINED. More...
 
json WSM.APIConnectVertexAndPoint3d (nHistoryID, nVertexID, point3d)
 APIConnectVertexAndPoint3d Parameters: In: nHistoryID, nVertexID, point3d Out: JSON_UNDEFINED. More...
 
json WSM.APIConnectVertices (nHistoryID, nVertexID1, nVertexID2)
 APIConnectVertices Parameters: In: nHistoryID, nVertexID1, nVertexID2 Out: JSON_UNDEFINED. More...
 
json WSM.APICopyObject (nHistoryID, nToHistoryID, nObjectID)
 APICopyObject copies nObjectID in nHistoryID to nToHistoryID. More...
 
json WSM.APICopyOrSketchAndTransformObjects (nFromHistoryID, nToHistoryID, aFromObjectIDs, transform, nNumCopies, bGroupBodies, groupTransf3d)
 
json WSM.APICover (nHistoryID, aEdgeIDs, bMerge)
 APICover makes Faces the cover a closed circuit of Edges. More...
 
json WSM.APICreateBlock (nHistoryID, point3d1, point3d2)
 Create a block with the given corners. More...
 
json WSM.APICreateCircleOrArc (nHistoryID, radius, posCenter, xAxis, yAxis, dStartParam, dEndParam, accuracyORcount, bReadOnly, trans, nMinimumNumberOfFacets)
 Create a circle or arc defined by C(t) = posCenter + radius * (xAxis * cos(t) + yAxis * sin(t)) where t goes from dStartParam to dEndParam Parameter accuracyORcount means: MAX distance between base circle and segment as portion of R, if < 1 number of divisions (double rounded to int) over 90 degree arc, if >= 1 Parameters: In: nHistoryID , radius, posCenter, xAxis, yAxis, dStartParam, dEndParam, accuracyORcount, trans, nMinimumNumberOfFacets Out: nObjectID. More...
 
json WSM.APICreateCircleOrArcFromPoints (nHistoryID, arcStartPos, arcEndPos, thirdPoint, accuracyORcount, bReadOnly, trans, nMinimumNumberOfFacets)
 Create a circle or arc defined by points Parameter accuracyORcount means: MAX distance between base circle and segment as portion of R, if < 1 number of divisions (double rounded to int) over 90 degree arc, if >= 1 Parameters: In: nHistoryID , radius, posCenter, xAxis, yAxis, dStartParam, dEndParam, accuracyORcount, trans, nMinimumNumberOfFacets Out: nObjectID. More...
 
json WSM.APICreateClampedHermiteSplineDataReadOnly (nHistoryID, aControlPoints, startTangent, endTangent, bClosed, aVertexIDsOnSpline, nNumberOfNewContolPoints)
 
json WSM.APICreateCone (nHistoryID, nRadius, nHeight, centerPt, nAccuracyORcount)
 Create a hemisphere with the radius and at the given center point. More...
 
json WSM.APICreateCylinder (nHistoryID, aPosCenter, aRadius, aHeight, aAccuracyORcount, aAxis)
 APICreateCylinder returns a cylinder. More...
 
json WSM.APICreateEdgesFromData (nHistoryID, aLayers, aEdges, aCurves)
 Load a set of edges from vectors of various data in a single delta. More...
 
json WSM.APICreateEmptyBody (nHistoryID)
 APICreateEmptyBody creates an empty body. More...
 
json WSM.APICreateExtrusion (nHistoryID, aPoint3ds, dist)
 APICreateExtrusion returns an extrusion body, which is extruded from a polygon formed by aPoint3ds. More...
 
json WSM.APICreateGeometryFromData (nHistoryID, aTextures, aMaterials, aLayers, aInstances, aFaces, aEdges, aCurves, aImages, aGroupName)
 Load a model from vectors of various data in a single delta. More...
 
json WSM.APICreateGroup (nHistoryID, aObjectIDs, aInstanceTransforms, nReferencedHistoryID, transGeometry)
 
json WSM.APICreateHemisphere (nHistoryID, nRadius, centerPt, nAccuracyORcount)
 Create a hemisphere with the radius and at the given center point. More...
 
json WSM.APICreateHermiteSpline (nHistoryID, aControlPoints, bClosed, startTangent, endTangent, bReadOnly)
 Tessellate a cubic spline that touches all aControlPoints Fills the tessellated points into aOutPoints bClosed specifies that the end point is the start point, so the curve must be smooth and closed startTangent is an optional Vector that specifies the tangent at the start point endTangent is an option Vector that specifies the tangent at the end point bReadOnly, if true does not put geometry into the scene, only returns the tessellated points. More...
 
json WSM.APICreateHistory (nHistoryID, bNonTemporary)
 APICreateHistory() function. More...
 
json WSM.APICreateImageObject (nHistoryID, sName, nTextureID, fAlphaValue, bFeaturesVisible, aCornersVector)
 APICreateImageObject creates a image object. More...
 
json WSM.APICreateImageObjectWithTexture (nHistoryID, sName, fAlphaValue, bFeaturesVisible, aCornersVector, aBitmapData, sTextureName)
 APICreateImageObjectWithTexture creates a image object with texture. More...
 
json WSM.APICreateLayer (nHistoryID, name, bDisplayed)
 Create a layer object with a given name and display flag. More...
 
json WSM.APICreateLevelObjects (nHistoryID, aLevelsData, aObjectIDs)
 
json WSM.APICreateMaterial (nHistoryID, nColor, dHorizonalScale, dVerticalScale, nTextureID, sMaterialName, sMaterialIdentifier, aAdditionalRenderData, aAdditionalTextures)
 APICreateMaterial makes a new Material. More...
 
json WSM.APICreateMaterialWithTexture (nHistoryID, nColor, dHorizonalScale, dVerticalScale, aBitmapData, bUseBitmapAlpha, sMaterialName, sMaterialIdentifier, aAdditionalRenderData, aAdditionalTextures, sTextureName)
 APICreateMaterialWithTexture makes a new Material. More...
 
json WSM.APICreatePolyline (nHistoryID, aPoint3ds, bForceClosed)
 APICreatePolyline creates a polyline from a vector of Point3ds. More...
 
json WSM.APICreateRectangle (nHistoryID, firstEdgePt1, firstEdgePt2, projectionPt, bReadOnly)
 Create a rectangle based on one edge and a third point. More...
 
json WSM.APICreateSatelliteImageObject (nHistoryID, sName, nTextureID, fAlphaValue, bFeaturesVisible, aCornersVector, coordinates, coordinatesSpan, aPixelDimensionsVector)
 APICreateSatelliteImageObject creates a image object. More...
 
json WSM.APICreateSeparateHistoriesForInstances (nHistoryID, aInstanceIDs, bNewGroupPerInstance)
 Creates new copies of the existing groups and the referenced histories for the specified instances. More...
 
json WSM.APICreateStringAttribute (nHistoryID, sKey, sValue, aObjIDs, nCopyBehavior, bIsSharedOnSplit)
 
json WSM.APIGetStringAttributeKeyValueReadOnly (nHistoryID, nStringAttributeID)
 Gets the key and value strings from a StringAttribute. More...
 
json WSM.APIGetStringAttributesByKeyReadOnly (nHistoryID, nObjectID, sKey)
 Returns all StringAttributes attached to the Object given by nObjectID with key matching sKey. More...
 
json WSM.APICreateTexture (nHistoryID, aBitmapData, bUseBitmapAlpha, sTextureName)
 APICreateTexture creates a new Texture object Parameters: In: nHistoryID, aBitmapData, sTextureName Out: nCreatedTextureID. More...
 
json WSM.APIDebugObjectReadOnly (nHistoryID, nObjectID)
 APIDebugObjectReadOnly() function. More...
 
json WSM.APIDeleteAllHistories ()
 Delete all Histories and reset next History Id to be 0. More...
 
json WSM.APIDeleteAllRedoHistory (nHistoryID, bReuseDiscardedObjectIDs)
 APIDeleteAllRedoHistory - Deletes all forward Deltas. More...
 
json WSM.APIDeleteHistory (nHistoryID)
 Delete the given History and also the active history managed by ScriptInstance. More...
 
json WSM.APIDeleteObject (nHistoryID, nObjectID)
 APIDeleteObject deletes nObjectID in the given nHistoryID. More...
 
json WSM.APIDeleteObjects (nHistoryID, aObjectIDs)
 
json WSM.APIDisableJournaling ()
 APIDisableJournaling() function. More...
 
json WSM.APIDragFace (nHistoryID, nObjectID, nDistance, bMerge)
 APIDragFace drags a face nObjectID along it normal by nDistance. More...
 
json WSM.APIDragFaces (nHistoryID, aaFaceIDs, aDists, aDirs, bMerge)
 APIDragFaces drags a group of faces aaFaceIDs by aDistance for each group. More...
 
json WSM.APIDumpResults ()
 Dump the list of Results managed by ScriptInstance. More...
 
json WSM.APIEnableJournaling (nHistoryID, sFilePath)
 
json WSM.APIEnableJournalingTypes (aTypes)
 APIEnableJournalingTypes() function. More...
 
json WSM.APIExtrudeEdges (nHistoryID, aProfileIDs, t)
 APIExtrudeEdges makes a Face from the given profile and a transformed copy of the edges. More...
 
json WSM.APIFaceContainsPointReadOnly (nHistoryID, nFaceID, point)
 APIFaceContainsPointReadOnly() function. More...
 
json WSM.APIFlattenGroupsOrInstances (nHistoryID, aGroupOrInstanceIDs, bRecursive)
 Replace the instances and/or groups referenced in aGroupOrInstanceIDs by a copy of the contents of the referenced history. More...
 
json WSM.APIGetActiveHistory ()
 Get the Active history managed by ScriptInstance. More...
 
json WSM.APIGetAllAggregateTransf3dsReadOnly (nReferencedHistoryID, nTopMostHistoryID)
 APIGetAllAggregateTransf3dsReadOnly returns aggregate global transformations on a History referenced by a Group or Groups. More...
 
json WSM.APIGetAllConnectedNonOwnedReadOnly (nHistoryID, nObjectID)
 APIGetAllConnectedNonOwnedReadOnly returns an array of all NonOwned Object IDs that are connected to nObjectID. More...
 
json WSM.APIGetAllHistoriesReadOnly (bWithTemporary)
 APIGetAllHistoriesReadOnly Gets the IDs of all active histories, optionally with temporary ones. More...
 
json WSM.APIGetAllHistoryDeltasReadOnly (nHistoryID)
 Get the IDs of all deltas in the given history. More...
 
json WSM.APIGetAllNonOwnedReadOnly (nHistoryID)
 APIGetAllNonOwnedReadOnly returns an array of all NonOwned Object IDs. More...
 
json WSM.APIGetAllObjectsByTypeReadOnly (nHistoryID, nType)
 Returns all the objects of type 'nType' contained by the history Parameters: In: nHistoryID, nType nType- WSM.nUnSpecifiedType WSM.nBodyType WSM.nLumpType WSM.nShellType WSM.nFaceType WSM.nLoopType WSM.nCoedgeType WSM.nEdgeType WSM.nVertexType Out: Array of Object IDs of the given nType. More...
 
json WSM.APIGetAllReachableHistoriesReadOnly (nHistoryID, bGoUp)
 Gets all the Histories reachable from the given History going either up or down the chain of Histories based on the flag bGoUp. More...
 
json WSM.APIGetBodyEdgesReadOnly (nHistoryID, nBodyID)
 APIGetBodyEdgesReadOnly returns an array of all edge IDs for the given nBodyID. More...
 
json WSM.APIGetBodyFacesReadOnly (nHistoryID, nObjectID)
 GetBodyFacesReadOnly returns an array of Face IDs. More...
 
json WSM.APIGetBoxReadOnly (nHistoryID, nObjectID)
 APIGeBoxReadOnly Parameters: In nHistoryID, nObjectID (Optional) Out: Interval3d. More...
 
json WSM.APIGetCoedgeDirectionReadOnly (nHistoryID, nObjectID)
 APIGetCoedgeDirectionReadOnly returns true if coedge and edge go in the same direction. More...
 
json WSM.APIGetConnectedEdgesReadOnly (nHistoryID, nEdgeID, bBreakOnNonSmooth)
 Returns all connected edges of a seed edge. More...
 
json WSM.APIGetConvexityConnectedComponentReadOnly (nHistoryID, nLoopOrFaceID, nConvexity)
 APIGetConvexityConnectedComponentReadOnly Parameters: In: nHistoryID, nLoopOrFaceID, nConvexity Out: aConnectedFaces. More...
 
json WSM.APIGetConvexityReadOnly (nHistoryID, nEdgeOrLoopID)
 APIGetConvexityReadOnly returns the convexity of Edge or Loop ID. More...
 
json WSM.APIGetCreatedChangedAndDeletedInActiveDeltaReadOnly (nHistoryID, nObjectType, bForUndo)
 APIGetCreatedChangedAndDeletedInActiveDeltaReadOnly Parameters: In: History ID, WSM.nObjectType nObjectType, bool bForUndo Out: Vector of Created, Vector of Changed, Vector of Deleted,. More...
 
json WSM.APIGetCreatedChangedAndDeletedInDeltaRangeReadOnly (nHistoryID, nStartDelta, nEndDelta, aObjectTypes)
 APIGetCreatedChangedAndDeletedInDeltaRangeReadOnly Parameters: In: History ID, first Delta ID, second Delta ID, nObjectTypes Out: Vector of Created, Vector of Changed, Vector of Deleted,. More...
 
json WSM.APIGetDynamoModelInformationReadOnly (nHistoryID)
 APIGetDynamoModelInformationReadOnly returns Dynamo Model information of the history. More...
 
json WSM.APIGetEdgeOrVertexMarkedSmoothReadOnly (nHistoryID, nObjectID)
 GetEdgeMarkedSmoothReadOnly Returns whether an edge is marked as smooth. More...
 
json WSM.APIGetEdgePointsReadOnly (nHistoryID, nEdgeID)
 APIGetEdgePointsReadOnly() function. More...
 
json WSM.APIGetEdgeStyleReadOnly (nHistoryID, nEdgeID)
 APIGetEdgeStyleReadOnly() function. More...
 
json WSM.APIGetEnabledJournalingTypesReadOnly ()
 APIGetEnabledJournalingTypesReadOnly returns the list of journaling 'types' that are enabled. More...
 
json WSM.APIGetFaceBacksideMaterialReadOnly (nHistoryID, nFaceID)
 Gets the material of the backside of the given face. More...
 
json WSM.APIGetFaceCentroidPoint3dReadOnly (nHistoryID, nFaceID)
 APIGetFaceCentroidPoint3dReadOnly returns the centroid point of nFaceID. More...
 
json WSM.APIGetFaceConnectedComponentReadOnly (nHistoryID, nFaceID, bUseVertices, bSmooth, aConnectedFaces)
 
json WSM.APIGetFaceFacetsReadOnly (nHistoryID, nFaceID)
 APIGetFaceFacetsReadOnly gets the list of vertices grouped by triangles Parameters: In: nHistoryID, nFaceID, aFacets Out: aFacets. More...
 
json WSM.APIGetFacePlaneReadOnly (nHistoryID, nFaceID)
 GetFacePlaneReadOnly returns the plane of nFaceID. More...
 
json WSM.APIGetFaceVariantReadOnly (nHistoryID, nFaceID)
 APIGetFaceVariantReadOnly returns the variant of nFaceID. More...
 
json WSM.APIGetFaceVertexNormalsReadOnly (nHistoryID, nFaceID, aVertexIDsAndNormals)
 
json WSM.APIGetGroupReferencedHistoryReadOnly (nHistoryID, nGroupID)
 APIGetGroupReferencedHistoryReadOnly returns the ID of the Group's referenced History Parameters: In: nHistoryID, nGroupID Out: nReferencedHistoryID. More...
 
json WSM.APIGetHistoryDeltasReadOnly (nHistoryID, nStartDeltaID, nEndDeltaID)
 Get the IDs of the deltas in the given closed range in the given history. More...
 
json WSM.APIGetHistoryReferencingGroupsReadOnly (nHistoryID)
 Returns a vector with groups that reference this history. More...
 
json WSM.APIGetIdOfActiveDeltaReadOnly (nHistoryID, nDeltaOffset)
 Get the active Delta ID. More...
 
json WSM.APIGetImageDataReadOnly (nHistoryID, nImageID)
 APIGetImageDataReadOnly gets image data Parameters: In: nHistoryID, nImageID Out: sName, nTextureID, nPosition, fAlphaValue, bFeaturesVisible, aCorners, bHasSatelliteData. More...
 
json WSM.APIGetInstanceTransf3dReadOnly (nHistoryID, nInstanceID)
 Returns the Instance's Transf3d. More...
 
json WSM.APIGetInvalidID ()
 APIGetInvalidID Parameters: In: Out: ID. More...
 
json WSM.APIGetLayerDataReadOnly (nHistoryID, nLayerID)
 Get the data from a layer. More...
 
json WSM.APIGetLevelDataReadOnly (nHistoryID, nLevelID)
 APIGetLevelDataReadOnly gets the elevation and name properties. More...
 
json WSM.APIGetLocalCoordinateSystemReadOnly (nHistoryID)
 Get the LCS (local coordinate system) of the given History. More...
 
json WSM.APIGetMaterialDataReadOnly (nHistoryID, nMaterialID)
 
json WSM.APIGetMemorySizeReadOnly (nHistoryID, bCollapsedHistoryWithLiveObjsOnly)
 APIGetMemorySizeReadOnly Parameters: In: nHistoryID Out: nBytes. More...
 
json WSM.APIGetObjectAttributesReadOnly (nHistoryID, nObjectID)
 Get all of the Attributes of the given Object. More...
 
json WSM.APIGetObjectLayersReadOnly (nHistoryID, nObjectID)
 APIGetObjectLayersReadOnly gets all layer ids of the given object. More...
 
json WSM.APIGetObjectLevelsReadOnly (nHistoryID, nObjectID)
 APIGetObjectLevelsReadOnly gets all level's ids of the given object. More...
 
json WSM.APIGetObjectMaterialReadOnly (nHistoryID, nFaceID)
 APIGetObjectMaterialReadOnly gets an Object's material. More...
 
json WSM.APIGetObjectNameReadOnly (nHistoryID, nObjectID)
 APIGetObjectNameReadOnly returns an object type. More...
 
json WSM.APIGetObjectPropertiesReadOnly (nHistoryID, nObjectID, sObjectName, bReportAreaByLevel)
 
json WSM.APIGetObjectTextureCoordinatesReadOnly (nHistoryID, nObjectID)
 APIGetObjectTextureCoordinatesReadOnly generates tex coords for body or single face Parameters: In: nHistoryID, nObjectID Out: aTexCoords. More...
 
json WSM.APIGetObjectTypeReadOnly (nHistoryID, nObjectID)
 APIGetObjectTypeReadOnly returns an object type. More...
 
json WSM.APIGetObjectsByTypeReadOnly (nHistoryID, nObjectID, nType, bUpstream)
 Returns all the objects of type 'nType' contained by the Object the given nObjectID if bUpstream is false; otherwise, return all the objects of type "nType" which are the parents of given object. More...
 
json WSM.APIGetPointsFromObjectIDsReadOnly (nHistoryID, aIDs)
 
json WSM.APIGetRenderableFaceReadOnly (nHistoryID, nFaceID, bCalculateTexCoords, bBackSide)
 APIGetRenderableFaceReadOnly() function. More...
 
json WSM.APIGetResultsCount ()
 Get the number of Results managed by ScriptInstance. More...
 
json WSM.APIGetRevitFamilyInformationReadOnly (nHistoryID)
 APIGetRevitFamilyInformationReadOnly returns Revit Family information of the history. More...
 
json WSM.APIGetSatelliteDataReadOnly (nHistoryID, nImageID)
 APIGetSatelliteDataReadOnly gets satellite data from image Parameters: In: nHistoryID, nImageID Out: sName, nTextureID, nPosition, fAlphaValue, bFeaturesVisible, aCorners, bHasSatelliteData. More...
 
json WSM.APIGetTextureDataReadOnly (nHistoryID, nTextureID)
 APIGetTextureDataReadOnly gets a Texture object's bitmap data Parameters: In: nHistoryID, nTextureID Out: JSON object with data. More...
 
json WSM.APIGetTopLevelOwnersReadOnly (nHistoryID, nObjectID)
 APIGetTopLevelOwnersReadOnly returns the top level owners of the given Object. More...
 
json WSM.APIGetVersionReadOnly ()
 APIGetVersionReadOnly Parameters: In: Out: JSON. More...
 
json WSM.APIGetVertexPoint3dReadOnly (nHistoryID, nVertexID)
 APIGetVertexPoint3d returns the Point3d of a Vertex Parameters: In: nHistoryID, nVertexID Out: pt. More...
 
json WSM.APIImprint (nHistoryID, nObjectID1, nObjectID2, bChangeBoth)
 APIImprint Parameters: In: nHistoryID, nObjectID1, nObjectID2, bChangeBoth Out: JSON_UNDEFINED. More...
 
json WSM.APIImprintWithPlane (nHistoryID, nObjectID, plane)
 APIImprintWithPlane Parameters: In: nHistoryID, nObjectID, plane Out: JSON_UNDEFINED. More...
 
json WSM.APIIntersectsNegativeSideOfPlanesReadOnly (nHistoryID, aPlanes, bVertices, bEdges, bFaces, bStrict, dTol, line3dPickRay, bSearchInGroups, bPickInstances)
 
json WSM.APIIsEdgeManifoldReadOnly (nHistoryID, nEdgeID)
 See WSMAPI for full comment Parameters: In: nHistoryID, nEdgeID Out: bool (isManifold) More...
 
json WSM.APIIsEdgeMergeableReadOnly (nHistoryID, nEdgeID, bUseMaterial)
 APIIsEdgeMergeableReadOnly In: nHistoryID, nEdgeID, bUseMaterial Out:bool (true or false that the Edge is mergeable. More...
 
json WSM.APIIsEdgeOnCircleReadOnly (nHistoryID, nEdgeID)
 APIIsEdgeOnCircleReadOnly Parameters: In: nHistoryID, nEdgeID Out: radius, center, normal, xaxis, aAllCircleSiblings. More...
 
json WSM.APIEditCircleEdges (nHistoryID, nEdgeIDs, radius, center, normal, xaxis)
 APIEditCircleEdges Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis. More...
 
json WSM.APIIsEdgeOnSplineReadOnly (nHistoryID, nEdgeID)
 APIIsEdgeOnSplineReadOnly Parameters: In: nHistoryID, nEdgeID Out: aControlPoints, bClosed, startTangent, endTangent, aAllSplineSiblings. More...
 
json WSM.APIEditSplineEdges (nHistoryID, nEdgeIDs, aControlPoints, bClosed, startTangent, endTangent)
 APIEditSplineEdges Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis. More...
 
json WSM.APIIsEdgeSilhouetteReadOnly (nHistoryID, nEdgeID, cameraPos, cameraDir, bPerspectiveView)
 APIIsEdgeSilhouetteReadOnly Returns whether an edge is a silhouette. More...
 
json WSM.APIDetectSilhouettesReadOnly (nHistoryID, nEdgeIDs, cameraPos, cameraDir, bPerspectiveView, bSmoothOnly)
 APIDetectSilhouettesReadOnly Returns a list of silhouette edges from a list of edges. More...
 
json WSM.APIDetectFreeEdgesReadOnly (nHistoryID, nEdgeIDs)
 APIDetectFreeEdgesReadOnly Returns a list of edges that have only one or zero faces connected and a list of non free edges. More...
 
json WSM.APIIsExactMatchReadOnly (nHistoryID1, nHistoryID2, nObjectID1, nObjectID2)
 API compares either two Histories or two Objects and sets bIsExact to true when they match exactly. More...
 
json WSM.APIIsFaceOnBlendReadOnly (nHistoryID, nFaceID)
 APIIsFaceOnBlendReadOnly Parameters: In: nHistoryID, nFaceID Out: radius, aPathPoints, aAllBlendSiblings. More...
 
json WSM.APIIsFaceOnCylinderReadOnly (nHistoryID, nFaceID)
 APIIsFaceOnCylinderReadOnly Parameters: In: nHistoryID, nFaceID Out: radius, center, normal, xaxis, aAllCylinderSiblings. More...
 
json WSM.APIEditCylinderFaces (nHistoryID, nFaceIDs, radius, center, normal, xaxis)
 APIEditCylinderFaces Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis. More...
 
json WSM.APIIsFaceOnExtrudeReadOnly (nHistoryID, nFaceID)
 APIIsFaceOnExtrudeReadOnly Parameters: In: nHistoryID, nFaceID Out: base, axis, xaxis, aControlPoints, bClosed, startTangent, endTangent, aAllExtrudeSiblings. More...
 
json WSM.APIIsFaceOnSphereReadOnly (nHistoryID, nFaceID)
 APIIsFaceOnSphereReadOnly Parameters: In: nHistoryID, nFaceID Out: radius, center, normal, xaxis, aAllSphereSiblings. More...
 
json WSM.APIEditSphereFaces (nHistoryID, nFaceIDs, radius, center, normal, xaxis)
 APIEditSphereFaces Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis. More...
 
json WSM.APIIsHistoryNonTemporaryReadOnly (nHistoryID)
 APIIsHistoryNonTemporaryReadOnly() function. More...
 
json WSM.APIIsJournalingReadOnly ()
 Check if Journaling is enabled. More...
 
json WSM.APIIsNonOwnedReadOnly (nHistoryID, nObjectID)
 APIIsNonOwnedReadOnly returns whether this object has an owner. More...
 
json WSM.APIIsObjectLiveReadOnly (nHistoryID, nObjectID)
 APIIsObjectLiveReadOnly checks if an object is alive in history Parameters: In: nHistoryID, nObjectID Out: bIsLive. More...
 
json WSM.APILoadAXMFile (nHistoryID, sFilePath, isImport, logOutputPath)
 APILoadAXMFile Parameters: In: nHistoryID, sFilePath, isImport, logOutputPath Out: JSON_UNDEFINED;. More...
 
json WSM.APILoadDeltaFromBinaryString (nHistoryID, base64Str, nDeltaID, base64encoded)
 APILoadDeltaFromBinaryString Parameters: In: nHistoryID, base64Str, [nDeltaID, [base64encoded]] Out: nDeltaID. More...
 
json WSM.APILoadDeltaFromBinaryFile (nHistoryID, sFilePath)
 APILoadDeltaFromBinaryFile Parameters: In: nHistoryID, sFilePath Out: JSON_UNDEFINED. More...
 
json WSM.APILoadFromFacets (nHistoryID, facetsData, nOptions, dMaxDistanceFromOrigin, dRemoveDuplicateTol)
 Parameters: In: nHistoryID, facetsData, nOptions, dMaxDistanceFromOrigin, dRemoveDuplicateTol Out: IDs of created objects. More...
 
json WSM.APILoadFromFile (nHistoryID, sFilePath, eFileType, nOptions, dMaxDistanceFromOrigin)
 APILoadFromFile Parameters: In: nHistoryID, sFilePath, eFileType, nOptions, dMaxDistanceFromOrigin Out: iObjectIdOffset. More...
 
json WSM.APILoadFromString (nHistoryID, saveStringName, eFileType, nOptions, dMaxDistanceFromOrigin, bBase64Encoded)
 APILoadFromString Parameters: In: nHistoryID, string or string name, [eFileType], [merge flag], [bBase64Encoded] Out: offset. More...
 
json WSM.APILoadHistoryFromBinaryString (nHistoryID, base64Str, base64encoded)
 APILoadHistoryFromBinaryString Parameters: In: nHistoryID, base64Str Out: JSON_UNDEFINED. More...
 
json WSM.APILoft (nHistoryID, aaProfileIDs, bDeleteInteriorProfileFaces)
 APILoft makes Faces that connect a vector of profiles. More...
 
json WSM.APIMergeBody (nHistoryID, nBodyID)
 APIMergeBody Parameters: In: nHistoryID, nBodyID Out: JSON_UNDEFINED;. More...
 
json WSM.APIMergeDeltas (nHistoryID, nStartDeltaID, nEndDeltaID, bReuseDiscardedObjectIDs)
 APIMergeDeltas merges the specified Delta range. More...
 
json WSM.APIMoveImage (nHistoryID, nImageID, nShift)
 APIMoveImage moves the image along z axis. More...
 
json WSM.APIMoveObject (nHistoryID, objectID, displacement)
 APIMoveObject moves the given object with displacement. More...
 
json WSM.APIMoveObjects (nHistoryID, objectIDs, transf3d)
 
json WSM.APIMoveVertices (nHistoryID, aVertexIDs, aNewVertexPositions)
 APIMoveVertices moves the vertices specified in aVertexIDs to the given positions in aNewVertexPositions. More...
 
json WSM.APIOffset3d (nHistoryID, nObjectID, dDistance)
 APIOffset3d offsets all the Faces in the given Object by the amount specified. More...
 
json WSM.APIOffsetEdges (nHistoryID, nEdgeIDs, dOffsetDistance, trans, bReadOnly)
 APIOffsetEdges offsets Edges by given distance. More...
 
json WSM.APIOffsetFace (nHistoryID, nFaceID, dOffsetDistance, bOffsetHolesToo, trans, bReadOnly)
 APIOffsetFace offsets a copy of the boundary a face by given distance. More...
 
json WSM.APIRayFireReadOnly (nHistoryID, line3dPickRay, dRayRadius, bVertices, bEdges, bFaces)
 APIRayFireReadOnly calls WSM.APIRayFireReadOnly. More...
 
json WSM.APIRayFireSortedReadOnly (nHistoryID, line3dPickRay, dRayRadius, bVertices, bEdges, bFaces, dMaxParam, bSearchInGroups)
 APIRayFireSortedReadOnly calls WSM.APIRayFireReadOnly. More...
 
json WSM.APIRedoHistory (nHistoryID, nApplyOnDeltaID)
 APIRedoHistory redoes History. More...
 
json WSM.APIRedoHistoryToDelta (nHistoryID, nDeltaID)
 APIRedoHistoryToDelta redoes History. More...
 
json WSM.APIRegisterProgressCallbacksReadOnly (startCbkStr, progressCbkStr, finishCbkStr, progressIncrement, progressStart, progressEnd)
 Register API progress callback. More...
 
json WSM.APIRemoveObjectsLayers (nHistoryID, aLayerIDs, aObjectIDs)
 
json WSM.APIRemoveSatelliteData (nHistoryID, nImageID)
 APIRemoveSatelliteData removes satellite data from image object Parameters: In: nHistoryID, nImageID Out: JSON_UNDEFINED;. More...
 
json WSM.APIReverseFaces (nHistoryID, aFaceIDs)
 APIReverseFaces Parameters: In: nHistoryID, aFaceIDs Out: JSON_UNDEFINED;. More...
 
json WSM.APIRotateFace (nHistoryID, nFaceID, aRadian)
 APIRotateFace rotates face by given radian using default rotation axis. More...
 
json WSM.APIRotateFaceBetweenPoints (nHistoryID, nFaceID, startPt, endPt)
 Rotates a Face between two given points Both points are projected into the face plane The angle of rotation is a radian from 0 to 2PI, determined by the angle counterclockwise from Vector(startPt-faceCenter) to Vector(endPt-faceCenter), with normal as the face's normal Parameters: In: nHistoryID, nFaceID, startPt, endPt Out: JSON_UNDEFINED;. More...
 
json WSM.APISaveAllActiveObjectsToBinaryFileReadOnly (nHistoryID, sFilePath)
 APISaveAllActiveObjectsToBinaryFileReadOnly Parameters: In: nHistoryID, sFilePath Out: JSON_UNDEFINED;. More...
 
json WSM.APISaveHistoryToBinaryFileReadOnly (nHistoryID, sFilePath, aLayerDisplayedNegateVec)
 APISaveHistoryToBinaryFileReadOnly Parameters: In: nHistoryID, sFilePath, [aLayerDisplayedNegateVec] Out: JSON_UNDEFINED;. More...
 
json WSM.APISaveHistoryToBinaryStringReadOnly (nHistoryID, bBase64Encode, aLayerDisplayedNegateVec)
 APISaveHistoryToBinaryBase64StringReadOnly Parameters: In: nHistoryID, bBase64Encode, [aLayerDisplayedNegateVec] Out: lastDeltaID. More...
 
json WSM.APISaveDeltaToBinaryStringReadOnly (nHistoryID, nDeltaID)
 APISaveDeltaToBinaryStringReadOnly Parameters: In: nHistoryID, [nDeltaID] Out: base64Str, deltaID. More...
 
json WSM.APISaveLastDeltaToBinaryFile (nHistoryID, sFilePath)
 APISaveLastDeltaToBinaryFile Parameters: In: nHistoryID, sFilePath Out: JSON_UNDEFINED;. More...
 
json WSM.APISaveToFileReadOnly (nHistoryID, aObjectIDs, sFilePath, eFileType, bWithChildren, dExportScale, aExcludedObjects, aLayerDisplayedNegateVec)
 
json WSM.APISaveToStringReadOnly (nHistoryID, aObjectIDs, saveStringName, bWithChildren, aExcludedObjects, bBase64Encode, aLayerDisplayedNegateVec)
 
json WSM.APIScaleFace (nHistoryID, nFaceID, aScaleFactor)
 APIScaleFace scales face by given scale factor. More...
 
json WSM.APISeparate (nHistoryID, nBodyID)
 APISeparate Parameters: In: nHistoryID, nBodyID Out: A vector of new Body IDs. More...
 
json WSM.APISetEdgesStyle (nHistoryID, aEdgeIDs, nColor)
 APISetEdgesStyle() function. More...
 
json WSM.APISetEdgesOrVerticesMarkedSmooth (nHistoryID, aObjectIDs, bSmooth)
 
json WSM.APISetDynamoModelInformation (nHistoryID, id, name, config, delta)
 APISetDynamoModelInformation sets Dynamo Model information of the history. More...
 
json WSM.APISetFaceBacksideMaterial (nHistoryID, aFaceIDs, nMaterialID)
 Sets the material given by MaterialID as the backside material of the given faces. More...
 
json WSM.APISetImageData (nHistoryID, nImageID, sName, nTextureID, fAlphaValue, bFeaturesVisible, aCornersVector)
 APISetImageData sets data to image object Parameters: In: nHistoryID, nImageID, sName, nTextureID, fAlphaValue, aCorners Out: JSON_UNDEFINED;. More...
 
json WSM.APISetLayerData (nHistoryID, nLayerID, name, bDisplayed)
 Set the data of a layer. More...
 
json WSM.APISetLayersDisplayed (nHistoryID, aLayerIDs, bDisplayed)
 Set the display flag of layers without affecting the other data. More...
 
json WSM.APISetLocalCoordinateSystem (nHistoryID, transf3d)
 Set the LCS (local coordinate system) of the given History. More...
 
json WSM.APISetLevelsData (nHistoryID, aLevelIDs, aLevelsData)
 APISetLevelsData sets the elevation and name properties on Level. More...
 
json WSM.APISetMaterialColor (nHistoryID, nMaterialID, nColor)
 APISetMaterialColor sets the color on a Material. More...
 
json WSM.APISetMaterialData (nHistoryID, nMaterialID, nColor, dHorizontalScale, dVerticalScale, nTextureID, sMaterialName, sMaterialIdentifier, aAdditionalRenderData, aAdditionalTextures)
 APISetMaterialData sets all the data of a Material. More...
 
json WSM.APISetMaterialTexture (nHistoryID, nMaterialID, dHorizontalScale, dVerticalScale, nTextureID)
 APISetMaterialTexture sets the texture properties on a Material. More...
 
json WSM.APISetObjectProperties (nHistoryID, nObjectID, sObjectName, bReportAreaByLevel, aDefaultLevelIDs)
 Sets the properties of a given object (Body): A name and if that particular body reports its area by level or not. More...
 
json WSM.APISetObjectsLevels (nHistoryID, aObjectIDs, aLevelsIDs)
 
json WSM.APISetObjectsMaterial (nHistoryID, aObjectIDs, nMaterialID)
 
json WSM.APISetRevitFamilyInformation (nHistoryID, bIsGeneratedFromRFA, bIsGeneratedFromBuiltinRFA, familyCategory, familyReference, familyType, familyExtraData)
 APISetRevitFamilyInformation sets Revit Family information of the history. More...
 
json WSM.APISetSatelliteData (nHistoryID, nImageID, coordinates, coordinatesSpan, aPixelDimensions)
 APISetSatelliteData sets satellite data to image object Parameters: In: nHistoryID, nImageID, coordinates, coordinatesSpan, aPixelDim Out: JSON_UNDEFINED;. More...
 
json WSM.APISetTextureData (nHistoryID, nTextureID, aBitmapData, bUseBitmapAlpha, sTextureName)
 APISetTexture data sets the bitmap data on a texture Parameters: In: nHistoryID, nTextureID, sBitmapData, nBytes Out: JSON_UNDEFINED;. More...
 
json WSM.APIShell (nHistoryID, nBodyID, dDistance, aOpenFaceIDs)
 APIShell shells the given Body by the specified distance. More...
 
json WSM.APISlice (nHistoryID, nDestinationHistoryID, nObjectID, plane)
 APISlice Parameters: In: nHistoryID, nDestinationHistoryID, nObjectID, plane Out: Vector of new top levels. More...
 
json WSM.APISubtract (nHistoryID, nObjectID1, nObjectID2, aExtraObjectsIDs)
 APISubtract Parameters: In: nHistoryID, nObjectID1, nObjectID2 Out: JSON_UNDEFINED. More...
 
json WSM.APISubtractNonDestructive (blank, tools)
 APISubtractNonDestructive Parameters: In: blank, tools Out: JSON_UNDEFINED. More...
 
json WSM.APISweep (nHistoryID, aProfile, aPath, bRemoveUnusedProfileAndPath)
 APISweep creates a sweep from profile and path from Objects in GroupInstancePaths in nHistoryID. More...
 
json WSM.APITaperFace (nHistoryID, nFaceID, dRadians, axis)
 Taper a Face by angle around the given axis The angle of rotation is a radian from -PI/2 to PI/2 The angle of rotation is relative to the direction of the axis and the normal of the face. More...
 
json WSM.APITransformObject (nHistoryID, nObjectID, transf3d)
 APITransformObject transforms nObjectID by the given transform (transf3d). More...
 
json WSM.APITransformObjects (nHistoryID, aObjectIDs, transf3d)
 
json WSM.APIUndoHistory (nHistoryID, bAndDeleteRedo, nApplyOnDeltaID)
 APIUndoHistory undoes History. More...
 
json WSM.APIUndoHistoryToDelta (nHistoryID, nDeltaID)
 APIUndoHistoryToDelta undoes History. More...
 
json WSM.APIUndoOrRedoHistoryToDelta (nHistoryID, nDeltaID, bAndDeleteRedo)
 Step backward or forward until the given Delta is reached. More...
 
json WSM.APIUnite (nHistoryID, nObjectID1, nObjectID2, aExtraObjectsIDs)
 APIUnite Parameters: In: nHistoryID, nObjectID1, nObjectID2 Out: JSON_UNDEFINED. More...
 
json WSM.APIUniteNonDestructive (blank, tools)
 APIUniteNonDestructive Parameters: In: blank, tools Out: JSON_UNDEFINED. More...
 
json WSM.APIValidID (nID)
 APIValidID. More...
 
json WSM.FacetsBodyData (m_points, m_polygonIndices, m_polygonSmoothingIds, m_colors, m_polygonColorIndices)
 GroupInstancePath creation method In: m_points, m_polygonIndices, m_polygonSmoothingIds, m_colors, m_polygonColorIndices Out: FacetsBodyData. More...
 
json WSM.GroupInstancePath (pathArray)
 
json WSM.GroupInstancePathAreEqual (path1, path2)
 ObjectHistoryIDAreEqual equals method In: path1, path2 Out: bool. More...
 
json WSM.ObjectHistoryID (nHistoryID, nObjectID)
 ObjectHistoryID creation method In: nHistoryID, nObjectID Out: ObjectHistoryID. More...
 
json WSM.ObjectHistoryIDAreEqual (id1, id2)
 ObjectHistoryIDAreEqual equals method In: ObjectID, ObjectID Out: bool. More...
 
json WSM.Color (r, g, b, a)
 Color constructs a Color. More...
 
json WSM.ColorAreEqual (c1, c2)
 ColorAreEqual returns true if the two given colors are equal. More...
 
json WSM.Is32Bit ()
 Is32Bit returns true if WSM is compiled in 32 bit. More...
 

Function Documentation

json WSM.APIAddFaceComponentToBody ( nHistoryID  ,
nFaceID  ,
nBodyID   
)

APIAddFaceComponentToBody adds a Face and all connected Faces to a Body.

Parameters: In: nHistoryID, nFaceID, nBodyID Out: JSON_UNDEFINED

Parameters
[in]nHistoryIDint
[in]nFaceIDint
[in]nBodyIDint
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIAddInstancesToGroup ( nHistoryID  ,
nGroupID  ,
aTransforms   
)

Creates new instances in the specified group and returns their IDs.

Parameters
[in]nHistoryIDint
[in]nGroupIDint
[in]aTransformsArray of WSM.Transf3d
Returns
aNewInstanceIDs
json WSM.APIAddObjectsLayers ( nHistoryID  ,
aLayerIDs  ,
aObjectIDs   
)
json WSM.APIAddRemoveObjectsLayers ( nHistoryID  ,
aAddLayerIDs  ,
aRemoveLayerIDs  ,
aObjectIDs   
)
json WSM.APIBlend ( nHistoryID  ,
dRadius  ,
aPathIDs   
)

APIBlend creates a blend surface using the specified path.

Parameters: In: nHistoryID, dRadius, aPathIDs Out: JSON_UNDEFINED

Parameters
[in]nHistoryIDint
[in]dRadiusdouble
[in]aPathIDsArray of int
Returns
json WSM.APICanRedoHistoryReadOnly ( nHistoryID  )

APICanRedoHistoryReadOnly true if redo is possible.

Parameters: In: nHistoryID Out: bool

Parameters
[in]nHistoryIDint
Returns
bCanRedo
json WSM.APICanRedoHistoryToDeltaReadOnly ( nHistoryID  ,
nDeltaID   
)

APICanRedoHistoryToDeltaReadOnly true if redo is possible.

Parameters: In: nHistoryID, nTargetDeltaID Out: bool

Parameters
[in]nHistoryIDint
[in]nDeltaIDint
Returns
bCanRedo
json WSM.APICanUndoHistoryReadOnly ( nHistoryID  )

APICanUndoHistoryReadOnly true if undo is possible.

Parameters: In: nHistoryID Out: bool

Parameters
[in]nHistoryIDint
Returns
bCanUndo
json WSM.APICanUndoHistoryToDeltaReadOnly ( nHistoryID  ,
nDeltaID   
)

APICanUndoHistoryToDeltaReadOnly true if undo is possible.

Parameters: In: nHistoryID, nTargetDeltaID Out: bool

Parameters
[in]nHistoryIDint
[in]nDeltaIDint
Returns
bCanUndo
json WSM.APIChangeHistoryID ( nHistoryID  )

APIChangeHistoryID() function.

Parameters
[in]nHistoryIDint
Returns
nHistoryID
json WSM.APICheckHistoryValidityReadOnly ( nHistoryID  )

Finds all errors in the History (including on every live Object in the History).

Note this is a read only operation. Returns the number of bad Results.

Parameters
[in]nHistoryIDint
Returns
scriptInstance.GetResults().size()
json WSM.APICheckValidityReadOnly ( nHistoryID  ,
nObjectID   
)

APICheckValidityReadOnly Parameters: In: nHistoryID, nObjectID Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
scriptInstance.GetResults().size()
json WSM.APICleanModel ( nHistoryID  ,
dEdgeTol   
)

Changes the model fixing errors and getting rid of undesired features.

Parameters: In: nHistoryID, dEdgeTol Out: Vector of changed History IDs

Parameters
[in]nHistoryIDint
[in]dEdgeTol(OPTIONAL, default = 0.0) double
Returns
aChangedHistories
json WSM.APIClearResults ( )

Clear the list of Results managed by ScriptInstance.

Returns
numResults
json WSM.APIComputeAreaReadOnly ( nHistoryID  ,
nObjectID  ,
transf   
)

APIComputeAreaReadOnly Parameters: In: nHistoryID, nObjectID, transf Out: nArea.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
[in]transf(OPTIONAL) WSM.Transf3d
Returns
nArea
json WSM.APIComputeVolumeReadOnly ( nHistoryID  ,
nObjectID  ,
transf   
)

APIComputeVolumeReadOnly Parameters: In: nHistoryID, nObjectID Out: nVolume.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
[in]transf(OPTIONAL) WSM.Transf3d
Returns
nVolume
json WSM.APIConnectPoint3ds ( nHistoryID  ,
point3d1  ,
point3d2   
)

APIConnectPoint3ds Parameters: In: nHistoryID, point3d1, point3d2 Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]point3d1WSM.Point3d
[in]point3d2WSM.Point3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIConnectVertexAndPoint3d ( nHistoryID  ,
nVertexID  ,
point3d   
)

APIConnectVertexAndPoint3d Parameters: In: nHistoryID, nVertexID, point3d Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]nVertexIDint
[in]point3dWSM.Point3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIConnectVertices ( nHistoryID  ,
nVertexID1  ,
nVertexID2   
)

APIConnectVertices Parameters: In: nHistoryID, nVertexID1, nVertexID2 Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]nVertexID1int
[in]nVertexID2int
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APICopyObject ( nHistoryID  ,
nToHistoryID  ,
nObjectID   
)

APICopyObject copies nObjectID in nHistoryID to nToHistoryID.

nHistoryID and nToHistoryID can be the same. Parameters: In: nHistoryID, nObjectID, nToHistoryID Out: nObjectID (The new copied Object)

Parameters
[in]nHistoryIDint
[in]nToHistoryIDint
[in]nObjectIDint
Returns
nCreatedObjectID
json WSM.APICopyOrSketchAndTransformObjects ( nFromHistoryID  ,
nToHistoryID  ,
aFromObjectIDs  ,
transform  ,
nNumCopies  ,
bGroupBodies  ,
groupTransf3d   
)
json WSM.APICover ( nHistoryID  ,
aEdgeIDs  ,
bMerge   
)

APICover makes Faces the cover a closed circuit of Edges.

Parameters: In: nHistoryID, aEdgeIDs, bMerge Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]aEdgeIDsArray of int
[in]bMerge(OPTIONAL, default = false) bool
Returns
json WSM.APICreateBlock ( nHistoryID  ,
point3d1  ,
point3d2   
)

Create a block with the given corners.

Parameters: In: nHistoryID, point3d1(Point3d) , point3d2(Point3d) Out: nObjectID

Parameters
[in]nHistoryIDint
[in]point3d1WSM.Point3d
[in]point3d2WSM.Point3d
Returns
objID
json WSM.APICreateCircleOrArc ( nHistoryID  ,
radius  ,
posCenter  ,
xAxis  ,
yAxis  ,
dStartParam  ,
dEndParam  ,
accuracyORcount  ,
bReadOnly  ,
trans  ,
nMinimumNumberOfFacets   
)

Create a circle or arc defined by C(t) = posCenter + radius * (xAxis * cos(t) + yAxis * sin(t)) where t goes from dStartParam to dEndParam Parameter accuracyORcount means: MAX distance between base circle and segment as portion of R, if < 1 number of divisions (double rounded to int) over 90 degree arc, if >= 1 Parameters: In: nHistoryID , radius, posCenter, xAxis, yAxis, dStartParam, dEndParam, accuracyORcount, trans, nMinimumNumberOfFacets Out: nObjectID.

Parameters
[in]nHistoryIDint
[in]radiusdouble
[in]posCenterWSM.Point3d
[in]xAxis(OPTIONAL, default = WSM.UnitVector3d.kXDir) WSM.UnitVector3d
[in]yAxis(OPTIONAL, default = WSM.UnitVector3d.kYDir) WSM.UnitVector3d
[in]dStartParam(OPTIONAL, default = 0.0) double
[in]dEndParam(OPTIONAL, default = WSM_2PI) double
[in]accuracyORcount(OPTIONAL, default = 10.0) double
[in]bReadOnly(OPTIONAL) bool
[in]trans(OPTIONAL, default = WSM.Transf3d.kIdentity) WSM.Transf3d
[in]nMinimumNumberOfFacets(OPTIONAL, default = 0) int
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APICreateCircleOrArcFromPoints ( nHistoryID  ,
arcStartPos  ,
arcEndPos  ,
thirdPoint  ,
accuracyORcount  ,
bReadOnly  ,
trans  ,
nMinimumNumberOfFacets   
)

Create a circle or arc defined by points Parameter accuracyORcount means: MAX distance between base circle and segment as portion of R, if < 1 number of divisions (double rounded to int) over 90 degree arc, if >= 1 Parameters: In: nHistoryID , radius, posCenter, xAxis, yAxis, dStartParam, dEndParam, accuracyORcount, trans, nMinimumNumberOfFacets Out: nObjectID.

Parameters
[in]nHistoryIDint
[in]arcStartPosWSM.Point3d
[in]arcEndPosWSM.Point3d
[in]thirdPointWSM.Point3d
[in]accuracyORcount(OPTIONAL, default = 10.0) double
[in]bReadOnly(OPTIONAL) bool
[in]trans(OPTIONAL, default = WSM.Transf3d.kIdentity) WSM.Transf3d
[in]nMinimumNumberOfFacets(OPTIONAL, default = 0) int
Returns
aPoints
json WSM.APICreateClampedHermiteSplineDataReadOnly ( nHistoryID  ,
aControlPoints  ,
startTangent  ,
endTangent  ,
bClosed  ,
aVertexIDsOnSpline  ,
nNumberOfNewContolPoints   
)
json WSM.APICreateCone ( nHistoryID  ,
nRadius  ,
nHeight  ,
centerPt  ,
nAccuracyORcount   
)

Create a hemisphere with the radius and at the given center point.

Parameters: In: nHistoryID, nRadius(#), nHeight(#), centerPt(Point3d), nAccuracyORcount(#) Out: nObjectID

Parameters
[in]nHistoryIDint
[in]nRadiusdouble
[in]nHeightdouble
[in]centerPtWSM.Point3d
[in]nAccuracyORcountdouble
Returns
objID
json WSM.APICreateCylinder ( nHistoryID  ,
aPosCenter  ,
aRadius  ,
aHeight  ,
aAccuracyORcount  ,
aAxis   
)

APICreateCylinder returns a cylinder.

Parameters: In: nHistoryID, aPosCenter, aRadius, aHeight, aAxis Out: objID

Parameters
[in]nHistoryIDint
[in]aPosCenterWSM.Point3d
[in]aRadiusdouble
[in]aHeightdouble
[in]aAccuracyORcount(OPTIONAL, default = 10) double
[in]aAxis(OPTIONAL, default = WSM.UnitVector3d.kZDir) WSM.UnitVector3d
Returns
json WSM.APICreateEdgesFromData ( nHistoryID  ,
aLayers  ,
aEdges  ,
aCurves   
)

Load a set of edges from vectors of various data in a single delta.

All edges are added in a new group which it's hisotry id is returned by this function The structures are defined in the header GeometryDataContainers.h

Parameters
[in]nHistoryIDint
[in]aLayers(OPTIONAL) Array of WSM.LayerData
[in]aEdges(OPTIONAL) Array of WSM.EdgeData
[in]aCurves(OPTIONAL) Array of WSM.CurveData
Returns
nCreatedGroupID
json WSM.APICreateEmptyBody ( nHistoryID  )

APICreateEmptyBody creates an empty body.

Parameters: In: nHistoryID Out: JSON_UNDEFINED

Parameters
[in]nHistoryIDint
Returns
objID
json WSM.APICreateExtrusion ( nHistoryID  ,
aPoint3ds  ,
dist   
)

APICreateExtrusion returns an extrusion body, which is extruded from a polygon formed by aPoint3ds.

Note aPoint3ds should have at least 3 points and be on the same plane. Parameters: In: nHistoryID, aPoint3ds, dist Out: objID.

Parameters
[in]nHistoryIDint
[in]aPoint3dsArray of WSM.Point3d
[in]distdouble
Returns
json WSM.APICreateGeometryFromData ( nHistoryID  ,
aTextures  ,
aMaterials  ,
aLayers  ,
aInstances  ,
aFaces  ,
aEdges  ,
aCurves  ,
aImages  ,
aGroupName   
)

Load a model from vectors of various data in a single delta.

The structures are defined in the header GeometryDataContainers.h aGroupName is an optional parameter to give a Name to an history it's mainly used when history is used in conjunction with Groups

Parameters
[in]nHistoryIDint
[in]aTextures(OPTIONAL) Array of WSM.TextureData
[in]aMaterials(OPTIONAL) Array of WSM.MaterialData
[in]aLayers(OPTIONAL) Array of WSM.LayerData
[in]aInstances(OPTIONAL) Array of WSM.InstanceData
[in]aFaces(OPTIONAL) Array of WSM.FaceData
[in]aEdges(OPTIONAL) Array of WSM.EdgeData
[in]aCurves(OPTIONAL) Array of WSM.CurveData
[in]aImages(OPTIONAL) Array of WSM.ImageData
[in]aGroupName(OPTIONAL) String
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APICreateGroup ( nHistoryID  ,
aObjectIDs  ,
aInstanceTransforms  ,
nReferencedHistoryID  ,
transGeometry   
)
json WSM.APICreateHemisphere ( nHistoryID  ,
nRadius  ,
centerPt  ,
nAccuracyORcount   
)

Create a hemisphere with the radius and at the given center point.

Parameters: In: nHistoryID, nRadius(#), centerPt(Point3d), nAccuracyORcount(#) Out: nObjectID

Parameters
[in]nHistoryIDint
[in]nRadiusdouble
[in]centerPtWSM.Point3d
[in]nAccuracyORcountdouble
Returns
objID
json WSM.APICreateHermiteSpline ( nHistoryID  ,
aControlPoints  ,
bClosed  ,
startTangent  ,
endTangent  ,
bReadOnly   
)

Tessellate a cubic spline that touches all aControlPoints Fills the tessellated points into aOutPoints bClosed specifies that the end point is the start point, so the curve must be smooth and closed startTangent is an optional Vector that specifies the tangent at the start point endTangent is an option Vector that specifies the tangent at the end point bReadOnly, if true does not put geometry into the scene, only returns the tessellated points.

Parameters: In: nHistoryID, aControlPoints, bClosed, startTangent, endTangent, bReadOnly Out: aOutPoints, aOutPointsParams

Parameters
[in]nHistoryIDint
[in]aControlPointsArray of WSM.Point3d
[in]bClosed(OPTIONAL) bool
[in]startTangent(OPTIONAL) WSM.Vector3d
[in]endTangent(OPTIONAL) WSM.Vector3d
[in]bReadOnly(OPTIONAL) bool
Returns
{ { "outpoints" , to_json(aOutPoints) }, { "outpointsparams" , to_json(aOutPointsParams) } };
json WSM.APICreateHistory ( nHistoryID  ,
bNonTemporary   
)

APICreateHistory() function.

Parameters
[in]nHistoryID(OPTIONAL, default = WSM.INVALID_ID) int
[in]bNonTemporary(OPTIONAL, default = true) bool
Returns
nHistoryID
json WSM.APICreateImageObject ( nHistoryID  ,
sName  ,
nTextureID  ,
fAlphaValue  ,
bFeaturesVisible  ,
aCornersVector   
)

APICreateImageObject creates a image object.

Parameters: In: nHistoryID, sName, nTextureID, fAlphaValue, bFeaturesVisible, aCorners Out: nObjectID.

Parameters
[in]nHistoryIDint
[in]sNameString
[in]nTextureIDint
[in]fAlphaValuedouble
[in]bFeaturesVisiblebool
[in]aCornersVectorArray of WSM.Point3d
Returns
nObjectID
json WSM.APICreateImageObjectWithTexture ( nHistoryID  ,
sName  ,
fAlphaValue  ,
bFeaturesVisible  ,
aCornersVector  ,
aBitmapData  ,
sTextureName   
)

APICreateImageObjectWithTexture creates a image object with texture.

Parameters: In: nHistoryID, sName, fAlphaValue, bFeaturesVisible, aCorners, aBitmapData, sTextureName Out: nObjectID.

Parameters
[in]nHistoryIDint
[in]sNameString
[in]fAlphaValuedouble
[in]bFeaturesVisiblebool
[in]aCornersVectorArray of WSM.Point3d
[in]aBitmapDataArray of char
[in]sTextureName(OPTIONAL) String
Returns
nObjectID
json WSM.APICreateLayer ( nHistoryID  ,
name  ,
bDisplayed   
)

Create a layer object with a given name and display flag.

Parameters
[in]nHistoryIDint
[in]nameString
[in]bDisplayedbool
Returns
nLayerID
json WSM.APICreateLevelObjects ( nHistoryID  ,
aLevelsData  ,
aObjectIDs   
)
json WSM.APICreateMaterial ( nHistoryID  ,
nColor  ,
dHorizonalScale  ,
dVerticalScale  ,
nTextureID  ,
sMaterialName  ,
sMaterialIdentifier  ,
aAdditionalRenderData  ,
aAdditionalTextures   
)

APICreateMaterial makes a new Material.

Parameters: In: nHistoryID, nColor, dHorizontalScale, dVerticalScale, nTextureID Out: nMaterialID

Parameters
[in]nHistoryIDint
[in]nColorWSM.Color
[in]dHorizonalScale(OPTIONAL, default = 1.0) double
[in]dVerticalScale(OPTIONAL, default = 1.0) double
[in]nTextureID(OPTIONAL, default = WSM.INVALID_ID) int
[in]sMaterialName(OPTIONAL) String
[in]sMaterialIdentifier(OPTIONAL) String
[in]aAdditionalRenderData(OPTIONAL) vectorpairstring
[in]aAdditionalTextures(OPTIONAL) vectorpairstringsize
Returns
nMaterialID
json WSM.APICreateMaterialWithTexture ( nHistoryID  ,
nColor  ,
dHorizonalScale  ,
dVerticalScale  ,
aBitmapData  ,
bUseBitmapAlpha  ,
sMaterialName  ,
sMaterialIdentifier  ,
aAdditionalRenderData  ,
aAdditionalTextures  ,
sTextureName   
)

APICreateMaterialWithTexture makes a new Material.

Parameters: In: nHistoryID, nColor, dHorizontalScale, dVerticalScale, aBitmapData, nBytes Out: nMaterialID

Parameters
[in]nHistoryIDint
[in]nColorWSM.Color
[in]dHorizonalScaledouble
[in]dVerticalScaledouble
[in]aBitmapDataArray of char
[in]bUseBitmapAlpha(OPTIONAL, default = true) bool
[in]sMaterialName(OPTIONAL) String
[in]sMaterialIdentifier(OPTIONAL) String
[in]aAdditionalRenderData(OPTIONAL) vectorpairstring
[in]aAdditionalTextures(OPTIONAL) vectorpairstringsize
[in]sTextureName(OPTIONAL) String
Returns
nMaterialID
json WSM.APICreatePolyline ( nHistoryID  ,
aPoint3ds  ,
bForceClosed   
)

APICreatePolyline creates a polyline from a vector of Point3ds.

Parameters: In: nHistoryID, aPoint3ds, bForceClosed Out: Face ID.

Parameters
[in]nHistoryIDint
[in]aPoint3dsArray of WSM.Point3d
[in]bForceClosedbool
Returns
json WSM.APICreateRectangle ( nHistoryID  ,
firstEdgePt1  ,
firstEdgePt2  ,
projectionPt  ,
bReadOnly   
)

Create a rectangle based on one edge and a third point.

Parameters firstEdgePt1 and firstEdgePt2 define the first edge of the rectangle Parameter projectionPt is projected onto the plane with origin at firstEdgePt2 and normal towards firstEdgePt1 this projection is the third corner of the rectangle. The fourth corner is calculated from those three Parameter aCreatedPts will return a vector of size 4, containing the four corners of the rectangle If parameter bReadOnly is true, no Objects are created, and only the points are returned

Parameters
[in]nHistoryIDint
[in]firstEdgePt1WSM.Point3d
[in]firstEdgePt2WSM.Point3d
[in]projectionPtWSM.Point3d
[in]bReadOnly(OPTIONAL) bool
Returns
aCreatedPts
json WSM.APICreateSatelliteImageObject ( nHistoryID  ,
sName  ,
nTextureID  ,
fAlphaValue  ,
bFeaturesVisible  ,
aCornersVector  ,
coordinates  ,
coordinatesSpan  ,
aPixelDimensionsVector   
)

APICreateSatelliteImageObject creates a image object.

Parameters: In: nHistoryID, sName, nTextureID, fAlphaValue, bFeaturesVisible, aCorners, coordinates, coordinatesSpan, aPixelDimensionsVector Out: nObjectID.

Parameters
[in]nHistoryIDint
[in]sNameString
[in]nTextureIDint
[in]fAlphaValuedouble
[in]bFeaturesVisiblebool
[in]aCornersVectorArray of WSM.Point3d
[in]coordinatesWSM.Vector2d
[in]coordinatesSpanWSM.Vector2d
[in]aPixelDimensionsVectorArray of int
Returns
nObjectID
json WSM.APICreateSeparateHistoriesForInstances ( nHistoryID  ,
aInstanceIDs  ,
bNewGroupPerInstance   
)

Creates new copies of the existing groups and the referenced histories for the specified instances.

If bNewGroupPerInstance is true, then each given instance gets a new group and history. If it is false, then any input instances that share a group and history currently will share a new group and history.

Parameters
[in]nHistoryIDint
[in]aInstanceIDsArray of int
[in]bNewGroupPerInstancebool
Returns
aNewGroupIDs
json WSM.APICreateStringAttribute ( nHistoryID  ,
sKey  ,
sValue  ,
aObjIDs  ,
nCopyBehavior  ,
bIsSharedOnSplit   
)
json WSM.APICreateTexture ( nHistoryID  ,
aBitmapData  ,
bUseBitmapAlpha  ,
sTextureName   
)

APICreateTexture creates a new Texture object Parameters: In: nHistoryID, aBitmapData, sTextureName Out: nCreatedTextureID.

Parameters
[in]nHistoryIDint
[in]aBitmapDataArray of char
[in]bUseBitmapAlpha(OPTIONAL, default = true) bool
[in]sTextureName(OPTIONAL) String
Returns
nCreatedTextureID
json WSM.APIDebugObjectReadOnly ( nHistoryID  ,
nObjectID   
)

APIDebugObjectReadOnly() function.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
escaped
json WSM.APIDeleteAllHistories ( )

Delete all Histories and reset next History Id to be 0.

Returns
scriptInstance.GetResults().size()
json WSM.APIDeleteAllRedoHistory ( nHistoryID  ,
bReuseDiscardedObjectIDs   
)

APIDeleteAllRedoHistory - Deletes all forward Deltas.

If bReuseDiscardedObjectIDs is true, all the IDs that are only used in the forward Deltas will be released to be used again as required. Parameters: In: nHistoryID, bReuseDiscardedObjectIDs Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]bReuseDiscardedObjectIDs(OPTIONAL) bool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIDeleteHistory ( nHistoryID  )

Delete the given History and also the active history managed by ScriptInstance.

Parameters
[in]nHistoryIDint
Returns
scriptInstance.GetResults().size()
json WSM.APIDeleteObject ( nHistoryID  ,
nObjectID   
)

APIDeleteObject deletes nObjectID in the given nHistoryID.

Parameters: In: nHistoryID, nObjectID Out: JSON_UNDEFINED

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIDeleteObjects ( nHistoryID  ,
aObjectIDs   
)
json WSM.APIDetectFreeEdgesReadOnly ( nHistoryID  ,
nEdgeIDs   
)

APIDetectFreeEdgesReadOnly Returns a list of edges that have only one or zero faces connected and a list of non free edges.

Parameters: In: nHistoryID, nEdgeIDs Out: A list of free and non-free edge ids.

Parameters
[in]nHistoryIDint
[in]nEdgeIDsArray of int
Returns
{ { "aFreeEdges" , to_json(aFreeEdgeIDs) }, { "aNonFreeEdges" , to_json(aNonFreeEdgeIDs) } };
json WSM.APIDetectSilhouettesReadOnly ( nHistoryID  ,
nEdgeIDs  ,
cameraPos  ,
cameraDir  ,
bPerspectiveView  ,
bSmoothOnly   
)

APIDetectSilhouettesReadOnly Returns a list of silhouette edges from a list of edges.

Parameters: In: nHistoryID, nEdgeID, cameraPos, cameraDir, bPerspectiveView, bSmoothOnly Out: A list of silhouette edge IDs

Parameters
[in]nHistoryIDint
[in]nEdgeIDsArray of int
[in]cameraPosWSM.Point3d
[in]cameraDirWSM.Vector3d
[in]bPerspectiveViewbool
[in]bSmoothOnlybool
Returns
aSilIDs
json WSM.APIDisableJournaling ( )

APIDisableJournaling() function.

Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIDragFace ( nHistoryID  ,
nObjectID  ,
nDistance  ,
bMerge   
)

APIDragFace drags a face nObjectID along it normal by nDistance.

nHistoryID and nToHistoryID can be the same. Parameters: In: nHistoryID, nObjectID, nDistance, bMerge Out:

Parameters
[in]nHistoryIDint
[in]nObjectIDint
[in]nDistancedouble
[in]bMerge(OPTIONAL) bool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIDragFaces ( nHistoryID  ,
aaFaceIDs  ,
aDists  ,
aDirs  ,
bMerge   
)

APIDragFaces drags a group of faces aaFaceIDs by aDistance for each group.

nHistoryID and nToHistoryID can be the same. Parameters: In: nHistoryID, nObjectID, nDistance, bMerge Out:

Parameters
[in]nHistoryIDint
[in]aaFaceIDsArray of std.vector
[in]aDistsArray of double
[in]aDirs(OPTIONAL) Array of WSM.UnitVector3d
[in]bMerge(OPTIONAL) bool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIDumpResults ( )

Dump the list of Results managed by ScriptInstance.

Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIEditCircleEdges ( nHistoryID  ,
nEdgeIDs  ,
radius  ,
center  ,
normal  ,
xaxis   
)

APIEditCircleEdges Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis.

Parameters
[in]nHistoryIDint
[in]nEdgeIDsArray of int
[in]radiusdouble
[in]centerWSM.Point3d
[in]normalWSM.UnitVector3d
[in]xaxisWSM.UnitVector3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIEditCylinderFaces ( nHistoryID  ,
nFaceIDs  ,
radius  ,
center  ,
normal  ,
xaxis   
)

APIEditCylinderFaces Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis.

Parameters
[in]nHistoryIDint
[in]nFaceIDsArray of int
[in]radiusdouble
[in]centerWSM.Point3d
[in]normalWSM.UnitVector3d
[in]xaxisWSM.UnitVector3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIEditSphereFaces ( nHistoryID  ,
nFaceIDs  ,
radius  ,
center  ,
normal  ,
xaxis   
)

APIEditSphereFaces Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis.

Parameters
[in]nHistoryIDint
[in]nFaceIDsArray of int
[in]radiusdouble
[in]centerWSM.Point3d
[in]normalWSM.UnitVector3d
[in]xaxisWSM.UnitVector3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIEditSplineEdges ( nHistoryID  ,
nEdgeIDs  ,
aControlPoints  ,
bClosed  ,
startTangent  ,
endTangent   
)

APIEditSplineEdges Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis.

Parameters
[in]nHistoryIDint
[in]nEdgeIDsArray of int
[in]aControlPointsArray of WSM.Point3d
[in]bClosedbool
[in]startTangentWSM.Vector3d
[in]endTangentWSM.Vector3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIEnableJournaling ( nHistoryID  ,
sFilePath   
)
json WSM.APIEnableJournalingTypes ( aTypes  )

APIEnableJournalingTypes() function.

Parameters
[in]aTypesArray of String
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIExtrudeEdges ( nHistoryID  ,
aProfileIDs  ,
 
)

APIExtrudeEdges makes a Face from the given profile and a transformed copy of the edges.

Parameters: In: nHistoryID, aProfileIDs, t Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]aProfileIDsArray of int
[in]tWSM.Transf3d
Returns
json WSM.APIFaceContainsPointReadOnly ( nHistoryID  ,
nFaceID  ,
point   
)

APIFaceContainsPointReadOnly() function.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
[in]pointWSM.Point3d
Returns
bContains
json WSM.APIFlattenGroupsOrInstances ( nHistoryID  ,
aGroupOrInstanceIDs  ,
bRecursive   
)

Replace the instances and/or groups referenced in aGroupOrInstanceIDs by a copy of the contents of the referenced history.

If bRecursive is true, repeat the process for all the new groups created by the copy.

Parameters
[in]nHistoryIDint
[in]aGroupOrInstanceIDsArray of int
[in]bRecursivebool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIGetActiveHistory ( )

Get the Active history managed by ScriptInstance.

Returns
scriptInstance.GetActiveHistory()
json WSM.APIGetAllAggregateTransf3dsReadOnly ( nReferencedHistoryID  ,
nTopMostHistoryID   
)

APIGetAllAggregateTransf3dsReadOnly returns aggregate global transformations on a History referenced by a Group or Groups.

Parameters: In: nReferencedHistoryID, nTopMostHistoryID Out: transforms, paths (vector of Transf3d, vector of GroupInstancePath).

Parameters
[in]nReferencedHistoryIDint
[in]nTopMostHistoryIDint
Returns
{{ "transforms" , to_json(aGroupAggregateTransf3dVec)}, { "paths" , to_json(aGroupAggregatePaths)}};
json WSM.APIGetAllConnectedNonOwnedReadOnly ( nHistoryID  ,
nObjectID   
)

APIGetAllConnectedNonOwnedReadOnly returns an array of all NonOwned Object IDs that are connected to nObjectID.

Parameters: In: nHistoryID, nObjectID Out: Array of IDs.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
aNonOwned
json WSM.APIGetAllHistoriesReadOnly ( bWithTemporary  )

APIGetAllHistoriesReadOnly Gets the IDs of all active histories, optionally with temporary ones.

In: bWithTemporary Out: array of IDs.

Parameters
[in]bWithTemporary(OPTIONAL) bool
Returns
aIDs
json WSM.APIGetAllHistoryDeltasReadOnly ( nHistoryID  )

Get the IDs of all deltas in the given history.

Parameters: In: nHistoryID Out: list of delta IDs

Parameters
[in]nHistoryIDint
Returns
aDeltaIDs
json WSM.APIGetAllNonOwnedReadOnly ( nHistoryID  )

APIGetAllNonOwnedReadOnly returns an array of all NonOwned Object IDs.

Parameters: In: nHistoryID Out: Array of IDs.

Parameters
[in]nHistoryIDint
Returns
aNonOwned
json WSM.APIGetAllObjectsByTypeReadOnly ( nHistoryID  ,
nType   
)

Returns all the objects of type 'nType' contained by the history Parameters: In: nHistoryID, nType nType- WSM.nUnSpecifiedType WSM.nBodyType WSM.nLumpType WSM.nShellType WSM.nFaceType WSM.nLoopType WSM.nCoedgeType WSM.nEdgeType WSM.nVertexType Out: Array of Object IDs of the given nType.

Parameters
[in]nHistoryIDint
[in]nTypeint
Returns
aObjectIDs
json WSM.APIGetAllReachableHistoriesReadOnly ( nHistoryID  ,
bGoUp   
)

Gets all the Histories reachable from the given History going either up or down the chain of Histories based on the flag bGoUp.

Note, includes itself. In: nHistoryId bGoUp Out: array of history IDs.

Parameters
[in]nHistoryIDint
[in]bGoUpbool
Returns
aIDs
json WSM.APIGetBodyEdgesReadOnly ( nHistoryID  ,
nBodyID   
)

APIGetBodyEdgesReadOnly returns an array of all edge IDs for the given nBodyID.

Parameters: In: nHistoryID, nBodyID Out: Array of edge IDs.

Parameters
[in]nHistoryIDint
[in]nBodyIDint
Returns
aEdgeIDs
json WSM.APIGetBodyFacesReadOnly ( nHistoryID  ,
nObjectID   
)

GetBodyFacesReadOnly returns an array of Face IDs.

Note this is a read only operation. Parameters: In: nHistoryID, nObjectID Out: Array of face IDs.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
aFaceIDs
json WSM.APIGetBoxReadOnly ( nHistoryID  ,
nObjectID   
)

APIGeBoxReadOnly Parameters: In nHistoryID, nObjectID (Optional) Out: Interval3d.

Parameters
[in]nHistoryIDint
[in]nObjectID(OPTIONAL, default = WSM.INVALID_ID) int
Returns
interval
json WSM.APIGetCoedgeDirectionReadOnly ( nHistoryID  ,
nObjectID   
)

APIGetCoedgeDirectionReadOnly returns true if coedge and edge go in the same direction.

Note this is a read only operation. Parameters: In: nHistoryID, nObjectID Out: bForward

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
bForward
json WSM.APIGetConnectedEdgesReadOnly ( nHistoryID  ,
nEdgeID  ,
bBreakOnNonSmooth   
)

Returns all connected edges of a seed edge.

In: nHistoryID, nEdgeID, bBreakOnNonSmooth Out: Vector of connected Edge IDs.

Parameters
[in]nHistoryIDint
[in]nEdgeIDint
[in]bBreakOnNonSmoothbool
Returns
aConnectedEdges
json WSM.APIGetConvexityConnectedComponentReadOnly ( nHistoryID  ,
nLoopOrFaceID  ,
nConvexity   
)

APIGetConvexityConnectedComponentReadOnly Parameters: In: nHistoryID, nLoopOrFaceID, nConvexity Out: aConnectedFaces.

Parameters
[in]nHistoryIDint
[in]nLoopOrFaceIDint
[in]nConvexityint
Returns
{{ "aConnectedFaces" , to_json(aConnectedFaces)}};
json WSM.APIGetConvexityReadOnly ( nHistoryID  ,
nEdgeOrLoopID   
)

APIGetConvexityReadOnly returns the convexity of Edge or Loop ID.

Note this is a read only operation. Parameters: In: nHistoryID, nEdgeOrLoopID Out: nConvexity.

Parameters
[in]nHistoryIDint
[in]nEdgeOrLoopIDint
Returns
json WSM.APIGetCreatedChangedAndDeletedInActiveDeltaReadOnly ( nHistoryID  ,
nObjectType  ,
bForUndo   
)

APIGetCreatedChangedAndDeletedInActiveDeltaReadOnly Parameters: In: History ID, WSM.nObjectType nObjectType, bool bForUndo Out: Vector of Created, Vector of Changed, Vector of Deleted,.

Parameters
[in]nHistoryIDint
[in]nObjectTypeWSM.nObjectType
[in]bForUndo(OPTIONAL) bool
Returns
{{ "created" , to_json(aCreated)}, { "changed" , to_json(aChanged)}, { "deleted" , to_json(aDeleted)}};
json WSM.APIGetCreatedChangedAndDeletedInDeltaRangeReadOnly ( nHistoryID  ,
nStartDelta  ,
nEndDelta  ,
aObjectTypes   
)

APIGetCreatedChangedAndDeletedInDeltaRangeReadOnly Parameters: In: History ID, first Delta ID, second Delta ID, nObjectTypes Out: Vector of Created, Vector of Changed, Vector of Deleted,.

Parameters
[in]nHistoryIDint
[in]nStartDeltaint
[in]nEndDeltaint
[in]aObjectTypesArray of WSM.nObjectType
Returns
{{ "created" , to_json(aCreated)}, { "changed" , to_json(aChanged)}, { "deleted" , to_json(aDeleted)}};
json WSM.APIGetDynamoModelInformationReadOnly ( nHistoryID  )

APIGetDynamoModelInformationReadOnly returns Dynamo Model information of the history.

Parameters: In: nHistoryID Out: id, name, config, delta

Parameters
[in]nHistoryIDint
Returns
{{ "id" , to_json( id )}, { "name" , to_json(name)}, { "config" , to_json(config)}, { "delta" , to_json(delta)}};
json WSM.APIGetEdgeOrVertexMarkedSmoothReadOnly ( nHistoryID  ,
nObjectID   
)

GetEdgeMarkedSmoothReadOnly Returns whether an edge is marked as smooth.

If bIsSmooth is returned 'false', this may mean either that the edge is non-smooth or its smoothness is unknown. Parameters: In: HistoryID, EdgeID (the edge in question) Out: bool (true or false, the edge in question is marked as smooth)

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
bIsSmooth
json WSM.APIGetEdgePointsReadOnly ( nHistoryID  ,
nEdgeID   
)

APIGetEdgePointsReadOnly() function.

Parameters
[in]nHistoryIDint
[in]nEdgeIDint
Returns
{{ "start" , to_json(start)}, { "end" , to_json(end)}};
json WSM.APIGetEdgeStyleReadOnly ( nHistoryID  ,
nEdgeID   
)

APIGetEdgeStyleReadOnly() function.

Parameters
[in]nHistoryIDint
[in]nEdgeIDint
Returns
{{ "color" , to_json(nColor)}};
json WSM.APIGetEnabledJournalingTypesReadOnly ( )

APIGetEnabledJournalingTypesReadOnly returns the list of journaling 'types' that are enabled.

In: Out: Vector of enabled string types.

Returns
types
json WSM.APIGetFaceBacksideMaterialReadOnly ( nHistoryID  ,
nFaceID   
)

Gets the material of the backside of the given face.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
nMaterialID
json WSM.APIGetFaceCentroidPoint3dReadOnly ( nHistoryID  ,
nFaceID   
)

APIGetFaceCentroidPoint3dReadOnly returns the centroid point of nFaceID.

Note this is a read only operation. Parameters: In: nHistoryID, nFaceID Out: Centroid.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
centroidPt
json WSM.APIGetFaceConnectedComponentReadOnly ( nHistoryID  ,
nFaceID  ,
bUseVertices  ,
bSmooth  ,
aConnectedFaces   
)
json WSM.APIGetFaceFacetsReadOnly ( nHistoryID  ,
nFaceID   
)

APIGetFaceFacetsReadOnly gets the list of vertices grouped by triangles Parameters: In: nHistoryID, nFaceID, aFacets Out: aFacets.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
aFacets
json WSM.APIGetFacePlaneReadOnly ( nHistoryID  ,
nFaceID   
)

GetFacePlaneReadOnly returns the plane of nFaceID.

Note this is a read only operation. Parameters: In: nHistoryID, nFaceID Out: Plane.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
json WSM.APIGetFaceVariantReadOnly ( nHistoryID  ,
nFaceID   
)

APIGetFaceVariantReadOnly returns the variant of nFaceID.

Note this is a read only operation. Parameters: In: nHistoryID, nFaceID Out: dVariant.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
json WSM.APIGetFaceVertexNormalsReadOnly ( nHistoryID  ,
nFaceID  ,
aVertexIDsAndNormals   
)
json WSM.APIGetGroupReferencedHistoryReadOnly ( nHistoryID  ,
nGroupID   
)

APIGetGroupReferencedHistoryReadOnly returns the ID of the Group's referenced History Parameters: In: nHistoryID, nGroupID Out: nReferencedHistoryID.

Parameters
[in]nHistoryIDint
[in]nGroupIDint
Returns
nReferencedHistoryID
json WSM.APIGetHistoryDeltasReadOnly ( nHistoryID  ,
nStartDeltaID  ,
nEndDeltaID   
)

Get the IDs of the deltas in the given closed range in the given history.

Parameters
[in]nHistoryIDint
[in]nStartDeltaIDint
[in]nEndDeltaIDint
Returns
aDeltaIDs
json WSM.APIGetHistoryReferencingGroupsReadOnly ( nHistoryID  )

Returns a vector with groups that reference this history.

In: nHistoryID Out: Vector of Group ObjectIDs.

Parameters
[in]nHistoryIDint
Returns
aObjectIDs
json WSM.APIGetIdOfActiveDeltaReadOnly ( nHistoryID  ,
nDeltaOffset   
)

Get the active Delta ID.

Parameters: In: nHistoryID, nDeltaID, nDeltaOffset (optional) Out: ID.

Parameters
[in]nHistoryIDint
[in]nDeltaOffset(OPTIONAL, default = 0) int
Returns
nDeltaID
json WSM.APIGetImageDataReadOnly ( nHistoryID  ,
nImageID   
)

APIGetImageDataReadOnly gets image data Parameters: In: nHistoryID, nImageID Out: sName, nTextureID, nPosition, fAlphaValue, bFeaturesVisible, aCorners, bHasSatelliteData.

Parameters
[in]nHistoryIDint
[in]nImageIDint
Returns
{{ "sName" , to_json(sName)}, { "nTextureID" , to_json(nTextureID)}, { "nPosition" , to_json(nPosition)}, { "fAlphaValue" , to_json(fAlphaValue)}, { "bFeaturesVisible" , to_json(bFeaturesVisible)}, { "bHasSatelliteData" , to_json(bHasSatelliteData)}, { "aCorners" , to_json(aCornersVec)}};
json WSM.APIGetInstanceTransf3dReadOnly ( nHistoryID  ,
nInstanceID   
)

Returns the Instance's Transf3d.

In: nHistoryID, nInstanceID Out: Instance's Transf3d

Parameters
[in]nHistoryIDint
[in]nInstanceIDint
Returns
t
json WSM.APIGetInvalidID ( )

APIGetInvalidID Parameters: In: Out: ID.

Returns
WSM.INVALID_ID
json WSM.APIGetLayerDataReadOnly ( nHistoryID  ,
nLayerID   
)

Get the data from a layer.

Parameters
[in]nHistoryIDint
[in]nLayerIDint
Returns
{{ "name" , to_json(name)}, { "displayed" , to_json(bDisplayed)}};
json WSM.APIGetLevelDataReadOnly ( nHistoryID  ,
nLevelID   
)

APIGetLevelDataReadOnly gets the elevation and name properties.

Parameters: In: nHistoryID, nLevelID Out: sLevelName, dElevation

Parameters
[in]nHistoryIDint
[in]nLevelIDint
Returns
{{ "dElevation" , to_json(dElevation)}, { "sLevelName" , to_json(sLevelName)}};
json WSM.APIGetLocalCoordinateSystemReadOnly ( nHistoryID  )

Get the LCS (local coordinate system) of the given History.

Parameters: In: nHistoryID Out: transf3d.

Parameters
[in]nHistoryIDint
Returns
transf3d
json WSM.APIGetMaterialDataReadOnly ( nHistoryID  ,
nMaterialID   
)
json WSM.APIGetMemorySizeReadOnly ( nHistoryID  ,
bCollapsedHistoryWithLiveObjsOnly   
)

APIGetMemorySizeReadOnly Parameters: In: nHistoryID Out: nBytes.

Parameters
[in]nHistoryIDint
[in]bCollapsedHistoryWithLiveObjsOnly(OPTIONAL) bool
Returns
nBytes
json WSM.APIGetObjectAttributesReadOnly ( nHistoryID  ,
nObjectID   
)

Get all of the Attributes of the given Object.

Parameters: In: nHistoryID, nObjectID Out: Array of Object IDs of the given nType.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
aObjectIDs
json WSM.APIGetObjectLayersReadOnly ( nHistoryID  ,
nObjectID   
)

APIGetObjectLayersReadOnly gets all layer ids of the given object.

Parameters: In: nHistoryID, nObjectID Out: aLayersIDs

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
aLayersIDs
json WSM.APIGetObjectLevelsReadOnly ( nHistoryID  ,
nObjectID   
)

APIGetObjectLevelsReadOnly gets all level's ids of the given object.

Parameters: In: nHistoryID, nObjectID Out: aLevelsIDs

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
aLevelsIDs
json WSM.APIGetObjectMaterialReadOnly ( nHistoryID  ,
nFaceID   
)

APIGetObjectMaterialReadOnly gets an Object's material.

Parameters: In: nHistoryID, nObjectID Out: nMaterialID

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
nMaterialID
json WSM.APIGetObjectNameReadOnly ( nHistoryID  ,
nObjectID   
)

APIGetObjectNameReadOnly returns an object type.

Note this is a read only operation. Parameters: In: nHistoryID, nObjectID, Out: nName

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
{{ "objectName" , to_json(nName)}};
json WSM.APIGetObjectPropertiesReadOnly ( nHistoryID  ,
nObjectID  ,
sObjectName  ,
bReportAreaByLevel   
)
json WSM.APIGetObjectsByTypeReadOnly ( nHistoryID  ,
nObjectID  ,
nType  ,
bUpstream   
)

Returns all the objects of type 'nType' contained by the Object the given nObjectID if bUpstream is false; otherwise, return all the objects of type "nType" which are the parents of given object.

Note this is a read only operation. Parameters: In: nHistoryID, nObjectID, nType, bUpstream nType- WSM.nUnSpecifiedType WSM.nBodyType WSM.nLumpType WSM.nShellType WSM.nFaceType WSM.nLoopType WSM.nCoedgeType WSM.nEdgeType WSM.nVertexType Out: Array of Object IDs of the given nType.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
[in]nTypeint
[in]bUpstream(OPTIONAL) bool
Returns
aObjectIDs
json WSM.APIGetObjectTextureCoordinatesReadOnly ( nHistoryID  ,
nObjectID   
)

APIGetObjectTextureCoordinatesReadOnly generates tex coords for body or single face Parameters: In: nHistoryID, nObjectID Out: aTexCoords.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
aTexCoords
json WSM.APIGetObjectTypeReadOnly ( nHistoryID  ,
nObjectID   
)

APIGetObjectTypeReadOnly returns an object type.

Note this is a read only operation. Parameters: In: nHistoryID, nObjectID, Out: nType- WSM.nUnSpecifiedType WSM.nBodyType WSM.nLumpType WSM.nShellType WSM.nFaceType WSM.nLoopType WSM.nCoedgeType WSM.nEdgeType WSM.nVertexType

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
nType
json WSM.APIGetPointsFromObjectIDsReadOnly ( nHistoryID  ,
aIDs   
)
json WSM.APIGetRenderableFaceReadOnly ( nHistoryID  ,
nFaceID  ,
bCalculateTexCoords  ,
bBackSide   
)

APIGetRenderableFaceReadOnly() function.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
[in]bCalculateTexCoordsbool
[in]bBackSide(OPTIONAL) bool
Returns
{{ "vertices" , to_json(vertices)}, { "normals" , to_json(normals)}, { "texCoords" , to_json(texCoords)}};
json WSM.APIGetResultsCount ( )

Get the number of Results managed by ScriptInstance.

Returns
numResults
json WSM.APIGetRevitFamilyInformationReadOnly ( nHistoryID  )

APIGetRevitFamilyInformationReadOnly returns Revit Family information of the history.

Parameters: In: nHistoryID Out: bIsGeneratedFromRFA, bIsGeneratedFromBuiltinRFA, familyCategory, familyReference, familyType, familyExtraData

Parameters
[in]nHistoryIDint
Returns
{{ "bIsGeneratedFromRFA" , to_json(bIsGeneratedFromRFA)}, { "bIsGeneratedFromBuiltinRFA" , to_json(bIsGeneratedFromBuiltinRFA)}, { "familyCategory" , to_json(familyCategory)}, { "familyReference" , to_json(familyReference)}, { "familyType" , to_json(familyType)}, { "familyExtraData" , to_json(familyExtraData)}};
json WSM.APIGetSatelliteDataReadOnly ( nHistoryID  ,
nImageID   
)

APIGetSatelliteDataReadOnly gets satellite data from image Parameters: In: nHistoryID, nImageID Out: sName, nTextureID, nPosition, fAlphaValue, bFeaturesVisible, aCorners, bHasSatelliteData.

Parameters
[in]nHistoryIDint
[in]nImageIDint
Returns
{{ "coordinates" , to_json(coordinates)}, { "coordinatesSpan" , to_json(coordinatesSpan)}, { "aPixelDimensions" , to_json(aPixelDim)}};
json WSM.APIGetStringAttributeKeyValueReadOnly ( nHistoryID  ,
nStringAttributeID   
)

Gets the key and value strings from a StringAttribute.

Also returns owners. Parameters: In: nHistoryID, nStringAttributeID Out: Object: {sKey, sValue, aOwnerIDs}

Parameters
[in]nHistoryIDint
[in]nStringAttributeIDint
Returns
j;
json WSM.APIGetStringAttributesByKeyReadOnly ( nHistoryID  ,
nObjectID  ,
sKey   
)

Returns all StringAttributes attached to the Object given by nObjectID with key matching sKey.

Note if nObjectID is WSM.INVALID_ID, then returns all StringAttributes in the History with key sKey. This is a read only operation. In: nHistoryID, nObjectID, sKey Out: aStringAttributeIDs

Parameters
[in]nHistoryIDint
[in]nObjectIDint
[in]sKeyString
Returns
aStringAttributeIDs
json WSM.APIGetTextureDataReadOnly ( nHistoryID  ,
nTextureID   
)

APIGetTextureDataReadOnly gets a Texture object's bitmap data Parameters: In: nHistoryID, nTextureID Out: JSON object with data.

Parameters
[in]nHistoryIDint
[in]nTextureIDint
Returns
{{ "bitmap" , to_json(bitmapDataInt)}, { "bUseBitmapAlpha" , to_json(bUseBitmapAlpha)}, { "sTextureName" , to_json(sTextureName)}};
json WSM.APIGetTopLevelOwnersReadOnly ( nHistoryID  ,
nObjectID   
)

APIGetTopLevelOwnersReadOnly returns the top level owners of the given Object.

Parameters: In: nHistoryID, nObjectID Out: aOwnerIDs.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
aOwnerIDs
json WSM.APIGetVersionReadOnly ( )

APIGetVersionReadOnly Parameters: In: Out: JSON.

Returns
{{ "nMajorVer" , to_json(nMajorVer)},{ "nMinorVer" , to_json(nMinorVer)}};
json WSM.APIGetVertexPoint3dReadOnly ( nHistoryID  ,
nVertexID   
)

APIGetVertexPoint3d returns the Point3d of a Vertex Parameters: In: nHistoryID, nVertexID Out: pt.

Parameters
[in]nHistoryIDint
[in]nVertexIDint
Returns
pt
json WSM.APIImprint ( nHistoryID  ,
nObjectID1  ,
nObjectID2  ,
bChangeBoth   
)

APIImprint Parameters: In: nHistoryID, nObjectID1, nObjectID2, bChangeBoth Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]nObjectID1int
[in]nObjectID2int
[in]bChangeBothbool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIImprintWithPlane ( nHistoryID  ,
nObjectID  ,
plane   
)

APIImprintWithPlane Parameters: In: nHistoryID, nObjectID, plane Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
[in]planeWSM.Plane
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIIntersectsNegativeSideOfPlanesReadOnly ( nHistoryID  ,
aPlanes  ,
bVertices  ,
bEdges  ,
bFaces  ,
bStrict  ,
dTol  ,
line3dPickRay  ,
bSearchInGroups  ,
bPickInstances   
)
json WSM.APIIsEdgeManifoldReadOnly ( nHistoryID  ,
nEdgeID   
)

See WSMAPI for full comment Parameters: In: nHistoryID, nEdgeID Out: bool (isManifold)

Parameters
[in]nHistoryIDint
[in]nEdgeIDint
Returns
bIsManifold
json WSM.APIIsEdgeMergeableReadOnly ( nHistoryID  ,
nEdgeID  ,
bUseMaterial   
)

APIIsEdgeMergeableReadOnly In: nHistoryID, nEdgeID, bUseMaterial Out:bool (true or false that the Edge is mergeable.

Parameters
[in]nHistoryIDint
[in]nEdgeIDint
[in]bUseMaterial(OPTIONAL) bool
Returns
bIsMergeable
json WSM.APIIsEdgeOnCircleReadOnly ( nHistoryID  ,
nEdgeID   
)

APIIsEdgeOnCircleReadOnly Parameters: In: nHistoryID, nEdgeID Out: radius, center, normal, xaxis, aAllCircleSiblings.

Parameters
[in]nHistoryIDint
[in]nEdgeIDint
Returns
{{ "radius" , to_json(radius)}, { "center" , to_json(center)}, { "normal" , to_json(normal)}, { "xaxis" , to_json(xaxis)}, { "aAllCircleSiblings" , to_json(aAllCircleSiblings)}, { "bHasCircleAttribute" , to_json(bHasCircleAttribute)}};
json WSM.APIIsEdgeOnSplineReadOnly ( nHistoryID  ,
nEdgeID   
)

APIIsEdgeOnSplineReadOnly Parameters: In: nHistoryID, nEdgeID Out: aControlPoints, bClosed, startTangent, endTangent, aAllSplineSiblings.

Parameters
[in]nHistoryIDint
[in]nEdgeIDint
Returns
{{ "aControlPoints" , to_json(aControlPoints)}, { "bClosed" , to_json(bClosed)}, { "startTangent" , to_json(startTangent)}, { "endTangent" , to_json(endTangent)}, { "aAllSplineSiblings" , to_json(aAllSplineSiblings)}, { "bHasSplineAttribute" , to_json(bHasSplineAttribute)}};
json WSM.APIIsEdgeSilhouetteReadOnly ( nHistoryID  ,
nEdgeID  ,
cameraPos  ,
cameraDir  ,
bPerspectiveView   
)

APIIsEdgeSilhouetteReadOnly Returns whether an edge is a silhouette.

Parameters: In: nHistoryID, nEdgeID, cameraPos, cameraDir, bPerspectiveView Out: bool (true or false, the edge in question is a silhouette)

Parameters
[in]nHistoryIDint
[in]nEdgeIDint
[in]cameraPosWSM.Point3d
[in]cameraDirWSM.Vector3d
[in]bPerspectiveViewbool
Returns
bIsSilhouette
json WSM.APIIsExactMatchReadOnly ( nHistoryID1  ,
nHistoryID2  ,
nObjectID1  ,
nObjectID2   
)

API compares either two Histories or two Objects and sets bIsExact to true when they match exactly.

If both nObjectID1 and nObjectId2 are WSM.INVALID_ID then the Histories are compared, otherwise the Objects are compared. In: nHistoryID1, nHistoryID2, nObjectID1, nObjectID2 Out:bool true or false as there is an exact match

Parameters
[in]nHistoryID1int
[in]nHistoryID2int
[in]nObjectID1(OPTIONAL, default = WSM.INVALID_ID) int
[in]nObjectID2(OPTIONAL, default = WSM.INVALID_ID) int
Returns
bIsExact
json WSM.APIIsFaceOnBlendReadOnly ( nHistoryID  ,
nFaceID   
)

APIIsFaceOnBlendReadOnly Parameters: In: nHistoryID, nFaceID Out: radius, aPathPoints, aAllBlendSiblings.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
{{ "radius" , to_json(radius)}, { "aPathPoints" , to_json(aPathPoints)}, { "aAllBlendSiblings" , to_json(aAllBlendSiblings)}, { "bHasBlendAttribute" , to_json(bHasBlendAttribute)}};
json WSM.APIIsFaceOnCylinderReadOnly ( nHistoryID  ,
nFaceID   
)

APIIsFaceOnCylinderReadOnly Parameters: In: nHistoryID, nFaceID Out: radius, center, normal, xaxis, aAllCylinderSiblings.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
{{ "radius" , to_json(radius)}, { "center" , to_json(center)}, { "normal" , to_json(normal)}, { "xaxis" , to_json(xaxis)}, { "aAllCylinderSiblings" , to_json(aAllCylinderSiblings)}, { "bHasCylinderAttribute" , to_json(bHasCylinderAttribute)}};
json WSM.APIIsFaceOnExtrudeReadOnly ( nHistoryID  ,
nFaceID   
)

APIIsFaceOnExtrudeReadOnly Parameters: In: nHistoryID, nFaceID Out: base, axis, xaxis, aControlPoints, bClosed, startTangent, endTangent, aAllExtrudeSiblings.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
{{ "base" , to_json(base)}, { "axis" , to_json(axis)}, { "xaxis" , to_json(xaxis)}, { "aControlPoints" , to_json(aControlPoints)}, { "startTangent" , to_json(startTangent)}, { "endTangent" , to_json(endTangent)}, { "bClosed" , to_json(bClosed)}, { "aAllExtrudeSiblings" , to_json(aAllExtrudeSiblings)}, { "bHasExtrudeAttribute" , to_json(bHasExtrudeAttribute)}};
json WSM.APIIsFaceOnSphereReadOnly ( nHistoryID  ,
nFaceID   
)

APIIsFaceOnSphereReadOnly Parameters: In: nHistoryID, nFaceID Out: radius, center, normal, xaxis, aAllSphereSiblings.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
Returns
{{ "radius" , to_json(radius)}, { "center" , to_json(center)}, { "normal" , to_json(normal)}, { "xaxis" , to_json(xaxis)}, { "aAllSphereSiblings" , to_json(aAllSphereSiblings)}, { "bHasSphereAttribute" , to_json(bHasSphereAttribute)}};
json WSM.APIIsHistoryNonTemporaryReadOnly ( nHistoryID  )

APIIsHistoryNonTemporaryReadOnly() function.

Parameters
[in]nHistoryIDint
Returns
isNonTemporary
json WSM.APIIsJournalingReadOnly ( )

Check if Journaling is enabled.

In: Out: bool

Returns
bIsJournaling
json WSM.APIIsNonOwnedReadOnly ( nHistoryID  ,
nObjectID   
)

APIIsNonOwnedReadOnly returns whether this object has an owner.

Parameters: In: nHistoryID, nObjectID Out: bNonOwned

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
bNonOwned
json WSM.APIIsObjectLiveReadOnly ( nHistoryID  ,
nObjectID   
)

APIIsObjectLiveReadOnly checks if an object is alive in history Parameters: In: nHistoryID, nObjectID Out: bIsLive.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
bIsLive
json WSM.APILoadAXMFile ( nHistoryID  ,
sFilePath  ,
isImport  ,
logOutputPath   
)

APILoadAXMFile Parameters: In: nHistoryID, sFilePath, isImport, logOutputPath Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]sFilePathString
[in]isImport(OPTIONAL) bool
[in]logOutputPath(OPTIONAL) String
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APILoadDeltaFromBinaryFile ( nHistoryID  ,
sFilePath   
)

APILoadDeltaFromBinaryFile Parameters: In: nHistoryID, sFilePath Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]sFilePathString
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APILoadDeltaFromBinaryString ( nHistoryID  ,
base64Str  ,
nDeltaID  ,
base64encoded   
)

APILoadDeltaFromBinaryString Parameters: In: nHistoryID, base64Str, [nDeltaID, [base64encoded]] Out: nDeltaID.

Parameters
[in]nHistoryIDint
[in]base64StrString
[in]nDeltaID(OPTIONAL, default = WSM.INVALID_ID) int
[in]base64encoded(OPTIONAL, default = true) bool
Returns
nDeltaID
json WSM.APILoadFromFacets ( nHistoryID  ,
facetsData  ,
nOptions  ,
dMaxDistanceFromOrigin  ,
dRemoveDuplicateTol   
)

Parameters: In: nHistoryID, facetsData, nOptions, dMaxDistanceFromOrigin, dRemoveDuplicateTol Out: IDs of created objects.

Parameters
[in]nHistoryIDint
[in]facetsDataArray of WSM.FacetsBodyData
[in]nOptions(OPTIONAL, default = to_ut(WSM.nLoadingOptions.Merge | WSM.nLoadingOptions.RemoveDuplicate)) int
[in]dMaxDistanceFromOrigin(OPTIONAL, default = 0.0) double
[in]dRemoveDuplicateTol(OPTIONAL, default = WSM_MACHINE_TOL) double
Returns
createdObjectIDs
json WSM.APILoadFromFile ( nHistoryID  ,
sFilePath  ,
eFileType  ,
nOptions  ,
dMaxDistanceFromOrigin   
)

APILoadFromFile Parameters: In: nHistoryID, sFilePath, eFileType, nOptions, dMaxDistanceFromOrigin Out: iObjectIdOffset.

Parameters
[in]nHistoryIDint
[in]sFilePathString
[in]eFileType(OPTIONAL, default = WSM.nFileTypeBinaryWSM) WSM.nFileType
[in]nOptions(OPTIONAL, default = to_ut(WSM.nLoadingOptions.RemoveDuplicate | WSM.nLoadingOptions.Merge)) int
[in]dMaxDistanceFromOrigin(OPTIONAL, default = 0.0) double
Returns
iObjectIdOffset
json WSM.APILoadFromString ( nHistoryID  ,
saveStringName  ,
eFileType  ,
nOptions  ,
dMaxDistanceFromOrigin  ,
bBase64Encoded   
)

APILoadFromString Parameters: In: nHistoryID, string or string name, [eFileType], [merge flag], [bBase64Encoded] Out: offset.

Parameters
[in]nHistoryIDint
[in]saveStringNameString
[in]eFileType(OPTIONAL, default = WSM.nFileTypeBinaryWSM) WSM.nFileType
[in]nOptions(OPTIONAL, default = to_ut(WSM.nLoadingOptions.RemoveDuplicate | WSM.nLoadingOptions.Merge)) int
[in]dMaxDistanceFromOrigin(OPTIONAL, default = 0.0) double
[in]bBase64Encoded(OPTIONAL, default = false) bool
Returns
iOffset
json WSM.APILoadHistoryFromBinaryString ( nHistoryID  ,
base64Str  ,
base64encoded   
)

APILoadHistoryFromBinaryString Parameters: In: nHistoryID, base64Str Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]base64StrString
[in]base64encoded(OPTIONAL, default = true) bool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APILoft ( nHistoryID  ,
aaProfileIDs  ,
bDeleteInteriorProfileFaces   
)

APILoft makes Faces that connect a vector of profiles.

Parameters: In: nHistoryID, aaProfileIDs, bDeleteInteriorProfileFaces Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]aaProfileIDsArray of std.vector
[in]bDeleteInteriorProfileFaces(OPTIONAL, default = false) bool
Returns
json WSM.APIMergeBody ( nHistoryID  ,
nBodyID   
)

APIMergeBody Parameters: In: nHistoryID, nBodyID Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]nBodyIDint
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIMergeDeltas ( nHistoryID  ,
nStartDeltaID  ,
nEndDeltaID  ,
bReuseDiscardedObjectIDs   
)

APIMergeDeltas merges the specified Delta range.

Parameters: In: nHistoryID, nStartDeltaID, nEndDeltaID, bReuseDiscardedObjectIDs Out: JSON_UNDEFINED

Parameters
[in]nHistoryIDint
[in]nStartDeltaID(OPTIONAL, default = WSM.INVALID_ID) int
[in]nEndDeltaID(OPTIONAL, default = WSM.INVALID_ID) int
[in]bReuseDiscardedObjectIDs(OPTIONAL, default = true) bool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIMoveImage ( nHistoryID  ,
nImageID  ,
nShift   
)

APIMoveImage moves the image along z axis.

Images positions >= 0 Parameters: In: nHistoryID, nImageID, nShift Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]nImageIDint
[in]nShiftint
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIMoveObject ( nHistoryID  ,
objectID  ,
displacement   
)

APIMoveObject moves the given object with displacement.

Parameters: In: nHistoryID, objectID, displacement Out: JSON_UNDEFINED

Parameters
[in]nHistoryIDint
[in]objectIDint
[in]displacementWSM.Vector3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIMoveObjects ( nHistoryID  ,
objectIDs  ,
transf3d   
)
json WSM.APIMoveVertices ( nHistoryID  ,
aVertexIDs  ,
aNewVertexPositions   
)

APIMoveVertices moves the vertices specified in aVertexIDs to the given positions in aNewVertexPositions.

Parameters: In: nHistoryID, aVertexIDs, aNewVertexPositions Out: JSON_UNDEFINED

Parameters
[in]nHistoryIDint
[in]aVertexIDsArray of int
[in]aNewVertexPositionsArray of WSM.Point3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIOffset3d ( nHistoryID  ,
nObjectID  ,
dDistance   
)

APIOffset3d offsets all the Faces in the given Object by the amount specified.

Parameters: In: nHistoryID, nObjectID, dDistance Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
[in]dDistancedouble
Returns
json WSM.APIOffsetEdges ( nHistoryID  ,
nEdgeIDs  ,
dOffsetDistance  ,
trans  ,
bReadOnly   
)

APIOffsetEdges offsets Edges by given distance.

Parameters: In: nHistoryID, nEdgeIDs, dOffsetDistance, trans = WSM.Transf3d.kIdentity, bReadOnly = false Out: bReadOnly == false ? JSON_UNDEFINED : offset Pts in boundary;

Parameters
[in]nHistoryIDint
[in]nEdgeIDsArray of int
[in]dOffsetDistancedouble
[in]trans(OPTIONAL, default = WSM.Transf3d.kIdentity) WSM.Transf3d
[in]bReadOnly(OPTIONAL, default = false) bool
Returns
json WSM.APIOffsetFace ( nHistoryID  ,
nFaceID  ,
dOffsetDistance  ,
bOffsetHolesToo  ,
trans  ,
bReadOnly   
)

APIOffsetFace offsets a copy of the boundary a face by given distance.

Parameters: In: nHistoryID, nFaceID, dOffsetDistance, bOffsetHolesToo = false, trans = WSM.Transf3d.kIdentity, bReadOnly = false Out: bReadOnly == false ? JSON_UNDEFINED : offset Pts in boundary;

Parameters
[in]nHistoryIDint
[in]nFaceIDint
[in]dOffsetDistancedouble
[in]bOffsetHolesToo(OPTIONAL, default = false) bool
[in]trans(OPTIONAL, default = WSM.Transf3d.kIdentity) WSM.Transf3d
[in]bReadOnly(OPTIONAL, default = false) bool
Returns
bReadOnly ? to_json(aOffsetPoints) : JSON_UNDEFINED;
json WSM.APIRayFireReadOnly ( nHistoryID  ,
line3dPickRay  ,
dRayRadius  ,
bVertices  ,
bEdges  ,
bFaces   
)

APIRayFireReadOnly calls WSM.APIRayFireReadOnly.

See WSMApi.h for comments. Parameters: In: nHistoryID, line3dPickRay, dRayRadius, bVertices, bEdges, bFaces Out: Array of IDs intersected by the ray.

Parameters
[in]nHistoryIDint
[in]line3dPickRayWSM.Line3d
[in]dRayRadiusdouble
[in]bVerticesbool
[in]bEdgesbool
[in]bFacesbool
Returns
aHits
json WSM.APIRayFireSortedReadOnly ( nHistoryID  ,
line3dPickRay  ,
dRayRadius  ,
bVertices  ,
bEdges  ,
bFaces  ,
dMaxParam  ,
bSearchInGroups   
)

APIRayFireSortedReadOnly calls WSM.APIRayFireReadOnly.

See WSMApi.h for comments. This version uses the pParamIndexVec param in WSM to get a sorted list. Parameters: In: nHistoryID, line3dPickRay, dRayRadius, bVertices, bEdges, bFaces, dMaxParam, bSearchInGroups Out: Array of IDs intersected by the ray.

Parameters
[in]nHistoryIDint
[in]line3dPickRayWSM.Line3d
[in]dRayRadiusdouble
[in]bVerticesbool
[in]bEdgesbool
[in]bFacesbool
[in]dMaxParam(OPTIONAL, default = WSM_DISTANCE_BIG) double
[in]bSearchInGroups(OPTIONAL) bool
Returns
{{ "directHits" , to_json(aHits)}, { "objectsInGroupsVec" , to_json(objectsInGroupsVec)}, { "groupAggregateTransf3dVec" , to_json(groupAggregateTransf3dVec)}, { "sortedIndices" , to_json(sortedIndices)}, { "sortedParameters" , to_json(sortedParameters)}};
json WSM.APIRedoHistory ( nHistoryID  ,
nApplyOnDeltaID   
)

APIRedoHistory redoes History.

Parameters: In: nHistoryID, nApplyOnDeltaID Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nApplyOnDeltaID(OPTIONAL, default = WSM.INVALID_ID) int
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIRedoHistoryToDelta ( nHistoryID  ,
nDeltaID   
)

APIRedoHistoryToDelta redoes History.

Parameters: In: nHistoryID, nDeltaID Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nDeltaIDint
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIRegisterProgressCallbacksReadOnly ( startCbkStr  ,
progressCbkStr  ,
finishCbkStr  ,
progressIncrement  ,
progressStart  ,
progressEnd   
)

Register API progress callback.

The first 3 parameters are names of the callback functions (passed as strings), which have to be global functions, i.e. defined outside of runtest(). All parameters are optional. Calling this API without arguments (or with the first argument being an empty string) resets the callbacks.

Parameters
[in]startCbkStr(OPTIONAL, default = "" s) String
[in]progressCbkStr(OPTIONAL, default = "" s) String
[in]finishCbkStr(OPTIONAL, default = "" s) String
[in]progressIncrement(OPTIONAL, default = 1.0f) float
[in]progressStart(OPTIONAL, default = 0.0f) float
[in]progressEnd(OPTIONAL, default = 100.0f) float
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIRemoveObjectsLayers ( nHistoryID  ,
aLayerIDs  ,
aObjectIDs   
)
json WSM.APIRemoveSatelliteData ( nHistoryID  ,
nImageID   
)

APIRemoveSatelliteData removes satellite data from image object Parameters: In: nHistoryID, nImageID Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]nImageIDint
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIReverseFaces ( nHistoryID  ,
aFaceIDs   
)

APIReverseFaces Parameters: In: nHistoryID, aFaceIDs Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]aFaceIDsArray of int
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIRotateFace ( nHistoryID  ,
nFaceID  ,
aRadian   
)

APIRotateFace rotates face by given radian using default rotation axis.

Parameters: In: nHistoryID, nFaceID, aRadian Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nFaceIDint
[in]aRadiandouble
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIRotateFaceBetweenPoints ( nHistoryID  ,
nFaceID  ,
startPt  ,
endPt   
)

Rotates a Face between two given points Both points are projected into the face plane The angle of rotation is a radian from 0 to 2PI, determined by the angle counterclockwise from Vector(startPt-faceCenter) to Vector(endPt-faceCenter), with normal as the face's normal Parameters: In: nHistoryID, nFaceID, startPt, endPt Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]nFaceIDint
[in]startPtWSM.Point3d
[in]endPtWSM.Point3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISaveAllActiveObjectsToBinaryFileReadOnly ( nHistoryID  ,
sFilePath   
)

APISaveAllActiveObjectsToBinaryFileReadOnly Parameters: In: nHistoryID, sFilePath Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]sFilePathString
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISaveDeltaToBinaryStringReadOnly ( nHistoryID  ,
nDeltaID   
)

APISaveDeltaToBinaryStringReadOnly Parameters: In: nHistoryID, [nDeltaID] Out: base64Str, deltaID.

Parameters
[in]nHistoryIDint
[in]nDeltaID(OPTIONAL, default = WSM.INVALID_ID) int
Returns
{{ "base64Str" , to_json(base64Str)}, { "deltaID" , to_json(nDeltaID)}};
json WSM.APISaveHistoryToBinaryFileReadOnly ( nHistoryID  ,
sFilePath  ,
aLayerDisplayedNegateVec   
)

APISaveHistoryToBinaryFileReadOnly Parameters: In: nHistoryID, sFilePath, [aLayerDisplayedNegateVec] Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]sFilePathString
[in]aLayerDisplayedNegateVec(OPTIONAL, default = {}) Array of WSM.ObjectHistoryID
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISaveHistoryToBinaryStringReadOnly ( nHistoryID  ,
bBase64Encode  ,
aLayerDisplayedNegateVec   
)

APISaveHistoryToBinaryBase64StringReadOnly Parameters: In: nHistoryID, bBase64Encode, [aLayerDisplayedNegateVec] Out: lastDeltaID.

Parameters
[in]nHistoryIDint
[in]bBase64Encodebool
[in]aLayerDisplayedNegateVec(OPTIONAL, default = {}) Array of WSM.ObjectHistoryID
Returns
{{ "output" , to_json(sOutputString)}, { "lastDeltaIDAssign" , to_json(lastDeltaID)}};
json WSM.APISaveLastDeltaToBinaryFile ( nHistoryID  ,
sFilePath   
)

APISaveLastDeltaToBinaryFile Parameters: In: nHistoryID, sFilePath Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]sFilePathString
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISaveToFileReadOnly ( nHistoryID  ,
aObjectIDs  ,
sFilePath  ,
eFileType  ,
bWithChildren  ,
dExportScale  ,
aExcludedObjects  ,
aLayerDisplayedNegateVec   
)
json WSM.APISaveToStringReadOnly ( nHistoryID  ,
aObjectIDs  ,
saveStringName  ,
bWithChildren  ,
aExcludedObjects  ,
bBase64Encode  ,
aLayerDisplayedNegateVec   
)
json WSM.APIScaleFace ( nHistoryID  ,
nFaceID  ,
aScaleFactor   
)

APIScaleFace scales face by given scale factor.

Parameters: In: nHistoryID, nFaceID, aScaleFactor Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nFaceIDint
[in]aScaleFactordouble
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISeparate ( nHistoryID  ,
nBodyID   
)

APISeparate Parameters: In: nHistoryID, nBodyID Out: A vector of new Body IDs.

Parameters
[in]nHistoryIDint
[in]nBodyIDint
Returns
aNewBodyIDs
json WSM.APISetDynamoModelInformation ( nHistoryID  ,
id  ,
name  ,
config  ,
delta   
)

APISetDynamoModelInformation sets Dynamo Model information of the history.

Parameters: In: nHistoryID, id, name, config, delta

Parameters
[in]nHistoryIDint
[in]id(OPTIONAL) String
[in]name(OPTIONAL) String
[in]config(OPTIONAL) String
[in]delta(OPTIONAL) String
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetEdgesOrVerticesMarkedSmooth ( nHistoryID  ,
aObjectIDs  ,
bSmooth   
)
json WSM.APISetEdgesStyle ( nHistoryID  ,
aEdgeIDs  ,
nColor   
)

APISetEdgesStyle() function.

Parameters
[in]nHistoryIDint
[in]aEdgeIDsArray of int
[in]nColorWSM.Color
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetFaceBacksideMaterial ( nHistoryID  ,
aFaceIDs  ,
nMaterialID   
)

Sets the material given by MaterialID as the backside material of the given faces.

Parameters
[in]nHistoryIDint
[in]aFaceIDsArray of int
[in]nMaterialIDint
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetImageData ( nHistoryID  ,
nImageID  ,
sName  ,
nTextureID  ,
fAlphaValue  ,
bFeaturesVisible  ,
aCornersVector   
)

APISetImageData sets data to image object Parameters: In: nHistoryID, nImageID, sName, nTextureID, fAlphaValue, aCorners Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]nImageIDint
[in]sNameString
[in]nTextureIDint
[in]fAlphaValuedouble
[in]bFeaturesVisiblebool
[in]aCornersVectorArray of WSM.Point3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetLayerData ( nHistoryID  ,
nLayerID  ,
name  ,
bDisplayed   
)

Set the data of a layer.

Parameters
[in]nHistoryIDint
[in]nLayerIDint
[in]nameString
[in]bDisplayedbool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetLayersDisplayed ( nHistoryID  ,
aLayerIDs  ,
bDisplayed   
)

Set the display flag of layers without affecting the other data.

Parameters
[in]nHistoryIDint
[in]aLayerIDsArray of int
[in]bDisplayedbool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetLevelsData ( nHistoryID  ,
aLevelIDs  ,
aLevelsData   
)

APISetLevelsData sets the elevation and name properties on Level.

Parameters: In: nHistoryID, aLevelIDs, aLevelsData Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]aLevelIDsArray of int
[in]aLevelsDataLevelDataType
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetLocalCoordinateSystem ( nHistoryID  ,
transf3d   
)

Set the LCS (local coordinate system) of the given History.

Parameters: In: nHistoryID, transf3d Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]transf3dWSM.Transf3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetMaterialColor ( nHistoryID  ,
nMaterialID  ,
nColor   
)

APISetMaterialColor sets the color on a Material.

Parameters: In: nHistoryID, nMaterialID, nColor Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nMaterialIDint
[in]nColorWSM.Color
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetMaterialData ( nHistoryID  ,
nMaterialID  ,
nColor  ,
dHorizontalScale  ,
dVerticalScale  ,
nTextureID  ,
sMaterialName  ,
sMaterialIdentifier  ,
aAdditionalRenderData  ,
aAdditionalTextures   
)

APISetMaterialData sets all the data of a Material.

Parameters: In: nHistoryID, nMaterialID, nColor, dHorizontalScale, dVerticalScale, nTextureID, sMaterialName, sMaterialIdentifier, aAdditionalRenderData, aAdditionalTextures Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nMaterialIDint
[in]nColorWSM.Color
[in]dHorizontalScaledouble
[in]dVerticalScaledouble
[in]nTextureIDint
[in]sMaterialName(OPTIONAL) String
[in]sMaterialIdentifier(OPTIONAL) String
[in]aAdditionalRenderData(OPTIONAL) vectorpairstring
[in]aAdditionalTextures(OPTIONAL) vectorpairstringsize
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetMaterialTexture ( nHistoryID  ,
nMaterialID  ,
dHorizontalScale  ,
dVerticalScale  ,
nTextureID   
)

APISetMaterialTexture sets the texture properties on a Material.

Parameters: In: nHistoryID, nMaterialID, dHorizontalScale, dVerticalScale, nTextureID Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nMaterialIDint
[in]dHorizontalScaledouble
[in]dVerticalScaledouble
[in]nTextureIDint
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetObjectProperties ( nHistoryID  ,
nObjectID  ,
sObjectName  ,
bReportAreaByLevel  ,
aDefaultLevelIDs   
)

Sets the properties of a given object (Body): A name and if that particular body reports its area by level or not.

Parameters: In: nHistoryID, nObjectID, sObjectName, bReportAreaByLevel, aDefaultLevelIDs Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nObjectIDint
[in]sObjectNameString
[in]bReportAreaByLevelbool
[in]aDefaultLevelIDs(OPTIONAL) Array of int
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetObjectsLevels ( nHistoryID  ,
aObjectIDs  ,
aLevelsIDs   
)
json WSM.APISetObjectsMaterial ( nHistoryID  ,
aObjectIDs  ,
nMaterialID   
)
json WSM.APISetRevitFamilyInformation ( nHistoryID  ,
bIsGeneratedFromRFA  ,
bIsGeneratedFromBuiltinRFA  ,
familyCategory  ,
familyReference  ,
familyType  ,
familyExtraData   
)

APISetRevitFamilyInformation sets Revit Family information of the history.

Parameters: In: nHistoryID, bIsGeneratedFromRFA, bIsGeneratedFromBuiltinRFA, familyCategory, familyReference, familyType, familyExtraData

Parameters
[in]nHistoryIDint
[in]bIsGeneratedFromRFAbool
[in]bIsGeneratedFromBuiltinRFAbool
[in]familyCategoryString
[in]familyReferenceString
[in]familyTypeString
[in]familyExtraDataString
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetSatelliteData ( nHistoryID  ,
nImageID  ,
coordinates  ,
coordinatesSpan  ,
aPixelDimensions   
)

APISetSatelliteData sets satellite data to image object Parameters: In: nHistoryID, nImageID, coordinates, coordinatesSpan, aPixelDim Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]nImageIDint
[in]coordinatesWSM.Vector2d
[in]coordinatesSpanWSM.Vector2d
[in]aPixelDimensionsArray of int
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISetTextureData ( nHistoryID  ,
nTextureID  ,
aBitmapData  ,
bUseBitmapAlpha  ,
sTextureName   
)

APISetTexture data sets the bitmap data on a texture Parameters: In: nHistoryID, nTextureID, sBitmapData, nBytes Out: JSON_UNDEFINED;.

Parameters
[in]nHistoryIDint
[in]nTextureIDint
[in]aBitmapDataArray of char
[in]bUseBitmapAlpha(OPTIONAL, default = true) bool
[in]sTextureName(OPTIONAL) String
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIShell ( nHistoryID  ,
nBodyID  ,
dDistance  ,
aOpenFaceIDs   
)

APIShell shells the given Body by the specified distance.

Faces in aOpenFaceIDs are not offset creating openings into the final Body. Parameters: In: nHistoryID, nBodyID, dDistance, aOpenFaceIDs - optional vector of FaceID that are left open Out: JSON_UNDEFINED

Parameters
[in]nHistoryIDint
[in]nBodyIDint
[in]dDistancedouble
[in]aOpenFaceIDs(OPTIONAL) Array of int
Returns
json WSM.APISlice ( nHistoryID  ,
nDestinationHistoryID  ,
nObjectID  ,
plane   
)

APISlice Parameters: In: nHistoryID, nDestinationHistoryID, nObjectID, plane Out: Vector of new top levels.

Parameters
[in]nHistoryIDint
[in]nDestinationHistoryIDint
[in]nObjectIDint
[in]planeWSM.Plane
Returns
aNewNonOwnedIDs
json WSM.APISubtract ( nHistoryID  ,
nObjectID1  ,
nObjectID2  ,
aExtraObjectsIDs   
)

APISubtract Parameters: In: nHistoryID, nObjectID1, nObjectID2 Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]nObjectID1int
[in]nObjectID2int
[in]aExtraObjectsIDs(OPTIONAL) Array of int
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APISubtractNonDestructive ( blank  ,
tools   
)

APISubtractNonDestructive Parameters: In: blank, tools Out: JSON_UNDEFINED.

Parameters
[in]blankWSM.GroupInstancePath
[in]toolsArray of WSM.GroupInstancePath
Returns
json WSM.APISweep ( nHistoryID  ,
aProfile  ,
aPath  ,
bRemoveUnusedProfileAndPath   
)

APISweep creates a sweep from profile and path from Objects in GroupInstancePaths in nHistoryID.

Parameters: In: nHistoryID, aProfile, aPath, bRemoveUnusedProfileAndPath Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]aProfileArray of WSM.GroupInstancePath
[in]aPathArray of WSM.GroupInstancePath
[in]bRemoveUnusedProfileAndPath(OPTIONAL, default = false) bool
Returns
json WSM.APITaperFace ( nHistoryID  ,
nFaceID  ,
dRadians  ,
axis   
)

Taper a Face by angle around the given axis The angle of rotation is a radian from -PI/2 to PI/2 The angle of rotation is relative to the direction of the axis and the normal of the face.

If the axis vector is along the positive direction of a coedge then the positive angle will be outward and negative angle will produce an inward taper. Parameters: In: nHistoryID, nFaceID, dRadians, axis Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nFaceIDint
[in]dRadiansdouble
[in]axisWSM.Line3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APITransformObject ( nHistoryID  ,
nObjectID  ,
transf3d   
)

APITransformObject transforms nObjectID by the given transform (transf3d).

Parameters: In: nHistoryID, nObjectID, transf3d

Parameters
[in]nHistoryIDint
[in]nObjectIDint
[in]transf3dWSM.Transf3d
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APITransformObjects ( nHistoryID  ,
aObjectIDs  ,
transf3d   
)
json WSM.APIUndoHistory ( nHistoryID  ,
bAndDeleteRedo  ,
nApplyOnDeltaID   
)

APIUndoHistory undoes History.

Parameters: In: nHistoryID, bAndDeleteRedo Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]bAndDeleteRedo(OPTIONAL) bool
[in]nApplyOnDeltaID(OPTIONAL, default = WSM.INVALID_ID) int
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIUndoHistoryToDelta ( nHistoryID  ,
nDeltaID   
)

APIUndoHistoryToDelta undoes History.

Parameters: In: nHistoryID, nDeltaID Out: JSON_UNDEFINED;

Parameters
[in]nHistoryIDint
[in]nDeltaIDint
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIUndoOrRedoHistoryToDelta ( nHistoryID  ,
nDeltaID  ,
bAndDeleteRedo   
)

Step backward or forward until the given Delta is reached.

Parameters: In: nHistoryID, nTargetDeltaID

Parameters
[in]nHistoryIDint
[in]nDeltaIDint
[in]bAndDeleteRedo(OPTIONAL) bool
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIUnite ( nHistoryID  ,
nObjectID1  ,
nObjectID2  ,
aExtraObjectsIDs   
)

APIUnite Parameters: In: nHistoryID, nObjectID1, nObjectID2 Out: JSON_UNDEFINED.

Parameters
[in]nHistoryIDint
[in]nObjectID1int
[in]nObjectID2int
[in]aExtraObjectsIDs(OPTIONAL) Array of int
Returns
JSON_UNDEFINED, i.e. {}
json WSM.APIUniteNonDestructive ( blank  ,
tools   
)

APIUniteNonDestructive Parameters: In: blank, tools Out: JSON_UNDEFINED.

Parameters
[in]blankWSM.GroupInstancePath
[in]toolsArray of WSM.GroupInstancePath
Returns
json WSM.APIValidID ( nID  )

APIValidID.

Parameters: In: Out: bool

Parameters
[in]nIDint
Returns
(nID != WSM.INVALID_ID) && (nID != WSM.INVALID_IDx32)
json WSM.Color ( ,
,
,
 
)

Color constructs a Color.

Parameter ranges from 0-255 (int). Parameters: In: red, green, blue, alpha Accepts values in the range 0.0-1.0 Out: Color

Parameters
[in]rint
[in]gint
[in]bint
[in]aint
Returns
{...}
json WSM.ColorAreEqual ( c1  ,
c2   
)

ColorAreEqual returns true if the two given colors are equal.

Parameters: In: Color, Color Out: bool

Parameters
[in]c1WSM.Color
[in]c2WSM.Color
Returns
c1 == c2
json WSM.FacetsBodyData ( m_points  ,
m_polygonIndices  ,
m_polygonSmoothingIds  ,
m_colors  ,
m_polygonColorIndices   
)

GroupInstancePath creation method In: m_points, m_polygonIndices, m_polygonSmoothingIds, m_colors, m_polygonColorIndices Out: FacetsBodyData.

Parameters
[in]m_pointsArray of WSM.Point3d
[in]m_polygonIndicesArray of std.vector
[in]m_polygonSmoothingIdsArray of int
[in]m_colors(OPTIONAL) Array of WSM.Color
[in]m_polygonColorIndices(OPTIONAL) Array of int
Returns
{...}
json WSM.GroupInstancePath ( pathArray  )
json WSM.GroupInstancePathAreEqual ( path1  ,
path2   
)

ObjectHistoryIDAreEqual equals method In: path1, path2 Out: bool.

Parameters
[in]path1WSM.GroupInstancePath
[in]path2WSM.GroupInstancePath
Returns
path1 == path2
json WSM.Is32Bit ( )

Is32Bit returns true if WSM is compiled in 32 bit.

Returns
{...}
json WSM.ObjectHistoryID ( nHistoryID  ,
nObjectID   
)

ObjectHistoryID creation method In: nHistoryID, nObjectID Out: ObjectHistoryID.

Parameters
[in]nHistoryIDint
[in]nObjectIDint
Returns
{...}
json WSM.ObjectHistoryIDAreEqual ( id1  ,
id2   
)

ObjectHistoryIDAreEqual equals method In: ObjectID, ObjectID Out: bool.

Parameters
[in]id1WSM.ObjectHistoryID
[in]id2WSM.ObjectHistoryID
Returns
id1 == id2