WSM Namespace Reference

Description

WSM namespace.

Namespaces
	AppHelper
	WSM.AppHelper namespace.
	Atf
	WSM.Atf namespace.
	Geom
	WSM.Geom namespace.
	GroupInstancePath
	WSM.GroupInstancePath namespace.
	InferenceEngine
	WSM.InferenceEngine namespace.
	Interval3d
	WSM.Interval3d namespace.
	Line3d
	WSM.Line3d namespace.
	Plane
	WSM.Plane namespace.
	Point3d
	WSM.Point3d namespace.
	RenderHelper
	WSM.RenderHelper namespace.
	Sat
	WSM.Sat namespace.
	Skup
	WSM.Skup namespace.
	Tools
	WSM.Tools namespace.
	Transf3d
	WSM.Transf3d namespace.
	UnitVector3d
	WSM.UnitVector3d namespace.
	Utils
	WSM.Utils namespace.
	Vector3d
	WSM.Vector3d namespace.

Typedefs
using	ObjectHistoryIDArray = std.vector< ObjectHistoryID >
using	GroupInstancePathArray = std.vector< GroupInstancePath >
using	ObjectIDArray = std.vector< size_t >

Functions
json	APIGetActiveHistory ()
	Get the Active history managed by ScriptInstance. More...
json	APICreateHistory (nHistoryID, bNonTemporary)
	APICreateHistory() function. More...
json	APIChangeHistoryID (nHistoryID)
	APIChangeHistoryID() function. More...
json	APIDeleteHistory (nHistoryID)
	Delete the given History and also the active history managed by ScriptInstance. More...
json	APIDeleteAllHistories ()
	Delete all Histories and reset next History Id to be 0. More...
json	APIGetAllHistoriesReadOnly (bWithTemporary)
	APIGetAllHistoriesReadOnly Gets the IDs of all active histories, optionally with temporary ones. More...
json	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	APIUndoHistory (nHistoryID, bAndDeleteRedo, nApplyOnDeltaID)
	APIUndoHistory undoes History. More...
json	APIRedoHistory (nHistoryID, nApplyOnDeltaID)
	APIRedoHistory redoes History. More...
json	APIUndoHistoryToDelta (nHistoryID, nDeltaID)
	APIUndoHistoryToDelta undoes History. More...
json	APIRedoHistoryToDelta (nHistoryID, nDeltaID)
	APIRedoHistoryToDelta redoes History. More...
json	APIDeleteAllRedoHistory (nHistoryID, bReuseDiscardedObjectIDs)
	APIDeleteAllRedoHistory - Deletes all forward Deltas. More...
json	APICanUndoHistoryReadOnly (nHistoryID)
	APICanUndoHistoryReadOnly true if undo is possible. More...
json	APICanRedoHistoryReadOnly (nHistoryID)
	APICanRedoHistoryReadOnly true if redo is possible. More...
json	APICanUndoHistoryToDeltaReadOnly (nHistoryID, nDeltaID)
	APICanUndoHistoryToDeltaReadOnly true if undo is possible. More...
json	APICanRedoHistoryToDeltaReadOnly (nHistoryID, nDeltaID)
	APICanRedoHistoryToDeltaReadOnly true if redo is possible. More...
json	APIUndoOrRedoHistoryToDelta (nHistoryID, nDeltaID, bAndDeleteRedo)
	Step backward or forward until the given Delta is reached. More...
json	APIGetAllHistoryDeltasReadOnly (nHistoryID)
	Get the IDs of all deltas in the given history. More...
json	APIGetHistoryDeltasReadOnly (nHistoryID, nStartDeltaID, nEndDeltaID)
	Get the IDs of the deltas in the given closed range in the given history. More...
json	APIMergeDeltas (nHistoryID, nStartDeltaID, nEndDeltaID, bReuseDiscardedObjectIDs)
	APIMergeDeltas merges the specified Delta range. More...
json	APIReverseFaces (nHistoryID, aFaceIDs)
	APIReverseFaces Parameters: In: nHistoryID, aFaceIDs Out: JSON_UNDEFINED;. More...
json	APICheckValidityReadOnly (nHistoryID, nObjectID)
	Finds all errors on the Object. More...
json	APICheckHistoryValidityReadOnly (nHistoryID)
	Finds all errors in the History (including on every live Object in the History). More...
json	APIComputeAreaReadOnly (nHistoryID, nObjectID, transf)
	Computes the surface area of the Object. More...
json	APIComputeVolumeReadOnly (nHistoryID, nObjectID, transf)
	Computes the volume of the Object. More...
json	APICopyObject (nHistoryID, nToHistoryID, nObjectID)
	APICopyObject copies nObjectID in nHistoryID to nToHistoryID. More...
json	APIDragFace (nHistoryID, nObjectID, nDistance, bMerge)
	APIDragFace drags a face nObjectID along it normal by nDistance. More...
json	APIDragFaces (nHistoryID, aaFaceIDs, aDists, aDirs, bMerge)
	APIDragFaces drags a group of faces aaFaceIDs by aDistance for each group. More...
json	APIScaleFace (nHistoryID, nFaceID, aScaleFactor)
	Scales a Face by given scale factor, around its centroid. More...
json	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	APIOffsetFace (nHistoryID, nFaceID, dOffsetDistance, bOffsetHolesToo, trans, bReadOnly)
	APIOffsetFace offsets a copy of the boundary a face by given distance. More...
json	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	APIRotateFace (nHistoryID, nFaceID, aRadian)
	APIRotateFace rotates face by given radian using default rotation axis. More...
json	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	APIMergeBody (nHistoryID, nBodyID, dSmoothCosAngle)
	Merges all the merge-able Edges and Vertices out of a Body. More...
json	APICreateBlock (nHistoryID, point3d1, point3d2)
	Create a block with the given corners. More...
