Package com.google.ar.sceneform.rendering

Class MaterialFactory

java.lang.Object

com.google.ar.sceneform.rendering.MaterialFactory

@RequiresApi(api=24)
public final class MaterialFactory
extends java.lang.Object

Utility class used to construct default Materials.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MATERIAL_COLOR	Name of material parameter for controlling the color of makeOpaqueWithColor(Context, Color) and makeTransparentWithColor(Context, Color) materials.
static java.lang.String	MATERIAL_METALLIC	Name of material parameter for controlling the metallic property of all MaterialFactory materials.
static java.lang.String	MATERIAL_REFLECTANCE	Name of material parameter for controlling the reflectance property of all MaterialFactory materials.
static java.lang.String	MATERIAL_ROUGHNESS	Name of material parameter for controlling the roughness property of all MaterialFactory materials.
static java.lang.String	MATERIAL_TEXTURE	Name of material parameter for controlling the texture of makeOpaqueWithTexture(Context, Texture) and makeTransparentWithTexture(Context, Texture) materials.

Constructor Summary

Constructors

Constructor	Description
MaterialFactory()

Method Summary

Modifier and Type	Method	Description
static java.util.concurrent.CompletableFuture<Material>	makeOpaqueWithColor(android.content.Context context, Color color)	Creates an opaque Material with the Color passed in.
static java.util.concurrent.CompletableFuture<Material>	makeOpaqueWithTexture(android.content.Context context, Texture texture)	Creates an opaque Material with the Texture passed in.
static java.util.concurrent.CompletableFuture<Material>	makeTransparentWithColor(android.content.Context context, Color color)	Creates a transparent Material with the Color passed in.
static java.util.concurrent.CompletableFuture<Material>	makeTransparentWithTexture(android.content.Context context, Texture texture)	Creates a transparent Material with the Texture passed in.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MATERIAL_COLOR

public static final java.lang.String MATERIAL_COLOR

Name of material parameter for controlling the color of makeOpaqueWithColor(Context, Color) and makeTransparentWithColor(Context, Color) materials.

See Also:

Material.setFloat3(String, Color), Material.setFloat4(String, Color), Constant Field Values

MATERIAL_TEXTURE

public static final java.lang.String MATERIAL_TEXTURE

Name of material parameter for controlling the texture of makeOpaqueWithTexture(Context, Texture) and makeTransparentWithTexture(Context, Texture) materials.

See Also:

Material.setTexture(String, Texture), Constant Field Values

MATERIAL_METALLIC

public static final java.lang.String MATERIAL_METALLIC

Name of material parameter for controlling the metallic property of all MaterialFactory materials. The metallic property defines whether the surface is a metallic (conductor) or a non-metallic (dielectric) surface. This property should be used as a binary value, set to either 0 or 1. Intermediate values are only truly useful to create transitions between different types of surfaces when using textures. The default value is 0.

See Also:

Material.setFloat(String, float), Constant Field Values

MATERIAL_ROUGHNESS

public static final java.lang.String MATERIAL_ROUGHNESS

Name of material parameter for controlling the roughness property of all MaterialFactory materials. The roughness property controls the perceived smoothness of the surface. When roughness is set to 0, the surface is perfectly smooth and highly glossy. The rougher a surface is, the "blurrier" the reflections are. The default value is 0.4.

See Also:

Material.setFloat(String, float), Constant Field Values

MATERIAL_REFLECTANCE

public static final java.lang.String MATERIAL_REFLECTANCE

Name of material parameter for controlling the reflectance property of all MaterialFactory materials. The reflectance property only affects non-metallic surfaces. This property can be used to control the specular intensity. This value is defined between 0 and 1 and represents a remapping of a percentage of reflectance. The default value is 0.5.

See Also:

Material.setFloat(String, float), Constant Field Values

Constructor Detail

MaterialFactory

public MaterialFactory()

Method Detail

makeOpaqueWithColor

public static java.util.concurrent.CompletableFuture<Material> makeOpaqueWithColor(android.content.Context context,
                                                                                   Color color)

Creates an opaque Material with the Color passed in. The Color can be modified by calling Material.setFloat3(String, Color) with MATERIAL_COLOR. The metallicness, roughness, and reflectance can be modified using Material.setFloat(String, float).

Parameters:

context - a context used for loading the material resource

color - the color for the material to render

Returns:

material that will render the given color

See Also:

MATERIAL_METALLIC, MATERIAL_ROUGHNESS, MATERIAL_REFLECTANCE

makeTransparentWithColor

public static java.util.concurrent.CompletableFuture<Material> makeTransparentWithColor(android.content.Context context,
                                                                                        Color color)

Creates a transparent Material with the Color passed in. The Color can be modified by calling Material.setFloat4(String, Color) with MATERIAL_COLOR. The metallicness, roughness, and reflectance can be modified using Material.setFloat(String, float).

Parameters:

context - a context used for loading the material resource

color - the color for the material to render

Returns:

material that will render the given color

See Also:

MATERIAL_METALLIC, MATERIAL_ROUGHNESS, MATERIAL_REFLECTANCE

makeOpaqueWithTexture

public static java.util.concurrent.CompletableFuture<Material> makeOpaqueWithTexture(android.content.Context context,
                                                                                     Texture texture)

Creates an opaque Material with the Texture passed in. The Texture can be modified by calling Material.setTexture(String, Texture) with MATERIAL_TEXTURE. The metallicness, roughness, and reflectance can be modified using Material.setFloat(String, float).

Parameters:

context - a context used for loading the material resource

texture - the texture for the material to render

Returns:

material that will render the given texture

See Also:

MATERIAL_METALLIC, MATERIAL_ROUGHNESS, MATERIAL_REFLECTANCE

makeTransparentWithTexture

public static java.util.concurrent.CompletableFuture<Material> makeTransparentWithTexture(android.content.Context context,
                                                                                          Texture texture)

Creates a transparent Material with the Texture passed in. The Texture can be modified by calling Material.setTexture(String, Texture) with MATERIAL_TEXTURE. The metallicness, roughness, and reflectance can be modified using Material.setFloat(String, float).

Parameters:

context - a context used for loading the material resource

texture - the texture for the material to render

Returns:

material that will render the given texture

See Also:

MATERIAL_METALLIC, MATERIAL_ROUGHNESS, MATERIAL_REFLECTANCE