Class CadApiModelHelper

Helper extensions for ICadIpcModel.

Inheritance

object

CadApiModelHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CADIPC.DotnetHelper

Assembly: CADIPC.DotnetHelper.dll

Syntax

public static class CadApiModelHelper

Methods

AddChamfer(ComWrapper<ICadIpcModel>, IListString, double)

Append a chamfer on the given topology edge ids (obtained from EdgeId(ComWrapper<ICadIpcBody>, int)). Body geometry materialises on the next Save.

Declaration

public static ComWrapper<ICadIpcChamferFeature> AddChamfer(this ComWrapper<ICadIpcModel> modelCom, IListString edgeIds, double size)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom
IListString	edgeIds
double	size

Returns

Type	Description
ComWrapper<ICadIpcChamferFeature>

AddDraft(ComWrapper<ICadIpcModel>, IListString, double)

Append a draft on the given topology face ids (obtained from FaceId(ComWrapper<ICadIpcBody>, int)). Body geometry materialises on the next Save.

Declaration

public static ComWrapper<ICadIpcDraftFeature> AddDraft(this ComWrapper<ICadIpcModel> modelCom, IListString faceIds, double angle)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom
IListString	faceIds
double	angle

Returns

Type	Description
ComWrapper<ICadIpcDraftFeature>

AddExtrude(ComWrapper<ICadIpcModel>, ComWrapper<ICadIpcSketchFace>, double)

Append an extrude feature on the given sketch face with signed depth. Body geometry materialises on the next Save.

Declaration

public static ComWrapper<ICadIpcExtrudeFeature> AddExtrude(this ComWrapper<ICadIpcModel> modelCom, ComWrapper<ICadIpcSketchFace> faceCom, double depth)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom
ComWrapper<ICadIpcSketchFace>	faceCom
double	depth

Returns

Type	Description
ComWrapper<ICadIpcExtrudeFeature>

AddFillet(ComWrapper<ICadIpcModel>, IListString, double)

Append a fillet on the given topology edge ids (obtained from EdgeId(ComWrapper<ICadIpcBody>, int)). Body geometry materialises on the next Save.

Declaration

public static ComWrapper<ICadIpcFilletFeature> AddFillet(this ComWrapper<ICadIpcModel> modelCom, IListString edgeIds, double radius)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom
IListString	edgeIds
double	radius

Returns

Type	Description
ComWrapper<ICadIpcFilletFeature>

AddRevolve(ComWrapper<ICadIpcModel>, ComWrapper<ICadIpcSketchFace>, double, double, double, double, double, double, double)

Append a revolve feature: rotate the given sketch face around the axis that passes through (axisX, axisY, axisZ) with direction (dirX, dirY, dirZ) by angle degrees. The direction must not be a zero vector. Body geometry materialises on the next Save.

Declaration

public static ComWrapper<ICadIpcRevolveFeature> AddRevolve(this ComWrapper<ICadIpcModel> modelCom, ComWrapper<ICadIpcSketchFace> faceCom, double axisX, double axisY, double axisZ, double dirX, double dirY, double dirZ, double angle)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom
ComWrapper<ICadIpcSketchFace>	faceCom
double	axisX
double	axisY
double	axisZ
double	dirX
double	dirY
double	dirZ
double	angle

Returns

Type	Description
ComWrapper<ICadIpcRevolveFeature>

AddSketch(ComWrapper<ICadIpcModel>, int, double)

Add a 2D sketch on one of the orthogonal coordinate planes via IPC. normalAxis: 1 = YZ plane, 2 = XZ plane, 3 = XY plane. offset shifts the plane along the chosen axis. Draw with AddLine / AddRectangle on the returned sketch, then call Save(ComWrapper<ICadIpcModel>) to publish changes as child tree nodes.

Declaration

public static ComWrapper<ICadIpcSketch> AddSketch(this ComWrapper<ICadIpcModel> modelCom, int normalAxis, double offset)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom
int	normalAxis
double	offset

Returns

Type	Description
ComWrapper<ICadIpcSketch>

Bodies(ComWrapper<ICadIpcModel>)

Enumerate bodies. Dispose each returned wrapper.

Declaration

public static IEnumerable<ComWrapper<ICadIpcBody>> Bodies(this ComWrapper<ICadIpcModel> modelCom)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom

Returns

Type	Description
IEnumerable<ComWrapper<ICadIpcBody>>

Body(ComWrapper<ICadIpcModel>, int)

Return the body at the given zero-based index.

Declaration

public static ComWrapper<ICadIpcBody> Body(this ComWrapper<ICadIpcModel> modelCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom
int	index

Returns

Type	Description
ComWrapper<ICadIpcBody>

BodyCount(ComWrapper<ICadIpcModel>)

Number of bodies (parts) in this CAD model.

Declaration

public static int BodyCount(this ComWrapper<ICadIpcModel> modelCom)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom

Returns

Type	Description
int

Feature(ComWrapper<ICadIpcModel>, int)

Return the feature at the given zero-based index.

Declaration

public static ComWrapper<ICadIpcFeature> Feature(this ComWrapper<ICadIpcModel> modelCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom
int	index

Returns

Type	Description
ComWrapper<ICadIpcFeature>

FeatureCount(ComWrapper<ICadIpcModel>)

Number of features in this CAD model's construction tree.

Declaration

public static int FeatureCount(this ComWrapper<ICadIpcModel> modelCom)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom

Returns

Type	Description
int

Features(ComWrapper<ICadIpcModel>)

Enumerate features. Dispose each returned wrapper.

Declaration

public static IEnumerable<ComWrapper<ICadIpcFeature>> Features(this ComWrapper<ICadIpcModel> modelCom)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom

Returns

Type	Description
IEnumerable<ComWrapper<ICadIpcFeature>>

Save(ComWrapper<ICadIpcModel>)

Publish in-memory CAD changes as child tree nodes of the host CAD group. Equivalent to "save sketch + exit CAD" in the GUI.

Declaration

public static void Save(this ComWrapper<ICadIpcModel> modelCom)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom

Sketch(ComWrapper<ICadIpcModel>, int)

Return an existing sketch at the given zero-based index.

Declaration

public static ComWrapper<ICadIpcSketch> Sketch(this ComWrapper<ICadIpcModel> modelCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom
int	index

Returns

Type	Description
ComWrapper<ICadIpcSketch>

SketchCount(ComWrapper<ICadIpcModel>)

Number of sketches in this CAD model.

Declaration

public static int SketchCount(this ComWrapper<ICadIpcModel> modelCom)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom

Returns

Type	Description
int

Sketches(ComWrapper<ICadIpcModel>)

Enumerate existing sketches in index order. The caller must dispose each returned wrapper. Keep the model alive and do not change the sketch collection during enumeration.

Declaration

public static IEnumerable<ComWrapper<ICadIpcSketch>> Sketches(this ComWrapper<ICadIpcModel> modelCom)

Parameters

Type	Name	Description
ComWrapper<ICadIpcModel>	modelCom

Returns

Type	Description
IEnumerable<ComWrapper<ICadIpcSketch>>