json	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 < .75 number of divisions (double rounded to int) over 90 degree arc, if >= .75 Parameters: In: nHistoryID , radius, posCenter, xAxis, yAxis, dStartParam, dEndParam, accuracyORcount, trans, nMinimumNumberOfFacets Out: nObjectID. More...
json	APICreateCircleOrArcFromPoints (nHistoryID, arcStartPos, arcEndPos, thirdPoint, accuracyORcount, bReadOnly, trans, nMinimumNumberOfFacets, bCircle)
	Create a circle or arc defined by points Parameter accuracyORcount means: MAX distance between base circle and segment as portion of R, if < .75 number of divisions (double rounded to int) over 90 degree arc, if >= .75 Parameters: In: nHistoryID, arcStartPos, arcEndPos, thirdPoint, accuracyORcount, bReadOnly, trans, nMinimumNumberOfFacets, bCircle Out: The created vector of points. More...
json	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	APICreateClampedHermiteSplineDataReadOnly (nHistoryID, aControlPoints, startTangent, endTangent, bClosed, aVertexIDsOnSpline, nNumberOfNewContolPoints)
json	APICreateRectangle (nHistoryID, firstEdgePt1, firstEdgePt2, projectionPt, bReadOnly)
	Create a rectangle based on one edge and a third point. More...
json	APICreateHemisphere (nHistoryID, nRadius, centerPt, nAccuracyORcount)
	Create a hemisphere with the radius and at the given center point. More...
json	APICreateCone (nHistoryID, nRadius, nHeight, centerPt, nAccuracyORcount)
	Create a cone (above Z=0) with given parameters. More...
json	APISweep (nHistoryID, aProfile, aPath, bRemoveUnusedProfileAndPath)
	APISweep creates a sweep from profile and path from Objects in GroupInstancePaths in nHistoryID. More...
json	APIOffset3d (nHistoryID, nObjectID, dDistance)
	APIOffset3d offsets all the Faces in the given Object by the amount specified. More...
json	APIShell (nHistoryID, nBodyID, dDistance, aOpenFaceIDs)
	APIShell shells the given Body by the specified distance. More...
json	APIBlend (nHistoryID, dRadius, aPathIDs, accuracyORcount, nMinimumNumberOfFacets)
	APIBlend creates a blend surface using the specified path. More...
json	APIOffsetEdges (nHistoryID, nEdgeIDs, dOffsetDistance, trans, bReadOnly)
	APIOffsetEdges offsets Edges by given distance. More...
json	APICover (nHistoryID, aEdgeIDs, bMerge)
	APICover makes Faces the cover a closed circuit of Edges. More...
json	APILoft (nHistoryID, aaProfileIDs, bDeleteInteriorProfileFaces)
	APILoft makes Faces that connect a vector of profiles. More...
json	APIExtrudeEdges (nHistoryID, aProfileIDs, t)
	APIExtrudeEdges makes a Face from the given profile and a transformed copy of the edges. More...
json	APILoadAXMFile (nHistoryID, sFilePath, isImport, logOutputPath)
	Load an AXM file, both pre WSM and current. More...
json	APILoadMaterialsFromAXMFile (nHistoryID, sFilePath)
	Load only materials and their textures from an AXM file into the given history. More...
json	APISaveToAXMFileReadOnly (nHistoryID, aObjectIDs, sFilePath, aPreviewImage, bWithChildren)
	Saves Objects to an AXM file. More...
json	APILoadFromFile (nHistoryID, sFilePath, eFileType, nOptions, dMaxDistanceFromOrigin, dScaleFactor)
	APILoadFromFile Parameters: In: nHistoryID, sFilePath, eFileType, nOptions, dMaxDistanceFromOrigin, dScaleFactor Out: iObjectIdOffset. More...
json	APILoadFromFacets (nHistoryID, facetsData, nOptions, dMaxDistanceFromOrigin, dRemoveDuplicateTol)
	Parameters: In: nHistoryID, facetsData, nOptions, dMaxDistanceFromOrigin, dRemoveDuplicateTol Out: IDs of created objects. More...
json	APISaveLastDeltaToBinaryFile (nHistoryID, sFilePath)
	Save last Delta and all changed Objects to a binary file. More...
json	APISaveDeltaToBinaryStringReadOnly (nHistoryID, nDeltaID)
	APISaveDeltaToBinaryStringReadOnly Parameters: In: nHistoryID, [nDeltaID] Out: base64Str, deltaID. More...
json	APIGetLastDeltaIDReadOnly (nHistoryID, nBeforeLast)
	Get the ID of the target Delta, which is nBeforeLast before the last Delta (even for zero nBeforeLast, it may be different from the active Delta ID, if there are available Redo states). More...
json	APISaveDeltaToSolidDefReadOnly (nHistoryID, bForUndo)
	Gets the changed, created, and deleted objects in the most recent delta and encodes this information in a solid-def JSON string so that solid-def stored in HFDM can be kept up to date. More...
json	APIAddSolidDefGuids (nHistoryID, aObjectIDs)
	APIAddSolidDefGuids: Adds solid-def guids in StringAttributes to the given Objects. More...
json	APILoadDeltaFromBinaryString (nHistoryID, base64Str, nDeltaID, base64encoded)
	APILoadDeltaFromBinaryString Parameters: In: nHistoryID, base64Str, [nDeltaID, [base64encoded]] Out: nDeltaID. More...
json	APISaveToFileReadOnly (nHistoryID, aObjectIDs, sFilePath, eFileType, bWithChildren, dExportScale, aExcludedObjects, aLayerDisplayedNegateVec)
	Save Objects to a file of the specified type. More...
json	APISaveAllActiveObjectsToBinaryFileReadOnly (nHistoryID, sFilePath)
	Save all active Objects to a binary file. More...
