WSM.Utils Namespace Reference

Description

WSM.Utils namespace.

Classes
class	HistoryObjects
	This is a helper class to convert the many representations of Objects used by the WSM APIs.class HistoryObjects. More...

Functions
json	AngleFullCircleInRadians (normal, vecA, vecB, returnPositive)
json	AppendSelectionToGroupInstancePathArray (aInput, aOutput)
	AppendSelectionToGroupInstancePathArray Parameters: In: aInput Out: std.vector<WSM.GroupInstancePath> More...
json	AppendToGroupInstancePathArray (nHistoryID, aInput, aOutput)
	AppendSelectionToGroupInstancePathArray Parameters: In: path, aInput Out: std.vector<WSM.GroupInstancePath> More...
json	ComputeFaceCentroid (historyID, faceID)
	ComputeFaceCentroid Parameters: In: historyID, faceID Out: success (bool), centroid (WSM.Point3d) More...
json	ComputeFaceNormal (historyID, faceID)
	ComputeFaceNormal Parameters: In: historyID, faceID Out: bool, WSM.UnitVector3d. More...
json	ConvertToFaces (aPaths)
	ConvertToFaces Parameters: In: aPaths); Out: std.vector<WSM.GroupInstancePath> More...
json	ConvertToTopLevel (nHistoryID, aObjectIDs, bAllowInstances, bAllowOwnedFaces)
	ConverToTopLevel Parameters: In: nHistoryID, aObjectIDs, bAllowInstances Out: std.vector<size_t> More...
json	ConvertToTopLevelPaths (aPaths, bAllowInstances, bAllowOwnedFaces)
	ConverToTopLevelPaths Parameters: In: aPaths, bAllowInstances Out: std.vector<WSM.GroupInstancePath> More...
json	DeleteObjectsIncludeSmoothAttachments (nHistoryID, toDelete)
	DeleteObjectsIncludeSmoothAttachments Parameters: In: nHistoryID, toDelete. More...
json	ExpandSelection (nHistoryID, objectID, selectionlevel, filter, bCanExpandInstances)
json	GetAllNonOwnedGeometricObjects (nHistoryID)
	GetAllNonOwnedGeometricObjects Parameters: In: nHistoryID Out: vector<size_t> More...
json	GetAxisAlignedBoundingBox (aObjectIDs, CS)
	GetAxisAlignedBoundingBox Parameters: In: aObjectIDs, CS (WSM.Utils.CoordSystem) WSM.Utils.CoordSystem.HCS The History being edited coordinate system. More...
json	GetCoedgePoints (nHistoryID, coedgeID)
	GetCoedgePoints Parameters: In: nHistoryID, coedgeID Out: bool, WSM.Point3d, WSM.Point3d. More...
json	GetEdgeCurveType (nHistoryID, edgeId)
	GetEdgeCurveType Parameters: In: nHistoryID, edgeId Out: type, size_t AttribID. More...
json	GetEdgeIDFromCoedge (nHistoryID, coedgeID)
	GetEdgeIDFromCoedge Parameters: In: nHistoryID, coedgeID Out: size_t. More...
json	GetEdgeLine (nHistoryID, edge)
	GetEdgeLine Parameters: In: nHistoryID, edge Out: Line3d. More...
json	GetFaceIDFromCoedge (nHistoryID, coedgeID)
	GetFaceIDFromCoedge Parameters: In: nHistoryID, coedgeID Out: size_t. More...
json	GetFacePoints (facePath)
	GetFacePoints Parameters: In: facePath Out: std.vector<WSM.Point3d> More...
json	GetGroupInstanceNonOwnedGeometricObjects (instance)
	GetGroupInstanceNonOwnedGeometricObjects Parameters: In: instance Out: std.vector<WSM.GroupInstancePath> More...
json	GetMemoryInfo (nHistoryID)
	GetMemoryInfo Parameters: In: nHistoryID Out: aRefdHistoryIDs, nFullSize, nCollapsedSize. More...
json	GetVertexCurveAttributes (historyID, vertexID)
	GetVertexCurveAttributes Parameters: In: historyID, vertexID Out: std.vector<std.pair<size_t, size_t>> aAttributeIDs. More...
json	HasSmoothEdge (nHistoryID, nObjectID)
	HasSmoothEdge Parameters: In: nHistoryID, nObjectID Out: true/false. More...
json	IsBackFace (path, cameraPos, cameraDir, perspectiveView)
	IsBackFace Parameters: In: path, cameraPos, cameraDir, perspectiveView Out: true/false. More...
json	IsLayerHidden (nHistoryID, id)
	IsLayerHidden Parameters: In: nHistoryID, id Out: true/false. More...
json	IsObjectHidden (nHistoryID, nObjectID)
	IsObjectHidden Parameters: In: nHistoryID, nObjectID Out: true/false. More...
json	IsObjectHiddenByPath (path)
	IsObjectHiddenByPath Parameters: In: path Out: true/false. More...
json	IsLayerNotPickable (nHistoryID, id)
	IsLayerNotPickable Parameters: In: nHistoryID, id Out: true/false. More...
json	IsObjectNotPickable (nHistoryID, nObjectID)
	IsObjectNotPickable Parameters: In: nHistoryID, nObjectID Out: true/false. More...
json	IsObjectNotPickableByPath (path)
	IsObjectNotPickableByPath Parameters: In: path Out: true/false. More...
json	IsObjectType (path, nObjectTypes)
	IsObjectType Parameters: In: path, nObjectTypes Out: bool. More...
json	IsOnCurveJunction (path, bInferencing)
json	IsSelectAllConnected (nHistoryID, selectedObjectIDs)
	IsSelectAllConnected Parameters: In: nHistoryID, selectedObjectIDs Out: true/false. More...
