Description

Functions
json	WSM.Tools.CompareOutputFiles (sGoodFile, sResultFile)
	CompareOutputFiles() function. More...

json	WSM.Tools.APIReset ()
	Register/Unregister AppHelper is not done from JS side FormIt/host application must expose this initialization. More...

json	WSM.Tools.APICreateTool (nType, toolArgs)
	APICreateTool() function. More...

json	WSM.Tools.APIDestroyTool (nToolID)
	APIDestroyTool() function. More...

json	WSM.Tools.APIGetAllLiveToolsReadOnly ()
	APIGetAllLiveToolsReadOnly() function. More...

json	WSM.Tools.APIGetToolTypeReadOnly (nToolID)
	APIGetToolTypeReadOnly() function. More...

json	WSM.Tools.APIGetResultDescriptionReadOnly (nResult)
	APIGetResultDescriptionReadOnly() function. More...

json	WSM.Tools.APIGetToolStateReadOnly (nToolID)
	APIGetToolStateReadOnly() function. More...

json	WSM.Tools.APIResetTool (nToolID, nReason)
	APIResetTool() function. More...

json	WSM.Tools.APIResetToolModelChange (nToolID, data)
	APIResetToolModelChange() function. More...

json	WSM.Tools.APIUpdateCurrentPoint (nToolID, pickray)
	APIUpdateCurrentPoint() function. More...

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

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

json	WSM.Tools.APILockInference (nToolID)
	APILockInference() function. More...

json	WSM.Tools.APIUnlockInference (nToolID)
	APIUnlockInference() function. More...

json	WSM.Tools.APIPickAndPlacePoint (nToolID, pickray)
	APIPickAndPlacePoint() function. More...

json	WSM.Tools.APIPlacePoint (nToolID, pInputPoint)
	APIPlacePoint() function. More...

json	WSM.Tools.APIFinalize (nToolID, pickray)
	APIFinalize() function. More...

json	WSM.Tools.APIGetCurrentPointReadOnly (nToolID)
	APIGetCurrentPointReadOnly() function. More...

json	WSM.Tools.APIGetPointReadOnly (nToolID, nPointIndex)
	APIGetPointReadOnly() function. More...

json	WSM.Tools.APISetOperationMode (nToolID, nMode)
	APISetOperationMode() function. More...

json	WSM.Tools.APIResetCurrentPoint (nToolID)
	APIResetCurrentPoint() function. More...

json	WSM.Tools.APISetDefaultPoints (nToolID)
	APISetDefaultPoints() function. More...

json	WSM.Tools.APISetEditingMode (nToolID, bEditingMode)
	APISetEditingMode() function. More...

json	WSM.Tools.APICreateGeometry (nToolID)
	APICreateGeometry() function. More...

json	WSM.Tools.APIModResetModel (nToolID, bDeleteRedo)
	APIModResetModel() function. More...

json	WSM.Tools.APIModSetObjectsToModify (nToolID, aObjectsToModify)
	APIModSetObjectsToModify() function. More...

json	WSM.Tools.APIModSetObjectsToModifyGroupInstancePath (nToolID, aObjectsToModify)
	APIModSetObjectsToModifyGroupInstancePath() function. More...

json	WSM.Tools.APIModIsInteractiveReadOnly (nToolID)
	APIModIsInteractiveReadOnly() function. More...

json	WSM.Tools.APIModFiltersInitialSelectionReadOnly (nToolID)
	APIModFiltersInitialSelectionReadOnly() function. More...

json	WSM.Tools.APIModDoModification (nToolID, bEndOfContinuous)
	APIModDoModification() function. More...

json	WSM.Tools.APIModGetFinishMessageReadOnly (nToolID)
	APIModGetFinishMessageReadOnly() function. More...

json	WSM.Tools.APICameraChanged (nToolID)
	APICameraChanged() function. More...

Function Documentation

json WSM.Tools.APICameraChanged ( nToolID )

APICameraChanged() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APICreateGeometry ( nToolID )

APICreateGeometry() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APICreateTool	(	nType	,
		toolArgs
	)

APICreateTool() function.

Parameters

[in]	nType	int
[in]	toolArgs	(OPTIONAL) utils.AnyDictionary

Returns: ToolAPIJSONReturn(res, toolID);

json WSM.Tools.APIDestroyTool ( nToolID )

APIDestroyTool() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APIFinalize	(	nToolID	,
		pickray
	)

APIFinalize() function.

