Interface PmiController

PMI (Product Manufacturing Information) controller is a global object accessible via OccViewer.pmi, responsible for managing various PMI presentations (dimensions, text annotations, etc.).

See also OccViewer.TextLabel and OccViewer.LengthDimension for object-oriented interface to PMI functionality.

interface PmiController {
    addLengthDimension(
        theParams: LengthDimensionParams,
        theToUpdate: boolean,
    ): string;
    addTextLabel(theParams: LabelParams, theToUpdate: boolean): string;
    editLengthDimension(
        theParams: LengthDimensionParams,
        theToUpdate: boolean,
    ): void;
    editTextLabel(theParams: LabelParams, theToUpdate: boolean): void;
    lengthDimensionParams(theId: string): LengthDimensionParams;
    textLabelParams(theId: string): LabelParams;
}

Methods

addLengthDimension addTextLabel editLengthDimension editTextLabel lengthDimensionParams textLabelParams

Methods

addLengthDimension

  • addLengthDimension(
        theParams: LengthDimensionParams,
        theToUpdate: boolean,
    ): string

  • Add line dimension (similar to corresponding C++ presentation class PrsDim_LengthDimension defined by OCCT).

    Parameters

    Returns string

    id of created object

addTextLabel

  • addTextLabel(theParams: LabelParams, theToUpdate: boolean): string

  • Add text label (similar to corresponding C++ presentation class AIS_TextLabel defined by OCCT).

    Parameters

    • theParams: LabelParams

      label parameters

    • theToUpdate: boolean

      update view

    Returns string

    id of created object

editLengthDimension

  • editLengthDimension(
        theParams: LengthDimensionParams,
        theToUpdate: boolean,
    ): void

  • Edit line dimension parameters.

    Parameters

    Returns void

editTextLabel

  • editTextLabel(theParams: LabelParams, theToUpdate: boolean): void

  • Edit text Label

    Parameters

    • theParams: LabelParams

      label parameters

    • theToUpdate: boolean

      update view

    Returns void

lengthDimensionParams

textLabelParams

  • textLabelParams(theId: string): LabelParams

  • Get text label parameters by its id

    Parameters

    • theId: string

      id of object

    Returns LabelParams

    label parameters

Settings

Member Visibility

On This Page

Methods