Class GeometryModelSketcherHelper

Helper methods for ICamApiGeometryModelSketcher

Inheritance

object

GeometryModelSketcherHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class GeometryModelSketcherHelper

Methods

AddLine(ComWrapper<ICamApiGeometryModelSketcher>, TST3DPoint, TST3DPoint)

Create a line segment in the Job geometry sub-tree

Declaration

public static ComWrapper<ICAMAPIGeometryTreeNode> AddLine(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, TST3DPoint p1, TST3DPoint p2)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
TST3DPoint	p1
TST3DPoint	p2

Returns

Type	Description
ComWrapper<ICAMAPIGeometryTreeNode>

AddLine(ComWrapper<ICamApiGeometryModelSketcher>, TST3DPoint, TST3DPoint, ComWrapper<ICamApiCoordinateSystem>)

Create a line segment whose endpoints are given in the csCom coordinate system.

Declaration

public static ComWrapper<ICAMAPIGeometryTreeNode> AddLine(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, TST3DPoint p1, TST3DPoint p2, ComWrapper<ICamApiCoordinateSystem> csCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
TST3DPoint	p1
TST3DPoint	p2
ComWrapper<ICamApiCoordinateSystem>	csCom

Returns

Type	Description
ComWrapper<ICAMAPIGeometryTreeNode>

AddLine(ComWrapper<ICamApiGeometryModelSketcher>, TST3DPoint, TST3DPoint, TST3DMatrix)

Create a line segment whose endpoints are given in lcs.

Declaration

public static ComWrapper<ICAMAPIGeometryTreeNode> AddLine(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, TST3DPoint p1, TST3DPoint p2, TST3DMatrix lcs)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
TST3DPoint	p1
TST3DPoint	p2
TST3DMatrix	lcs

Returns

Type	Description
ComWrapper<ICAMAPIGeometryTreeNode>

AddNormalLine(ComWrapper<ICamApiGeometryModelSketcher>, TST3DPoint, TST3DPoint)

Create a "normal line" (anchored at origin, ending at endPoint) in the Job geometry sub-tree

Declaration

public static ComWrapper<ICAMAPIGeometryTreeNode> AddNormalLine(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, TST3DPoint origin, TST3DPoint endPoint)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
TST3DPoint	origin
TST3DPoint	endPoint

Returns

Type	Description
ComWrapper<ICAMAPIGeometryTreeNode>

AddNormalLine(ComWrapper<ICamApiGeometryModelSketcher>, TST3DPoint, TST3DPoint, ComWrapper<ICamApiCoordinateSystem>)

Create a "normal line" whose points are given in the csCom coordinate system.

Declaration

public static ComWrapper<ICAMAPIGeometryTreeNode> AddNormalLine(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, TST3DPoint origin, TST3DPoint endPoint, ComWrapper<ICamApiCoordinateSystem> csCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
TST3DPoint	origin
TST3DPoint	endPoint
ComWrapper<ICamApiCoordinateSystem>	csCom

Returns

Type	Description
ComWrapper<ICAMAPIGeometryTreeNode>

AddNormalLine(ComWrapper<ICamApiGeometryModelSketcher>, TST3DPoint, TST3DPoint, TST3DMatrix)

Create a "normal line" whose points are given in lcs.

Declaration

public static ComWrapper<ICAMAPIGeometryTreeNode> AddNormalLine(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, TST3DPoint origin, TST3DPoint endPoint, TST3DMatrix lcs)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
TST3DPoint	origin
TST3DPoint	endPoint
TST3DMatrix	lcs

Returns

Type	Description
ComWrapper<ICAMAPIGeometryTreeNode>

AddPoint(ComWrapper<ICamApiGeometryModelSketcher>, double, double, double)

Create a point in the Job geometry sub-tree

Declaration

public static ComWrapper<ICAMAPIGeometryTreeNode> AddPoint(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, double x, double y, double z)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
double	x
double	y
double	z

Returns

Type	Description
ComWrapper<ICAMAPIGeometryTreeNode>

AddPoint(ComWrapper<ICamApiGeometryModelSketcher>, double, double, double, ComWrapper<ICamApiCoordinateSystem>)

Create a point whose coordinates are given in the csCom coordinate system.

Declaration

public static ComWrapper<ICAMAPIGeometryTreeNode> AddPoint(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, double x, double y, double z, ComWrapper<ICamApiCoordinateSystem> csCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
double	x
double	y
double	z
ComWrapper<ICamApiCoordinateSystem>	csCom

Returns

Type	Description
ComWrapper<ICAMAPIGeometryTreeNode>

AddPoint(ComWrapper<ICamApiGeometryModelSketcher>, double, double, double, TST3DMatrix)

Create a point whose coordinates are given in lcs.

Declaration

public static ComWrapper<ICAMAPIGeometryTreeNode> AddPoint(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, double x, double y, double z, TST3DMatrix lcs)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
double	x
double	y
double	z
TST3DMatrix	lcs

Returns

Type	Description
ComWrapper<ICAMAPIGeometryTreeNode>

GetTargetCS(ComWrapper<ICamApiGeometryModelSketcher>)

Coordinate system that plain AddPoint / AddLine / AddNormalLine / StartPolyline / StartSpline interpret their coordinates in. Identity by default (coordinates are Global).

Declaration

public static TST3DMatrix GetTargetCS(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom

Returns

Type	Description
TST3DMatrix

SetTargetCS(ComWrapper<ICamApiGeometryModelSketcher>, ComWrapper<ICamApiCoordinateSystem>)

Set the target coordinate system from a coordinate-system object; all subsequent plain AddPoint / AddLine / ... place geometry in it.

Declaration

public static void SetTargetCS(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, ComWrapper<ICamApiCoordinateSystem> csCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
ComWrapper<ICamApiCoordinateSystem>	csCom

SetTargetCS(ComWrapper<ICamApiGeometryModelSketcher>, TST3DMatrix)

Set the coordinate system that plain AddPoint / AddLine / ... interpret their coordinates in, as a raw world matrix.

Declaration

public static void SetTargetCS(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, TST3DMatrix targetCs)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
TST3DMatrix	targetCs

StartPolyline(ComWrapper<ICamApiGeometryModelSketcher>)

Begin building a polyline. Append knots on the returned builder then call Finish(ComWrapper<ICamApiSpatialCurveBuilder>) to commit.

Declaration

public static ComWrapper<ICamApiSpatialCurveBuilder> StartPolyline(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom

Returns

Type	Description
ComWrapper<ICamApiSpatialCurveBuilder>

StartPolyline(ComWrapper<ICamApiGeometryModelSketcher>, ComWrapper<ICamApiCoordinateSystem>)

Begin building a polyline whose knots are given in the csCom coordinate system.

Declaration

public static ComWrapper<ICamApiSpatialCurveBuilder> StartPolyline(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, ComWrapper<ICamApiCoordinateSystem> csCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
ComWrapper<ICamApiCoordinateSystem>	csCom

Returns

Type	Description
ComWrapper<ICamApiSpatialCurveBuilder>

StartPolyline(ComWrapper<ICamApiGeometryModelSketcher>, TST3DMatrix)

Begin building a polyline whose knots are given in lcs.

Declaration

public static ComWrapper<ICamApiSpatialCurveBuilder> StartPolyline(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, TST3DMatrix lcs)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
TST3DMatrix	lcs

Returns

Type	Description
ComWrapper<ICamApiSpatialCurveBuilder>

StartSpline(ComWrapper<ICamApiGeometryModelSketcher>)

Begin building a smooth spline. Append knots on the returned builder then call Finish(ComWrapper<ICamApiSpatialCurveBuilder>) to commit.

Declaration

public static ComWrapper<ICamApiSpatialCurveBuilder> StartSpline(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom

Returns

Type	Description
ComWrapper<ICamApiSpatialCurveBuilder>

StartSpline(ComWrapper<ICamApiGeometryModelSketcher>, ComWrapper<ICamApiCoordinateSystem>)

Begin building a smooth spline whose knots are given in the csCom coordinate system.

Declaration

public static ComWrapper<ICamApiSpatialCurveBuilder> StartSpline(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, ComWrapper<ICamApiCoordinateSystem> csCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
ComWrapper<ICamApiCoordinateSystem>	csCom

Returns

Type	Description
ComWrapper<ICamApiSpatialCurveBuilder>

StartSpline(ComWrapper<ICamApiGeometryModelSketcher>, TST3DMatrix)

Begin building a smooth spline whose knots are given in lcs.

Declaration

public static ComWrapper<ICamApiSpatialCurveBuilder> StartSpline(this ComWrapper<ICamApiGeometryModelSketcher> sketcherCom, TST3DMatrix lcs)

Parameters

Type	Name	Description
ComWrapper<ICamApiGeometryModelSketcher>	sketcherCom
TST3DMatrix	lcs

Returns

Type	Description
ComWrapper<ICamApiSpatialCurveBuilder>