Class SketchHelper

Helper extensions for ICadApiSketch.

Inheritance

object

SketchHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CADAPI.DotnetHelper

Assembly: CADAPI.DotnetHelper.dll

Syntax

public static class SketchHelper

Methods

AddArc(ComWrapper<ICadApiSketch>, double, double, double, double, double, double, double, string)

Declaration

public static ComWrapper<ICadApiArc> AddArc(this ComWrapper<ICadApiSketch> sketchCom, double x1, double y1, double x2, double y2, double cx, double cy, double r, string id = "")

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	x1
double	y1
double	x2
double	y2
double	cx
double	cy
double	r
string	id

Returns

Type	Description
ComWrapper<ICadApiArc>

AddArcFromCenter(ComWrapper<ICadApiSketch>, double, double, double, double, double, string)

Arc from centre (cx, cy) with radius r, from startAngle to endAngle (degrees, CCW).

Declaration

public static ComWrapper<ICadApiArc> AddArcFromCenter(this ComWrapper<ICadApiSketch> sketchCom, double cx, double cy, double r, double startAngle, double endAngle, string id = "")

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	cx
double	cy
double	r
double	startAngle
double	endAngle
string	id

Returns

Type	Description
ComWrapper<ICadApiArc>

AddArcSlot(ComWrapper<ICadApiSketch>, double, double, double, double, double, double, double, double)

Circular (arc) slot. Guiding arc: (x1,y1)→(x2,y2), centre (cx,cy), radius arcR. Cap radius slotR = half slot width. Requires arcR > slotR.

Declaration

public static void AddArcSlot(this ComWrapper<ICadApiSketch> sketchCom, double x1, double y1, double x2, double y2, double cx, double cy, double arcR, double slotR)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	x1
double	y1
double	x2
double	y2
double	cx
double	cy
double	arcR
double	slotR

AddCircle(ComWrapper<ICadApiSketch>, double, double, double, string)

Declaration

public static ComWrapper<ICadApiArc> AddCircle(this ComWrapper<ICadApiSketch> sketchCom, double cx, double cy, double r, string id = "")

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	cx
double	cy
double	r
string	id

Returns

Type	Description
ComWrapper<ICadApiArc>

AddLine(ComWrapper<ICadApiSketch>, double, double, double, double, string)

Declaration

public static ComWrapper<ICadApiLine> AddLine(this ComWrapper<ICadApiSketch> sketchCom, double x1, double y1, double x2, double y2, string id = "")

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	x1
double	y1
double	x2
double	y2
string	id

Returns

Type	Description
ComWrapper<ICadApiLine>

AddPoint(ComWrapper<ICadApiSketch>, double, double, string)

Declaration

public static ComWrapper<ICadApiPoint> AddPoint(this ComWrapper<ICadApiSketch> sketchCom, double x, double y, string id = "")

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	x
double	y
string	id

Returns

Type	Description
ComWrapper<ICadApiPoint>

AddPolygon(ComWrapper<ICadApiSketch>, double, double, double, int)

Declaration

public static void AddPolygon(this ComWrapper<ICadApiSketch> sketchCom, double cx, double cy, double r, int sides)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	cx
double	cy
double	r
int	sides

AddRectangle(ComWrapper<ICadApiSketch>, double, double, double, double)

Axis-aligned rectangle with bottom-left corner at (x, y).

Declaration

public static void AddRectangle(this ComWrapper<ICadApiSketch> sketchCom, double x, double y, double width, double height)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	x
double	y
double	width
double	height

AddRectangleFromCenter(ComWrapper<ICadApiSketch>, double, double, double, double)

Axis-aligned rectangle centred at (cx, cy).

Declaration

public static void AddRectangleFromCenter(this ComWrapper<ICadApiSketch> sketchCom, double cx, double cy, double width, double height)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	cx
double	cy
double	width
double	height

AddSlot(ComWrapper<ICadApiSketch>, double, double, double, double, double)

Declaration

public static void AddSlot(this ComWrapper<ICadApiSketch> sketchCom, double x1, double y1, double x2, double y2, double r)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
double	x1
double	y1
double	x2
double	y2
double	r

Area(ComWrapper<ICadApiSketchFace>)

Signed planar area of the face in the sketch coordinate system.