json	APISaveHistoryToBinaryFileReadOnly (nHistoryID, sFilePath, aLayerDisplayedNegateVec)
	Save the whole history (with all undo states) to a binary file. More...
json	APISaveHistoryToBinaryStringReadOnly (nHistoryID, bBase64Encode, aLayerDisplayedNegateVec)
	Save the whole history (with all undo states) to a binary string. More...
json	APISaveToStringReadOnly (nHistoryID, aObjectIDs, bWithChildren, aExcludedObjects, aLayerDisplayedNegateVec, eFileType)
	Save Objects to a string. More...
json	APILoadFromString (nHistoryID, saveString, eFileType, nOptions, dMaxDistanceFromOrigin, dScaleFactor)
	Load a model from a string containing serialization of one of the supported types. More...
json	APILoadHistoryFromBinaryString (nHistoryID, base64Str, base64encoded)
	Load the whole history (with all undo states) from an, optionally base64 encoded, string and add to to an empty History. More...
json	APILoadDeltaFromBinaryFile (nHistoryID, sFilePath)
	Load Delta from a binary file and add it to the History. More...
json	APICreatePolyline (nHistoryID, aPoint3ds, bForceClosed)
	Creates a polyline using 3D sketching not linking with existing topology. More...
json	APICreateExtrusion (nHistoryID, aPoint3ds, dist)
	Create an extrusion on the given History. More...
json	APICreateCylinder (nHistoryID, aPosCenter, aRadius, aHeight, aAccuracyORcount, aAxis)
	Create a cylinder on the given History. More...
json	APIGetBodyFacesReadOnly (nHistoryID, nObjectID)
	GetBodyFacesReadOnly returns an array of Face IDs. More...
json	APIRegisterProgressCallbacksReadOnly (startCbkStr, progressCbkStr, finishCbkStr, progressIncrement, progressStart, progressEnd)
	Register API progress callback. More...
json	APIGetTopLevelOwnersReadOnly (nHistoryID, nObjectID)
	APIGetTopLevelOwnersReadOnly returns the top level owners of the given Object. More...
json	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	APIGetAllObjectsByTypeReadOnly (nHistoryID, nType)
	Returns all the objects of type 'nType' contained by the history Parameters: In: nHistoryID, nType nType- WSM.nObjectType.nUnSpecifiedType WSM.nObjectType.nBodyType WSM.nObjectType.nLumpType WSM.nObjectType.nShellType WSM.nObjectType.nFaceType WSM.nObjectType.nLoopType WSM.nObjectType.nCoedgeType WSM.nObjectType.nEdgeType WSM.nObjectType.nVertexType Out: Array of Object IDs of the given nType. More...
json	APIGetObjectTypeReadOnly (nHistoryID, nObjectID)
	APIGetObjectTypeReadOnly returns an object type. More...
json	APIGetObjectNameReadOnly (nHistoryID, nObjectID)
	APIGetObjectNameReadOnly returns an object type. More...
json	APIGetObjectPropertiesReadOnly (nHistoryID, nObjectID)
	Gets 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, Out: sObjectName, bReportAreaByLevel. More...
json	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	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	APIGetEdgeOrVertexMarkedSmoothReadOnly (nHistoryID, nObjectID)
	GetEdgeMarkedSmoothReadOnly Returns whether an edge is marked as smooth. More...
json	APISetEdgesOrVerticesMarkedSmooth (nHistoryID, aObjectIDs, bSmooth)
	SetEdgesOrVerticesMarkedSmooth Marks all of aObjectIDs' smoothness. More...
json	APIIsEdgeSilhouetteReadOnly (nHistoryID, nEdgeID, cameraPos, cameraDir, bPerspectiveView)
	APIIsEdgeSilhouetteReadOnly Returns whether an edge is a silhouette. More...
json	APIDetectSilhouettesReadOnly (nHistoryID, nEdgeIDs, cameraPos, cameraDir, bPerspectiveView, bSmoothOnly)
	APIDetectSilhouettesReadOnly Returns a list of silhouette edges from a list of edges. More...
json	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	APIIsEdgeManifoldReadOnly (nHistoryID, nEdgeID)
	Returns whether an edge has exactly two coedges on two distinct faces. More...
json	APIGetFacePlaneReadOnly (nHistoryID, nFaceID)
	GetFacePlaneReadOnly returns the plane of nFaceID. More...
json	APIGetFaceCentroidPoint3dReadOnly (nHistoryID, nFaceID)
	APIGetFaceCentroidPoint3dReadOnly returns the centroid point of nFaceID. More...
json	APIGetFaceConnectedComponentReadOnly (nHistoryID, nFaceID, bUseVertices, bSmooth)
	APIGetFaceConnectedComponentReadOnly Parameters: In: nHistoryID, nFaceID, bUseVertices, bSmooth Out: aConnectedFaces. More...
json	APIGetFaceVariantReadOnly (nHistoryID, nFaceID)
	APIGetFaceVariantReadOnly returns the variant of nFaceID. More...
json	APIGetFaceVertexNormalsReadOnly (nHistoryID, nFaceID)
	APIGetFaceVertexNormalsReadOnly returns the plane of nFaceID. More...
json	APIGetVertexPoint3dReadOnly (nHistoryID, nVertexID)
	APIGetVertexPoint3d returns the Point3d of a Vertex Parameters: In: nHistoryID, nVertexID Out: pt. More...
json	APIGetIdOfActiveDeltaReadOnly (nHistoryID, nDeltaOffset)
	Get the active Delta ID. More...
json	APIGetBodyEdgesReadOnly (nHistoryID, nBodyID)
	APIGetBodyEdgesReadOnly returns an array of all edge IDs for the given nBodyID. More...
json	APIGetAllNonOwnedReadOnly (nHistoryID)
	APIGetAllNonOwnedReadOnly returns an array of all NonOwned Object IDs. More...
