Description

Functions
json	WSM.Utils.AngleFullCircleInRadians (normal, vecA, vecB, returnPositive)

json	WSM.Utils.AppendSelectionToGroupInstancePathArray (aInput, aOutput)
	AppendSelectionToGroupInstancePathArray Parameters: In: aInput Out: std.vector<WSM.GroupInstancePath> More...

json	WSM.Utils.AppendToGroupInstancePathArray (nHistoryID, aInput, aOutput)
	AppendSelectionToGroupInstancePathArray Parameters: In: path, aInput Out: std.vector<WSM.GroupInstancePath> More...

json	WSM.Utils.ComputeFaceCentroid (historyID, faceID)
	ComputeFaceCentroid Parameters: In: historyID, faceID Out: success (bool), centroid (WSM.Point3d) More...

json	WSM.Utils.ComputeFaceNormal (historyID, faceID)
	ComputeFaceNormal Parameters: In: historyID, faceID Out: bool, WSM.UnitVector3d. More...

json	WSM.Utils.ConvertToFaces (aPaths)
	ConvertToFaces Parameters: In: aPaths); Out: std.vector<WSM.GroupInstancePath> More...

json	WSM.Utils.ConvertToTopLevel (nHistoryID, aObjectIDs, bAllowInstances, bAllowOwnedFaces)
	ConverToTopLevel Parameters: In: nHistoryID, aObjectIDs, bAllowInstances Out: std.vector<size_t> More...

json	WSM.Utils.ConvertToTopLevelPaths (aPaths, bAllowInstances, bAllowOwnedFaces)
	ConverToTopLevelPaths Parameters: In: aPaths, bAllowInstances Out: std.vector<WSM.GroupInstancePath> More...

json	WSM.Utils.DeleteObjectsIncludeSmoothAttachments (nHistoryID, toDelete)
	DeleteObjectsIncludeSmoothAttachments Parameters: In: nHistoryID, toDelete. More...

json	WSM.Utils.ExpandSelection (nHistoryID, objectID, selectionlevel, filter, bCanExpandInstances)

json	WSM.Utils.GetAllNonOwnedGeometricObjects (nHistoryID)
	GetAllNonOwnedGeometricObjects Parameters: In: nHistoryID Out: vector<size_t> More...

json	WSM.Utils.GetAxisAlignedBoundingBox (aObjectIDs, CS)
	GetAxisAlignedBoundingBox Parameters: In: aObjectIDs, CS (WSM.Utils.CoordSystem) WSM.Utils.CoordSystem.HCS The History being edited coordinate system. More...

json	WSM.Utils.GetCoedgePoints (nHistoryID, coedgeID)
	GetCoedgePoints Parameters: In: nHistoryID, coedgeID Out: bool, WSM.Point3d, WSM.Point3d. More...

json	WSM.Utils.GetEdgeCurveType (nHistoryID, edgeId)
	GetEdgeCurveType Parameters: In: nHistoryID, edgeId Out: type, size_t AttribID. More...

json	WSM.Utils.GetEdgeIDFromCoedge (nHistoryID, coedgeID)
	GetEdgeIDFromCoedge Parameters: In: nHistoryID, coedgeID Out: size_t. More...

json	WSM.Utils.GetEdgeLine (nHistoryID, edge)
	GetEdgeLine Parameters: In: nHistoryID, edge Out: Line3d. More...

json	WSM.Utils.GetFaceIDFromCoedge (nHistoryID, coedgeID)
	GetFaceIDFromCoedge Parameters: In: nHistoryID, coedgeID Out: size_t. More...

json	WSM.Utils.GetFacePoints (facePath)
	GetFacePoints Parameters: In: facePath Out: std.vector<WSM.Point3d> More...

json	WSM.Utils.GetGroupInstanceNonOwnedGeometricObjects (instance)
	GetGroupInstanceNonOwnedGeometricObjects Parameters: In: instance Out: std.vector<WSM.GroupInstancePath> More...

json	WSM.Utils.GetMemoryInfo (nHistoryID)
	GetMemoryInfo Parameters: In: nHistoryID Out: aRefdHistoryIDs, nFullSize, nCollapsedSize. More...

