Description

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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

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

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

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

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

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

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

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

Function Documentation

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. {}

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. {}

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. {}

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. {}

json WSM.InferenceEngine.ClearCustomLineInferences ( )

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

Returns: JSON_UNDEFINED, i.e. {}

json WSM.InferenceEngine.ClearCustomPlaneInference ( )

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

Returns: JSON_UNDEFINED, i.e. {}

json WSM.InferenceEngine.ClearCustomPointInferences ( )

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

Returns: JSON_UNDEFINED, i.e. {}

json WSM.InferenceEngine.ClearIgnoreObjects ( )

ClearIgnoreObjects- Clear the ignored objects set.

Parameters: Out: JSON_UNDEFINED

Returns: JSON_UNDEFINED, i.e. {}

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. {}

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

json WSM.InferenceEngine.HaveLockedInference ( )

HaveLockedInference checkes whether there is a locked inference.

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

Returns: {...}

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. {}

json WSM.InferenceEngine.InputPoint ( point3d )

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

Parameters

[in] point3d WSM.Point3d

Returns: inputPt

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

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

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. {}

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

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. {}

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. {}

json WSM.InferenceEngine.ReleaseLockedInference ( )

ReleaseLockedInference clears the locked Inference.

Parameters: In: Out: JSON_UNDEFINED

Returns: JSON_UNDEFINED, i.e. {}

json WSM.InferenceEngine.Reset ( )

Reset Parameters: In: Out: JSON.

Returns: JSON_UNDEFINED, i.e. {}

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. {}

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. {}

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. {}

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. {}

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. {}

Description

Functions

Function Documentation