MotorXP-PM Scripting API
    Preparing search index...

    Interface RotorElement

    Rotor element (motor.rotor, RotorObject)

    interface RotorElement {
        axialSkew: number;
        axialSkewChanged: SignalConnector<number>;
        createGeometryFinished: SignalConnector;
        createGeometryStarted: SignalConnector<string>;
        geometryChanged: SignalConnector;
        geometryCleared: SignalConnector;
        innerDiameter: number;
        innerDiameterChanged: SignalConnector<number>;
        innerRadius: number;
        numberPolePairs: number;
        numberPolePairsChanged: SignalConnector<number>;
        outerDiameter: number;
        outerDiameterChanged: SignalConnector<number>;
        outerRadius: number;
        partChanged: SignalConnector;
        partPointsChanged: SignalConnector;
        partPointsCleared: SignalConnector;
        piecesCleared: SignalConnector;
        properties: { [name: string]: any };
        rotorChanged: SignalConnector;
        script: string;
        scriptChanged: SignalConnector<string>;
        scriptEngineErrorChanged: SignalConnector<string>;
        scriptEngineWarningChanged: SignalConnector<string>;
        scriptLoaded: SignalConnector;
        appendError(text: string, separator?: string): void;
        appendWarning(text: string, separator?: string): void;
        changeProperty(propName: string, value: any): boolean;
        error(): string;
        rebuildGeometry(): void;
        setError(text: string): void;
        setWarning(text: string): void;
        warning(): string;
    }

    Hierarchy (View Summary)

    Index

    Methods

    appendError appendWarning changeProperty error rebuildGeometry setError setWarning warning

    Properties

    axialSkew axialSkewChanged createGeometryFinished createGeometryStarted geometryChanged geometryCleared innerDiameter innerDiameterChanged innerRadius numberPolePairs numberPolePairsChanged outerDiameter outerDiameterChanged outerRadius partChanged partPointsChanged partPointsCleared piecesCleared properties rotorChanged script scriptChanged scriptEngineErrorChanged scriptEngineWarningChanged scriptLoaded

    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

    • Changes a property value. The change can be undone with the Undo command in the GUI.

      Parameters

      • propName: string

        Property name.

      • value: any

        Property value.

      Returns boolean

      True on success.

    • Current script-defined geometry error.

      Returns string

      Error text.

    • Rebuilds the rotor geometry.

      Returns void

    • 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

    axialSkew: number

    Axial skew.

    axialSkewChanged: SignalConnector<number>

    Signal emitted when the axial skew changes.

    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.

    numberPolePairs: number

    Number of pole pairs.

    numberPolePairsChanged: SignalConnector<number>

    Signal emitted when the number of pole pairs 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.

    piecesCleared: SignalConnector

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

    properties: { [name: string]: any }

    Rotor properties as an object (name: value).

    rotorChanged: SignalConnector

    Signal emitted when the rotor changes.

    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.

    Settings

    Member Visibility

    On This Page

    Methods
    Properties