com.eteks.sweethome3d.model

Class HomeMaterial

java.lang.Object

com.eteks.sweethome3d.model.HomeMaterial

All Implemented Interfaces:

java.io.Serializable

public class HomeMaterial
extends java.lang.Object
implements java.io.Serializable

The color and other properties of a material.

Since:

4.0

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HomeMaterial(java.lang.String name, java.lang.Integer color, HomeTexture texture, java.lang.Float shininess) Creates a material instance from parameters.
HomeMaterial(java.lang.String name, java.lang.String key, java.lang.Integer color, HomeTexture texture, java.lang.Float shininess) Creates a material instance from parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Returns true if this material is equal to object.
java.lang.Integer	getColor() Returns the color of this material.
java.lang.String	getKey() Returns the key of this material.
java.lang.String	getName() Returns the name of this material.
java.lang.Float	getShininess() Returns the shininess of this material.
HomeTexture	getTexture() Returns the texture of this material.
int	hashCode() Returns a hash code for this material.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HomeMaterial

public HomeMaterial(java.lang.String name,
                    java.lang.Integer color,
                    HomeTexture texture,
                    java.lang.Float shininess)

Creates a material instance from parameters.

Since:

4.0

HomeMaterial

public HomeMaterial(java.lang.String name,
                    java.lang.String key,
                    java.lang.Integer color,
                    HomeTexture texture,
                    java.lang.Float shininess)

Creates a material instance from parameters.

Since:

5.3

Method Detail

getName

public java.lang.String getName()

Returns the name of this material.

Returns:

the name of the material or null if material has no name.

Since:

4.0

getKey

public java.lang.String getKey()

Returns the key of this material. If not null, this key should be used as the unique identifier to find this material among the ones available on a model, rather than the name of this material.

Returns:

the key of the material or null if material has no key.

Since:

5.3

getColor

public java.lang.Integer getColor()

Returns the color of this material.

Returns:

the color of the material as RGB code or null if material color is unchanged.

Since:

4.0

getTexture

public HomeTexture getTexture()

Returns the texture of this material.

Returns:

the texture of the material or null if material texture is unchanged.

Since:

4.0

getShininess

public java.lang.Float getShininess()

Returns the shininess of this material.

Returns:

a value between 0 (matt) and 1 (very shiny) or null if material shininess is unchanged.

Since:

4.0

equals

public boolean equals(java.lang.Object object)

Returns true if this material is equal to object.

Overrides:

equals in class java.lang.Object

Since:

6.0

hashCode

public int hashCode()

Returns a hash code for this material.

Overrides:

hashCode in class java.lang.Object

Since:

6.0