Description

Functions
json	WSM.InferenceEngine.FindInputPoint (pickRay, previousInputPoint)
	FindInputPoint Parameters: In: pickRay, previousInputPoint Out: InputPoint

json	WSM.InferenceEngine.Reset ()
	Reset Parameters: In: Out: JSON

json	WSM.InferenceEngine.InputPointsAreEqual (inputPoint1, inputPoint2)
	InputPointsEqual Parameters: In: inputPoint1, inputPoint2 Out: bool

json	WSM.InferenceEngine.DisableHoveredInferences (disable)
	DisableHoveredInferences is a way to permanently disable line inferences.

json	WSM.InferenceEngine.PushHoveredLineInference (inference)
	PushHoveredLineInference pushes the given lineInf onto the stack of hovered line inferences.

json	WSM.InferenceEngine.PushHoveredPointInference (inference)
	PushHoveredPointInference pushes the given ptInf onto the stack of hovered point inferences.

json	WSM.InferenceEngine.AddInference (arg1, arg2, arg3, arg4)

json	WSM.InferenceEngine.AddPointInference (inference)
	AddPointInference adds a custom point inference.

json	WSM.InferenceEngine.AddLineInference (inference)
	AddLineInference adds a custom line inference.

json	WSM.InferenceEngine.AddPlaneInference (inference)
	AddPlaneInference adds a custom plane inference.

json	WSM.InferenceEngine.LockInference (inference)
	LockInference will cause the InputPointFinder to constrain the resulting InputPoint that it finds to the given Inference.

json	WSM.InferenceEngine.ReleaseLockedInference ()
	ReleaseLockedInference clears the locked Inference.

json	WSM.InferenceEngine.HaveLockedInference ()
	HaveLockedInference checkes whether there is a locked inference.

json	WSM.InferenceEngine.SetVertexSnappingOnSplines (snap)
	SetVertexSnappingOnSplines- Set the flag to control turning on / off Vertex snapping on curves.

json	WSM.InferenceEngine.SetUseExternalInputPointFinder (use)
	SetUseExternalInputPointFinder- Set the flag to control using the external input point finder.

json	WSM.InferenceEngine.SetUseExternalInputPointFinderForTesting (use)
	SetUseExternalInputPointFinderForTesting- Set the flag to control using the external input point finder.

json	WSM.InferenceEngine.IgnoreObject (nObjectID, ignore)
	IgnoreObject- Add given object to the ignored objects set.

json	WSM.InferenceEngine.ClearIgnoreObjects ()
	ClearIgnoreObjects- Clear the ignored objects set.

json	WSM.InferenceEngine.UseAsObscuringObject (nObjectID, andChildren)
	UseAsObscuringObject- This, unlike ignoreObject, will not use picks against this object, but it will also not try to pick farther into the scene, defaulting to the ground plane after a hit Parameters: In: nObjectID (size_t) In: andChildren (bool) Out: JSON_UNDEFINED

json	WSM.InferenceEngine.LineInference (line3d, lineInferenceType)
	LineInference- Constructor for a line inference object Parameters: In: line3d In: LineInferenceType Out: line inference

json	WSM.InferenceEngine.PointInference (point3d)
	PointInference- Constructor for a point inference object Parameters: In: point3d Out: point inference

json	WSM.InferenceEngine.InputPoint (point3d)
	InputPoint- Constructor for an InputPoint object Parameters: In: point3d Out: InputPoint

json	WSM.InferenceEngine.AddLineInferencesForObject (groupInstancePath, noLimit, alwaysShowInference)
	AddLineInferencesForObject- Add line inferences for every Edge associated with the given GroupInstancePath.

json	WSM.InferenceEngine.SetHoveredInferencesEnabled (enabled)
	SetHoveredInferencesEnabled disables hovered inferences until Reset is called.

json	WSM.InferenceEngine.ClearCustomPointInferences ()
	ClearCustomPointInferences clears all custom point inferences Parameters: In: Out: JSON_UNDEFINED

