WSM.Tools API

Description

Functions
json	WSM.Tools.CompareOutputFiles (sGoodFile, sResultFile)
	CompareOutputFiles() function.
json	WSM.Tools.APIReset ()
	Register/Unregister AppHelper is not done from JS side FormIt/host application must expose this initialization.
json	WSM.Tools.APICreateTool (nType, toolArgs)
	APICreateTool() function.
json	WSM.Tools.APIDestroyTool (nToolID)
	APIDestroyTool() function.
json	WSM.Tools.APIGetAllLiveToolsReadOnly ()
	APIGetAllLiveToolsReadOnly() function.
json	WSM.Tools.APIGetToolTypeReadOnly (nToolID)
	APIGetToolTypeReadOnly() function.
json	WSM.Tools.APIGetResultDescriptionReadOnly (nResult)
	APIGetResultDescriptionReadOnly() function.
json	WSM.Tools.APIGetToolStateReadOnly (nToolID)
	APIGetToolStateReadOnly() function.
json	WSM.Tools.APIResetTool (nToolID, nReason)
	APIResetTool() function.
json	WSM.Tools.APIResetToolModelChange (nToolID, data)
	APIResetToolModelChange() function.
json	WSM.Tools.APIUpdateCurrentPoint (nToolID, pickray)
	APIUpdateCurrentPoint() function.
json	WSM.Tools.APIUpdatePointPick (nToolID, nPointIndex, pickray, bFinal)
	APIUpdatePointPick() function.
json	WSM.Tools.APIUpdatePoint (nToolID, nPointIndex, pInputPoint, bFinal)
	APIUpdatePoint() function.
json	WSM.Tools.APILockInference (nToolID)
	APILockInference() function.
json	WSM.Tools.APIUnlockInference (nToolID)
	APIUnlockInference() function.
json	WSM.Tools.APIPickAndPlacePoint (nToolID, pickray)
	APIPickAndPlacePoint() function.
json	WSM.Tools.APIPlacePoint (nToolID, pInputPoint)
	APIPlacePoint() function.
json	WSM.Tools.APIFinalize (nToolID, pickray)
	APIFinalize() function.
json	WSM.Tools.APIGetCurrentPointReadOnly (nToolID)
	APIGetCurrentPointReadOnly() function.
json	WSM.Tools.APIGetPointReadOnly (nToolID, nPointIndex)
	APIGetPointReadOnly() function.
json	WSM.Tools.APISetOperationMode (nToolID, nMode)
	APISetOperationMode() function.
json	WSM.Tools.APIResetCurrentPoint (nToolID)
	APIResetCurrentPoint() function.
json	WSM.Tools.APISetDefaultPoints (nToolID)
	APISetDefaultPoints() function.
json	WSM.Tools.APISetEditingMode (nToolID, bEditingMode)
	APISetEditingMode() function.
json	WSM.Tools.APICreateGeometry (nToolID)
	APICreateGeometry() function.
json	WSM.Tools.APIModResetModel (nToolID, bDeleteRedo)
	APIModResetModel() function.
json	WSM.Tools.APIModSetObjectsToModify (nToolID, aObjectsToModify)
	APIModSetObjectsToModify() function.
json	WSM.Tools.APIModSetObjectsToModifyGroupInstancePath (nToolID, aObjectsToModify)
	APIModSetObjectsToModifyGroupInstancePath() function.
json	WSM.Tools.APIModIsInteractiveReadOnly (nToolID)
	APIModIsInteractiveReadOnly() function.
json	WSM.Tools.APIModFiltersInitialSelectionReadOnly (nToolID)
	APIModFiltersInitialSelectionReadOnly() function.
json	WSM.Tools.APIModDoModification (nToolID, bEndOfContinuous)
	APIModDoModification() function.
json	WSM.Tools.APIModGetFinishMessageReadOnly (nToolID)
	APIModGetFinishMessageReadOnly() function.
json	WSM.Tools.APICameraChanged (nToolID)
	APICameraChanged() function.

Function Documentation

APICameraChanged()

json WSM.Tools.APICameraChanged

(

nToolID

)

APICameraChanged() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res);

APICreateGeometry()

json WSM.Tools.APICreateGeometry

(

nToolID

)

APICreateGeometry() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res);

APICreateTool()

json WSM.Tools.APICreateTool	(	nType	,
		toolArgs
	)

APICreateTool() function.

Parameters

[in]	nType	int
[in]	toolArgs	(OPTIONAL) json

Returns

ToolAPIJSONReturn(res, toolID);

APIDestroyTool()

json WSM.Tools.APIDestroyTool

(

nToolID

)

APIDestroyTool() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res);

APIFinalize()

json WSM.Tools.APIFinalize	(	nToolID	,
		pickray
	)

APIFinalize() function.

Parameters

[in]	nToolID	WSMToolID
[in]	pickray	WSM.Utils.PickRay

Returns

ToolAPIJSONReturn(res);

APIGetAllLiveToolsReadOnly()

json WSM.Tools.APIGetAllLiveToolsReadOnly

(

)

APIGetAllLiveToolsReadOnly() function.

Returns

ToolAPIJSONReturn(res, aToolIDs);

APIGetCurrentPointReadOnly()

json WSM.Tools.APIGetCurrentPointReadOnly

(

nToolID

)

APIGetCurrentPointReadOnly() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res, pCurrentPt);

APIGetPointReadOnly()

json WSM.Tools.APIGetPointReadOnly	(	nToolID	,
		nPointIndex
	)

APIGetPointReadOnly() function.

Parameters

[in]	nToolID	WSMToolID
[in]	nPointIndex	int

Returns

ToolAPIJSONReturn(res, pPt);

APIGetResultDescriptionReadOnly()

json WSM.Tools.APIGetResultDescriptionReadOnly

(

nResult

)

APIGetResultDescriptionReadOnly() function.

Parameters

[in]

nResult

int

Returns

ToolAPIJSONReturn(res, str);

APIGetToolStateReadOnly()

json WSM.Tools.APIGetToolStateReadOnly

(

nToolID

)

APIGetToolStateReadOnly() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res, size_t (state));

APIGetToolTypeReadOnly()

json WSM.Tools.APIGetToolTypeReadOnly

(

nToolID

)

APIGetToolTypeReadOnly() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res, size_t (type));

APILockInference()

json WSM.Tools.APILockInference

(

nToolID

)

APILockInference() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res);

APIModDoModification()

json WSM.Tools.APIModDoModification	(	nToolID	,
		bEndOfContinuous
	)

APIModDoModification() function.

Parameters

[in]	nToolID	WSMToolID
[in]	bEndOfContinuous	(OPTIONAL) bool

Returns

ToolAPIJSONReturn(res, bModificationWasDid);

APIModFiltersInitialSelectionReadOnly()

json WSM.Tools.APIModFiltersInitialSelectionReadOnly

(

nToolID

)

APIModFiltersInitialSelectionReadOnly() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res, bFiltersInitialSelection);

APIModGetFinishMessageReadOnly()

json WSM.Tools.APIModGetFinishMessageReadOnly

(

nToolID

)

APIModGetFinishMessageReadOnly() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res, aFinishMessage);

APIModIsInteractiveReadOnly()

json WSM.Tools.APIModIsInteractiveReadOnly

(

nToolID

)

APIModIsInteractiveReadOnly() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res, isInteractive);

APIModResetModel()

json WSM.Tools.APIModResetModel	(	nToolID	,
		bDeleteRedo
	)

APIModResetModel() function.

Parameters

[in]	nToolID	WSMToolID
[in]	bDeleteRedo	(OPTIONAL, default = true) bool

Returns

ToolAPIJSONReturn(res);

APIModSetObjectsToModify()

json WSM.Tools.APIModSetObjectsToModify	(	nToolID	,
		aObjectsToModify
	)

APIModSetObjectsToModify() function.

Parameters

[in]	nToolID	WSMToolID
[in]	aObjectsToModify	Array of int

Returns

ToolAPIJSONReturn(res, bUsed);

APIModSetObjectsToModifyGroupInstancePath()

json WSM.Tools.APIModSetObjectsToModifyGroupInstancePath	(	nToolID	,
		aObjectsToModify
	)

APIModSetObjectsToModifyGroupInstancePath() function.

Parameters

[in]	nToolID	WSMToolID
[in]	aObjectsToModify	WSM.Utils.HistoryObjects

Returns