json	APIGetAllConnectedNonOwnedReadOnly (nHistoryID, nObjectID)
	APIGetAllConnectedNonOwnedReadOnly returns an array of all NonOwned Object IDs that are connected to nObjectID. More...
json	APIRayFireReadOnly (nHistoryID, line3dPickRay, dRayRadius, bVertices, bEdges, bFaces)
	APIRayFireReadOnly calls WSM.APIRayFireReadOnly. More...
json	APIRayFireSortedReadOnly (nHistoryID, line3dPickRay, dRayRadius, bVertices, bEdges, bFaces, dMaxParam, bSearchInGroups, aIgnoreObjects)
	APIRayFireSortedReadOnly calls WSM.APIRayFireReadOnly. More...
json	APIIntersectsNegativeSideOfPlanesReadOnly (nHistoryID, aPlanes, bVertices, bEdges, bFaces, bStrict, dTol, line3dPickRay, bSearchInGroups, bPickInstances, aIgnoreObjects, bOneOnlyTest)
json	APITransformObject (nHistoryID, nObjectID, transf3d)
	APITransformObject transforms nObjectID by the given transform (transf3d). More...
json	APITransformObjects (nHistoryID, aObjectIDs, transf3d)
	APITransformObjects transforms aObjectIDs by the given transform (transf3d). More...
json	APIDeleteObject (nHistoryID, nObjectID)
	APIDeleteObject deletes nObjectID in the given nHistoryID. More...
json	APIDeleteObjects (nHistoryID, aObjectIDs)
	APIDeleteObjects deletes a vector of aObjectIDs in the given nHistoryID. More...
json	APICreateEmptyBody (nHistoryID)
	APICreateEmptyBody creates an empty body. More...
json	APIAddFaceComponentToBody (nHistoryID, nFaceID, nBodyID)
	APIAddFaceComponentToBody adds a Face and all connected Faces to a Body. More...
json	APIMoveVertices (nHistoryID, aVertexIDs, aNewVertexPositions)
	APIMoveVertices moves the vertices specified in aVertexIDs to the given positions in aNewVertexPositions. More...
json	APIMoveObject (nHistoryID, objectID, displacement)
	APIMoveObject moves the given object with displacement. More...
json	APIMoveObjects (nHistoryID, objectIDs, transf3d)
	APIMoveObjects moves the given objects with t. More...
json	APIDumpResults ()
	Dump the list of Results managed by ScriptInstance. More...
json	APIGetResultsCount ()
	Get the number of Results managed by ScriptInstance. More...
json	APIClearResults ()
	Clear the list of Results managed by ScriptInstance. More...
json	APIConnectPoint3ds (nHistoryID, point3d1, point3d2)
	APIConnectPoint3ds Parameters: In: nHistoryID, point3d1, point3d2 Out: JSON_UNDEFINED. More...
json	APIConnectVertexAndPoint3d (nHistoryID, nVertexID, point3d)
	APIConnectVertexAndPoint3d Parameters: In: nHistoryID, nVertexID, point3d Out: JSON_UNDEFINED. More...
json	APIConnectVertices (nHistoryID, nVertexID1, nVertexID2)
	APIConnectVertices Parameters: In: nHistoryID, nVertexID1, nVertexID2 Out: JSON_UNDEFINED. More...
json	APIImprint (nHistoryID, nObjectID1, nObjectID2, bChangeBoth)
	APIImprint Parameters: In: nHistoryID, nObjectID1, nObjectID2, bChangeBoth Out: JSON_UNDEFINED. More...
json	APIImprintWithPlane (nHistoryID, nObjectID, plane)
	APIImprintWithPlane Parameters: In: nHistoryID, nObjectID, plane Out: JSON_UNDEFINED. More...
json	APIIsEdgeOnCircleReadOnly (nHistoryID, nEdgeID)
	APIIsEdgeOnCircleReadOnly Parameters: In: nHistoryID, nEdgeID Out: radius, center, normal, xaxis, aAllCircleSiblings, bHasCircleAttribute. More...
json	APIEditCircleEdges (nHistoryID, nEdgeIDs, radius, center, normal, xaxis, angle)
	APIEditCircleEdges Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis. More...
json	APIIsEdgeOnSplineReadOnly (nHistoryID, nEdgeID)
	APIIsEdgeOnSplineReadOnly Parameters: In: nHistoryID, nEdgeID Out: aControlPoints, bClosed, startTangent, endTangent, aAllSplineSiblings, bHasSplineAttribute. More...
json	APIEditSplineEdges (nHistoryID, nEdgeIDs, aControlPoints, bClosed, startTangent, endTangent)
	APIEditSplineEdges Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis. More...
json	APIIsFaceOnCylinderReadOnly (nHistoryID, nFaceID)
	APIIsFaceOnCylinderReadOnly Parameters: In: nHistoryID, nFaceID Out: radius, center, normal, xaxis, aAllCylinderSiblings, bHasCylinderAttribute. More...
json	APIEditCylinderFaces (nHistoryID, nFaceIDs, radius, center, normal, xaxis)
	APIEditCylinderFaces Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis. More...
json	APIIsFaceOnSphereReadOnly (nHistoryID, nFaceID)
	APIIsFaceOnSphereReadOnly Parameters: In: nHistoryID, nFaceID Out: radius, center, normal, xaxis, aAllSphereSiblings, bHasSphereAttribute. More...
json	APIEditSphereFaces (nHistoryID, nFaceIDs, radius, center, normal, xaxis)
	APIEditSphereFaces Parameters: In: nHistoryID, nEdgeIDs, radius, center, normal, xaxis. More...