json	WSM.InferenceEngine.ClearCustomLineInferences ()
	ClearCustomLineInferences clears all custom line inferences Parameters: In: Out: JSON_UNDEFINED

json	WSM.InferenceEngine.ClearCustomPlaneInference ()
	ClearCustomPlaneInference clears the custom plane inference Parameters: In: Out: JSON_UNDEFINED

json	WSM.InferenceEngine.OnTimerTick ()
	OnTimerTick updates things like hovered inferences and tooltips Parameters: In: Out: JSON_UNDEFINED

json	WSM.InferenceEngine.UseWSMIAppHelper (bUseFormItIAppHelper, bUseFormItICamera)
	Replace the current IAppHelper with InferencingAppHelper If bUseFormItIAppHelper is false, the InferenceEngine will not delegate to the default IAppHelper Parameters: In: bUseFormItIAppHelper (bool) In: bUseFormItICamera (bool)

json	WSM.InferenceEngine.SetTopLevelHistory (nHistoryID)
	SetTopLevelHistory sets the History that FindInputPoint operates on.

json	WSM.InferenceEngine.GetTopLevelHistory ()
	GetTopLevelHistory gets the top-level History that FindInputPoint operates on.

json	WSM.InferenceEngine.SetEditHistory (nHistoryID)
	SetEditHistory sets the History that is being edited.

json	WSM.InferenceEngine.GetEditHistory ()
	GetEditHistory gets the History that is being edited.

json	WSM.InferenceEngine.DebugInferencingAppHelper (bAlsoCallOriginalAppHelper, bAlsoCallOriginalCamera, bReturnOriginal)
	DebugInferencingAppHelper allows control whether to call the delegate IAppHelper.

json	WSM.InferenceEngine.SetCameraData (cameraData)

Function Documentation

◆ AddInference()

json WSM.InferenceEngine.AddInference	(	arg1	,
		arg2	,
		arg3	,
		arg4
	)

◆ AddLineInference()

json WSM.InferenceEngine.AddLineInference ( inference )

AddLineInference adds a custom line inference.

Parameters: In: "inference" Out: JSON_UNDEFINED

Parameters

[in] inference WSM.IInferencePtr

Returns: JSON_UNDEFINED, i.e. {}

◆ AddLineInferencesForObject()

json WSM.InferenceEngine.AddLineInferencesForObject	(	groupInstancePath	,
		noLimit	,
		alwaysShowInference
	)

AddLineInferencesForObject- Add line inferences for every Edge associated with the given GroupInstancePath.

Parameters: In: groupInstancePath, noLimit (Optional), alwaysShowInference (Optional) Out: JSON_UNDEFINED

Parameters

[in]	groupInstancePath	WSM.GroupInstancePath
[in]	noLimit	(OPTIONAL, default = false) bool
[in]	alwaysShowInference	(OPTIONAL, default = false) bool

Returns: JSON_UNDEFINED, i.e. {}

◆ AddPlaneInference()

json WSM.InferenceEngine.AddPlaneInference ( inference )

AddPlaneInference adds a custom plane inference.

Parameters: In: "inference" Out: JSON_UNDEFINED

Parameters

[in] inference WSM.IInferencePtr

Returns: JSON_UNDEFINED, i.e. {}

◆ AddPointInference()

json WSM.InferenceEngine.AddPointInference ( inference )

AddPointInference adds a custom point inference.

Parameters: In: "inference" Out: JSON_UNDEFINED

Parameters

[in] inference WSM.IInferencePtr

Returns: JSON_UNDEFINED, i.e. {}

◆ ClearCustomLineInferences()

json WSM.InferenceEngine.ClearCustomLineInferences ( )

ClearCustomLineInferences clears all custom line inferences Parameters: In: Out: JSON_UNDEFINED

Returns: JSON_UNDEFINED, i.e. {}

◆ ClearCustomPlaneInference()

json WSM.InferenceEngine.ClearCustomPlaneInference ( )

ClearCustomPlaneInference clears the custom plane inference Parameters: In: Out: JSON_UNDEFINED

