Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkRIBExporter Class Reference

export a scene into RenderMan RIB format. More...

#include <vtkRIBExporter.h>

Inheritance diagram for vtkRIBExporter:

Inheritance graph
[legend]
Collaboration diagram for vtkRIBExporter:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetSize (int, int)
void SetSize (int[2])
virtual int * GetSize ()
virtual void GetSize (int data[2])
virtual void SetPixelSamples (int, int)
void SetPixelSamples (int[2])
virtual int * GetPixelSamples ()
virtual void GetPixelSamples (int data[2])
virtual void SetFilePrefix (const char *)
virtual char * GetFilePrefix ()
virtual void SetTexturePrefix (const char *)
virtual char * GetTexturePrefix ()
virtual void SetBackground (int)
virtual int GetBackground ()
virtual void BackgroundOn ()
virtual void BackgroundOff ()

Static Public Methods

vtkRIBExporter * New ()
int IsTypeOf (const char *type)
vtkRIBExporter * SafeDownCast (vtkObject *o)

Protected Methods

 vtkRIBExporter ()
 ~vtkRIBExporter ()
 vtkRIBExporter (const vtkRIBExporter &)
void operator= (const vtkRIBExporter &)
void WriteHeader (vtkRenderer *aRen)
void WriteTrailer ()
void WriteTexture (vtkTexture *aTexture)
void WriteViewport (vtkRenderer *aRenderer, int size[2])
void WriteCamera (vtkCamera *aCamera)
void WriteLight (vtkLight *aLight, int count)
void WriteAmbientLight (int count)
void WriteProperty (vtkProperty *aProperty, vtkTexture *aTexture)
void WritePolygons (vtkPolyData *pd, vtkScalars *colors, vtkProperty *aProperty)
void WriteStrips (vtkPolyData *pd, vtkScalars *colors, vtkProperty *aProperty)
void WriteData ()
void WriteActor (vtkActor *anActor)
char * GetTextureName (vtkTexture *aTexture)
char * GetTIFFName (vtkTexture *aTexture)

Protected Attributes

int Background
int Size [2]
int PixelSamples [2]
char * FilePrefix
FILE * FilePtr
char * TexturePrefix

Detailed Description

export a scene into RenderMan RIB format.

Date:
2000/12/10 20:08:26
Revision:
1.13

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.

See also:
vtkExporter vtkRIBProperty
Examples:
vtkRIBExporter (examples)

Definition at line 87 of file vtkRIBExporter.h.

Constructor & Destructor Documentation

vtkRIBExporter::vtkRIBExporter (    )  [protected]
 

vtkRIBExporter::~vtkRIBExporter (    )  [protected]
 

vtkRIBExporter::vtkRIBExporter (  const vtkRIBExporter &    )  [inline, protected]
 

Definition at line 133 of file vtkRIBExporter.h.

Member Function Documentation

vtkRIBExporter* vtkRIBExporter::New (    )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkRIBExporter::GetClassName (    )  [virtual]
 

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

Reimplemented from vtkExporter.

int vtkRIBExporter::IsTypeOf (  const char *    type )  [static]
 

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

Reimplemented from vtkExporter.

virtual int vtkRIBExporter::IsA (  const char *    type )  [virtual]
 

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkExporter.

vtkRIBExporter* vtkRIBExporter::SafeDownCast (  vtkObject *    o )  [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkExporter.

void vtkRIBExporter::PrintSelf (  ostream &    os,
vtkIndent    indent
)  [virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkExporter.

virtual void vtkRIBExporter::SetSize (  int   ,
int   
)  [virtual]
 

Specify the size of the image for RenderMan. If none is specified, the size of the render window will be used.

void vtkRIBExporter::SetSize (  int   [2] ) 
 

virtual int* vtkRIBExporter::GetSize (    )  [virtual]
 

virtual void vtkRIBExporter::GetSize (  int    data[2] )  [virtual]
 

virtual void vtkRIBExporter::SetPixelSamples (  int   ,
int   
)  [virtual]
 

Specify the sampling rate for the rendering. Default is 2 2.

void vtkRIBExporter::SetPixelSamples (  int   [2] ) 
 

virtual int* vtkRIBExporter::GetPixelSamples (    )  [virtual]
 

virtual void vtkRIBExporter::GetPixelSamples (  int    data[2] )  [virtual]
 

virtual void vtkRIBExporter::SetFilePrefix (  const char *    )  [virtual]
 

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

virtual char* vtkRIBExporter::GetFilePrefix (    )  [virtual]
 

virtual void vtkRIBExporter::SetTexturePrefix (  const char *    )  [virtual]
 

Specify the prefix of any generated texture files.

virtual char* vtkRIBExporter::GetTexturePrefix (    )  [virtual]
 

virtual void vtkRIBExporter::SetBackground (  int    )  [virtual]
 

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.

virtual int vtkRIBExporter::GetBackground (    )  [virtual]
 

virtual void vtkRIBExporter::BackgroundOn (    )  [virtual]
 

virtual void vtkRIBExporter::BackgroundOff (    )  [virtual]
 

void vtkRIBExporter::operator= (  const vtkRIBExporter &    )  [inline, protected]
 

Definition at line 134 of file vtkRIBExporter.h.

void vtkRIBExporter::WriteHeader (  vtkRenderer *    aRen )  [protected]
 

Write the RIB header.

void vtkRIBExporter::WriteTrailer (    )  [protected]
 

void vtkRIBExporter::WriteTexture (  vtkTexture *    aTexture )  [protected]
 

void vtkRIBExporter::WriteViewport (  vtkRenderer *    aRenderer,
int    size[2]
)  [protected]
 

void vtkRIBExporter::WriteCamera (  vtkCamera *    aCamera )  [protected]
 

void vtkRIBExporter::WriteLight (  vtkLight *    aLight,
int    count
)  [protected]
 

void vtkRIBExporter::WriteAmbientLight (  int    count )  [protected]
 

void vtkRIBExporter::WriteProperty (  vtkProperty *    aProperty,
vtkTexture *    aTexture
)  [protected]
 

void vtkRIBExporter::WritePolygons (  vtkPolyData *    pd,
vtkScalars *    colors,
vtkProperty *    aProperty
)  [protected]
 

void vtkRIBExporter::WriteStrips (  vtkPolyData *    pd,
vtkScalars *    colors,
vtkProperty *    aProperty
)  [protected]
 

void vtkRIBExporter::WriteData (    )  [protected, virtual]
 

Reimplemented from vtkExporter.

void vtkRIBExporter::WriteActor (  vtkActor *    anActor )  [protected]
 

char* vtkRIBExporter::GetTextureName (  vtkTexture *    aTexture )  [protected]
 

char* vtkRIBExporter::GetTIFFName (  vtkTexture *    aTexture )  [protected]
 

Member Data Documentation

int vtkRIBExporter::Background [protected]
 

Definition at line 136 of file vtkRIBExporter.h.

int vtkRIBExporter::Size[2] [protected]
 

Definition at line 137 of file vtkRIBExporter.h.

int vtkRIBExporter::PixelSamples[2] [protected]
 

Definition at line 138 of file vtkRIBExporter.h.

char* vtkRIBExporter::FilePrefix [protected]
 

Definition at line 155 of file vtkRIBExporter.h.

FILE* vtkRIBExporter::FilePtr [protected]
 

Definition at line 156 of file vtkRIBExporter.h.

char* vtkRIBExporter::TexturePrefix [protected]
 

Definition at line 157 of file vtkRIBExporter.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:59:52 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001