json	WSM.Utils.GetVertexCurveAttributes (historyID, vertexID)
	GetVertexCurveAttributes Parameters: In: historyID, vertexID Out: std.vector<std.pair<size_t, size_t>> aAttributeIDs. More...

json	WSM.Utils.HasSmoothEdge (nHistoryID, nObjectID)
	HasSmoothEdge Parameters: In: nHistoryID, nObjectID Out: true/false. More...

json	WSM.Utils.IsBackFace (path, cameraPos, cameraDir, perspectiveView)
	IsBackFace Parameters: In: path, cameraPos, cameraDir, perspectiveView Out: true/false. More...

json	WSM.Utils.IsLayerHidden (nHistoryID, id)
	IsLayerHidden Parameters: In: nHistoryID, id Out: true/false. More...

json	WSM.Utils.IsObjectHidden (nHistoryID, nObjectID)
	IsObjectHidden Parameters: In: nHistoryID, nObjectID Out: true/false. More...

json	WSM.Utils.IsObjectHiddenByPath (path)
	IsObjectHiddenByPath Parameters: In: path Out: true/false. More...

json	WSM.Utils.IsLayerNotPickable (nHistoryID, id)
	IsLayerNotPickable Parameters: In: nHistoryID, id Out: true/false. More...

json	WSM.Utils.IsObjectNotPickable (nHistoryID, nObjectID)
	IsObjectNotPickable Parameters: In: nHistoryID, nObjectID Out: true/false. More...

json	WSM.Utils.IsObjectNotPickableByPath (path)
	IsObjectNotPickableByPath Parameters: In: path Out: true/false. More...

json	WSM.Utils.IsObjectType (path, nObjectTypes)
	IsObjectType Parameters: In: path, nObjectTypes Out: bool. More...

json	WSM.Utils.IsOnCurveJunction (path, bInferencing)

json	WSM.Utils.IsSelectAllConnected (nHistoryID, selectedObjectIDs)
	IsSelectAllConnected Parameters: In: nHistoryID, selectedObjectIDs Out: true/false. More...

json	WSM.Utils.IsSilhouetteEdge (nHistoryID, edgeId, cameraPos, cameraDir, perspectiveView)
	IsSilhouetteEdge Parameters: In: nHistoryID, edgeId, cameraPos, cameraDir, perspectiveView Out: true/false. More...

json	WSM.Utils.IsSmooth (path)
	IsSmooth Parameters: In: path Out: true/false. More...

json	WSM.Utils.IsTopLevelObjectHidden (nHistoryID, nObjectID)
	IsTopLevelObjectHidden Parameters: In: path Out: true/false. More...

json	WSM.Utils.IsTopLevelObjectHiddenByPath (path)
	IsTopLevelObjectHiddenByPath Parameters: In: path Out: true/false. More...

json	WSM.Utils.IsVertexEditable (nHistoryID, nObjectID)
	IsVertexEditable Parameters: In: nHistoryID, nObjectID Out: true/false. More...

json	WSM.Utils.IsVertexOnCurve (historyID, vertexID)
	IsVertexOnCurve Parameters: In: historyID, vertexID Out: true/false. More...

json	WSM.Utils.MakePickRayFromWindow (firstWindowSelectPoint, secondWindowSelectPoint)
	MakePickRayFromWindow Parameters: In: firstWindowSelectPoint, secondWindowSelectPoint Out: PickRay. More...

json	WSM.Utils.MatchesSelectionType (selectedObjectIDs, aNewSelectedObjects, bSelectAll)
	MatchesSelectionType Parameters: In: selectedObjectIDs, aNewSelectedObjects, bSelectAll Out: true/false. More...

json	WSM.Utils.ObjectCanBeHidden (nHistoryID, nObjectID)
	ObjectCanBeHidden Parameters: In: nHistoryID, nObjectID Out: true/false. More...

json	WSM.Utils.PickBody (pickray)
	PickBody Parameters: In: pickRay Out: size_t. More...

json	WSM.Utils.PickGeometry (pickray, pickFilter, bAllowAdjustRayRadius)
	PickGeometry Parameters: In: pickray, pickVertices, pickEdges, pickFaces, pickInstances, bAllowAdjustRayRadius Out: size_t. More...