json	APIIsFaceOnExtrudeReadOnly (nHistoryID, nFaceID)
	APIIsFaceOnExtrudeReadOnly Parameters: In: nHistoryID, nFaceID Out: base, axis, xaxis, aControlPoints, bClosed, startTangent, endTangent, aAllExtrudeSiblings, bHasExtrudeAttribute. More...
json	APIIsFaceOnBlendReadOnly (nHistoryID, nFaceID)
	APIIsFaceOnBlendReadOnly Parameters: In: nHistoryID, nFaceID Out: radius, aPathPoints, aAllBlendSiblings, bHasBlendAttribute. More...
json	APIUnite (nHistoryID, nObjectID1, nObjectID2, aExtraObjectsIDs)
	APIUnite Parameters: In: nHistoryID, nObjectID1, nObjectID2 Out: JSON_UNDEFINED. More...
json	APISubtract (nHistoryID, nObjectID1, nObjectID2, aExtraObjectsIDs)
	APISubtract Parameters: In: nHistoryID, nObjectID1, nObjectID2 Out: JSON_UNDEFINED. More...
json	APIUniteNonDestructive (blank, tools)
	APIUniteNonDestructive Parameters: In: blank, tools Out: JSON_UNDEFINED. More...
json	APISubtractNonDestructive (blank, tools)
	APISubtractNonDestructive Parameters: In: blank, tools Out: JSON_UNDEFINED. More...
json	APISeparate (nHistoryID, nBodyID)
	APISeparate Parameters: In: nHistoryID, nBodyID Out: A vector of new Body IDs. More...
json	APISlice (nHistoryID, nDestinationHistoryID, nObjectID, plane, aIgnoreObjects)
	APISlice When aIgnoreObjects is not empty, only objects that are not part of aIgnoreObjects are sliced. More...
json	APISliceHistoryReadOnly (nHistoryID, plane, aIgnoreObjects)
	APISliceHistoryReadOnly Slices the history with the Plane creating line points. More...
json	APIGetMemorySizeReadOnly (nHistoryID, bCollapsedHistoryWithLiveObjsOnly)
	APIGetMemorySizeReadOnly Parameters: In: nHistoryID Out: nBytes. More...
json	APIGetVersionReadOnly ()
	APIGetVersionReadOnly Parameters: In: Out: JSON. More...
json	APIGetDatabaseVersionReadOnly ()
	APIGetDatabaseVersionReadOnly Parameters: In: Out: JSON. More...
json	APIGetBoxReadOnly (nHistoryID, nObjectID, transf)
	APIGetBoxReadOnly Parameters: In nHistoryID, nObjectID (Optional), transf (Optional) Out: Interval3d. More...
json	APIEnableJournaling (nHistoryID, sFilePath)
	APIEnableJournaling If sFilePath is not provided, the journal will be stored in a string. More...
json	APIEnableJournalingToString (nHistoryID)
json	APIEnableJournalingTypes (aTypes)
	APIEnableJournalingTypes() function. More...
json	APIDisableJournaling ()
	APIDisableJournaling() function. More...
json	APIFaceContainsPointReadOnly (nHistoryID, nFaceID, point)
	APIFaceContainsPointReadOnly() function. More...
json	APIGetInvalidID ()
	APIGetInvalidID Parameters: In: Out: ID. More...
json	APIValidID (nID)
	APIValidID. More...
json	FacetsBodyData (m_points, m_polygonIndices, m_polygonSmoothingIds, m_colors, m_polygonColorIndices, m_pointColors)
	GroupInstancePath creation method In: m_points, m_polygonIndices, m_polygonSmoothingIds, m_colors, m_polygonColorIndices, m_pointColors Out: FacetsBodyData. More...
json	GroupInstancePath (objectIDs)
	GroupInstancePath takes any form of Objects (GroupInstancePath, GroupInstancePathArray, ObjectHistoryIDArray, ObjectIDArray) and coverts to GroupInstancePath. More...
json	ObjectHistoryID (nHistoryID, nObjectID)
json	ObjectHistoryIDAreEqual (id1, id2)
	ObjectHistoryIDAreEqual equals method In: ObjectID, ObjectID Out: bool. More...
json	Color (r, g, b, a)
	Color constructs a Color. More...
json	ColorAreEqual (c1, c2)
	ColorAreEqual returns true if the two given colors are equal. More...
json	APIGetCoedgeDirectionReadOnly (nHistoryID, nObjectID)
	APIGetCoedgeDirectionReadOnly returns true if coedge and edge go in the same direction. More...
json	APIGetConvexityReadOnly (nHistoryID, nEdgeOrLoopID)
	APIGetConvexityReadOnly returns the convexity of Edge or Loop ID. More...
json	APIGetConvexityConnectedComponentReadOnly (nHistoryID, nLoopOrFaceID, nConvexity)
	APIGetConvexityConnectedComponentReadOnly Parameters: In: nHistoryID, nLoopOrFaceID, nConvexity Out: aConnectedFaces. More...
json	APICopyOrSketchAndTransformObjects (nFromHistoryID, nToHistoryID, aFromObjectIDs, transform, nNumCopies, bGroupBodies, groupTransf3d)
	APICopyOrSketchAndTransformObjects makes numCopies of the given objects. More...
json	APISetObjectsMaterial (nHistoryID, aObjectIDs, nMaterialID)
	APISetObjectsMaterial sets a material for the given object. More...
json	APISetFaceBacksideMaterial (nHistoryID, aFaceIDs, nMaterialID)
	Sets the material given by MaterialID as the backside material of the given faces. More...
json	APIGetFaceBacksideMaterialReadOnly (nHistoryID, nFaceID)
	Gets the material of the backside of the given face. More...
json	APIGetObjectAttributesReadOnly (nHistoryID, nObjectID)
	Get all of the Attributes of the given Object. More...
json	APIGetObjectMaterialReadOnly (nHistoryID, nFaceID)
	APIGetObjectMaterialReadOnly gets an Object's material. More...
