Module com.marginallyclever.robotoverlord

Package com.marginallyclever.ro3.node.nodes

Class Material

java.lang.Object

com.marginallyclever.ro3.node.Node

com.marginallyclever.ro3.node.nodes.Material

public class Material
extends Node

Material contains properties for rendering a surface. The first use case is to apply a texture to a Mesh.

This class provides several functionalities:

• It can set and get the texture.
• It can set and get the diffuse color.
• It can set and get the specular color.
• It can set and get the emission color.
• It can set and get the shininess.
• It can set and get the lit status.
• It can serialize and deserialize itself to and from JSON format.

Constructor Summary

Constructors

Constructor	Description
Material()
Material(String name)

Method Summary

Modifier and Type	Method	Description
void	fromJSON(org.json.JSONObject from)	Deserialize this node and its children from a JSON object and its children.
void	getComponents(List<JPanel> list)	Build a Swing Component that represents this Node.
Color	getDiffuseColor()
TextureWithMetadata	getDiffuseTexture()
Color	getEmissionColor()
double	getEmissionStrength()
ColorDouble	getEmittedLight()	Calculate the emitted light from a material based on its emission color and strength.
Icon	getIcon()	Set a custom icon for this node.
double	getIOR()
TextureWithMetadata	getNormalTexture()
double	getPDF(Hit hit, javax.vecmath.Vector3d in, javax.vecmath.Vector3d out)	Cosine-weighted hemisphere PDF for diffuse reflection.
double	getReflectivity()
int	getShininess()
Color	getSpecularColor()
double	getSpecularStrength()
TextureWithMetadata	getSpecularTexture()
boolean	isEmissive()
boolean	isLit()
ColorDouble	lightSamplingBRDF(Hit hit, javax.vecmath.Vector3d wi, javax.vecmath.Vector3d wo)	Diffuse-only BRDF (f) for next-event (light) sampling.
ScatterRecord	scatter(Ray ray, Hit hit, RayXY pixel)
void	setDiffuseColor(Color color)
void	setDiffuseTexture(TextureWithMetadata texture)
void	setEmissionColor(Color color)
void	setEmissionStrength(double emissionStrength)
void	setIOR(double ior)	Set the index of refraction.
void	setLit(boolean isLit)
void	setNormalTexture(TextureWithMetadata texture)
void	setReflectivity(double arg0)	Set the reflectivity of the material.
void	setShininess(int arg0)
void	setSpecularColor(Color color)
void	setSpecularStrength(double specularStrength)
void	setSpecularTexture(TextureWithMetadata texture)
org.json.JSONObject	toJSON()	Serialize this node and its children to a JSON object and its children.

Methods inherited from class com.marginallyclever.ro3.node.Node

addAttachListener, addChild, addChild, addDetachListener, addReadyListener, addRenameListener, findByPath, findChild, findChild, findFirstChild, findFirstSibling, findNodeByID, findParent, findParent, getAbsolutePath, getChildren, getName, getParent, getRootNode, getUniqueID, hasParent, isNameUsedBySibling, removeAttachListener, removeChild, removeDetachListener, removeReadyListener, removeRenameListener, setName, update, witnessProtection

Methods inherited from class java.lang.Object

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

Constructor Details

Material

public Material()

Material

public Material(String name)

Method Details

getComponents

public void getComponents(List<JPanel> list)

Description copied from class: Node

Build a Swing Component that represents this Node.

Overrides:

getComponents in class Node

Parameters:

list - the list to add components to.

setDiffuseTexture

public void setDiffuseTexture(TextureWithMetadata texture)

getDiffuseTexture

public TextureWithMetadata getDiffuseTexture()

setNormalTexture

public void setNormalTexture(TextureWithMetadata texture)

getNormalTexture

public TextureWithMetadata getNormalTexture()

setSpecularTexture

public void setSpecularTexture(TextureWithMetadata texture)

getSpecularTexture

public TextureWithMetadata getSpecularTexture()

toJSON

public org.json.JSONObject toJSON()

Description copied from class: Node

Serialize this node and its children to a JSON object and its children. Classes that override this method should call super.toJSON() first, then add to the object returned.

Overrides:

toJSON in class Node

Returns:

the JSON object.

fromJSON

public void fromJSON(org.json.JSONObject from)

Description copied from class: Node

Deserialize this node and its children from a JSON object and its children. Classes that override this method should call super.fromJSON(). When they do it will trigger the creation of child nodes. The child nodes will then call their own fromJSON() methods.

Overrides:

fromJSON in class Node

Parameters:

from - the JSON object to read from.

getDiffuseColor

public Color getDiffuseColor()

setDiffuseColor

public void setDiffuseColor(Color color)

getSpecularColor

public Color getSpecularColor()

setSpecularColor

public void setSpecularColor(Color color)

getEmissionColor

public Color getEmissionColor()

setEmissionColor

public void setEmissionColor(Color color)

getEmissionStrength

public double getEmissionStrength()

Returns:

the emission strength of the material. >=0

setEmissionStrength

public void setEmissionStrength(double emissionStrength)

Parameters:

emissionStrength - the emission strength of the material. >=0

isEmissive

public boolean isEmissive()

setShininess

public void setShininess(int arg0)

getShininess

public int getShininess()

Returns:

the shininess of the material 0...128

isLit

public boolean isLit()

setLit

public void setLit(boolean isLit)

getIcon

public Icon getIcon()

Description copied from class: Node

Set a custom icon for this node.

Overrides:

getIcon in class Node

Returns:

the icon, or null if none.

setSpecularStrength

public void setSpecularStrength(double specularStrength)

getSpecularStrength

public double getSpecularStrength()

setIOR

public void setIOR(double ior)

Set the index of refraction.

Parameters:

ior - the index of refraction

getIOR

public double getIOR()

Returns:

the index of refraction.

setReflectivity

public void setReflectivity(double arg0)

Set the reflectivity of the material.

Parameters:

arg0 - 0...1.0

getReflectivity

public double getReflectivity()

Returns:

the reflectivity of the material.

getPDF

public double getPDF(Hit hit,
 javax.vecmath.Vector3d in,
 javax.vecmath.Vector3d out)

Cosine-weighted hemisphere PDF for diffuse reflection.

Parameters:

hit - the hit record

in - incoming direction (unit, towards surface)

out - outgoing direction (unit, towards viewer)

Returns:

the PDF value

getEmittedLight

public ColorDouble getEmittedLight()

Calculate the emitted light from a material based on its emission color and strength.

Returns:

the emitted light as a ColorDouble

scatter

public ScatterRecord scatter(Ray ray,
 Hit hit,
 RayXY pixel)

lightSamplingBRDF

public ColorDouble lightSamplingBRDF(Hit hit,
 javax.vecmath.Vector3d wi,
 javax.vecmath.Vector3d wo)

Diffuse-only BRDF (f) for next-event (light) sampling. Excludes specular (never light sampled) and transmission (delta). Does NOT include the cosine term or any pdf factors.