json	WSM.Utils.PickObjectsWithFilter (pickray, filter, currentSelectionLevel)
	PickObjectsWithFilter Parameters: In: pickray, filter, currentSelectionLevel Out: WSM.GroupInstancePath firstSelectedObject, std.vector<WSM.GroupInstancePath> allSelectedObjects, ObjectsAndPickPoints aObjectsAndPickPoints. More...

json	WSM.Utils.PickObjectsWithRay (pickray, pickFilter, bAllowAdjustRayRadius, bIgnoreInContext)
	PickObjectsWithRay Parameters: In: pickRay, pickFilter, bAllowAdjustRayRadius Out: ObjectIDsAndPickPoints aObjectsAndPickPoints. More...

json	WSM.Utils.RayFireWithObjects (objectIds, ray)
	RayFireWithObjects Parameters: In: objectIds, ray Out: bool, WSM.Point3d pickPointOnObject. More...

json	WSM.Utils.SelectionFromGroupInstancePathArray (aInput)
	SelectionFromGroupInstancePathArray Parameters: In: aInput Out: aOutput. More...

json	WSM.Utils.SelectionToGroupInstancePath (nObjectID)
	SelectionToGroupInstancePath Parameters: In: nObjectID Out: GroupInstancePath. More...

json	WSM.Utils.SelectionToGroupInstancePathArray (aInput)
	SelectionToGroupInstancePathArray Parameters: In: aInput Out: aOutput. More...

json	WSM.Utils.SetToOwnerBody (path)
	SetToOwnerBody Parameters: In: path Out: WSM.GroupInstancePath. More...

json	WSM.Utils.TestPickImages (nHistoryID, imageIds, pickRay)
	TestPickImages Parameters: In: nHistoryID, imageIds, pickRay Out: size_t, Point3d pickPointOnImage. More...

json	WSM.Utils.ObjectIDsAreEqual (id1, id2)
	ObjectIDsAreEqual Parameters: In: id1, id2 Out: areSame (bool) More...

json	WSM.Utils.GroupInstancePathsAreEqual (path1, path2)
	GroupInstancePathsAreEqual Parameters: In: path1, path2 Out: areSame (bool) More...

json	WSM.Utils.PickRay (pickrayLine, planes, screenPickRayRadius, perspectiveScaleFactor, baseRadius, normalizedScreenPoint)
	PickRay constructs a PickRay. More...

json	WSM.Utils.PickRayFromLine (pickrayLine)
	PickRay constructs a PickRay. More...

json	WSM.Utils.PickRayFromNormalizedScreenPoint (ptX, ptY, yUp)
	PickRayFromNormalizedScreenPoint() function. More...

json	WSM.Utils.GroupInstancePathArray (objectIDs, History, groupInstancePath)

json	WSM.Utils.GetGroupInstancePathFinalObjectHistoryID (ObjectIDs)
	GetGroupInstancePathFinalObjectHistoryID takes any form of Objects (GroupInstancePath, GroupInstancePathArray, ObjectHistoryIDArray, ObjectIDArray) and returns the final ObjectHistoryID. More...

json	WSM.Utils.ObjectHistoryIDArray (objectIDs, History)

json	WSM.Utils.ObjectIDArray (objectIDs)

json	WSM.Utils.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	WSM.Utils.GetStringAttributeForObject (nHistoryID, nObjectID, key)
	Gets the string attribute value for a given object and key. More...

json	WSM.Utils.ObjectTypeFilter ()
	Default constructor for WSM.Utils.ObjectTypeFilter. More...

json	WSM.Utils.ObjectHistoryID (nHistoryID, nObjectID)
	ObjectHistoryID creation method In: nHistoryID, nObjectID Out: ObjectHistoryID. More...

json	WSM.Utils.IsOwnerOf (parent, child)
	Checks whether parent is an owner of child Parameters: In: parent, child as WSM.GroupInstancePath Out: true/false. More...

Function Documentation

json WSM.Utils.AngleFullCircleInRadians	(	normal	,
		vecA	,
		vecB	,
		returnPositive
	)

json WSM.Utils.AppendSelectionToGroupInstancePathArray	(	aInput	,
		aOutput
	)

AppendSelectionToGroupInstancePathArray Parameters: In: aInput Out: std.vector<WSM.GroupInstancePath>

Parameters

