MotorXP-PM Scripting API
    Preparing search index...

    Interface ShaftElement

    Shaft element (motor.shaft, ShaftObject)

    interface ShaftElement {
        createGeometryFinished: SignalConnector;
        createGeometryStarted: SignalConnector<string>;
        geometryChanged: SignalConnector;
        geometryCleared: SignalConnector;
        innerDiameter: number;
        innerDiameterChanged: SignalConnector<number>;
        innerRadius: number;
        numberPeriodicities: number;
        numberPeriodicitiesChanged: SignalConnector<number>;
        outerDiameter: number;
        outerDiameterChanged: SignalConnector<number>;
        outerRadius: number;
        partChanged: SignalConnector;
        partPointsChanged: SignalConnector;
        partPointsCleared: SignalConnector;
        periodicitiesList: number[];
        periodicitiesListChanged: SignalConnector<number[]>;
        piecesCleared: SignalConnector;
        script: string;
        scriptChanged: SignalConnector<string>;
        scriptEngineErrorChanged: SignalConnector<string>;
        scriptEngineWarningChanged: SignalConnector<string>;
        scriptLoaded: SignalConnector;
        shaftChanged: SignalConnector;
        appendError(text: string, separator?: string): void;
        appendWarning(text: string, separator?: string): void;
        error(): string;
        setError(text: string): void;
        setWarning(text: string): void;
        warning(): string;
    }

    Hierarchy (View Summary)

    Index

    Methods

    appendError appendWarning error setError setWarning warning

    Properties

    createGeometryFinished createGeometryStarted geometryChanged geometryCleared innerDiameter innerDiameterChanged innerRadius numberPeriodicities numberPeriodicitiesChanged outerDiameter outerDiameterChanged outerRadius partChanged partPointsChanged partPointsCleared periodicitiesList periodicitiesListChanged piecesCleared script scriptChanged scriptEngineErrorChanged scriptEngineWarningChanged scriptLoaded shaftChanged

    Methods

    • Appends a script-defined geometry error for display in the scene.

      Parameters

      • text: string

        Error text.

      • Optionalseparator: string

        Separator inserted before the error text.

      Returns void

    • Appends a script-defined geometry warning for display in the scene.

      Parameters

      • text: string

        Warning text.

      • Optionalseparator: string

        Separator inserted before the warning text.

      Returns void

    • Current script-defined geometry error.

      Returns string

      Error text.

    • Sets a script-defined geometry error for display in the scene.

      Parameters

      • text: string

        Error text.

      Returns void

    • Sets a script-defined geometry warning for display in the scene.

      Parameters

      • text: string

        Warning text.

      Returns void

    • Current script-defined geometry warning.

      Returns string

      Warning text.

    Properties

    createGeometryFinished: SignalConnector

    Signal emitted when geometry creation finishes.

    createGeometryStarted: SignalConnector<string>

    Signal emitted when geometry creation starts.

    geometryChanged: SignalConnector

    Signal emitted when the 2D geometry changes.

    geometryCleared: SignalConnector

    Signal emitted when the 2D geometry is cleared.

    innerDiameter: number

    Inner diameter.

    innerDiameterChanged: SignalConnector<number>

    Signal emitted when the inner diameter changes.

    innerRadius: number

    Inner radius.

    numberPeriodicities: number

    Number of periodicities.

    numberPeriodicitiesChanged: SignalConnector<number>

    Signal emitted when the number of periodicities changes.

    outerDiameter: number

    Outer diameter.

    outerDiameterChanged: SignalConnector<number>

    Signal emitted when the outer diameter changes.

    outerRadius: number

    Outer radius.

    partChanged: SignalConnector

    Signal emitted when parts change.

    partPointsChanged: SignalConnector

    Signal emitted when the part points change.

    partPointsCleared: SignalConnector

    Signal emitted when the part points are cleared.

    periodicitiesList: number[]

    Allowed numbers of periodicities.

    periodicitiesListChanged: SignalConnector<number[]>

    Signal emitted when the list of periodicities changes.

    piecesCleared: SignalConnector

    Signal emitted when 3D pieces are cleared while the 2D geometry is kept.

    script: string

    File name of the element script.

    scriptChanged: SignalConnector<string>

    Signal emitted when the script changes.

    scriptEngineErrorChanged: SignalConnector<string>

    Signal emitted when the script engine error text changes.

    scriptEngineWarningChanged: SignalConnector<string>

    Signal emitted when the script engine warning text changes.

    scriptLoaded: SignalConnector

    Signal emitted when the script is loaded.

    shaftChanged: SignalConnector

    Signal emitted when the shaft changes.

    Settings

    Member Visibility

    On This Page

    Methods
    Properties