Returns: JSON_UNDEFINED, i.e. {}

◆ ClearCustomPointInferences()

json WSM.InferenceEngine.ClearCustomPointInferences ( )

ClearCustomPointInferences clears all custom point inferences Parameters: In: Out: JSON_UNDEFINED

Returns: JSON_UNDEFINED, i.e. {}

◆ ClearIgnoreObjects()

json WSM.InferenceEngine.ClearIgnoreObjects ( )

ClearIgnoreObjects- Clear the ignored objects set.

Parameters: Out: JSON_UNDEFINED

Returns: JSON_UNDEFINED, i.e. {}

◆ DebugInferencingAppHelper()

json WSM.InferenceEngine.DebugInferencingAppHelper	(	bAlsoCallOriginalAppHelper	,
		bAlsoCallOriginalCamera	,
		bReturnOriginal
	)

DebugInferencingAppHelper allows control whether to call the delegate IAppHelper.

This is for debugging so you can compare results to make sure we're getting the same results. If bAlsoCallOriginalICamera is true, InferencingAppHelper will also call the original IAppHelper (FormIt), so you can tell if you're getting the right result. If bReturnOriginal is true, it will return the original IAppHelper result to make sure the results are working, for like running a test. Parameters: In: bAlsoCallOriginalAppHelper (bool) Also call the original IAppHelper to compare at runtime In: bAlsoCallOriginalICamera (bool) Also call the original ICamera to compare at runtime In: bReturnOriginal (bool) Returns the result from the original IAppHelper Out: JSON_UNDEFINED

Parameters

[in]	bAlsoCallOriginalAppHelper	bool
[in]	bAlsoCallOriginalCamera	bool
[in]	bReturnOriginal	bool

Returns: JSON_UNDEFINED, i.e. {}

◆ DisableHoveredInferences()

json WSM.InferenceEngine.DisableHoveredInferences ( disable )

DisableHoveredInferences is a way to permanently disable line inferences.

Reset won't turn them back on. Only calling DisableHoveredInferences again will turn them back on. This is mainly for testing. Parameters: In: disable Out: bool

Parameters

[in] disable bool

Returns: JSON_UNDEFINED, i.e. {}

◆ FindInputPoint()

json WSM.InferenceEngine.FindInputPoint	(	pickRay	,
		previousInputPoint
	)

FindInputPoint Parameters: In: pickRay, previousInputPoint Out: InputPoint

Parameters

[in]	pickRay	WSM.Utils.PickRay
[in]	previousInputPoint	(OPTIONAL) WSM.IInputPointPtr

Returns: WSMAppHelper.App3DHelper.KeepAliveInputPoint(ip);

Parameters

[in]	pickRay	WSM.Utils.PickRay
[in]	previousInputPoint	(OPTIONAL) WSM.IInputPointPtr

Returns: ip

◆ GetEditHistory()

json WSM.InferenceEngine.GetEditHistory ( )

GetEditHistory gets the History that is being edited.

The inference engine does no History management, so Get/SetGetEditHistory only returns what the application says to inference. Parameters: Out: History id

Returns: {...}

◆ GetTopLevelHistory()

json WSM.InferenceEngine.GetTopLevelHistory ( )

GetTopLevelHistory gets the top-level History that FindInputPoint operates on.

The inference engine does no History management, so Get/SetTopLevelHistory only returns what the application says to inference. Parameters: Out: History id

Returns: {...}

◆ HaveLockedInference()

json WSM.InferenceEngine.HaveLockedInference ( )

HaveLockedInference checkes whether there is a locked inference.

Parameters: In: Out: true if there is a locked inference

Returns: {...}

◆ IgnoreObject()

json WSM.InferenceEngine.IgnoreObject	(	nObjectID	,
		ignore
	)

IgnoreObject- Add given object to the ignored objects set.

Parameters: In: nObjectID (size_t) In: andChildren (bool) Out: JSON_UNDEFINED

Parameters

[in]	nObjectID	int
[in]	ignore	WSM.InputPointFinder.IgnoreType

