Module pov.ray

Package de.grogra.ext.povray

Class POVExport

java.lang.Object

de.grogra.pf.io.FilterBase

de.grogra.imp3d.io.SceneGraphExport

de.grogra.ext.povray.POVExport

All Implemented Interfaces:

SceneTree.Visitor, FileWriterSource, Filter, FilterSource, WriterSource, RegistryContext, Map

public class POVExport
extends SceneGraphExport
implements FileWriterSource, WriterSource

Nested Class Summary

Nested classes/interfaces inherited from class de.grogra.imp3d.io.SceneGraphExport

SceneGraphExport.NodeExport, SceneGraphExport.ObjectExport

Nested classes/interfaces inherited from interface de.grogra.pf.io.FilterSource

FilterSource.MetaDataKey<V>

Nested classes/interfaces inherited from interface de.grogra.util.Map

Map.Chain

Field Summary

Fields

Modifier and Type	Field	Description
static final FilterSource.MetaDataKey<Float>	ASPECT
static final FilterSource.MetaDataKey<Float>	FLATNESS
static final IOFlavor	FLAVOR
static final FilterSource.MetaDataKey<Boolean>	LAYERS
static final MimeType	MIME_TYPE
final PolygonArray	polygons
final Pool	pool
static final FilterSource.MetaDataKey<Boolean>	TEMPORARY

Fields inherited from class de.grogra.pf.io.FilterBase

item, source

Fields inherited from interface de.grogra.pf.io.FilterSource

AUTO_PROGRESS, DESTINATION_FILE, DESTINATION_URL

Fields inherited from interface de.grogra.util.Map

DEFAULT_VALUE, EMPTY_MAP

Constructor Summary

Constructors

Constructor	Description
POVExport(FilterItem item, FilterSource source)

Method Summary

Modifier and Type	Method	Description
protected void	beginGroup(SceneTree.InnerNode group)	This method is invoked at the beginning of every inner node group which has more than one child.
protected SceneTree	createSceneTree(View3D scene)	The implementation of this method creates the scene tree which is to be exported by this export.
String	declareObject(Object object, String name)
protected void	endGroup(SceneTree.InnerNode group)	This method is invoked at the end of every inner node group which has more than one child.
static void	export(Context ctx, String file)
boolean	export(Object object)	This method is invoked for some attribute value in order to export the value.
boolean	export(Object object, String type)
void	exportPolygons()
String	getDeclaredName(Object object)
SceneGraphExport.NodeExport	getExportFor(Object object, boolean asNode)	This method is used to obtain an instance of NodeExport capable of exporting the object of a SceneTree.Leaf.
Object	getFile(String name)	This method creates a file in SceneGraphExport.getDirectory().
String	getObjectType(String type)
protected Object	initDirectory()	Determines the directory to use.
protected FileSystem	initFileSystem()	Determines the file system to use.
protected void	write()	Exports the scene of the view.
void	write(File out)	This method writes the data to out.
void	write(Writer w)	This method writes the data to out.

Methods inherited from class de.grogra.imp3d.io.SceneGraphExport

export, getDirectory, getExportForObject, getFiles, getFileSystem, getGraphState, getOutputStream, getPath, getPath, getView, visit, visitEnter, visitLeave

Methods inherited from class de.grogra.pf.io.FilterBase

get, getFilter, getFlavor, getImpl, getMetaData, getRegistry, getSource, getSystemId, initProgressMonitor, setFlavor, setMetaData, setMetaData, setProgress, setSystemId, toString, toURL

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.grogra.pf.io.FilterSource

getFilter, getFlavor, getMetaData, getSystemId, initProgressMonitor, setMetaData, setProgress

Methods inherited from interface de.grogra.pf.registry.RegistryContext

getRegistry

Field Details

FLATNESS

public static final FilterSource.MetaDataKey<Float> FLATNESS

LAYERS

public static final FilterSource.MetaDataKey<Boolean> LAYERS

ASPECT

public static final FilterSource.MetaDataKey<Float> ASPECT

TEMPORARY

public static final FilterSource.MetaDataKey<Boolean> TEMPORARY

pool

public final Pool pool

MIME_TYPE

public static final MimeType MIME_TYPE

FLAVOR

public static final IOFlavor FLAVOR

polygons

public final PolygonArray polygons

Constructor Details

POVExport

public POVExport(FilterItem item,
 FilterSource source)

Method Details

createSceneTree

protected SceneTree createSceneTree(View3D scene)

Description copied from class: SceneGraphExport

The implementation of this method creates the scene tree which is to be exported by this export.