Parameters

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

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APIGetAllLiveToolsReadOnly ( )

APIGetAllLiveToolsReadOnly() function.

Returns: ToolAPIJSONReturn(res, aToolIDs);

json WSM.Tools.APIGetCurrentPointReadOnly ( nToolID )

APIGetCurrentPointReadOnly() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res, pCurrentPt);

json WSM.Tools.APIGetPointReadOnly	(	nToolID	,
		nPointIndex
	)

APIGetPointReadOnly() function.

Parameters

[in]	nToolID	WSMToolID
[in]	nPointIndex	int

Returns: ToolAPIJSONReturn(res, pPt);

json WSM.Tools.APIGetResultDescriptionReadOnly ( nResult )

APIGetResultDescriptionReadOnly() function.

Parameters

[in] nResult int

Returns: ToolAPIJSONReturn(res, str);

json WSM.Tools.APIGetToolStateReadOnly ( nToolID )

APIGetToolStateReadOnly() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res, size_t (state));

json WSM.Tools.APIGetToolTypeReadOnly ( nToolID )

APIGetToolTypeReadOnly() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res, size_t (type));

json WSM.Tools.APILockInference ( nToolID )

APILockInference() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APIModDoModification	(	nToolID	,
		bEndOfContinuous
	)

APIModDoModification() function.

Parameters

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

Returns: ToolAPIJSONReturn(res, bModificationWasDid);

json WSM.Tools.APIModFiltersInitialSelectionReadOnly ( nToolID )

APIModFiltersInitialSelectionReadOnly() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res, bFiltersInitialSelection);

json WSM.Tools.APIModGetFinishMessageReadOnly ( nToolID )

APIModGetFinishMessageReadOnly() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res, aFinishMessage);

json WSM.Tools.APIModIsInteractiveReadOnly ( nToolID )

APIModIsInteractiveReadOnly() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res, isInteractive);

json WSM.Tools.APIModResetModel	(	nToolID	,
		bDeleteRedo
	)

APIModResetModel() function.

Parameters

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

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APIModSetObjectsToModify	(	nToolID	,
		aObjectsToModify
	)

APIModSetObjectsToModify() function.

Parameters

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

Returns: ToolAPIJSONReturn(res, bUsed);

json WSM.Tools.APIModSetObjectsToModifyGroupInstancePath	(	nToolID	,
		aObjectsToModify
	)

APIModSetObjectsToModifyGroupInstancePath() function.

Parameters

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

Returns: ToolAPIJSONReturn(res, bUsed);

json WSM.Tools.APIPickAndPlacePoint	(	nToolID	,
		pickray
	)

APIPickAndPlacePoint() function.

Parameters

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

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APIPlacePoint	(	nToolID	,
		pInputPoint
	)

APIPlacePoint() function.

Parameters

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

Returns: ToolAPIJSONReturn(res);

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);

json WSM.Tools.APIResetCurrentPoint ( nToolID )

APIResetCurrentPoint() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APIResetTool	(	nToolID	,
		nReason
	)

APIResetTool() function.

Parameters

[in]	nToolID	WSMToolID
[in]	nReason	int

Returns: ToolAPIJSONReturn(res, bDidReset);

json WSM.Tools.APIResetToolModelChange	(	nToolID	,
		data
	)

APIResetToolModelChange() function.

Parameters

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

Returns: ToolAPIJSONReturn(res, bDidReset);

json WSM.Tools.APISetDefaultPoints ( nToolID )

APISetDefaultPoints() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APISetEditingMode	(	nToolID	,
		bEditingMode
	)

APISetEditingMode() function.

Parameters

[in]	nToolID	WSMToolID
[in]	bEditingMode	bool

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APISetOperationMode	(	nToolID	,
		nMode
	)

APISetOperationMode() function.

Parameters

[in]	nToolID	WSMToolID
[in]	nMode	int

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APIUnlockInference ( nToolID )

APIUnlockInference() function.

Parameters

[in] nToolID WSMToolID

Returns: ToolAPIJSONReturn(res);

json WSM.Tools.APIUpdateCurrentPoint	(	nToolID	,
		pickray
	)

APIUpdateCurrentPoint() function.

Parameters

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

Returns: ToolAPIJSONReturn(res);

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);

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);

json WSM.Tools.CompareOutputFiles	(	sGoodFile	,
		sResultFile
	)

CompareOutputFiles() function.

Parameters

[in]	sGoodFile	String
[in]	sResultFile	String

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

Description

Functions

Function Documentation