ObjectMaterialMix

export type ObjectMaterial = {
  /**
   * @default standard
   */
  type?: ObjectMaterialType;

  /**
   * Blending destination. It's one of the blending mode constants defined in Three.js. Default OneMinusSrcAlphaFactor.
   * * @see {@link https://threejs.org/docs/#api/en/constants/Textures}
   * @default OneMinusSrcAlphaFactor
   */
  blendDst?: BlendingDstFactor;

  /**
   * The tranparency of the .blendDst. Default is null.
   * @see {@link https://threejs.org/docs/index.html#api/en/constants/CustomBlendingEquation}
   * @default null
   */
  blendDstAlpha?: number | null;

  /**
   * Blending equation to use when applying blending. Default is AddEquation.
   * @see {@link https://threejs.org/docs/index.html#api/en/constants/CustomBlendingEquation}
   * @default AddEquation
   */
  blendEquation?: BlendingEquation;

  /**
   * The tranparency of the .blendEquation. Default is null.
   * @default null
   */
  blendEquationAlpha?: number | null;

  /**
   * Which blending to use when displaying objects with this material. Default is NormalBlending.
   * @see {@link https://threejs.org/docs/index.html#api/en/constants/CustomBlendingEquation}
   * @default NormalBlending
   */
  blending?: Blending;

  /**
   * Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.
   * @see {@link https://threejs.org/docs/index.html#api/en/constants/CustomBlendingEquation}
   * @default SrcAlphaFactor
   */
  blendSrc?: BlendingSrcFactor | BlendingDstFactor;

  /**
   * The tranparency of the .blendSrc. Default is null.
   * @default null
   */
  blendSrcAlpha?: number | null;

  /**
   * Whether to render the material's color. This can be used in conjunction with a mesh's .renderOrder property to create invisible objects that occlude other objects. Default is true.
   * @default true
   */
  colorWrite?: boolean;

  /**
   * Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.
   * @see {@link https://threejs.org/docs/index.html#api/en/constants/CustomBlendingEquation}
   * @default LessEqualDepth
   */
  depthFunc?: DepthModes;

  /**
   * Whether to have depth test enabled when rendering this material. Default is true.
   * @default true
   */
  depthTest?: boolean;

  /**
   * Whether rendering this material has any effect on the depth buffer. Default is true.
   * When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.
   * @default true
   */
  depthWrite?: boolean;

  /**
   * Opacity. Default is 1.
   * @default 1
   */
  opacity?: number;

  /**
   * Defines which of the face sides will be rendered - front, back or both.
   * Default is FrontSide. Other options are BackSide and DoubleSide.
   * @see {@link https://threejs.org/docs/index.html#api/en/constants/CustomBlendingEquation}
   * @default FrontSide
   */
  side?: Side;

  /**
   * Defines which of the face sides will cast shadows. Default is *null*.
   * If *null*, the value is opposite that of side, above.
   * @see {@link https://threejs.org/docs/index.html#api/en/constants/CustomBlendingEquation}
   * @default null
   */
  shadowSide?: Side | null;

  /**
   * Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects.
   * When set to true, the extent to which the material is transparent is controlled by setting it's .opacity property.
   * Default is false.
   * @default false
   */
  transparent?: boolean;

  /**
   * Sets the alpha value to be used when running an alpha test. Default is 0.
   * @default 0
   */
  alphaTest?: number;

  /**
   * Defines whether vertex coloring is used. Default is false.
   * @default false
   */
  vertexColors?: boolean;
};

export type ObjectMaterialSharedProps = {
  /**
   * @default white
   */
  color?: ColorType;

  /**
   * Whether the material is affected by fog. Default is true.
   * @default true
   */
  fog?: boolean;

  /**
   * @default null
   */
  lightMap?: ObjectTextureType;

  /**
   * @default 1
   */
  lightMapIntensity?: number;

  /**
   * @default null
   */
  aoMap?: ObjectTextureType;

  /**
   * @default 1
   */
  aoMapIntensity?: number;

  /**
   * @default null
   */
  alphaMap?: ObjectTextureType;

  /**
   * @default false
   */
  wireframe?: boolean;
};