Returns: JSON_UNDEFINED, i.e. {}

◆ InputPoint()

json WSM.InferenceEngine.InputPoint ( point3d )

InputPoint- Constructor for an InputPoint object Parameters: In: point3d Out: InputPoint

Parameters

[in] point3d WSM.Point3d

Returns: inputPt

◆ InputPointsAreEqual()

json WSM.InferenceEngine.InputPointsAreEqual	(	inputPoint1	,
		inputPoint2
	)

InputPointsEqual Parameters: In: inputPoint1, inputPoint2 Out: bool

Parameters

[in]	inputPoint1	WSM.IInputPointPtr
[in]	inputPoint2	WSM.IInputPointPtr

Returns: inputPoint1->AreEqual(inputPoint2);

◆ LineInference()

json WSM.InferenceEngine.LineInference	(	line3d	,
		lineInferenceType
	)

LineInference- Constructor for a line inference object Parameters: In: line3d In: LineInferenceType Out: line inference

Parameters

[in]	line3d	WSM.Line3d
[in]	lineInferenceType	WSM.LineInferenceType

Returns: lineInference

◆ LockInference()

json WSM.InferenceEngine.LockInference ( inference )

LockInference will cause the InputPointFinder to constrain the resulting InputPoint that it finds to the given Inference.

Parameters: In: "inference" Out: JSON_UNDEFINED

Parameters

[in] inference WSM.IInferencePtr

Returns: JSON_UNDEFINED, i.e. {}

◆ OnTimerTick()

json WSM.InferenceEngine.OnTimerTick ( )

OnTimerTick updates things like hovered inferences and tooltips Parameters: In: Out: JSON_UNDEFINED

Returns: JSON_UNDEFINED, i.e. {}

◆ PointInference()

json WSM.InferenceEngine.PointInference ( point3d )

PointInference- Constructor for a point inference object Parameters: In: point3d Out: point inference

Parameters

[in] point3d WSM.Point3d

Returns: pointInference

◆ PushHoveredLineInference()

json WSM.InferenceEngine.PushHoveredLineInference ( inference )

PushHoveredLineInference pushes the given lineInf onto the stack of hovered line inferences.

This method is mainly for scripting the InputPointFinder. Parameters: In: "inference" Out: bool

Parameters

[in] inference WSM.IInferencePtr

Returns: JSON_UNDEFINED, i.e. {}

◆ PushHoveredPointInference()

json WSM.InferenceEngine.PushHoveredPointInference ( inference )

PushHoveredPointInference pushes the given ptInf onto the stack of hovered point inferences.

This method is mainly for scripting the InputPointFinder. Parameters: In: "inference" Out: JSON_UNDEFINED

Parameters

[in] inference WSM.IInferencePtr

Returns: JSON_UNDEFINED, i.e. {}

◆ ReleaseLockedInference()

json WSM.InferenceEngine.ReleaseLockedInference ( )

ReleaseLockedInference clears the locked Inference.

Parameters: In: Out: JSON_UNDEFINED

Returns: JSON_UNDEFINED, i.e. {}

◆ Reset()

json WSM.InferenceEngine.Reset ( )

Reset Parameters: In: Out: JSON

Reset

Parameters: In: Out: JSON.

Returns: JSON_UNDEFINED, i.e. {}

◆ SetCameraData()

json WSM.InferenceEngine.SetCameraData ( cameraData )

◆ SetEditHistory()

json WSM.InferenceEngine.SetEditHistory ( nHistoryID )

SetEditHistory sets the History that is being edited.

The inference engine does no History management, so Get/SetEditHistory only returns what the application says to inference. Parameters: In: nHistoryID Out: JSON_UNDEFINED

Parameters

[in] nHistoryID int

Returns: JSON_UNDEFINED, i.e. {}

◆ SetHoveredInferencesEnabled()

json WSM.InferenceEngine.SetHoveredInferencesEnabled ( enabled )

SetHoveredInferencesEnabled disables hovered inferences until Reset is called.

Parameters: In: enabled Out: JSON_UNDEFINED

