vtk
Class vtkRIBExporter

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkExporter
              vtk.vtkRIBExporter

All Implemented Interfaces:

java.io.Serializable

public class vtkRIBExporter

extends vtkExporter

implements java.io.Serializable

vtkRIBExporter - export a scene into RenderMan RIB format.. vtkRIBExporter is a concrete subclass of vtkExporter that writes a Renderman .RIB files. The input specifies a vtkRenderWindow. All visible actors and lights will be included in the rib file. The following file naming conventions apply: rib file - FilePrefix.rib image file created by RenderMan - FilePrefix.tif texture files - TexturePrefix_0xADDR_MTIME.tif This object does NOT generate an image file. The user must run either RenderMan or a RenderMan emulator like Blue Moon Ray Tracer (BMRT). vtk properties are convert to Renderman shaders as follows: Normal property, no texture map - plastic.sl Normal property with texture map - txtplastic.sl These two shaders must be compiled by the rendering package being used. vtkRIBExporter also supports custom shaders. The shaders are written using the Renderman Shading Language. See "The Renderman Companion", ISBN 0-201-50868, 1989 for details on writing shaders. vtkRIBProperty specifies the declarations and parameter settings for custom shaders. Tcl Example: generate a rib file for the current rendering. vtkRIBExporter myRIB myRIB SetInput $renWin myRIB SetFIlePrefix mine myRIB Write This will create a file mine.rib. After running this file through a Renderman renderer a file mine.tif will contain the rendered image. JavaBean wrapper for vtkRIBExporter object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

vtkExporter, Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkRIBExporter()
protected	vtkRIBExporter(int dmy)

Method Summary

void	backgroundOff() Set/Get the background flag.
void	backgroundOn() Set/Get the background flag.
void	exportArraysOff() Set or get the ExportArrays.
void	exportArraysOn() Set or get the ExportArrays.
int	getBackground() Set/Get the background flag.
java.lang.String	getClassName() Return the class name as a string.
int	getExportArrays() Set or get the ExportArrays.
int	getExportArraysMaxValue() Set or get the ExportArrays.
int	getExportArraysMinValue() Set or get the ExportArrays.
java.lang.String	getFilePrefix() Specify the prefix of the files to write out.
int[]	getPixelSamples()
int[]	getSize()
java.lang.String	getTexturePrefix() Specify the prefix of any generated texture files.
vtkRIBExporter	getThisRIBExporter()
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	setBackground(int id0) Set/Get the background flag.
void	setExportArrays(int id0) Set or get the ExportArrays.
void	setFilePrefix(java.lang.String id0) Specify the prefix of the files to write out.
void	setPixelSamples(int[] id0)
void	setPixelSamples(int id0, int id1)
void	setSize(int[] id0)
void	setSize(int id0, int id1)
void	setTexturePrefix(java.lang.String id0) Specify the prefix of any generated texture files.
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkExporter

getInput, getMTime, getRenderWindow, getThisExporter, setEndWrite, setInput, setRenderWindow, setStartWrite, update, write

Methods inherited from class vtk.vtkObject

AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay, unRegister

Methods inherited from class vtk.vtkObjectBase

addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete

Methods inherited from class java.lang.Object

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

Field Detail

changes

protected java.beans.PropertyChangeSupport changes

Constructor Detail

vtkRIBExporter

public vtkRIBExporter()

vtkRIBExporter

protected vtkRIBExporter(int dmy)

Method Detail

getThisRIBExporter

public vtkRIBExporter getThisRIBExporter()

getClassName

public java.lang.String getClassName()

Description copied from class: vtkObjectBase

Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

getClassName in class vtkExporter

isA

public int isA(java.lang.String id0)

Description copied from class: vtkObjectBase

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

isA in class vtkExporter

setSize

public void setSize(int id0,
                    int id1)

setSize

public void setSize(int[] id0)

getSize

public int[] getSize()

setPixelSamples

public void setPixelSamples(int id0,
                            int id1)

setPixelSamples

public void setPixelSamples(int[] id0)

getPixelSamples

public int[] getPixelSamples()

setFilePrefix

public void setFilePrefix(java.lang.String id0)

Specify the prefix of the files to write out. The resulting file names will have .RIB appended to them.

getFilePrefix

public java.lang.String getFilePrefix()

Specify the prefix of the files to write out. The resulting file names will have .RIB appended to them.

setTexturePrefix

public void setTexturePrefix(java.lang.String id0)

