Class FeatureHelper

Helper methods for ICamApiFeature and its specialised sub-interfaces. Use AsHoleFeature, AsPocketFeature, etc. to obtain a typed wrapper via QueryInterface.

Inheritance

object

FeatureHelper

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 FeatureHelper

Methods

AsChamferFeature(ComWrapper<ICamApiFeature>)

Returns the feature as ICamApiChamferFeature. Check .IsNull if not a chamfer.

Declaration

public static ComWrapper<ICamApiChamferFeature> AsChamferFeature(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
ComWrapper<ICamApiChamferFeature>

AsComplexHoleFeature(ComWrapper<ICamApiFeature>)

Returns the feature as ICamApiComplexHoleFeature. Check .IsNull if not a complex hole.

Declaration

public static ComWrapper<ICamApiComplexHoleFeature> AsComplexHoleFeature(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
ComWrapper<ICamApiComplexHoleFeature>

AsEdgeFeature(ComWrapper<ICamApiFeature>)

Returns the feature as ICamApiEdgeFeature. Check .IsNull if not a loop/edge feature.

Declaration

public static ComWrapper<ICamApiEdgeFeature> AsEdgeFeature(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
ComWrapper<ICamApiEdgeFeature>

AsFilletFeature(ComWrapper<ICamApiFeature>)

Returns the feature as ICamApiFilletFeature. Check .IsNull if not a fillet.

Declaration

public static ComWrapper<ICamApiFilletFeature> AsFilletFeature(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
ComWrapper<ICamApiFilletFeature>

AsHoleFeature(ComWrapper<ICamApiFeature>)

Returns the feature as ICamApiHoleFeature. Check .IsNull if not a hole.

Declaration

public static ComWrapper<ICamApiHoleFeature> AsHoleFeature(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
ComWrapper<ICamApiHoleFeature>

AsPlaneFeature(ComWrapper<ICamApiFeature>)

Returns the feature as ICamApiPlaneFeature. Check .IsNull if not a plane.

Declaration

public static ComWrapper<ICamApiPlaneFeature> AsPlaneFeature(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
ComWrapper<ICamApiPlaneFeature>

AsPocketFeature(ComWrapper<ICamApiFeature>)

Returns the feature as ICamApiPocketFeature. Check .IsNull if not a pocket/boss/side.

Declaration

public static ComWrapper<ICamApiPocketFeature> AsPocketFeature(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
ComWrapper<ICamApiPocketFeature>

AsTangentEdgeFeature(ComWrapper<ICamApiFeature>)

Returns the feature as ICamApiTangentEdgeFeature. Check .IsNull if not a tangent edge.

Declaration

public static ComWrapper<ICamApiTangentEdgeFeature> AsTangentEdgeFeature(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
ComWrapper<ICamApiTangentEdgeFeature>

BaseEntityCount(ComWrapper<ICamApiFeature>)

Number of base geometry entities that make up this feature.

Declaration

public static int BaseEntityCount(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
int

BaseEntityName(ComWrapper<ICamApiFeature>, int)

Display name of a base geometry entity (0..BaseEntityCount-1).

Declaration

public static string BaseEntityName(this ComWrapper<ICamApiFeature> featureCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom
int	index

Returns

Type	Description
string

BaseEntityNames(ComWrapper<ICamApiFeature>)

All base entity names for this feature.

Declaration

public static IReadOnlyList<string> BaseEntityNames(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
IReadOnlyList<string>

Caption(ComWrapper<ICamApiFeature>)

Display caption of the feature.

Declaration

public static string Caption(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
string

FeatureType(ComWrapper<ICamApiFeature>)

Type of the feature.

Declaration

public static TCamApiFeatureType FeatureType(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
TCamApiFeatureType

GetSubFeature(ComWrapper<ICamApiFeature>, int)

Sub-feature by index (0..SubFeatureCount-1).

Declaration

public static ComWrapper<ICamApiFeature> GetSubFeature(this ComWrapper<ICamApiFeature> featureCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom
int	index

Returns

Type	Description
ComWrapper<ICamApiFeature>

Id(ComWrapper<ICamApiFeature>)

Unique identifier of the feature.

Declaration

public static string Id(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
string

IsMachined(ComWrapper<ICamApiFeature>)

True if the feature is marked as machined.

Declaration

public static bool IsMachined(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
bool

IsValid(ComWrapper<ICamApiFeature>)

True if the feature is geometrically valid.

Declaration

public static bool IsValid(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
bool

Lcs(ComWrapper<ICamApiFeature>)

Local coordinate system of the feature (axis and position).

Declaration

public static TST3DMatrix Lcs(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
TST3DMatrix

Selected(ComWrapper<ICamApiFeature>)

True if the feature is selected in the UI.

Declaration

public static bool Selected(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
bool

SetSelected(ComWrapper<ICamApiFeature>, bool)

Select or deselect the feature. Selecting highlights the feature and its base geometry entities in the viewport.

Declaration

public static void SetSelected(this ComWrapper<ICamApiFeature> featureCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom
bool	value

Status(ComWrapper<ICamApiFeature>)

Status of the feature.

Declaration

public static TCamApiFeatureStatus Status(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
TCamApiFeatureStatus

SubFeatureCount(ComWrapper<ICamApiFeature>)

Number of sub-features (e.g. steps in a complex hole).

Declaration

public static int SubFeatureCount(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
int

ZMax(ComWrapper<ICamApiFeature>)

Maximum Z coordinate of the feature in its LCS.

Declaration

public static double ZMax(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
double

ZMin(ComWrapper<ICamApiFeature>)

Minimum Z coordinate of the feature in its LCS.

Declaration

public static double ZMin(this ComWrapper<ICamApiFeature> featureCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeature>	featureCom

Returns

Type	Description
double