[in]	aInput	WSM.Utils.HistoryObjects
[in]	aOutput	(OPTIONAL) Array of WSM.GroupInstancePath

Returns: aOutput

json WSM.Utils.AppendToGroupInstancePathArray	(	nHistoryID	,
		aInput	,
		aOutput
	)

AppendSelectionToGroupInstancePathArray Parameters: In: path, aInput Out: std.vector<WSM.GroupInstancePath>

Parameters

[in]	nHistoryID	int
[in]	aInput	WSM.Utils.HistoryObjects
[in]	aOutput	(OPTIONAL) Array of WSM.GroupInstancePath

Returns: aOutput

json WSM.Utils.ComputeFaceCentroid	(	historyID	,
		faceID
	)

ComputeFaceCentroid Parameters: In: historyID, faceID Out: success (bool), centroid (WSM.Point3d)

Parameters

[in]	historyID	int
[in]	faceID	int

Returns: {{ "success" , bRet}, { "centroid" , to_json(centroid)}};

json WSM.Utils.ComputeFaceNormal	(	historyID	,
		faceID
	)

ComputeFaceNormal Parameters: In: historyID, faceID Out: bool, WSM.UnitVector3d.

Parameters

[in]	historyID	int
[in]	faceID	int

Returns: {{ "success" , bRet},{ "normal" , to_json(faceNormal)}};

json WSM.Utils.ConvertToFaces ( aPaths )

ConvertToFaces Parameters: In: aPaths); Out: std.vector<WSM.GroupInstancePath>

Parameters

[in] aPaths WSM.Utils.HistoryObjects

Returns: aGroupInstancePaths

json WSM.Utils.ConvertToTopLevel	(	nHistoryID	,
		aObjectIDs	,
		bAllowInstances	,
		bAllowOwnedFaces
	)

ConverToTopLevel Parameters: In: nHistoryID, aObjectIDs, bAllowInstances Out: std.vector<size_t>

Parameters

[in]	nHistoryID	int
[in]	aObjectIDs	WSM.Utils.HistoryObjects
[in]	bAllowInstances	bool
[in]	bAllowOwnedFaces	bool

Returns: idArray

json WSM.Utils.ConvertToTopLevelPaths	(	aPaths	,
		bAllowInstances	,
		bAllowOwnedFaces
	)

ConverToTopLevelPaths Parameters: In: aPaths, bAllowInstances Out: std.vector<WSM.GroupInstancePath>

Parameters

[in]	aPaths	WSM.Utils.HistoryObjects
[in]	bAllowInstances	bool
[in]	bAllowOwnedFaces	bool

Returns: aGroupInstancePathArray

json WSM.Utils.DeleteObjectsIncludeSmoothAttachments	(	nHistoryID	,
		toDelete
	)

DeleteObjectsIncludeSmoothAttachments Parameters: In: nHistoryID, toDelete.

Parameters

[in]	nHistoryID	int
[in]	toDelete	WSM.Utils.HistoryObjects

Returns: JSON_UNDEFINED, i.e. {}

json WSM.Utils.ExpandSelection	(	nHistoryID	,
		objectID	,
		selectionlevel	,
		filter	,
		bCanExpandInstances
	)

json WSM.Utils.GetAllNonOwnedGeometricObjects ( nHistoryID )

GetAllNonOwnedGeometricObjects Parameters: In: nHistoryID Out: vector<size_t>

Parameters

[in] nHistoryID int

Returns: {...}

json WSM.Utils.GetAxisAlignedBoundingBox	(	aObjectIDs	,
		CS
	)

GetAxisAlignedBoundingBox Parameters: In: aObjectIDs, CS (WSM.Utils.CoordSystem) WSM.Utils.CoordSystem.HCS The History being edited coordinate system.

WSM.Utils.CoordSystem.LCS The History being edited local coordinate system. WSM.Utils.CoordSystem.WHCS The World History coordinate system. WSM.Utils.CoordSystem.WLCS The World History local coordinate system. Out: AxisAlignedBoundingBox

Parameters

[in]	aObjectIDs	WSM.Utils.HistoryObjects
[in]	CS	WSM.Utils.CoordSystem

Returns: {...}

json WSM.Utils.GetCoedgePoints	(	nHistoryID	,
		coedgeID
	)

