Function: litMaterialAttributes()

function litMaterialAttributes(description): ObjectNode<{
  castshadow: Attr<
    boolean,
    {
      description: 'Cast shadows from the lights of `scene.lighting` with `castshadow` (onto three.js material types and the ground plane).';
      dflt: false;
      editType: 'calc';
    }
  >;
  clearcoat: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      max: 1;
      min: 0;
    }
  >;
  clearcoatroughness: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      max: 1;
      min: 0;
    }
  >;
  emissive: Attr<
    string,
    {
      description: string;
      editType: 'calc';
    }
  >;
  emissiveintensity: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      min: 0;
    }
  >;
  envmapintensity: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      min: 0;
    }
  >;
  ior: Attr<
    number,
    {
      description: 'Index of refraction (`physical`). Default 1.5.';
      editType: 'calc';
      max: 2.333;
      min: 1;
    }
  >;
  iridescence: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      max: 1;
      min: 0;
    }
  >;
  matcap: Attr<
    string,
    {
      description: 'URL of a matcap image (`matcap`): the surface takes its colors from it by normal direction.';
      editType: 'calc';
    }
  >;
  metalness: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      max: 1;
      min: 0;
    }
  >;
  receiveshadow: Attr<
    boolean,
    {
      description: 'Receive shadows (three.js material types only).';
      dflt: false;
      editType: 'calc';
    }
  >;
  reflectivity: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      max: 1;
      min: 0;
    }
  >;
  roughness: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      max: 1;
      min: 0;
    }
  >;
  sheen: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      max: 1;
      min: 0;
    }
  >;
  sheencolor: Attr<
    string,
    {
      description: string;
      editType: 'calc';
    }
  >;
  sheenroughness: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      max: 1;
      min: 0;
    }
  >;
  shininess: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      min: 0;
    }
  >;
  specular: Attr<
    string,
    {
      description: string;
      editType: 'calc';
    }
  >;
  steps: Attr<
    number,
    {
      description: 'Number of shading bands (`toon`).';
      dflt: 3;
      editType: 'calc';
      max: 16;
      min: 2;
    }
  >;
  thickness: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      min: 0;
    }
  >;
  transmission: Attr<
    number,
    {
      description: string;
      editType: 'calc';
      max: 1;
      min: 0;
    }
  >;
  type: Attr<
    'plotly' | 'flat' | 'basic' | 'lambert' | 'phong' | 'standard' | 'physical' | 'toon' | 'matcap',
    {
      description: "How surfaces are shaded. `plotly`: Plotly's lighting model. `flat`: unlit, colors as given. `basic`, `lambert`, `phong`, `standard`, `physical`, `toon`, `matcap`: the three.js material of that name, lit by the lights of the scene (`scene.lighting`) or of the 2.5D view.";
      dflt: 'plotly';
      editType: 'calc';
      values: readonly [
        'plotly',
        'flat',
        'basic',
        'lambert',
        'phong',
        'standard',
        'physical',
        'toon',
        'matcap',
      ];
    }
  >;
}>;

Experimental

The material attribute (Holochart extension, E8.7): shared by the 3D traces (sceneMaterialAttributes) and extruded 2D traces (extrusionAttributes). description describes the container. Unset parameters keep the three.js material's defaults.

Parameters

Parameter	Type
description	string

Returns

ObjectNode<{ castshadow: Attr<boolean, { description: "Cast shadows from the lights of `scene.lighting` with `castshadow` (onto three.js material types and the ground plane)."; dflt: false; editType: "calc"; }>; clearcoat: Attr<number, { description: string; editType: "calc"; max: 1; min: 0; }>; clearcoatroughness: Attr<number, { description: string; editType: "calc"; max: 1; min: 0; }>; emissive: Attr<string, { description: string; editType: "calc"; }>; emissiveintensity: Attr<number, { description: string; editType: "calc"; min: 0; }>; envmapintensity: Attr<number, { description: string; editType: "calc"; min: 0; }>; ior: Attr<number, { description: "Index of refraction (`physical`). Default 1.5."; editType: "calc"; max: 2.333; min: 1; }>; iridescence: Attr<number, { description: string; editType: "calc"; max: 1; min: 0; }>; matcap: Attr<string, { description: "URL of a matcap image (`matcap`): the surface takes its colors from it by normal direction."; editType: "calc"; }>; metalness: Attr<number, { description: string; editType: "calc"; max: 1; min: 0; }>; receiveshadow: Attr<boolean, { description: "Receive shadows (three.js material types only)."; dflt: false; editType: "calc"; }>; reflectivity: Attr<number, { description: string; editType: "calc"; max: 1; min: 0; }>; roughness: Attr<number, { description: string; editType: "calc"; max: 1; min: 0; }>; sheen: Attr<number, { description: string; editType: "calc"; max: 1; min: 0; }>; sheencolor: Attr<string, { description: string; editType: "calc"; }>; sheenroughness: Attr<number, { description: string; editType: "calc"; max: 1; min: 0; }>; shininess: Attr<number, { description: string; editType: "calc"; min: 0; }>; specular: Attr<string, { description: string; editType: "calc"; }>; steps: Attr<number, { description: "Number of shading bands (`toon`)."; dflt: 3; editType: "calc"; max: 16; min: 2; }>; thickness: Attr<number, { description: string; editType: "calc"; min: 0; }>; transmission: Attr<number, { description: string; editType: "calc"; max: 1; min: 0; }>; type: Attr< | "plotly" | "flat" | "basic" | "lambert" | "phong" | "standard" | "physical" | "toon" | "matcap", { description: "How surfaces are shaded. `plotly`: Plotly's lighting model. `flat`: unlit, colors as given. `basic`, `lambert`, `phong`, `standard`, `physical`, `toon`, `matcap`: the three.js material of that name, lit by the lights of the scene (`scene.lighting`) or of the 2.5D view."; dflt: "plotly"; editType: "calc"; values: readonly ["plotly", "flat", "basic", "lambert", "phong", "standard", "physical", "toon", "matcap"]; }>; }>