export type ObjectMaterialStandard = ObjectMaterial &
  ObjectMaterialSharedProps & {
    /**
     * @default 1
     */
    roughness?: number;

    /**
     * @default 0
     */
    metalness?: number;

    /**
     * @default null
     */
    map?: ObjectTextureType;

    /**
     * @default black
     */
    emissive?: ColorType;

    /**
     * @default 1
     */
    emissiveIntensity?: number;

    /**
     * @default null
     */
    emissiveMap?: ObjectTextureType;

    /**
     * @default null
     */
    bumpMap?: ObjectTextureType;

    /**
     * @default 1
     */
    bumpScale?: number;

    /**
     * @default null
     */
    normalMap?: ObjectTextureType;

    /**
     * @see {@link https://threejs.org/docs/#api/en/constants/Textures}
     * @default TangentSpaceNormalMap
     */
    normalMapType?: NormalMapTypes;

    /**
     * @default new Array( 1, 1 )
     */
    normalScale?: Vector2Array;

    /**
     * @default null
     */
    displacementMap?: ObjectTextureType;

    /**
     * @default 1
     */
    displacementScale?: number;

    /**
     * @default 0
     */
    displacementBias?: number;

    /**
     * @default null
     */
    roughnessMap?: ObjectTextureType;

    /**
     * @default null
     */
    metalnessMap?: ObjectTextureType;

    /**
     * @default null
     */
    envMap?: ObjectTextureType;

    /**
     * @default 1
     */
    envMapIntensity?: number;

    /**
     * Define whether the material is rendered with flat shading. Default is false.
     * @default false
     */
    flatShading?: boolean;
  };

export type ObjectMaterialPhysical = ObjectMaterialStandard & {
  /**
   * @default 0
   */
  clearcoat?: number;

  /**
   * @default null
   */
  clearcoatMap?: ObjectTextureType;

  /**
   * @default 0
   */
  clearcoatRoughness?: number;

  /**
   * @default null
   */
  clearcoatRoughnessMap?: ObjectTextureType;

  /**
   * @default new Array(1, 1)
   */
  clearcoatNormalScale?: Vector2Array;

  /**
   * @default null
   */
  clearcoatNormalMap?: ObjectTextureType;

  /**
   * @default 0.5
   */
  reflectivity?: number;

  /**
   * @default 1.5
   */
  ior?: number;

  /**
   * @default 0.0
   */
  sheen?: number;

  /**
   * @default 0x000000
   */
  sheenColor?: ColorType;

  /**
   * @default null
   */
  sheenColorMap?: ObjectTextureType;

  /**
   * @default 1.0
   */
  sheenRoughness?: number;

  /**
   * @default null
   */
  sheenRoughnessMap?: ObjectTextureType;

  /**
   * @default 0
   */
  transmission?: number;

  /**
   * @default null
   */
  transmissionMap?: ObjectTextureType;

  /**
   * @default 0.01
   */
  thickness?: number;

  /**
   * @default null
   */
  thicknessMap?: ObjectTextureType;

  /**
   * @default 0.0
   */
  attenuationDistance?: number;

  /**
   * @default white
   */
  attenuationColor?: ColorType;

  /**
   * @default 1.0
   */
  specularIntensity?: number;

  /**
   * @default white
   */
  specularColor?: ColorType;

  /**
   * @default null
   */
  specularIntensityMap?: ObjectTextureType;

  /**
   * @default null
   */
  specularColorMap?: ObjectTextureType;

  /**
   * @default null
   */
  iridescenceMap?: ObjectTextureType;

  /**
   * @default 1.3
   */
  iridescenceIOR?: number;

  /**
   * @default 0
   */
  iridescence?: number;

  /**
   * @default [100, 400]
   */
  iridescenceThicknessRange?: Vector2Array;

  /**
   * @default null
   */
  iridescenceThicknessMap?: ObjectTextureType;
};

export type ObjectMaterialBasic = ObjectMaterial &
  ObjectMaterialSharedProps & {
    /**
     * @default null
     */
    map?: ObjectTextureType;

    /**
     * @default null
     */
    envMap?: ObjectTextureType;

    /**
     * @default null
     */
    specularMap?: ObjectTextureType;

    /**
     * @see {@link https://threejs.org/docs/#api/en/constants/Textures}
     * @default MultiplyOperation
     */
    combine?: Combine;

    /**
     * @default 1
     */
    reflectivity?: number;

    /**
     * @default 0.98
     */
    refractionRatio?: number;
  };

export type ObjectMaterialNormal = ObjectMaterial & {
  wireframe?: boolean;

  flatShading?: boolean;
};

export type ObjectMaterialDepth = ObjectMaterial & {
  wireframe?: boolean;

  alphaMap?: ObjectTextureType;
};

export type ObjectMaterialMix = ObjectMaterialStandard &
  ObjectMaterialPhysical &
  ObjectMaterialBasic &
  ObjectMaterialNormal &
  ObjectMaterialDepth;