Parameters

[in] enabled bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetTopLevelHistory()

json WSM.InferenceEngine.SetTopLevelHistory ( nHistoryID )

SetTopLevelHistory sets the History that FindInputPoint operates on.

The inference engine does no History management, so Get/SetTopLevelHistory only returns what the application says to inference. Parameters: In: nHistoryID Out: JSON_UNDEFINED

Parameters

[in] nHistoryID int

Returns: JSON_UNDEFINED, i.e. {}

◆ SetUseExternalInputPointFinder()

json WSM.InferenceEngine.SetUseExternalInputPointFinder ( use )

SetUseExternalInputPointFinder- Set the flag to control using the external input point finder.

(Used for testing). Parameters: In: use (bool) Out: JSON_UNDEFINED

Parameters

[in] use bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetUseExternalInputPointFinderForTesting()

json WSM.InferenceEngine.SetUseExternalInputPointFinderForTesting ( use )

SetUseExternalInputPointFinderForTesting- Set the flag to control using the external input point finder.

(Used for testing). Parameters: In: use (bool) Out: JSON_UNDEFINED

Parameters

[in] use bool

Returns: JSON_UNDEFINED, i.e. {}

◆ SetVertexSnappingOnSplines()

json WSM.InferenceEngine.SetVertexSnappingOnSplines ( snap )

SetVertexSnappingOnSplines- Set the flag to control turning on / off Vertex snapping on curves.

Parameters: In: snap (bool) Out: JSON_UNDEFINED

Parameters

[in] snap bool

Returns: JSON_UNDEFINED, i.e. {}

◆ UseAsObscuringObject()

json WSM.InferenceEngine.UseAsObscuringObject	(	nObjectID	,
		andChildren
	)

UseAsObscuringObject- This, unlike ignoreObject, will not use picks against this object, but it will also not try to pick farther into the scene, defaulting to the ground plane after a hit Parameters: In: nObjectID (size_t) In: andChildren (bool) Out: JSON_UNDEFINED

Parameters

[in]	nObjectID	int
[in]	andChildren	bool

Returns: JSON_UNDEFINED, i.e. {}

◆ UseWSMIAppHelper()

json WSM.InferenceEngine.UseWSMIAppHelper	(	bUseFormItIAppHelper	,
		bUseFormItICamera
	)

Replace the current IAppHelper with InferencingAppHelper If bUseFormItIAppHelper is false, the InferenceEngine will not delegate to the default IAppHelper Parameters: In: bUseFormItIAppHelper (bool) In: bUseFormItICamera (bool)

Parameters

[in]	bUseFormItIAppHelper	(OPTIONAL, default = false) bool
[in]	bUseFormItICamera	(OPTIONAL, default = false) bool

Returns: JSON_UNDEFINED

Description

Functions

Function Documentation

◆ AddInference()

◆ AddLineInference()

◆ AddLineInferencesForObject()

◆ AddPlaneInference()

◆ AddPointInference()

◆ ClearCustomLineInferences()

◆ ClearCustomPlaneInference()

◆ ClearCustomPointInferences()

◆ ClearIgnoreObjects()

◆ DebugInferencingAppHelper()

◆ DisableHoveredInferences()

◆ FindInputPoint()

◆ GetEditHistory()

◆ GetTopLevelHistory()

◆ HaveLockedInference()

◆ IgnoreObject()

◆ InputPoint()

◆ InputPointsAreEqual()

◆ LineInference()

◆ LockInference()

◆ OnTimerTick()

◆ PointInference()

◆ PushHoveredLineInference()

◆ PushHoveredPointInference()

◆ ReleaseLockedInference()

◆ Reset()

◆ SetCameraData()

◆ SetEditHistory()

◆ SetHoveredInferencesEnabled()

◆ SetTopLevelHistory()

◆ SetUseExternalInputPointFinder()

◆ SetUseExternalInputPointFinderForTesting()

◆ SetVertexSnappingOnSplines()

◆ UseAsObscuringObject()

◆ UseWSMIAppHelper()