GetCoedgePoints Parameters: In: nHistoryID, coedgeID Out: bool, WSM.Point3d, WSM.Point3d.

Parameters

[in]	nHistoryID	int
[in]	coedgeID	int

Returns: {{ "success" , to_json(bRet)}, { "begin" , to_json(begin)}, { "end" , to_json(end)}};

json WSM.Utils.GetEdgeCurveType	(	nHistoryID	,
		edgeId
	)

GetEdgeCurveType Parameters: In: nHistoryID, edgeId Out: type, size_t AttribID.

Parameters

[in]	nHistoryID	int
[in]	edgeId	int

Returns: {{ "type" , to_json(nType)}, { "id" , to_json(attribID)}};

json WSM.Utils.GetEdgeIDFromCoedge	(	nHistoryID	,
		coedgeID
	)

GetEdgeIDFromCoedge Parameters: In: nHistoryID, coedgeID Out: size_t.

Parameters

[in]	nHistoryID	int
[in]	coedgeID	int

Returns: {...}

json WSM.Utils.GetEdgeLine	(	nHistoryID	,
		edge
	)

GetEdgeLine Parameters: In: nHistoryID, edge Out: Line3d.

Parameters

[in]	nHistoryID	int
[in]	edge	int

Returns: {...}

json WSM.Utils.GetFaceIDFromCoedge	(	nHistoryID	,
		coedgeID
	)

GetFaceIDFromCoedge Parameters: In: nHistoryID, coedgeID Out: size_t.

Parameters

[in]	nHistoryID	int
[in]	coedgeID	int

Returns: {...}

json WSM.Utils.GetFacePoints ( facePath )

GetFacePoints Parameters: In: facePath Out: std.vector<WSM.Point3d>

Parameters

[in] facePath WSM.Utils.HistoryObjects

Returns: aPoints

json WSM.Utils.GetGroupInstanceNonOwnedGeometricObjects ( instance )

GetGroupInstanceNonOwnedGeometricObjects Parameters: In: instance Out: std.vector<WSM.GroupInstancePath>

Parameters

[in] instance WSM.Utils.HistoryObjects

Returns: nonOwnedObjects

json WSM.Utils.GetGroupInstancePathFinalObjectHistoryID ( ObjectIDs )

GetGroupInstancePathFinalObjectHistoryID takes any form of Objects (GroupInstancePath, GroupInstancePathArray, ObjectHistoryIDArray, ObjectIDArray) and returns the final ObjectHistoryID.

Parameters: In: ObjectIDs Out: Final ObjectHistoryID

Parameters

[in] ObjectIDs WSM.Utils.HistoryObjects

Returns: path.GetFinalObjectHistoryID()

json WSM.Utils.GetMemoryInfo ( nHistoryID )

GetMemoryInfo Parameters: In: nHistoryID Out: aRefdHistoryIDs, nFullSize, nCollapsedSize.

Parameters

[in] nHistoryID int

Returns: {{ "histories" , to_json(aRefdHistoryIDs)}, { "nFullSize" , to_json(nFullSize)}, { "nCollapsedSize" , to_json(nCollapsedSize)}};

json WSM.Utils.GetStringAttributeForObject	(	nHistoryID	,
		nObjectID	,
		key
	)

Gets the string attribute value for a given object and key.

Returns true if the object has a string attribute with that key. Returns false if not.

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int
[in]	key	String

Returns: {{ "success" , to_json(success)}, { "value" , to_json(value)}};

json WSM.Utils.GetVertexCurveAttributes	(	historyID	,
		vertexID
	)

GetVertexCurveAttributes Parameters: In: historyID, vertexID Out: std.vector<std.pair<size_t, size_t>> aAttributeIDs.

Parameters

[in]	historyID	int
[in]	vertexID	int

Returns: aAttributeIDs

json WSM.Utils.GroupInstancePathArray	(	objectIDs	,
		History	,
		groupInstancePath
	)

json WSM.Utils.GroupInstancePathsAreEqual	(	path1	,
		path2
	)

GroupInstancePathsAreEqual Parameters: In: path1, path2 Out: areSame (bool)

Parameters

[in]	path1	WSM.Utils.HistoryObjects
[in]	path2	WSM.Utils.HistoryObjects

