Link Search Menu Expand Document

arena-py API v1.3.0

arena.attributes.material

class Material(arena.attributes.attribute.Attribute):

Material attribute class to manage its properties in the ARENA: The material properties of the object's surface. More properties at https://aframe.io/docs/1.5.0/components/material.html A-Frame Material. Usage: material=Material(...)

Parameters
  • float alphaTest: Alpha test threshold for transparency. Defaults to '0' (optional)
  • float anisotropy: The anisotropic filtering sample rate to use for the textures. A value of 0 means the default value will be used, see renderer. Defaults to '0' (optional)
  • str blending: The blending mode for the material's RGB and Alpha sent to the WebGLRenderer. Allows [none, normal, additive, subtractive, multiply] Defaults to 'normal' (optional)
  • str color: Base diffuse color. Defaults to '#ffffff' (optional)
  • **str combine: How the environment map mixes with the material. Requires shader**: phong. Allows [mix, add, multiply] Defaults to 'mix' (optional)
  • bool depthTest: Whether depth testing is enabled when rendering the material. Defaults to 'True' (optional)
  • bool depthWrite: Render when depth test succeeds. Defaults to 'True' (optional)
  • bool dithering: Whether material is dithered with noise. Removes banding from gradients like ones produced by lighting. Defaults to 'True' (optional)
  • **str emissive: The color of the emissive lighting component. Used to make objects produce light even without other lighting in the scene. Requires shader**: standard or phong. Defaults to '#000000' (optional)
  • **float emissiveIntensity: Intensity of the emissive lighting component. Requires shader**: standard or phong. Defaults to '1' (optional)
  • bool flatShading: Use THREE.FlatShading rather than THREE.StandardShading. Defaults to 'False' (optional)
  • bool fog: Whether or not material is affected by fog. Defaults to 'True' (optional)
  • **int height: Height of video (in pixels), if defining a video texture. Requires shader**: standard or flat. Defaults to '256' (optional)
  • **float metalness: How metallic the material is from 0 to 1. Requires shader**: standard. Defaults to '0' (optional)
  • bool npot: Use settings for non-power-of-two (NPOT) texture. Defaults to 'False' (optional)
  • dict offset: Texture offset to be used. Defaults to '{'x': 0, 'y': 0}' (optional)
  • float opacity: Extent of transparency. If the transparent property is not true, then the material will remain opaque and opacity will only affect color. Defaults to '1' (optional)
  • **float reflectivity: How much the environment map affects the surface. Requires shader**: phong. Defaults to '0.9' (optional)
  • **bool refract: Whether the defined envMap should refract. Requires shader**: phong. Defaults to 'False' (optional)
  • float refractionRatio: refractionRatio Defaults to '0.98' (optional)
  • dict repeat: How many times a texture (defined by src) repeats in the X and Y direction. Defaults to '{'x': 1, 'y': 1}' (optional)
  • **float roughness: How rough the material is from 0 to 1. A rougher material will scatter reflected light in more directions than a smooth material. Requires shader**: standard. Defaults to '0' (optional)
  • str shader: Which material to use. Defaults to the standard material. Can be set to the flat material or to a registered custom shader material. Allows [flat, standard, phong] Defaults to 'standard' (optional)
  • **float shininess: How shiny the specular highlight is; a higher value gives a sharper highlight. Requires shader**: phong. Defaults to '30' (optional)
  • str side: Which sides of the mesh to render. Allows [front, back, double] Defaults to 'front' (optional)
  • **str specular: This defines how shiny the material is and the color of its shine. Requires shader**: phong. Defaults to '#111111' (optional)
  • str src: URI, relative or full path of an image/video file. e.g. 'store/users/wiselab/images/360falls.mp4'. (optional)
  • **bool toneMapped: Whether to ignore toneMapping, set to false you are using renderer.toneMapping and an element should appear to emit light. Requires shader**: flat. Defaults to 'True' (optional)
  • bool transparent: Whether material is transparent. Transparent entities are rendered after non-transparent entities. Defaults to 'False' (optional)
  • bool vertexColorsEnabled: Whether to use vertex or face colors to shade the material. Defaults to 'False' (optional)
  • bool visible: Whether material is visible. Raycasters will ignore invisible materials. Defaults to 'True' (optional)
  • **int width: Width of video (in pixels), if defining a video texture. Requires shader**: standard or flat. Defaults to '512' (optional)
  • bool wireframe: Whether to render just the geometry edges. Defaults to 'False' (optional)
  • int wireframeLinewidth: Width in px of the rendered line. Defaults to '2' (optional)
Material(**kwargs)
Inherited Members