Package org.sunflow
Class SunflowAPI
java.lang.Object
org.sunflow.SunflowAPI
- All Implemented Interfaces:
SunflowAPIInterface
- Direct Known Subclasses:
RealtimeBenchmark
This API gives a simple interface for creating scenes procedurally. This is
the main entry point to Sunflow. To use this class, extend from it and
implement the build method which may execute arbitrary code to create a
scene.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
build()
This method does nothing, but may be overriden to create scenes procedurally.final void
Defines a camera with a given name.static SunflowAPI
Compile the specified code string via Janino.static SunflowAPI
Create an API object from the specified file.int
Read the value of the current frame.void
currentFrame
(int currentFrame) Set the value of the current frame.final void
Defines a geometry with a given name.final BoundingBox
Retrieve the bounding box of the scene.final boolean
Parse the specified filename.final void
Instance the specified geometry into the scene.final void
Defines a light source with a given name.final Geometry
lookupGeometry
(String name) Retrieve a geometry object by its name, ornull
if no geometry was found, or if the specified object is not a geometry.final Modifier
lookupModifier
(String name) Retrieve a modifier object by its name, ornull
if no modifier was found, or if the specified object is not a modifier.final Shader
lookupShader
(String name) Retrieve a shader object by its name, ornull
if no shader was found, or if the specified object is not a shader.final void
Defines a modifier with a given name.final void
Defines an option object to hold the current parameters.final void
Declare a parameter with the specified name and value.final void
Declare a parameter with the specified name and value.final void
Declare a parameter with the specified name and value.final void
Declare a parameter with the specified name and value.final void
Declare a parameter with the specified name and value.final void
Declare a parameter with the specified name and value.final void
Declare a color parameter in the given colorspace using the specified name and value.final void
Declare a parameter with the specified name.final void
Declare a parameter with the specified name and value.final void
Declare a parameter with the specified name and value.final void
Declare a parameter with the specified name and value.final void
Declare a parameter with the specified name and value.final void
Declare a plugin of the specified type with the given name from a java code string.void
Remove the specified render object.final void
Render using the specified options and the specified display.final void
reset()
Reset the state of the API completely.final String
resolveIncludeFilename
(String filename) Attempts to resolve the specified filename by checking it against the include search path.final String
resolveTextureFilename
(String filename) Attempts to resolve the specified filename by checking it against the texture search path.static void
This is a quick system test which verifies that the user has launched Java properly.final void
searchpath
(String type, String path) Add the specified path to the list of directories which are searched automatically to resolve scene filenames or textures.final void
Defines a shader with a given name.static boolean
Translate specfied file into the native sunflow scene file format.
-
Field Details
-
VERSION
- See Also:
-
DEFAULT_OPTIONS
- See Also:
-
-
Constructor Details
-
SunflowAPI
public SunflowAPI()Creates an empty scene.
-
-
Method Details
-
runSystemCheck
public static void runSystemCheck()This is a quick system test which verifies that the user has launched Java properly. -
reset
public final void reset()Description copied from interface:SunflowAPIInterface
Reset the state of the API completely. The object table is cleared, and all search paths are set back to their default values.- Specified by:
reset
in interfaceSunflowAPIInterface
-
plugin
Description copied from interface:SunflowAPIInterface
Declare a plugin of the specified type with the given name from a java code string. The code will be compiled with Janino and registered as a new plugin type upon success.- Specified by:
plugin
in interfaceSunflowAPIInterface
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a color parameter in the given colorspace using the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namecolorspace
- color space ornull
to assume internal color spacedata
- floating point color data
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name and value. This parameter will be added to the currently active parameter list.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter namevalue
- parameter value
-
parameter
Description copied from interface:SunflowAPIInterface
Declare a parameter with the specified name. The type may be one of the follow: "float", "point", "vector", "texcoord", "matrix". The interpolation determines how the parameter is to be interpreted over surface (seeParameterList.InterpolationType
). The data is specified in a flattened float array.- Specified by:
parameter
in interfaceSunflowAPIInterface
- Parameters:
name
- parameter nametype
- parameter data typeinterpolation
- parameter interpolation modedata
- raw floating point data
-
remove
Description copied from interface:SunflowAPIInterface
Remove the specified render object. Note that this may cause the removal of other objects which depended on it.- Specified by:
remove
in interfaceSunflowAPIInterface
- Parameters:
name
- name of the object to remove
-
searchpath
Description copied from interface:SunflowAPIInterface
Add the specified path to the list of directories which are searched automatically to resolve scene filenames or textures. Currently the supported searchpath types are: "include" and "texture". All other types will be ignored.- Specified by:
searchpath
in interfaceSunflowAPIInterface
-
resolveTextureFilename
Attempts to resolve the specified filename by checking it against the texture search path.- Parameters:
filename
- filename- Returns:
- a path which matches the filename, or filename if no matches are found
-
resolveIncludeFilename
Attempts to resolve the specified filename by checking it against the include search path.- Parameters:
filename
- filename- Returns:
- a path which matches the filename, or filename if no matches are found
-
shader
Description copied from interface:SunflowAPIInterface
Defines a shader with a given name. If the shader type name is leftnull
, the shader with the given name will be updated (if it exists).- Specified by:
shader
in interfaceSunflowAPIInterface
- Parameters:
name
- a unique name given to the shadershaderType
- a shader plugin type
-
modifier
Description copied from interface:SunflowAPIInterface
Defines a modifier with a given name. If the modifier type name is leftnull
, the modifier with the given name will be updated (if it exists).- Specified by:
modifier
in interfaceSunflowAPIInterface
- Parameters:
name
- a unique name given to the modifiermodifierType
- a modifier plugin type name
-
geometry
Description copied from interface:SunflowAPIInterface
Defines a geometry with a given name. The geometry is built from the specified type. Note that geometries may be created fromTesselatable
objects orPrimitiveList
objects. This means that two seperate plugin lists will be searched for the geometry type.Tesselatable
objects are search first. If the type name is leftnull
, the geometry with the given name will be updated (if it exists).- Specified by:
geometry
in interfaceSunflowAPIInterface
- Parameters:
name
- a unique name given to the geometrytypeName
- a tesselatable or primitive plugin type name
-
instance
Description copied from interface:SunflowAPIInterface
Instance the specified geometry into the scene. If geoname isnull
, the specified instance object will be updated (if it exists). In order to change the instancing relationship of an existing instance, you should use the "geometry" string attribute.- Specified by:
instance
in interfaceSunflowAPIInterface
- Parameters:
name
- instance namegeoname
- name of the geometry to instance
-
light
Description copied from interface:SunflowAPIInterface
Defines a light source with a given name. If the light type name is leftnull
, the light source with the given name will be updated (if it exists).- Specified by:
light
in interfaceSunflowAPIInterface
- Parameters:
name
- a unique name given to the light sourcelightType
- a light source plugin type name
-
camera
Description copied from interface:SunflowAPIInterface
Defines a camera with a given name. The camera is built from the specified camera lens type plugin. If the lens type name is leftnull
, the camera with the given name will be updated (if it exists). It is not currently possible to change the lens of a camera after it has been created.- Specified by:
camera
in interfaceSunflowAPIInterface
- Parameters:
name
- camera namelensType
- a camera lens plugin type name
-
options
Description copied from interface:SunflowAPIInterface
Defines an option object to hold the current parameters. If the object already exists, the values will simply override previous ones.- Specified by:
options
in interfaceSunflowAPIInterface
-
lookupGeometry
Retrieve a geometry object by its name, ornull
if no geometry was found, or if the specified object is not a geometry.- Parameters:
name
- geometry name- Returns:
- the geometry object associated with that name
-
lookupShader
Retrieve a shader object by its name, ornull
if no shader was found, or if the specified object is not a shader.- Parameters:
name
- shader name- Returns:
- the shader object associated with that name
-
lookupModifier
Retrieve a modifier object by its name, ornull
if no modifier was found, or if the specified object is not a modifier.- Parameters:
name
- modifier name- Returns:
- the modifier object associated with that name
-
render
Description copied from interface:SunflowAPIInterface
Render using the specified options and the specified display. If the specified options do not exist - defaults will be used.- Specified by:
render
in interfaceSunflowAPIInterface
- Parameters:
optionsName
- name of theRenderObject
which contains the optionsdisplay
- display object
-
include
Description copied from interface:SunflowAPIInterface
Parse the specified filename. The include paths are searched first. The contents of the file are simply added to the active scene. This allows to break up a scene into parts, even across file formats. The appropriate parser is chosen based on file extension.- Specified by:
include
in interfaceSunflowAPIInterface
- Parameters:
filename
- filename to load- Returns:
true
upon sucess,false
if an error occured.
-
getBounds
Retrieve the bounding box of the scene. This method will be valid only after a first call torender(String, Display)
has been made. -
build
public void build()This method does nothing, but may be overriden to create scenes procedurally. -
create
Create an API object from the specified file. Java files are read by Janino and are expected to implement a build method (they implement a derived class of SunflowAPI. The build method is called if the code compiles succesfully. Other files types are handled by the parse method.- Parameters:
filename
- filename to load- Returns:
- a valid SunflowAPI object or
null
on failure
-
translate
Translate specfied file into the native sunflow scene file format.- Parameters:
filename
- input filenameoutputFilename
- output filename- Returns:
true
upon success,false
otherwise
-
compile
Compile the specified code string via Janino. The code must implement a build method as described above. The build method is not called on the output, it is up the caller to do so.- Parameters:
code
- java code string- Returns:
- a valid SunflowAPI object upon succes,
null
otherwise.
-
currentFrame
public int currentFrame()Read the value of the current frame. This value is intended only for procedural animation creation. It is not used by the Sunflow core in anyway. The default value is 1.- Returns:
- current frame number
-
currentFrame
public void currentFrame(int currentFrame) Description copied from interface:SunflowAPIInterface
Set the value of the current frame. This value is intended only for procedural animation creation. It is not used by the Sunflow core in anyway. The default value is 1.- Specified by:
currentFrame
in interfaceSunflowAPIInterface
- Parameters:
currentFrame
- current frame number
-
getTextureCache
-