Specify the prefix of any generated texture files.

getTexturePrefix

public java.lang.String getTexturePrefix()

Specify the prefix of any generated texture files.

setBackground

public void setBackground(int id0)

Set/Get the background flag. Default is 0 (off). If set, the rib file will contain an image shader that will use the renderer window's background color. Normally, RenderMan does generate backgrounds. Backgrounds are composited into the scene with the tiffcomp program that comes with Pixar's RenderMan Toolkit. In fact, Pixar's Renderman will accept an image shader but only sets the alpha of the background. Images created this way will still have a black background but contain an alpha of 1 at all pixels and CANNOT be subsequently composited with other images using tiffcomp. However, other RenderMan compliant renderers like Blue Moon Ray Tracing (BMRT) do allow image shaders and properly set the background color. If this sounds too confusing, use the following rules: If you are using Pixar's Renderman, leave the Background off. Otherwise, try setting BackGroundOn and see if you get the desired results.

getBackground

public int getBackground()

Set/Get the background flag. Default is 0 (off). If set, the rib file will contain an image shader that will use the renderer window's background color. Normally, RenderMan does generate backgrounds. Backgrounds are composited into the scene with the tiffcomp program that comes with Pixar's RenderMan Toolkit. In fact, Pixar's Renderman will accept an image shader but only sets the alpha of the background. Images created this way will still have a black background but contain an alpha of 1 at all pixels and CANNOT be subsequently composited with other images using tiffcomp. However, other RenderMan compliant renderers like Blue Moon Ray Tracing (BMRT) do allow image shaders and properly set the background color. If this sounds too confusing, use the following rules: If you are using Pixar's Renderman, leave the Background off. Otherwise, try setting BackGroundOn and see if you get the desired results.

backgroundOn

public void backgroundOn()

Set/Get the background flag. Default is 0 (off). If set, the rib file will contain an image shader that will use the renderer window's background color. Normally, RenderMan does generate backgrounds. Backgrounds are composited into the scene with the tiffcomp program that comes with Pixar's RenderMan Toolkit. In fact, Pixar's Renderman will accept an image shader but only sets the alpha of the background. Images created this way will still have a black background but contain an alpha of 1 at all pixels and CANNOT be subsequently composited with other images using tiffcomp. However, other RenderMan compliant renderers like Blue Moon Ray Tracing (BMRT) do allow image shaders and properly set the background color. If this sounds too confusing, use the following rules: If you are using Pixar's Renderman, leave the Background off. Otherwise, try setting BackGroundOn and see if you get the desired results.

backgroundOff

public void backgroundOff()

Set/Get the background flag. Default is 0 (off). If set, the rib file will contain an image shader that will use the renderer window's background color. Normally, RenderMan does generate backgrounds. Backgrounds are composited into the scene with the tiffcomp program that comes with Pixar's RenderMan Toolkit. In fact, Pixar's Renderman will accept an image shader but only sets the alpha of the background. Images created this way will still have a black background but contain an alpha of 1 at all pixels and CANNOT be subsequently composited with other images using tiffcomp. However, other RenderMan compliant renderers like Blue Moon Ray Tracing (BMRT) do allow image shaders and properly set the background color. If this sounds too confusing, use the following rules: If you are using Pixar's Renderman, leave the Background off. Otherwise, try setting BackGroundOn and see if you get the desired results.

setExportArrays

public void setExportArrays(int id0)

Set or get the ExportArrays. If ExportArrays is set, then all point data, field data, and cell data arrays will get exported together with polygons.

getExportArraysMinValue

public int getExportArraysMinValue()

Set or get the ExportArrays. If ExportArrays is set, then all point data, field data, and cell data arrays will get exported together with polygons.

getExportArraysMaxValue

public int getExportArraysMaxValue()

Set or get the ExportArrays. If ExportArrays is set, then all point data, field data, and cell data arrays will get exported together with polygons.

exportArraysOn

public void exportArraysOn()

Set or get the ExportArrays. If ExportArrays is set, then all point data, field data, and cell data arrays will get exported together with polygons.

exportArraysOff

public void exportArraysOff()

Set or get the ExportArrays. If ExportArrays is set, then all point data, field data, and cell data arrays will get exported together with polygons.

getExportArrays

public int getExportArrays()

Set or get the ExportArrays. If ExportArrays is set, then all point data, field data, and cell data arrays will get exported together with polygons.

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkExporter