fr.cnes.sirius.patrius.assembly.properties

Class RadiativeProperty

java.lang.Object

fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty

All Implemented Interfaces:

IPartProperty, Serializable

public final class RadiativeProperty
extends Object
implements IPartProperty, Serializable

This class is a part property for the PATRIUS assembly. It is the radiative property of a part. Three optical coefficients are defined in the visible domain (for absorption, specular reflection and diffuse reflection).

Since:

1.1

Version:

$Id$

Author:

Gerald Mercadier

See Also:

Serialized Form

Concurrency :

immutable

Field Summary

Fields

Modifier and Type	Field and Description
static String	ABSORPTION_COEFFICIENT Parameter name for absorption coefficient.
static String	DIFFUSION_COEFFICIENT Parameter name for diffusion coefficient.
static String	SPECULAR_COEFFICIENT Parameter name for reflection coefficient.

Constructor Summary

Constructors

Constructor and Description
RadiativeProperty(double ka, double ks, double kd) Constructor of this property.
RadiativeProperty(Parameter ka, Parameter ks, Parameter kd) Constructor of this property using Parameter.

Method Summary

Modifier and Type	Method and Description
Parameter	getAbsorptionRatio() Get the parameter representing the ratio of light absorbed: Ka = α.
Parameter	getDiffuseReflectionRatio() Get the parameter representing the ratio of light subjected to diffuse reflectance : Kd = (1 - α) (1 - τ).
Parameter	getSpecularReflectionRatio() Get the parameter representing the ratio of light subjected to specular reflectance : Ks = (1 - α) τ.
PropertyType	getType() Get the type of the property.

Methods inherited from class java.lang.Object

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

Field Detail

ABSORPTION_COEFFICIENT

public static final String ABSORPTION_COEFFICIENT

Parameter name for absorption coefficient.

See Also:

Constant Field Values

SPECULAR_COEFFICIENT

public static final String SPECULAR_COEFFICIENT

Parameter name for reflection coefficient.

See Also:

Constant Field Values

DIFFUSION_COEFFICIENT

public static final String DIFFUSION_COEFFICIENT

Parameter name for diffusion coefficient.

See Also:

Constant Field Values

Constructor Detail

RadiativeProperty

public RadiativeProperty(double ka,
                         double ks,
                         double kd)

Constructor of this property.

Parameters:

ka - The ratio ka of light absorbed of the part (between 0 and 1).

ks - The ratio ks of light undergoing specular reflectance (between 0 and 1).

kd - The ratio kd of light undergoing diffuse reflectance (between 0 and 1).

RadiativeProperty

public RadiativeProperty(Parameter ka,
                         Parameter ks,
                         Parameter kd)

Constructor of this property using Parameter.

Parameters:

ka - The parameter representing the ratio ka of light absorbed of the part (between 0 and 1).

ks - The parameter representing the ratio ks of light undergoing specular reflectance (between 0 and 1).

kd - The parameter representing the ratio kd of light undergoing diffuse reflectance (between 0 and 1).

Method Detail

getAbsorptionRatio

public Parameter getAbsorptionRatio()

Get the parameter representing the ratio of light absorbed: Ka = α.

Returns:

the parameter representing the absorption ratio coefficient

getSpecularReflectionRatio

public Parameter getSpecularReflectionRatio()

Get the parameter representing the ratio of light subjected to specular reflectance : Ks = (1 - α) τ.

Returns:

the parameter representing the specular reflection ratio coefficient

getDiffuseReflectionRatio

public Parameter getDiffuseReflectionRatio()

Get the parameter representing the ratio of light subjected to diffuse reflectance : Kd = (1 - α) (1 - τ).

Returns:

the parameter representing the diffuse reflection ratio coefficient

getType

public PropertyType getType()

Get the type of the property.

Specified by:

getType in interface IPartProperty

Returns:

the type of the property (see PropertyType enumeration)