org.scijava.java3d.loaders

Interface Loader

All Known Implementing Classes:

LoaderBase, Lw3dLoader, ObjectFile

public interface Loader

The Loader interface is used to specify the location and elements of a file format to load. The interface is used to give loaders of various file formats a common public interface. Ideally the Scene interface will be implemented to give the user a consistent interface to extract the data.

See Also:

Scene

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOAD_ALL This flag enables the loading of all objects into the scene.
static int	LOAD_BACKGROUND_NODES This flag enables the loading of background objects into the scene.
static int	LOAD_BEHAVIOR_NODES This flag enables the loading of behaviors into the scene.
static int	LOAD_FOG_NODES This flag enables the loading of fog objects into the scene.
static int	LOAD_LIGHT_NODES This flag enables the loading of light objects into the scene.
static int	LOAD_SOUND_NODES This flag enables the loading of sound objects into the scene.
static int	LOAD_VIEW_GROUPS This flag enables the loading of view (camera) objects into the scene.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBasePath() Returns the current base path setting.
URL	getBaseUrl() Returns the current base URL setting.
int	getFlags() Returns the current loading flags setting.
Scene	load(Reader reader) This method loads the Reader and returns the Scene containing the scene.
Scene	load(String fileName) This method loads the named file and returns the Scene containing the scene.
Scene	load(URL url) This method loads the named file and returns the Scene containing the scene.
void	setBasePath(String pathName) This method sets the base path name for data files associated with the file passed into the load(String) method.
void	setBaseUrl(URL url) This method sets the base URL name for data files associated with the file passed into the load(URL) method.
void	setFlags(int flags) This method sets the load flags for the file.

Field Detail

LOAD_LIGHT_NODES

static final int LOAD_LIGHT_NODES

This flag enables the loading of light objects into the scene.

See Also:

Constant Field Values

LOAD_FOG_NODES

static final int LOAD_FOG_NODES

This flag enables the loading of fog objects into the scene.

See Also:

Constant Field Values

LOAD_BACKGROUND_NODES

static final int LOAD_BACKGROUND_NODES

This flag enables the loading of background objects into the scene.

See Also:

Constant Field Values

LOAD_BEHAVIOR_NODES

static final int LOAD_BEHAVIOR_NODES

This flag enables the loading of behaviors into the scene.

See Also:

Constant Field Values

LOAD_VIEW_GROUPS

static final int LOAD_VIEW_GROUPS

This flag enables the loading of view (camera) objects into the scene.

See Also:

Constant Field Values

LOAD_SOUND_NODES

static final int LOAD_SOUND_NODES

This flag enables the loading of sound objects into the scene.

See Also:

Constant Field Values

LOAD_ALL

static final int LOAD_ALL

This flag enables the loading of all objects into the scene.

See Also:

Constant Field Values

Method Detail

load

Scene load(String fileName)
           throws FileNotFoundException,
                  IncorrectFormatException,
                  ParsingErrorException

This method loads the named file and returns the Scene containing the scene. Any data files referenced by this file should be located in the same place as the named file; otherwise users should specify an alternate base path with the setBasePath(String) method.

Throws:

FileNotFoundException

IncorrectFormatException

ParsingErrorException

load

Scene load(URL url)
           throws FileNotFoundException,
                  IncorrectFormatException,
                  ParsingErrorException

This method loads the named file and returns the Scene containing the scene. Any data files referenced by the Reader should be located in the same place as the named file; otherwise, users should specify an alternate base path with the setBaseUrl(URL) method.

Throws:

FileNotFoundException

IncorrectFormatException

ParsingErrorException

load

Scene load(Reader reader)
           throws FileNotFoundException,
                  IncorrectFormatException,
                  ParsingErrorException

This method loads the Reader and returns the Scene containing the scene. Any data files referenced by the Reader should be located in the user's current working directory.

Throws:

FileNotFoundException

IncorrectFormatException

ParsingErrorException

setBaseUrl

void setBaseUrl(URL url)

This method sets the base URL name for data files associated with the file passed into the load(URL) method. The basePath should be null by default, which is an indicator to the loader that it should look for any associated files starting from the same directory as the file passed into the load(URL) method.

setBasePath

void setBasePath(String pathName)

This method sets the base path name for data files associated with the file passed into the load(String) method. The basePath should be null by default, which is an indicator to the loader that it should look for any associated files starting from the same directory as the file passed into the load(String) method.

getBaseUrl

URL getBaseUrl()

Returns the current base URL setting. By default this is null, implying the loader should look for associated files starting from the same directory as the file passed into the load(URL) method.

getBasePath

String getBasePath()

Returns the current base path setting. By default this is null, implying the loader should look for associated files starting from the same directory as the file passed into the load(String) method.

setFlags

void setFlags(int flags)

This method sets the load flags for the file. The flags should equal 0 by default (which tells the loader to only load geometry). To enable the loading of any particular scene elements, pass in a logical OR of the LOAD values specified above.

getFlags

int getFlags()

Returns the current loading flags setting.