Interface ICamApiFeatureFinder

Feature finder — provides access to recognized features of the current project

Namespace: CAMAPI.FeatureFinder

Assembly: CAMAPI.FeatureFinder.dll

Syntax

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("4F2F777E-1125-47B7-BCD6-6A52383E8FEF")]
public interface ICamApiFeatureFinder

Properties

IsUpdating

True while feature recognition is running in background

Declaration

bool IsUpdating { get; }

Property Value

Type	Description
bool

RecognitionProgress

Current recognition progress (0..100). Read while IsUpdating = true.

Declaration

double RecognitionProgress { get; }

Property Value

Type	Description
double

UpdateStamp

Incremented each time the feature list changes

Declaration

int UpdateStamp { get; }

Property Value

Type	Description
int

Methods

CancelRecognition(out TResultStatus)

Declaration

void CancelRecognition(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

GetAllFeatures(bool, out TResultStatus)

Declaration

ICamApiFeatureList GetAllFeatures(bool IncludeDeleted, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
bool	IncludeDeleted
TResultStatus	ResultStatus

Returns

Type	Description
ICamApiFeatureList

GetFeatureById(string, out TResultStatus)

Declaration

ICamApiFeature GetFeatureById(string Id, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	Id
TResultStatus	ResultStatus

Returns

Type	Description
ICamApiFeature

GetFeatures(bool, out TResultStatus)

Declaration

ICamApiFeatureList GetFeatures(bool IncludeDeleted, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
bool	IncludeDeleted
TResultStatus	ResultStatus

Returns

Type	Description
ICamApiFeatureList

GetFeaturesByType(TCamApiFeatureType, out TResultStatus)

Declaration

ICamApiFeatureList GetFeaturesByType(TCamApiFeatureType FeatureType, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TCamApiFeatureType	FeatureType
TResultStatus	ResultStatus

Returns

Type	Description
ICamApiFeatureList

GetFeaturesForNode(string, bool, TST3DMatrix, out TResultStatus)

Declaration

ICamApiFeatureList GetFeaturesForNode(string NodeName, bool UseRefMatrix, TST3DMatrix RefMatrix, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	NodeName
bool	UseRefMatrix
TST3DMatrix	RefMatrix
TResultStatus	ResultStatus

Returns

Type	Description
ICamApiFeatureList

GetFeaturesForSelected(out TResultStatus)

Declaration

ICamApiFeatureList GetFeaturesForSelected(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

Returns

Type	Description
ICamApiFeatureList

GetSelectedFeatures(out TResultStatus)

Declaration

ICamApiFeatureList GetSelectedFeatures(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

Returns

Type	Description
ICamApiFeatureList

RunRecognition(bool, out TResultStatus)

Declaration

void RunRecognition(bool WaitForCompletion, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
bool	WaitForCompletion
TResultStatus	ResultStatus

SelectFeatureByBaseEntities(string, TCamApiFeatureType, out TResultStatus)

Declaration

bool SelectFeatureByBaseEntities(string BaseEntityNames, TCamApiFeatureType FeatureType, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	BaseEntityNames
TCamApiFeatureType	FeatureType
TResultStatus	ResultStatus

Returns

Type	Description
bool