json	APICreateMaterial (nHistoryID, nColor, dHorizonalScale, dVerticalScale, nTextureID, sMaterialName, sMaterialIdentifier, aAdditionalRenderData, aAdditionalTextures)
	APICreateMaterial makes a new Material. More...
json	APICreateMaterialWithTexture (nHistoryID, nColor, dHorizonalScale, dVerticalScale, aBitmapData, bUseBitmapAlpha, sMaterialName, sMaterialIdentifier, aAdditionalRenderData, aAdditionalTextures, sTextureName)
	APICreateMaterialWithTexture makes a new Material. More...
json	APISetMaterialColor (nHistoryID, nMaterialID, nColor)
	APISetMaterialColor sets the color on a Material. More...
json	APISetMaterialData (nHistoryID, nMaterialID, nColor, dHorizontalScale, dVerticalScale, nTextureID, sMaterialName, sMaterialIdentifier, aAdditionalRenderData, aAdditionalTextures)
	APISetMaterialData sets all the data of a Material. More...
json	APISetMaterialTexture (nHistoryID, nMaterialID, dHorizontalScale, dVerticalScale, nTextureID)
	APISetMaterialTexture sets the texture properties on a Material. More...
json	APIGetMaterialDataReadOnly (nHistoryID, nMaterialID)
	APIGetMaterialDataReadOnly gets the Material properties. More...
json	APICreateTexture (nHistoryID, aBitmapData, bUseBitmapAlpha, sTextureName)
	APICreateTexture creates a new Texture object Parameters: In: nHistoryID, aBitmapData, sTextureName Out: nCreatedTextureID. More...
json	APIGetTextureDataReadOnly (nHistoryID, nTextureID)
	APIGetTextureDataReadOnly gets a Texture object's bitmap data Parameters: In: nHistoryID, nTextureID Out: JSON object with data. More...
json	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	APIGetObjectTextureCoordinatesReadOnly (nHistoryID, nObjectID)
	APIGetObjectTextureCoordinatesReadOnly generates tex coords for body or single face Parameters: In: nHistoryID, nObjectID Out: aTexCoords. More...
json	APICreateLevelObjects (nHistoryID, aLevelsData)
	APICreateLevelObjects makes new Levels. More...
json	APISetLevelsData (nHistoryID, aLevelIDs, aLevelsData)
	APISetLevelsData sets the elevation and name properties on Level. More...
json	APIGetLevelDataReadOnly (nHistoryID, nLevelID)
	APIGetLevelDataReadOnly gets the elevation and name properties. More...
json	APISetObjectsLevels (nHistoryID, aObjectIDs, aLevelsIDs)
	APISetObjectsLevels sets the Levels pointed by aLevelsIDs to objects pointed by aObjectIDs. More...
json	APIGetObjectLayersReadOnly (nHistoryID, nObjectID)
	APIGetObjectLayersReadOnly gets all layer ids of the given object. More...
json	APIGetObjectLevelsReadOnly (nHistoryID, nObjectID)
	APIGetObjectLevelsReadOnly gets all level's ids of the given object. More...
json	APIIsObjectLiveReadOnly (nHistoryID, nObjectID)
	APIIsObjectLiveReadOnly checks if an object is alive in history Parameters: In: nHistoryID, nObjectID Out: bIsLive. More...
json	APIIsHistoryLiveReadOnly (nHistoryID)
	APIIsHistoryLiveReadOnly checks if an history is alive Parameters: In: nHistoryID Out: bIsLive. More...
json	APIIsNonOwnedReadOnly (nHistoryID, nObjectID)
	APIIsNonOwnedReadOnly returns whether this object has an owner. More...
json	APIGetLocalCoordinateSystemReadOnly (nHistoryID)
	Get the LCS (local coordinate system) of the given History. More...
json	APISetLocalCoordinateSystem (nHistoryID, transf3d)
	Set the LCS (local coordinate system) of the given History. More...
json	APICreateImageObject (nHistoryID, sName, nTextureID, fAlphaValue, bFeaturesVisible, aCornersVector)
	APICreateImageObject creates a image object. More...
json	APICreateImageObjectWithTexture (nHistoryID, sName, fAlphaValue, bFeaturesVisible, aCornersVector, aBitmapData, sTextureName)
	APICreateImageObjectWithTexture creates a image object with texture. More...
json	APICreateSatelliteImageObject (nHistoryID, sName, nTextureID, fAlphaValue, bFeaturesVisible, aCornersVector, coordinates, coordinatesSpan, aPixelDimensionsVector)
	APICreateSatelliteImageObject creates a image object. More...
json	APIMoveImage (nHistoryID, nImageID, nShift)
	APIMoveImage moves the image along z axis. More...
json	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	APIGetFaceFacetsReadOnly (nHistoryID, nFaceID)
	APIGetFaceFacetsReadOnly gets the list of vertices grouped by triangles Parameters: In: nHistoryID, nFaceID Out: aFacets. More...
json	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	APIRemoveSatelliteData (nHistoryID, nImageID)
	APIRemoveSatelliteData removes satellite data from image object Parameters: In: nHistoryID, nImageID Out: JSON_UNDEFINED;. More...
json	APIGetImageDataReadOnly (nHistoryID, nImageID)
	APIGetImageDataReadOnly gets image data Parameters: In: nHistoryID, nImageID Out: sName, nTextureID, nPosition, fAlphaValue, bFeaturesVisible, aCorners, bHasSatelliteData. More...
json	APIGetSatelliteDataReadOnly (nHistoryID, nImageID)
	APIGetSatelliteDataReadOnly gets satellite data from image Parameters: In: nHistoryID, nImageID Out: sName, nTextureID, nPosition, fAlphaValue, bFeaturesVisible, aCorners, bHasSatelliteData. More...
