Class SpatialCurveBuilderHelper

Helper methods for ICamApiSpatialCurveBuilder

Inheritance
object
SpatialCurveBuilderHelper
Inherited Members
Namespace: CAMAPI.DotnetHelper
Assembly: CAMAPI.DotnetHelper.dll
Syntax
public static class SpatialCurveBuilderHelper

Methods

AddKnot(ComWrapper<ICamApiSpatialCurveBuilder>, TST3DPoint)

Append a knot point to the in-progress curve

Declaration
public static void AddKnot(this ComWrapper<ICamApiSpatialCurveBuilder> builderCom, TST3DPoint p)
Parameters
Type Name Description
ComWrapper<ICamApiSpatialCurveBuilder> builderCom
TST3DPoint p

Finish(ComWrapper<ICamApiSpatialCurveBuilder>)

Commit accumulated knots and insert the curve into the geometry tree. After a successful call the builder is exhausted.

Declaration
public static ComWrapper<ICAMAPIGeometryTreeNode> Finish(this ComWrapper<ICamApiSpatialCurveBuilder> builderCom)
Parameters
Type Name Description
ComWrapper<ICamApiSpatialCurveBuilder> builderCom
Returns
Type Description
ComWrapper<ICAMAPIGeometryTreeNode>

TryAddKnot(ComWrapper<ICamApiSpatialCurveBuilder>, TST3DPoint, out TResultStatus)

Variant of AddKnot(ComWrapper<ICamApiSpatialCurveBuilder>, TST3DPoint) that returns the raw TResultStatus instead of throwing, for callers that want to inspect error codes directly.

Declaration
public static void TryAddKnot(this ComWrapper<ICamApiSpatialCurveBuilder> builderCom, TST3DPoint p, out TResultStatus status)
Parameters
Type Name Description
ComWrapper<ICamApiSpatialCurveBuilder> builderCom
TST3DPoint p
TResultStatus status

TryFinish(ComWrapper<ICamApiSpatialCurveBuilder>, out TResultStatus)

Variant of Finish(ComWrapper<ICamApiSpatialCurveBuilder>) that returns the raw TResultStatus instead of throwing, for callers that want to inspect error codes directly.

Declaration
public static ComWrapper<ICAMAPIGeometryTreeNode> TryFinish(this ComWrapper<ICamApiSpatialCurveBuilder> builderCom, out TResultStatus status)
Parameters
Type Name Description
ComWrapper<ICamApiSpatialCurveBuilder> builderCom
TResultStatus status
Returns
Type Description
ComWrapper<ICAMAPIGeometryTreeNode>