ToolAPIJSONReturn(res, bUsed);

APIPickAndPlacePoint()

json WSM.Tools.APIPickAndPlacePoint	(	nToolID	,
		pickray
	)

APIPickAndPlacePoint() function.

Parameters

[in]	nToolID	WSMToolID
[in]	pickray	WSM.Utils.PickRay

Returns

ToolAPIJSONReturn(res);

APIPlacePoint()

json WSM.Tools.APIPlacePoint	(	nToolID	,
		pInputPoint
	)

APIPlacePoint() function.

Parameters

[in]	nToolID	WSMToolID
[in]	pInputPoint	WSM.IInputPointPtr

Returns

ToolAPIJSONReturn(res);

APIReset()

json WSM.Tools.APIReset

(

)

Register/Unregister AppHelper is not done from JS side FormIt/host application must expose this initialization.

For API Documentation, see WSMTools/wsmToolsApi.h

Returns

ToolAPIJSONReturn(res);

APIResetCurrentPoint()

json WSM.Tools.APIResetCurrentPoint

(

nToolID

)

APIResetCurrentPoint() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res);

APIResetTool()

json WSM.Tools.APIResetTool	(	nToolID	,
		nReason
	)

APIResetTool() function.

Parameters

[in]	nToolID	WSMToolID
[in]	nReason	int

Returns

ToolAPIJSONReturn(res, bDidReset);

APIResetToolModelChange()

json WSM.Tools.APIResetToolModelChange	(	nToolID	,
		data
	)

APIResetToolModelChange() function.

Parameters

[in]	nToolID	WSMToolID
[in]	data	WSM.ModelChangeData

Returns

ToolAPIJSONReturn(res, bDidReset);

APISetDefaultPoints()

json WSM.Tools.APISetDefaultPoints

(

nToolID

)

APISetDefaultPoints() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res);

APISetEditingMode()

json WSM.Tools.APISetEditingMode	(	nToolID	,
		bEditingMode
	)

APISetEditingMode() function.

Parameters

[in]	nToolID	WSMToolID
[in]	bEditingMode	bool

Returns

ToolAPIJSONReturn(res);

APISetOperationMode()

json WSM.Tools.APISetOperationMode	(	nToolID	,
		nMode
	)

APISetOperationMode() function.

Parameters

[in]	nToolID	WSMToolID
[in]	nMode	int

Returns

ToolAPIJSONReturn(res);

APIUnlockInference()

json WSM.Tools.APIUnlockInference

(

nToolID

)

APIUnlockInference() function.

Parameters

[in]

nToolID

WSMToolID

Returns

ToolAPIJSONReturn(res);

APIUpdateCurrentPoint()

json WSM.Tools.APIUpdateCurrentPoint	(	nToolID	,
		pickray
	)

APIUpdateCurrentPoint() function.

Parameters

[in]	nToolID	WSMToolID
[in]	pickray	WSM.Utils.PickRay

Returns

ToolAPIJSONReturn(res);

APIUpdatePoint()

json WSM.Tools.APIUpdatePoint	(	nToolID	,
		nPointIndex	,
		pInputPoint	,
		bFinal
	)

APIUpdatePoint() function.

Parameters

[in]	nToolID	WSMToolID
[in]	nPointIndex	int
[in]	pInputPoint	WSM.IInputPointPtr
[in]	bFinal	(OPTIONAL) bool

Returns

ToolAPIJSONReturn(res);

APIUpdatePointPick()

json WSM.Tools.APIUpdatePointPick	(	nToolID	,
		nPointIndex	,
		pickray	,
		bFinal
	)

APIUpdatePointPick() function.

Parameters

[in]	nToolID	WSMToolID
[in]	nPointIndex	int
[in]	pickray	WSM.Utils.PickRay
[in]	bFinal	(OPTIONAL) bool

Returns

ToolAPIJSONReturn(res);

CompareOutputFiles()

json WSM.Tools.CompareOutputFiles	(	sGoodFile	,
		sResultFile
	)

CompareOutputFiles() function.

Parameters

[in]	sGoodFile	String
[in]	sResultFile	String

Returns

{{ "ok" , same}, { "lineNumber" , lineNum}, { "goodLine" , goodLine}, { "badLine" , resultLine}};