MotorXP-AFM Scripting API
    Preparing search index...

    Variable MaterialConst

    Material: {
        conductor(): ConductorMaterial;
        custom(color?: color): CustomMaterial;
        empty(): EmptyMaterial;
        endturn(): EndturnMaterial;
        general(): GeneralMaterial;
        iron(fillCoefs?: number[], dsomaloy?: number): IronMaterial;
        magnetParallel(
            angle?: number,
            segmentRadiuses?: number[],
            savePoleBorder?: boolean,
        ): MagnetParallelMaterial;
        magnetRadial(
            direction?: Magnetization,
            center?: point,
            segmentRadiuses?: number[],
        ): MagnetRadialMaterial;
        winding(layer?: number, turn?: number, strand?: number): WindingMaterial;
    }

    Built-in Material object

    Type Declaration

    • conductor: function
    • custom: function
      • Custom material with the specified color.

        Parameters

        • Optionalcolor: color

          color [default=Qt.red] - Material color.

        Returns CustomMaterial

        CustomMaterial object.

    • empty: function
    • endturn: function
      • Material for winding end turns (Endturns).

        Returns EndturnMaterial

        EndturnMaterial object

    • general: function
    • iron: function
      • Iron material.

        Parameters

        • OptionalfillCoefs: number[]

          fillCoefs [default=[]] - Material fill factor.

        • Optionaldsomaloy: number

          dsomaloy [default=0] - Smallest transverse dimension of the component [m] for Somaloy material.

        Returns IronMaterial

        IronMaterial object.

    • magnetParallel: function
      • Material for a magnet with parallel magnetization.

        Parameters

        • Optionalangle: number

          angle [default=0] - Parallel magnetization angle.

        • OptionalsegmentRadiuses: number[]

          segmentRadiuses [default=[]] - Array of magnet segment radii.

        • OptionalsavePoleBorder: boolean

          savePoleBorder [default=true] - If true, preserves the boundary between magnets of adjacent poles.

        Returns MagnetParallelMaterial

        MagnetParallelMaterial object.

    • magnetRadial: function
      • Material for a magnet with radial magnetization.

        Parameters

        • Optionaldirection: Magnetization

          direction [default=Magnetization.From] - Magnetization direction.

        • Optionalcenter: point

          center [default=Qt.point(0, 0)] - Magnetization center.

        • OptionalsegmentRadiuses: number[]

          segmentRadiuses [default=[]] - Array of magnet segment radii.

        Returns MagnetRadialMaterial

        MagnetRadialMaterial object.

    • winding: function
      • Winding material.

        Parameters

        • Optionallayer: number

          layer [default=Winding.Auto] - Layer number: Winding.Auto, Winding.First, or Winding.Second.

        • Optionalturn: number

          turn [default=0] - Turn number.

        • Optionalstrand: number

          strand [default=0] - Strand number within a turn.

        Returns WindingMaterial

        WindingMaterial object.