Returns: path1 == path2

json WSM.Utils.HasSmoothEdge	(	nHistoryID	,
		nObjectID
	)

HasSmoothEdge Parameters: In: nHistoryID, nObjectID Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int

Returns: {...}

json WSM.Utils.IsBackFace	(	path	,
		cameraPos	,
		cameraDir	,
		perspectiveView
	)

IsBackFace Parameters: In: path, cameraPos, cameraDir, perspectiveView Out: true/false.

Parameters

[in]	path	WSM.Utils.HistoryObjects
[in]	cameraPos	WSM.Point3d
[in]	cameraDir	WSM.Vector3d
[in]	perspectiveView	bool

Returns: {...}

json WSM.Utils.IsLayerHidden	(	nHistoryID	,
		id
	)

IsLayerHidden Parameters: In: nHistoryID, id Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	id	int

Returns: {...}

json WSM.Utils.IsLayerNotPickable	(	nHistoryID	,
		id
	)

IsLayerNotPickable Parameters: In: nHistoryID, id Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	id	int

Returns: {...}

json WSM.Utils.IsObjectHidden	(	nHistoryID	,
		nObjectID
	)

IsObjectHidden Parameters: In: nHistoryID, nObjectID Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int

Returns: {...}

json WSM.Utils.IsObjectHiddenByPath ( path )

IsObjectHiddenByPath Parameters: In: path Out: true/false.

Parameters

[in] path WSM.Utils.HistoryObjects

Returns: {...}

json WSM.Utils.IsObjectNotPickable	(	nHistoryID	,
		nObjectID
	)

IsObjectNotPickable Parameters: In: nHistoryID, nObjectID Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int

Returns: {...}

json WSM.Utils.IsObjectNotPickableByPath ( path )

IsObjectNotPickableByPath Parameters: In: path Out: true/false.

Parameters

[in] path WSM.Utils.HistoryObjects

Returns: {...}

json WSM.Utils.IsObjectType	(	path	,
		nObjectTypes
	)

IsObjectType Parameters: In: path, nObjectTypes Out: bool.

Parameters

[in]	path	WSM.Utils.HistoryObjects
[in]	nObjectTypes	Array of WSM.nObjectType

Returns: {...}

json WSM.Utils.IsOnCurveJunction	(	path	,
		bInferencing
	)

json WSM.Utils.IsOwnerOf	(	parent	,
		child
	)

Checks whether parent is an owner of child Parameters: In: parent, child as WSM.GroupInstancePath Out: true/false.

Parameters

[in]	parent	WSM.GroupInstancePath
[in]	child	WSM.GroupInstancePath

Returns: {...}

json WSM.Utils.IsSelectAllConnected	(	nHistoryID	,
		selectedObjectIDs
	)

IsSelectAllConnected Parameters: In: nHistoryID, selectedObjectIDs Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	selectedObjectIDs	WSM.Utils.HistoryObjects

Returns: {...}

json WSM.Utils.IsSilhouetteEdge	(	nHistoryID	,
		edgeId	,
		cameraPos	,
		cameraDir	,
		perspectiveView
	)

IsSilhouetteEdge Parameters: In: nHistoryID, edgeId, cameraPos, cameraDir, perspectiveView Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	edgeId	int
[in]	cameraPos	WSM.Point3d
[in]	cameraDir	WSM.Vector3d
[in]	perspectiveView	bool

Returns: {...}

json WSM.Utils.IsSmooth ( path )

IsSmooth Parameters: In: path Out: true/false.

Parameters

[in] path WSM.Utils.HistoryObjects

Returns: {...}

json WSM.Utils.IsTopLevelObjectHidden	(	nHistoryID	,
		nObjectID
	)

IsTopLevelObjectHidden Parameters: In: path Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int

Returns: {...}

json WSM.Utils.IsTopLevelObjectHiddenByPath ( path )

IsTopLevelObjectHiddenByPath Parameters: In: path Out: true/false.

Parameters

[in] path WSM.Utils.HistoryObjects

Returns: {...}

json WSM.Utils.IsVertexEditable	(	nHistoryID	,
		nObjectID
	)

IsVertexEditable Parameters: In: nHistoryID, nObjectID Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int

Returns: {...}