json	APICreateGroup (nHistoryID, aObjectIDs, aInstanceTransforms, nReferencedHistoryID, transGeometry)
	APICreateGroup creates a Group from a vector of Objects Parameters: In: nHistoryID, aObjectIDs, aInstanceTransforms, nReferencedHistoryID Out: nCreatedGroupID. More...
json	APIGetRevitFamilyInformationReadOnly (nHistoryID)
	APIGetRevitFamilyInformationReadOnly returns Revit Family information of the history. More...
json	APISetRevitFamilyInformation (nHistoryID, bIsGeneratedFromRFA, bIsGeneratedFromBuiltinRFA, familyCategory, familyReference, familyType, familyExtraData)
	APISetRevitFamilyInformation sets Revit Family information of the history. More...
json	APIGetGroupReferencedHistoryReadOnly (nHistoryID, nGroupOrInstanceID, bDeletedInstanceOK, nDeltaOffset)
	APIGetGroupReferencedHistoryReadOnly returns the ID of the Group's or Instance's referenced History Parameters: In: nHistoryID, nGroupOrInstanceID, bDeletedInstanceOK, nDeltaOffset Out: nReferencedHistoryID. More...
json	APIGetAllAggregateTransf3dsReadOnly (nReferencedHistoryID, nTopMostHistoryID)
	APIGetAllAggregateTransf3dsReadOnly returns aggregate global transformations on a History referenced by a Group or Groups. More...
json	APIFlattenGroupsOrInstances (nHistoryID, aGroupOrInstanceIDs, bRecursive, bImprint)
	Replace the instances and/or groups referenced in aGroupOrInstanceIDs by a copy of the contents of the referenced history. More...
json	APIAddInstancesToGroup (nHistoryID, nGroupID, aTransforms)
	Creates new instances in the specified group and returns their IDs. More...
json	APICreateSeparateHistoriesForInstances (nHistoryID, aInstanceIDs, bNewGroupPerInstance)
	Creates new copies of the existing groups and the referenced histories for the specified instances. More...
json	APICreateStringAttribute (nHistoryID, sKey, sValue, aObjIDs, nCopyBehavior, bIsSharedOnSplit)
	Create a StringAttribute optionally attaching it to the given Objects. More...
json	APIGetStringAttributeKeyValueReadOnly (nHistoryID, nStringAttributeID)
	Gets the key and value strings from a StringAttribute. More...
json	APISetStringAttributeValue (nHistoryID, nStringAttributeID, sValue)
	Sets the value strings for a StringAttribute In: nHistoryID, nStringAttributeID, sValue. More...
json	APIGetStringAttributesByKeyReadOnly (nHistoryID, nObjectID, sKey)
	Returns all StringAttributes attached to the Object given by nObjectID with key matching sKey. More...
json	APIGetRenderableFaceReadOnly (nHistoryID, nFaceID, bCalculateTexCoords, bBackSide)
	Returns vertices in groups of 3 (triangles), with associated normals and optionally texture coordinates. More...
json	APISetFaceUVDataAttributes (nHistoryID, aFaceIDs, rTransf3d, bReplaceTransform, tformCenter, tformUVCenter)
	Sets FaceUVDataAttributes on the faces passed in and applies a transform to them. More...
json	APIGetFaceUVDataTransformReadOnly (nHistoryID, nFaceID, bBackSide)
	Gets the 2d transform, returned as a 3d transform, for the uvs on the given Face. More...
json	APIGetFaceUVDataAttributeUVsReadOnly (nHistoryID, nFaceUVDataAttributeID)
	Gets the UVs from a FaceUVDataAttribute. More...
json	APIGetEdgePointsReadOnly (nHistoryID, nEdgeID)
	Get edge endpoints directly. More...
json	APIIsHistoryNonTemporaryReadOnly (nHistoryID)
	Returns whether a history is temporary or not. More...
json	APICreateLayer (nHistoryID, name, bDisplayed)
	Create a layer object with a given name and display flag. More...
json	APIGetLayerDataReadOnly (nHistoryID, nLayerID)
	Get the data from a layer. More...
json	APISetLayerData (nHistoryID, nLayerID, name, bDisplayed)
	Set the data of a layer. More...
json	APISetLayersDisplayed (nHistoryID, aLayerIDs, bDisplayed)
	Set the display flag of layers without affecting the other data. More...
json	APIAddObjectsLayers (nHistoryID, aLayerIDs, aObjectIDs)
	Add layers to objects. More...
json	APIRemoveObjectsLayers (nHistoryID, aLayerIDs, aObjectIDs)
	Remove layers from objects. More...
json	APIAddRemoveObjectsLayers (nHistoryID, aAddLayerIDs, aRemoveLayerIDs, aObjectIDs)
	Add layers to and remove layers from objects in a single operation. More...
json	APICreateGeometryFromData (nHistoryID, aTextures, aMaterials, aLayers, aInstances, aFaceCollections, aEdges, aCurves, aImages, aGroupName, bCreateMesh)
	Load a model from vectors of various data in a single delta. More...
json	APICreateEdgesFromData (nHistoryID, aLayers, aEdges, aCurves, bCreateMesh, accuracyORcount)
	Load a set of edges from vectors of various data in a single delta. More...
