Package org.sunflow.image
Class ColorFactory
java.lang.Object
org.sunflow.image.ColorFactory
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Color
createColor
(String colorspace, float... data) Creates a color value in the renderer's internal color space from a string (representing the color space name) and an array of floating point values.static String
Return the name of the internal color space.static int
getRequiredDataValues
(String colorspace) Checks to see how many values are required to specify a color using the given colorspace.
-
Constructor Details
-
ColorFactory
public ColorFactory()
-
-
Method Details
-
getInternalColorspace
Return the name of the internal color space. This string can be used interchangeably withnull
in the following methods.- Returns:
- internal colorspace name
-
getRequiredDataValues
Checks to see how many values are required to specify a color using the given colorspace. This number can be variable for spectrum colors, in which case the returned value is -1. If the colorspace name is invalid, this method returns -2. No exception is thrown. This method is intended for parsers that want to know how many floating values to retrieve from a file.- Parameters:
colorspace
-- Returns:
- number of floating point numbers expected, -1 for any, -2 on error
-
createColor
public static Color createColor(String colorspace, float... data) throws ColorFactory.ColorSpecificationException Creates a color value in the renderer's internal color space from a string (representing the color space name) and an array of floating point values. If the colorspace string is null, we assume the data was supplied in internal space. This method does much error checking and may throw aRuntimeException
if its parameters are not consistent. Here are the currently supported color spaces:"sRGB nonlinear"
- requires 3 values"sRGB linear"
- requires 3 values"XYZ"
- requires 3 valuesblackbody
- requires 1 value (temperature in Kelvins)spectrum [min] [max]
- any number of values (must be >0), [start] and [stop] is the range over which the spectrum is defined in nanometers.
- Parameters:
colorspace
- color space namedata
- data describing this color- Returns:
- a valid color in the renderer's color space
- Throws:
ColorFactory.ColorSpecificationException
-