CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface ICamApiFeature

    Base interface of a recognized feature

    Namespace: CAMAPI.FeatureFinder
    Assembly: CAMAPI.FeatureFinder.dll
    Syntax
    [Guid("F8727973-EF9C-4EAD-8D7C-0C062587BF5E")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface ICamApiFeature

    Properties

    BaseEntityCount

    Number of base geometry entities that make up this feature

    Declaration
    int BaseEntityCount { get; }
    Property Value
    Type Description
    int

    BaseEntityName[int]

    Declaration
    string BaseEntityName[int Index] { get; }
    Parameters
    Type Name Description
    int Index
    Property Value
    Type Description
    string

    Caption

    Display caption of the feature

    Declaration
    string Caption { get; }
    Property Value
    Type Description
    string

    FeatureType

    Type of the feature

    Declaration
    TCamApiFeatureType FeatureType { get; }
    Property Value
    Type Description
    TCamApiFeatureType

    Highlighted

    Transient highlight of the feature's base entities in the viewport (the standard FF preview state, distinct from Selected). Use for hover-preview: it does not change the actual selection, so it is not captured as a macro selection step.

    Declaration
    bool Highlighted { get; set; }
    Property Value
    Type Description
    bool

    Id

    Unique identifier of the feature

    Declaration
    string Id { get; }
    Property Value
    Type Description
    string

    IsMachined

    True if the feature is marked as machined

    Declaration
    bool IsMachined { get; }
    Property Value
    Type Description
    bool

    IsValid

    True if the feature is geometrically valid

    Declaration
    bool IsValid { get; }
    Property Value
    Type Description
    bool

    Lcs

    Local coordinate system of the feature (axis and position)

    Declaration
    TST3DMatrix Lcs { get; }
    Property Value
    Type Description
    TST3DMatrix

    Selected

    True if the feature is selected in the UI. Writable — set to highlight/unhighlight the feature and its base entities in the viewport.

    Declaration
    bool Selected { get; set; }
    Property Value
    Type Description
    bool

    Status

    Status of the feature

    Declaration
    TCamApiFeatureStatus Status { get; }
    Property Value
    Type Description
    TCamApiFeatureStatus

    SubFeature[int]

    Declaration
    ICamApiFeature SubFeature[int Index] { get; }
    Parameters
    Type Name Description
    int Index
    Property Value
    Type Description
    ICamApiFeature

    SubFeatureCount

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

    Declaration
    int SubFeatureCount { get; }
    Property Value
    Type Description
    int

    ZMax

    Maximum Z coordinate of the feature in its LCS

    Declaration
    double ZMax { get; }
    Property Value
    Type Description
    double

    ZMin

    Minimum Z coordinate of the feature in its LCS

    Declaration
    double ZMin { get; }
    Property Value
    Type Description
    double
    In this article