json	APIIsEdgeMergeableReadOnly (nHistoryID, nEdgeID, bUseMaterial)
	APIIsEdgeMergeableReadOnly In: nHistoryID, nEdgeID, bUseMaterial Out:bool (true or false that the Edge is mergeable. More...
json	APIGetEdgeStyleReadOnly (nHistoryID, nEdgeID)
	Get the style of an edge. More...
json	APISetEdgesStyle (nHistoryID, aEdgeIDs, nColor)
	Set the style of edges on given objects. More...
json	APIIsExactMatchReadOnly (nHistoryID1, nHistoryID2, nObjectID1, nObjectID2)
	API compares either two Histories or two Objects and sets bIsExact to true when they match exactly. More...
json	APIDebugObjectReadOnly (nHistoryID, nObjectID)
	APIDebugObjectReadOnly() function. More...
json	APIGetDynamoModelInformationReadOnly (nHistoryID)
	APIGetDynamoModelInformationReadOnly returns Dynamo Model information of the history. More...
json	APISetDynamoModelInformation (nHistoryID, id, name, config, delta)
	APISetDynamoModelInformation sets Dynamo Model information of the history. More...
json	Is32Bit ()
	Is32Bit returns true if WSM is compiled in 32 bit. More...
json	APIGetConnectedEdgesReadOnly (nHistoryID, nEdgeID, bBreakOnNonSmooth)
	Returns all connected edges of a seed edge. More...
json	APIGetEnabledJournalingTypesReadOnly ()
	APIGetEnabledJournalingTypesReadOnly returns the list of journaling 'types' that are enabled. More...
json	APIGetHistoryReferencingGroupsReadOnly (nHistoryID)
	Returns a vector with groups that reference this history. More...
json	APIGetInstanceTransf3dReadOnly (nHistoryID, nInstanceID)
	Returns the Instance's Transf3d. More...
json	APIGetPointsFromObjectIDsReadOnly (nHistoryID, aIDs)
	Helper function used in sweeping to get points from the profile or path Objects. More...
json	APIIsJournalingReadOnly ()
	Check if Journaling is enabled. More...
json	APICleanModel (nHistoryID, dEdgeTol)
	Changes the model fixing errors and getting rid of undesired features. More...
json	APISplitAtNonManifoldEdgesAndVertices (nHistoryID)
	Changes the model so that every edge on more than two faces and every vertex with more than one edge group is copied so that these conditions no longer occur. More...
json	APICreateMesh (nHistoryID, aPoints, aTriangles, aNormals, aUVs, aColors)
	Create a Mesh. More...
json	APIGetMeshDataReadOnly (nHistoryID, nMeshID)
	Get the data from a Mesh. More...
json	APIComputeSharedMeshDataReadOnly (nHistoryID, nMeshID, dCosSmoothAngle)
	Compute the shared data from a Mesh where mesh vertices with the same point and normal are not repeated. More...
json	APIMeshContainsPointReadOnly (nHistoryID, nMeshID, point)
	Returns true and the normal if the Mesh contains the point. More...
json	APIMeshPointOnOrInsideIfManifoldReadOnly (nHistoryID, nMeshID, point)
	Return true if the given point is on the Mesh. More...
json	APIMeshComputeSilhouetteEdgesReadOnly (nHistoryID, nMeshID, cameraPos, cameraDir, bPerspectiveView)
	Returns silhouette edges from the Mesh. More...
json	APIMeshComputeNonSmoothEdgesReadOnly (nHistoryID, nMeshID, dCosSmoothAngle)
	Returns non-smooth edges from the Mesh. More...
json	APIConvertMeshesToObjects (nHistoryID, aMeshIDs, dCosSmoothAngle, bFlatten)
	Converts Meshes into Bodies with triangular Faces. More...
json	APILinkMeshesForConversion (nHistoryID, aMeshIDs)
	Link the Meshes with a shared string Attribute. More...
json	APIConvertObjectsToMeshes (nHistoryID, aObjectIDs)
	Converts non-Mesh Objects into Meshes with one Mesh per Material used. More...
json	APICreateVertex (nHistoryID, position)
	Create a Vertex with the given position. More...
json	APIFlattenFaces (nHistoryID, aFaceIDs, dTol)
	Flattens all Faces given by aFaceIDs onto the plane of the first Face when all Faces lie within dTol of the first Face's plane, then merges into a single Face. More...
json	APICreateLineMesh (nHistoryID, aPoints, aIndices, aCounts)
	Create a LineMesh. More...
json	APIGetLineMeshDataReadOnly (nHistoryID, nLineMeshID)
	Get the data from a LineMesh. More...
json	APILineMeshContainsPointReadOnly (nHistoryID, nLineMeshID, point)
	Returns true if the LineMesh contains the point. More...
json	APILineMeshGetPointsOnNegativeSideOfPlanesReadOnly (nHistoryID, nLineMeshID, aPlanes, line3dPickRay, dTol)
	Get all points nearest the given line from segments of the LineMesh that lie on the negative side of all the given Planes. More...
json	APICreatePointMesh (nHistoryID, aPoints)
	Create a PointMesh. More...
json	APIGetPointMeshDataReadOnly (nHistoryID, nPointMeshID)
	Get the data from a PointMesh. More...
json	APIPointMeshContainsPointReadOnly (nHistoryID, nPointMeshID, point)
	Returns true if the PointMesh contains the point. More...
json	APIIsMeshManifoldReadOnly (nHistoryID, nMeshID)
	Returns true if the Mesh is manifold, i.e. More...
json	APIPointMeshGetPointsOnNegativeSideOfPlanesReadOnly (nHistoryID, nPointMeshID, aPlanes, dTol)
	Get all points of the PointMesh that lie on the negative side of all the given Planes. More...
json	APIPushMirrorTransformationsOntoGeometry (nHistoryID)
	Pushes mirror Instance transformations onto the underlying geometry sharing referenced Histories as much as possible. More...
json	APICheckMassesCollideReadOnly (nHistoryID)
	Returns true if bodies that enclose volume (possibly in instances) touch or overlap. More...

Typedef Documentation

using WSM.GroupInstancePathArray = typedef std.vector <GroupInstancePath>

using WSM.ObjectHistoryIDArray = typedef std.vector<ObjectHistoryID>

using WSM.ObjectIDArray = typedef std.vector<size_t>