Declaration

public static double Area(this ComWrapper<ICadApiSketchFace> faceCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketchFace>	faceCom

Returns

Type	Description
double

BaseZ(ComWrapper<ICadApiSketchFace>)

Z coordinate of the face within the sketch's local coordinate system. Zero for a face flat on the sketch plane; the sketch's world-space offset lives separately on the owning sketch.

Declaration

public static double BaseZ(this ComWrapper<ICadApiSketchFace> faceCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketchFace>	faceCom

Returns

Type	Description
double

Contour(ComWrapper<ICadApiSketch>, int)

Declaration

public static ComWrapper<ICadApiSketchContour> Contour(this ComWrapper<ICadApiSketch> sketchCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
int	index

Returns

Type	Description
ComWrapper<ICadApiSketchContour>

ContourCount(ComWrapper<ICadApiSketch>)

Declaration

public static int ContourCount(this ComWrapper<ICadApiSketch> sketchCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom

Returns

Type	Description
int

Contours(ComWrapper<ICadApiSketch>)

Declaration

public static IEnumerable<ComWrapper<ICadApiSketchContour>> Contours(this ComWrapper<ICadApiSketch> sketchCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom

Returns

Type	Description
IEnumerable<ComWrapper<ICadApiSketchContour>>

EnumerateSegments(ComWrapper<ICadApiSketchContour>)

Declaration

public static IEnumerable<ComWrapper<ICadApiSegment>> EnumerateSegments(this ComWrapper<ICadApiSketchContour> contourCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketchContour>	contourCom

Returns

Type	Description
IEnumerable<ComWrapper<ICadApiSegment>>

EnumerateSegments(ComWrapper<ICadApiSketchFace>)

Declaration

public static IEnumerable<ComWrapper<ICadApiSegment>> EnumerateSegments(this ComWrapper<ICadApiSketchFace> faceCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketchFace>	faceCom

Returns

Type	Description
IEnumerable<ComWrapper<ICadApiSegment>>

EnumerateSegments(ComWrapper<ICadApiSketch>)

Declaration

public static IEnumerable<ComWrapper<ICadApiSegment>> EnumerateSegments(this ComWrapper<ICadApiSketch> sketchCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom

Returns

Type	Description
IEnumerable<ComWrapper<ICadApiSegment>>

Face(ComWrapper<ICadApiSketch>, int)

Declaration

public static ComWrapper<ICadApiSketchFace> Face(this ComWrapper<ICadApiSketch> sketchCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
int	index

Returns

Type	Description
ComWrapper<ICadApiSketchFace>

FaceCount(ComWrapper<ICadApiSketch>)

Declaration

public static int FaceCount(this ComWrapper<ICadApiSketch> sketchCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom

Returns

Type	Description
int

Faces(ComWrapper<ICadApiSketch>)

Declaration

public static IEnumerable<ComWrapper<ICadApiSketchFace>> Faces(this ComWrapper<ICadApiSketch> sketchCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom

Returns

Type	Description
IEnumerable<ComWrapper<ICadApiSketchFace>>

Segment(ComWrapper<ICadApiSketchContour>, int)

Declaration

public static ComWrapper<ICadApiSegment> Segment(this ComWrapper<ICadApiSketchContour> contourCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketchContour>	contourCom
int	index

Returns

Type	Description
ComWrapper<ICadApiSegment>

Segment(ComWrapper<ICadApiSketchFace>, int)

Declaration

public static ComWrapper<ICadApiSegment> Segment(this ComWrapper<ICadApiSketchFace> faceCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketchFace>	faceCom
int	index

Returns

Type	Description
ComWrapper<ICadApiSegment>

Segment(ComWrapper<ICadApiSketch>, int)

Declaration

public static ComWrapper<ICadApiSegment> Segment(this ComWrapper<ICadApiSketch> sketchCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom
int	index

Returns

Type	Description
ComWrapper<ICadApiSegment>

SegmentCount(ComWrapper<ICadApiSketch>)

Declaration

public static int SegmentCount(this ComWrapper<ICadApiSketch> sketchCom)

Parameters

Type	Name	Description
ComWrapper<ICadApiSketch>	sketchCom

Returns

Type	Description
int