com.jme3.material

Class MatParam

java.lang.Object

com.jme3.material.MatParam

All Implemented Interfaces:

Savable, java.lang.Cloneable

Direct Known Subclasses:

MatParamOverride, MatParamTexture

public class MatParam
extends java.lang.Object
implements Savable, java.lang.Cloneable

Describes a material parameter. This is used for both defining a name and type as well as a material parameter value.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
protected java.lang.String	prefixedName
protected VarType	type
protected boolean	typeCheck
protected java.lang.Object	value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MatParam() Serialization only.
	MatParam(VarType type, java.lang.String name, java.lang.Object value) Create a new material parameter.

Method Summary

Modifier and Type	Method and Description
MatParam	clone()
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name of the material parameter.
java.lang.String	getPrefixedName() Returns the name with "m_" prefixed to it.
java.lang.Object	getValue() Returns the value of this material parameter.
java.lang.String	getValueAsString() Returns the material parameter value as it would appear in a J3M file.
VarType	getVarType() Returns the material parameter type.
int	hashCode()
boolean	isTypeCheckEnabled()
void	read(JmeImporter im)
void	setTypeCheckEnabled(boolean v) Enable type check for this param.
void	setValue(java.lang.Object value) Sets the value of this material parameter.
java.lang.String	toString()
void	write(JmeExporter ex)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

protected VarType type

name

protected java.lang.String name

prefixedName

protected java.lang.String prefixedName

value

protected java.lang.Object value

typeCheck

protected boolean typeCheck

Constructor Detail

MatParam

public MatParam(VarType type,
                java.lang.String name,
                java.lang.Object value)

Create a new material parameter. For internal use only.

Parameters:

type - the type of the parameter

name - the desired parameter name

value - the desired parameter value (alias created)

MatParam

protected MatParam()

Serialization only. Do not use.

Method Detail

isTypeCheckEnabled

public boolean isTypeCheckEnabled()

setTypeCheckEnabled

public void setTypeCheckEnabled(boolean v)

Enable type check for this param. When type check is enabled a RuntimeException is thrown if an object of the wrong type is passed to setValue.

Parameters:

v - (default = true)

getVarType

public VarType getVarType()

Returns the material parameter type.

Returns:

the material parameter type.

getName

public java.lang.String getName()

Returns the name of the material parameter.

Returns:

the name of the material parameter.

getPrefixedName

public java.lang.String getPrefixedName()

Returns the name with "m_" prefixed to it.

Returns:

the name with "m_" prefixed to it

getValue

public java.lang.Object getValue()

Returns the value of this material parameter.

Material parameters that are used for material definitions will not have a value, unless there's a default value declared in the definition.

Returns:

the value of this material parameter.

setValue

public void setValue(java.lang.Object value)

Sets the value of this material parameter.

It is assumed the value is of the same type as this material parameter.

Parameters:

value - the value of this material parameter.

getValueAsString

public java.lang.String getValueAsString()

Returns the material parameter value as it would appear in a J3M file. E.g.

 MaterialParameters {
     ABC : 1 2 3 4
 }
 

Assuming "ABC" is a Vector4 parameter, then the value "1 2 3 4" would be returned by this method.

Returns:

material parameter value as it would appear in a J3M file.

clone

public MatParam clone()

Overrides:

clone in class java.lang.Object

write

public void write(JmeExporter ex)
           throws java.io.IOException

Specified by:

write in interface Savable

Throws:

java.io.IOException

read

public void read(JmeImporter im)
          throws java.io.IOException

Specified by:

read in interface Savable

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object