json	IsSilhouetteEdge (nHistoryID, edgeId, cameraPos, cameraDir, perspectiveView)
	IsSilhouetteEdge Parameters: In: nHistoryID, edgeId, cameraPos, cameraDir, perspectiveView Out: true/false. More...
json	IsSmooth (path)
	IsSmooth Parameters: In: path Out: true/false. More...
json	IsTopLevelObjectHidden (nHistoryID, nObjectID)
	IsTopLevelObjectHidden Parameters: In: path Out: true/false. More...
json	IsTopLevelObjectHiddenByPath (path)
	IsTopLevelObjectHiddenByPath Parameters: In: path Out: true/false. More...
json	IsVertexEditable (nHistoryID, nObjectID)
	IsVertexEditable Parameters: In: nHistoryID, nObjectID Out: true/false. More...
json	IsVertexOnCurve (historyID, vertexID)
	IsVertexOnCurve Parameters: In: historyID, vertexID Out: true/false. More...
json	MakePickRayFromWindow (firstWindowSelectPoint, secondWindowSelectPoint)
	MakePickRayFromWindow Parameters: In: firstWindowSelectPoint, secondWindowSelectPoint Out: PickRay. More...
json	MatchesSelectionType (selectedObjectIDs, aNewSelectedObjects, bSelectAll)
	MatchesSelectionType Parameters: In: selectedObjectIDs, aNewSelectedObjects, bSelectAll Out: true/false. More...
json	ObjectCanBeHidden (nHistoryID, nObjectID)
	ObjectCanBeHidden Parameters: In: nHistoryID, nObjectID Out: true/false. More...
json	PickBody (pickray)
	PickBody Parameters: In: pickRay Out: size_t. More...
json	PickGeometry (pickray, pickFilter, bAllowAdjustRayRadius)
	PickGeometry Parameters: In: pickray, pickVertices, pickEdges, pickFaces, pickInstances, bAllowAdjustRayRadius Out: size_t. More...
json	PickObjectsWithFilter (pickray, filter, currentSelectionLevel)
	PickObjectsWithFilter Parameters: In: pickray, filter, currentSelectionLevel Out: WSM.GroupInstancePath firstSelectedObject, std.vector<WSM.GroupInstancePath> allSelectedObjects, ObjectsAndPickPoints aObjectsAndPickPoints. More...
json	PickObjectsWithRay (pickray, pickFilter, bAllowAdjustRayRadius, bIgnoreInContext)
	PickObjectsWithRay Parameters: In: pickRay, pickFilter, bAllowAdjustRayRadius Out: ObjectIDsAndPickPoints aObjectsAndPickPoints. More...
json	RayFireWithObjects (objectIds, ray)
	RayFireWithObjects Parameters: In: objectIds, ray Out: bool, WSM.Point3d pickPointOnObject. More...
json	SelectionFromGroupInstancePathArray (aInput)
	SelectionFromGroupInstancePathArray Parameters: In: aInput Out: aOutput. More...
json	SelectionToGroupInstancePath (nObjectID)
	SelectionToGroupInstancePath Parameters: In: nObjectID Out: GroupInstancePath. More...
json	SelectionToGroupInstancePathArray (aInput)
	SelectionToGroupInstancePathArray Parameters: In: aInput Out: aOutput. More...
json	SetToOwnerBody (path)
	SetToOwnerBody Parameters: In: path Out: WSM.GroupInstancePath. More...
json	TestPickImages (nHistoryID, imageIds, pickRay)
	TestPickImages Parameters: In: nHistoryID, imageIds, pickRay Out: size_t, Point3d pickPointOnImage. More...
json	ObjectIDsAreEqual (id1, id2)
	ObjectIDsAreEqual Parameters: In: id1, id2 Out: areSame (bool) More...
json	GroupInstancePathsAreEqual (path1, path2)
	GroupInstancePathsAreEqual Parameters: In: path1, path2 Out: areSame (bool) More...
json	PickRay (pickrayLine, planes, screenPickRayRadius, perspectiveScaleFactor, baseRadius, normalizedScreenPoint)
	PickRay constructs a PickRay. More...
json	PickRayFromLine (pickrayLine)
	PickRay constructs a PickRay. More...
json	PickRayFromNormalizedScreenPoint (ptX, ptY, yUp)
	PickRayFromNormalizedScreenPoint() function. More...
json	GroupInstancePathArray (objectIDs, History, groupInstancePath)
json	GetGroupInstancePathFinalObjectHistoryID (ObjectIDs)
	GetGroupInstancePathFinalObjectHistoryID takes any form of Objects (GroupInstancePath, GroupInstancePathArray, ObjectHistoryIDArray, ObjectIDArray) and returns the final ObjectHistoryID. More...
json	ObjectHistoryIDArray (objectIDs, History)
json	ObjectIDArray (objectIDs)
json	SetOrCreateStringAttributeForObject (nHistoryID, nObjectID, key, value, nCB, bIsSharedOnSplit)
	Sets the value of a string attribute of a given object, if that object has such an attribute with the given key. More...
json	GetStringAttributeForObject (nHistoryID, nObjectID, key)
	Gets the string attribute value for a given object and key. More...
json	ObjectTypeFilter ()
	Default constructor for WSM.Utils.ObjectTypeFilter. More...
json	ObjectHistoryID (nHistoryID, nObjectID)
	ObjectHistoryID creation method In: nHistoryID, nObjectID Out: ObjectHistoryID. More...
json	IsOwnerOf (parent, child)
	Checks whether parent is an owner of child Parameters: In: parent, child as WSM.GroupInstancePath Out: true/false. More...