Class FeatureFinderHelper

Helper methods for ICamApiFeatureFinder

Inheritance

object

FeatureFinderHelper

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 FeatureFinderHelper

Methods

GetAllFeatures(ComWrapper<ICamApiFeatureFinder>, bool)

Features across all setups of the entire model.

Declaration

public static ComWrapper<ICamApiFeatureList> GetAllFeatures(this ComWrapper<ICamApiFeatureFinder> featureFinderCom, bool includeDeleted = false)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom	Feature finder
bool	includeDeleted	When true, includes features with status cafsDeleted

Returns

Type	Description
ComWrapper<ICamApiFeatureList>

GetFeatureById(ComWrapper<ICamApiFeatureFinder>, string)

Find a feature by its unique identifier. Returns null if not found.

Declaration

public static ComWrapper<ICamApiFeature>? GetFeatureById(this ComWrapper<ICamApiFeatureFinder> featureFinderCom, string id)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom
string	id

Returns

Type	Description
ComWrapper<ICamApiFeature>

GetFeatures(ComWrapper<ICamApiFeatureFinder>, bool)

Features of the current part setup.

Declaration

public static ComWrapper<ICamApiFeatureList> GetFeatures(this ComWrapper<ICamApiFeatureFinder> featureFinderCom, bool includeDeleted = false)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom	Feature finder
bool	includeDeleted	When true, includes features with status cafsDeleted

Returns

Type	Description
ComWrapper<ICamApiFeatureList>

GetFeaturesForNode(ComWrapper<ICamApiFeatureFinder>, string, bool, TST3DMatrix)

Recognize features for a specific geometry tree node by its full name. nodeName = ICAMAPIGeometryTreeNode.NodeFullName.

Declaration

public static ComWrapper<ICamApiFeatureList> GetFeaturesForNode(this ComWrapper<ICamApiFeatureFinder> featureFinderCom, string nodeName, bool useRefMatrix = false, TST3DMatrix refMatrix = default)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom
string	nodeName
bool	useRefMatrix
TST3DMatrix	refMatrix

Returns

Type	Description
ComWrapper<ICamApiFeatureList>

GetFeaturesForSelected(ComWrapper<ICamApiFeatureFinder>)

Recognize candidate features for the currently selected geometry tree nodes.

Declaration

public static ComWrapper<ICamApiFeatureList> GetFeaturesForSelected(this ComWrapper<ICamApiFeatureFinder> featureFinderCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom

Returns

Type	Description
ComWrapper<ICamApiFeatureList>

GetSelectedFeatures(ComWrapper<ICamApiFeatureFinder>)

Currently selected features

Declaration

public static ComWrapper<ICamApiFeatureList> GetSelectedFeatures(this ComWrapper<ICamApiFeatureFinder> featureFinderCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom

Returns

Type	Description
ComWrapper<ICamApiFeatureList>

IsUpdating(ComWrapper<ICamApiFeatureFinder>)

True while feature recognition is running in background

Declaration

public static bool IsUpdating(this ComWrapper<ICamApiFeatureFinder> featureFinderCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom

Returns

Type	Description
bool

RecognitionProgress(ComWrapper<ICamApiFeatureFinder>)

Current recognition progress (0..100)

Declaration

public static double RecognitionProgress(this ComWrapper<ICamApiFeatureFinder> featureFinderCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom

Returns

Type	Description
double

RunRecognition(ComWrapper<ICamApiFeatureFinder>, bool)

Start feature recognition. waitForCompletion = false: starts in background, subscribe to FeatureFinderUpdated for completion. waitForCompletion = true: blocks until recognition finishes.

Declaration

public static void RunRecognition(this ComWrapper<ICamApiFeatureFinder> featureFinderCom, bool waitForCompletion = false)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom
bool	waitForCompletion

SelectFeatureByBaseEntities(ComWrapper<ICamApiFeatureFinder>, string, int)

Select, in the geometry model, the base entities of the recognized feature whose base-entity names cover baseEntityNames (newline-separated) and whose type equals featureType. Mirrors the recognize-menu pick so a following CreateOperation consumes them into its Job Assignment. Returns false if no feature matched.

Declaration

public static bool SelectFeatureByBaseEntities(this ComWrapper<ICamApiFeatureFinder> featureFinderCom, string baseEntityNames, int featureType)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom
string	baseEntityNames
int	featureType

Returns

Type	Description
bool

UpdateStamp(ComWrapper<ICamApiFeatureFinder>)

Incremented each time the feature list changes

Declaration

public static int UpdateStamp(this ComWrapper<ICamApiFeatureFinder> featureFinderCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiFeatureFinder>	featureFinderCom

Returns

Type	Description
int