Specified by:

createSceneTree in class SceneGraphExport

Parameters:

scene - the view which defines the scene to export

Returns:

scene tree for the view

beginGroup

protected void beginGroup(SceneTree.InnerNode group)
                   throws IOException

Description copied from class: SceneGraphExport

This method is invoked at the beginning of every inner node group which has more than one child. Its children will be processed until the corresponding method SceneGraphExport.endGroup(de.grogra.imp3d.objects.SceneTree.InnerNode) is invoked. The export should write the hierarchy and transformation information of the group.

Specified by:

beginGroup in class SceneGraphExport

Parameters:

group - the group

Throws:

IOException

endGroup

protected void endGroup(SceneTree.InnerNode group)
                 throws IOException

Description copied from class: SceneGraphExport

This method is invoked at the end of every inner node group which has more than one child. Its children have been processed completely.

Specified by:

endGroup in class SceneGraphExport

Parameters:

group - the group

Throws:

IOException

See Also:

• SceneGraphExport.beginGroup(de.grogra.imp3d.objects.SceneTree.InnerNode)

initFileSystem

protected FileSystem initFileSystem()
                             throws IOException

Description copied from class: SceneGraphExport

Determines the file system to use. This method is invoked once by SceneGraphExport.getFileSystem().

Overrides:

initFileSystem in class SceneGraphExport

Returns:

file system to use

Throws:

IOException

initDirectory

protected Object initDirectory()
                        throws IOException

Description copied from class: SceneGraphExport

Determines the directory to use. This method is invoked once by SceneGraphExport.getDirectory().

Overrides:

initDirectory in class SceneGraphExport

Returns:

directory to use

Throws:

IOException

getFile

public Object getFile(String name)
               throws IOException

Description copied from class: SceneGraphExport

This method creates a file in SceneGraphExport.getDirectory(). The file name is based ob name: E.g., if name is test.png, the actual name could be something like test123.png. It is ensured that no file will be returned twice during a single export.

Overrides:

getFile in class SceneGraphExport

Parameters:

name - name for file

Returns:

file

Throws:

IOException

write

protected void write()
              throws IOException

Description copied from class: SceneGraphExport

Exports the scene of the view. This method at first creates the scene tree using SceneGraphExport.createSceneTree(View3D), then it lets this export instance visit the created scene tree. During visit, the methods SceneGraphExport.beginGroup(de.grogra.imp3d.objects.SceneTree.InnerNode), SceneGraphExport.endGroup(de.grogra.imp3d.objects.SceneTree.InnerNode) and SceneGraphExport.export(SceneTree.Leaf, SceneTree.InnerNode) are invoked; these have to be implemented to perform the actual export to the destination.

Overrides:

write in class SceneGraphExport

Throws:

IOException

write

public void write(File out)
           throws IOException

Description copied from interface: FileWriterSource

This method writes the data to out.

Specified by:

write in interface FileWriterSource

Parameters:

out - the file to which data is written

Throws:

IOException

write

public void write(Writer w)
           throws IOException

Description copied from interface: WriterSource

This method writes the data to out.

Specified by:

write in interface WriterSource

Parameters:

w - the writer to which data is written

Throws:

IOException

getDeclaredName

public String getDeclaredName(Object object)

declareObject

public String declareObject(Object object,
 String name)

exportPolygons

public void exportPolygons()
                    throws IOException

Throws:

IOException

export

public boolean export(Object object,
 String type)
               throws IOException

Throws:

IOException

export

public boolean export(Object object)
               throws IOException

Description copied from class: SceneGraphExport

This method is invoked for some attribute value in order to export the value.

This implementation obtains an SceneGraphExport.ObjectExport via SceneGraphExport.getExportForObject(Object) and, if successful, uses this to export the value.

Overrides:

export in class SceneGraphExport

Parameters:

object - object to export

Throws:

IOException

getObjectType

public String getObjectType(String type)

getExportFor

public SceneGraphExport.NodeExport getExportFor(Object object,
 boolean asNode)

Description copied from class: SceneGraphExport

This method is used to obtain an instance of NodeExport capable of exporting the object of a SceneTree.Leaf. If no such export is defined, null is returned.

This implementation looks for an export defined in the registry: As name, the name of the class of object is chosen, the export is searched as a child of FilterBase.item.

Overrides:

getExportFor in class SceneGraphExport

Parameters:

object - object of the original scene graph

asNode - is object a node or an edge?

Returns:

suitable export for the object or null

export

public static void export(Context ctx,
 String file)