json WSM.Utils.IsVertexOnCurve	(	historyID	,
		vertexID
	)

IsVertexOnCurve Parameters: In: historyID, vertexID Out: true/false.

Parameters

[in]	historyID	int
[in]	vertexID	int

Returns: {...}

json WSM.Utils.MakePickRayFromWindow	(	firstWindowSelectPoint	,
		secondWindowSelectPoint
	)

MakePickRayFromWindow Parameters: In: firstWindowSelectPoint, secondWindowSelectPoint Out: PickRay.

Parameters

[in]	firstWindowSelectPoint	WSM.Point2d
[in]	secondWindowSelectPoint	WSM.Point2d

Returns: WSM.Utils.PickRay{ firstWindowSelectPoint, secondWindowSelectPoint}

json WSM.Utils.MatchesSelectionType	(	selectedObjectIDs	,
		aNewSelectedObjects	,
		bSelectAll
	)

MatchesSelectionType Parameters: In: selectedObjectIDs, aNewSelectedObjects, bSelectAll Out: true/false.

Parameters

[in]	selectedObjectIDs	WSM.Utils.HistoryObjects
[in]	aNewSelectedObjects	WSM.Utils.HistoryObjects
[in]	bSelectAll	bool

Returns: {...}

json WSM.Utils.ObjectCanBeHidden	(	nHistoryID	,
		nObjectID
	)

ObjectCanBeHidden Parameters: In: nHistoryID, nObjectID Out: true/false.

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int

Returns: {...}

json WSM.Utils.ObjectHistoryID	(	nHistoryID	,
		nObjectID
	)

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

ObjectHistoryID constructs an ObjectHistoryID.

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int

Returns: {...}

Parameters: In: nHistoryID, nObjectID Out: ObjectHistoryID

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int

Returns: objectHistoryID

json WSM.Utils.ObjectHistoryIDArray	(	objectIDs	,
		History
	)

json WSM.Utils.ObjectIDArray ( objectIDs )

json WSM.Utils.ObjectIDsAreEqual	(	id1	,
		id2
	)

ObjectIDsAreEqual Parameters: In: id1, id2 Out: areSame (bool)

Parameters

[in]	id1	WSM.ObjectHistoryID
[in]	id2	WSM.ObjectHistoryID

Returns: id1 == id2

json WSM.Utils.ObjectTypeFilter ( )

Default constructor for WSM.Utils.ObjectTypeFilter.

Returns: filter

json WSM.Utils.PickBody ( pickray )

PickBody Parameters: In: pickRay Out: size_t.

Parameters

[in] pickray WSM.Utils.PickRay

Returns: {...}

json WSM.Utils.PickGeometry	(	pickray	,
		pickFilter	,
		bAllowAdjustRayRadius
	)

PickGeometry Parameters: In: pickray, pickVertices, pickEdges, pickFaces, pickInstances, bAllowAdjustRayRadius Out: size_t.

Parameters

[in]	pickray	WSM.Utils.PickRay
[in]	pickFilter	WSM.Utils.ObjectTypeFilter
[in]	bAllowAdjustRayRadius	bool

Returns: {...}

json WSM.Utils.PickObjectsWithFilter	(	pickray	,
		filter	,
		currentSelectionLevel
	)

PickObjectsWithFilter Parameters: In: pickray, filter, currentSelectionLevel Out: WSM.GroupInstancePath firstSelectedObject, std.vector<WSM.GroupInstancePath> allSelectedObjects, ObjectsAndPickPoints aObjectsAndPickPoints.

Parameters

[in]	pickray	WSM.Utils.PickRay
[in]	filter	WSM.Utils.ObjectTypeFilter
[in]	currentSelectionLevel	SelectionLevel

Returns: {{ "firstSelectedObject" , to_json(firstSelectedObject)}, { "allSelectedObjects" , to_json(allSelectedObjects)}, { "aObjectsAndPickPoints" , to_json(aObjectsAndPickPoints)}};

json WSM.Utils.PickObjectsWithRay	(	pickray	,
		pickFilter	,
		bAllowAdjustRayRadius	,
		bIgnoreInContext
	)

PickObjectsWithRay Parameters: In: pickRay, pickFilter, bAllowAdjustRayRadius Out: ObjectIDsAndPickPoints aObjectsAndPickPoints.

Parameters

[in]	pickray	WSM.Utils.PickRay
[in]	pickFilter	WSM.Utils.ObjectTypeFilter
[in]	bAllowAdjustRayRadius	bool
[in]	bIgnoreInContext	bool

Returns

json WSM.Utils.PickRay	(	pickrayLine	,
		planes	,
		screenPickRayRadius	,
		perspectiveScaleFactor	,
		baseRadius	,
		normalizedScreenPoint
	)

PickRay constructs a PickRay.

Parameters: In: pickrayLine, planes, screenPickRayRadius, perspectiveScaleFactor, baseRadius, normalizedScreenPoint Out: PickRay

Parameters

[in]	pickrayLine	WSM.Line3d
[in]	planes	Array of WSM.Plane
[in]	screenPickRayRadius	double
[in]	perspectiveScaleFactor	double
[in]	baseRadius	double
[in]	normalizedScreenPoint	(OPTIONAL, default = WSM.Point2d()) WSM.Point2d

Returns: pickRay

json WSM.Utils.PickRayFromLine ( pickrayLine )

PickRay constructs a PickRay.

Expose a different constructor than just PickRay above Parameters: In: pickrayLine Out: PickRay

Parameters

[in] pickrayLine WSM.Line3d

Returns: pickRay

json WSM.Utils.PickRayFromNormalizedScreenPoint	(	ptX	,
		ptY	,
		yUp
	)

PickRayFromNormalizedScreenPoint() function.

Parameters

[in]	ptX	double
[in]	ptY	double
[in]	yUp	(OPTIONAL, default = false) bool

Returns: pickRay

json WSM.Utils.RayFireWithObjects	(	objectIds	,
		ray
	)

RayFireWithObjects Parameters: In: objectIds, ray Out: bool, WSM.Point3d pickPointOnObject.

Parameters

[in]	objectIds	WSM.Utils.HistoryObjects
[in]	ray	WSM.Utils.PickRay

Returns: {{ "success" , to_json(bRet)}, { "point" , to_json(pickPointOnObject)}};

json WSM.Utils.SelectionFromGroupInstancePathArray ( aInput )

SelectionFromGroupInstancePathArray Parameters: In: aInput Out: aOutput.

Parameters

[in] aInput WSM.Utils.HistoryObjects

Returns: aOutput

json WSM.Utils.SelectionToGroupInstancePath ( nObjectID )

SelectionToGroupInstancePath Parameters: In: nObjectID Out: GroupInstancePath.

Parameters

[in] nObjectID int

Returns: {...}

json WSM.Utils.SelectionToGroupInstancePathArray ( aInput )

SelectionToGroupInstancePathArray Parameters: In: aInput Out: aOutput.

Parameters

[in] aInput WSM.Utils.HistoryObjects

Returns: aOutput

json WSM.Utils.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.

Otherwise it creates the attribute first. The copy behavior and bIsSharedOnSplit flag are only used when the attribute is created. Returns true if successful, false otherwise. If ObjectID is WSM.INVALID_ID, the attribute is created on the History. In : HistoryID, ObjectID, key, value, copy behavior, shared flag

Parameters

[in]	nHistoryID	int
[in]	nObjectID	int
[in]	key	String
[in]	value	String
[in]	nCB	(OPTIONAL, default = ( int )WSM.nCopyBehavior.nShareOrCopy) int
[in]	bIsSharedOnSplit	(OPTIONAL, default = true) bool

Returns: success

json WSM.Utils.SetToOwnerBody ( path )

SetToOwnerBody Parameters: In: path Out: WSM.GroupInstancePath.

Parameters

[in] path WSM.Utils.HistoryObjects

Returns: path2

json WSM.Utils.TestPickImages	(	nHistoryID	,
		imageIds	,
		pickRay
	)

TestPickImages Parameters: In: nHistoryID, imageIds, pickRay Out: size_t, Point3d pickPointOnImage.

Parameters

[in]	nHistoryID	int
[in]	imageIds	WSM.Utils.HistoryObjects
[in]	pickRay	WSM.Utils.PickRay

Returns: {{ "id" , to_json( id )}, { "point" , to_json(pickPointOnImage)}};

Description

Functions

Function Documentation