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

#include <vtkRIBExporter.h>

Inheritance diagram for vtkRIBExporter:

Collaboration diagram for vtkRIBExporter:

Public Types
typedef vtkExporter	Superclass

Public Types inherited from vtkExporter
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkRIBExporter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...


virtual void	SetSize (int, int)
	Specify the size of the image for RenderMan. More...

void	SetSize (int[2])
	Specify the size of the image for RenderMan. More...

virtual int *	GetSize ()
	Specify the size of the image for RenderMan. More...

virtual void	GetSize (int data[2])
	Specify the size of the image for RenderMan. More...


virtual void	SetPixelSamples (int, int)
	Specify the sampling rate for the rendering. More...

void	SetPixelSamples (int[2])
	Specify the sampling rate for the rendering. More...

virtual int *	GetPixelSamples ()
	Specify the sampling rate for the rendering. More...

virtual void	GetPixelSamples (int data[2])
	Specify the sampling rate for the rendering. More...


virtual void	SetFilePrefix (const char *)
	Specify the prefix of the files to write out. More...

virtual char *	GetFilePrefix ()
	Specify the prefix of the files to write out. More...


virtual void	SetTexturePrefix (const char *)
	Specify the prefix of any generated texture files. More...

virtual char *	GetTexturePrefix ()
	Specify the prefix of any generated texture files. More...


virtual void	SetBackground (int)
	Set/Get the background flag. More...

virtual int	GetBackground ()
	Set/Get the background flag. More...

virtual void	BackgroundOn ()
	Set/Get the background flag. More...

virtual void	BackgroundOff ()
	Set/Get the background flag. More...


virtual void	SetExportArrays (int)
	Set or get the ExportArrays. More...

virtual void	ExportArraysOn ()
	Set or get the ExportArrays. More...

virtual void	ExportArraysOff ()
	Set or get the ExportArrays. More...

virtual int	GetExportArrays ()
	Set or get the ExportArrays. More...

Public Member Functions inherited from vtkExporter
vtkExporter *	NewInstance () const

virtual void	Write ()
	Write data to output. More...

void	Update ()
	Convenient alias for Write() method. More...

void	SetStartWrite (void(f)(void ), void *arg)
	Specify a function to be called before data is written. More...

void	SetEndWrite (void(f)(void ), void *arg)
	Specify a function to be called after data is written. More...

void	SetStartWriteArgDelete (void(f)(void ))
	Set the arg delete method. More...

void	SetEndWriteArgDelete (void(f)(void ))
	Set the arg delete method. More...

vtkMTimeType	GetMTime ()
	Returns the MTime also considering the RenderWindow. More...

virtual void	SetRenderWindow (vtkRenderWindow *)
	Set/Get the rendering window that contains the scene to be written. More...

virtual vtkRenderWindow *	GetRenderWindow ()
	Set/Get the rendering window that contains the scene to be written. More...

void	SetInput (vtkRenderWindow *renWin)
	These methods are provided for backward compatibility. More...

vtkRenderWindow *	GetInput ()
	These methods are provided for backward compatibility. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkRIBExporter *	New ()

static int	IsTypeOf (const char *type)

static vtkRIBExporter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkExporter
static int	IsTypeOf (const char *type)

static vtkExporter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRIBExporter ()

	~vtkRIBExporter ()

void	WriteData ()

void	WriteActor (vtkActor *anActor)

void	ModifyArrayName (char newname, const char name)
	Since additional variables are sent to the shader as variables, and their names are used in the shader, these names have to follow C naming convention. More...

char *	GetTextureName (vtkTexture *aTexture)

char *	GetTIFFName (vtkTexture *aTexture)


void	WriteHeader (vtkRenderer *aRen)
	Write the RIB header. More...

void	WriteTrailer ()
	Write the RIB header. More...

void	WriteTexture (vtkTexture *aTexture)
	Write the RIB header. More...

void	WriteViewport (vtkRenderer *aRenderer, int size[2])
	Write the RIB header. More...

void	WriteCamera (vtkCamera *aCamera)
	Write the RIB header. More...

void	WriteLight (vtkLight *aLight, int count)
	Write the RIB header. More...

void	WriteAmbientLight (int count)
	Write the RIB header. More...

void	WriteProperty (vtkProperty aProperty, vtkTexture aTexture)
	Write the RIB header. More...

void	WritePolygons (vtkPolyData pd, vtkUnsignedCharArray colors, vtkProperty *aProperty)
	Write the RIB header. More...

void	WriteStrips (vtkPolyData pd, vtkUnsignedCharArray colors, vtkProperty *aProperty)
	Write the RIB header. More...

Protected Member Functions inherited from vtkExporter
	vtkExporter ()

	~vtkExporter ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Background

int	Size [2]

int	PixelSamples [2]

int	ExportArrays
	This variable defines whether the arrays are exported or not. More...

char *	FilePrefix

FILE *	FilePtr

char *	TexturePrefix

Protected Attributes inherited from vtkExporter
vtkRenderWindow *	RenderWindow

void(*	StartWrite )(void *)

void(*	StartWriteArgDelete )(void *)

void *	StartWriteArg

void(*	EndWrite )(void *)

void(*	EndWriteArgDelete )(void *)

void *	EndWriteArg

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

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.

See also: vtkExporter vtkRIBProperty vtkRIBLight

Tests:: vtkRIBExporter (Tests)

Definition at line 67 of file vtkRIBExporter.h.

Member Typedef Documentation

typedef vtkExporter vtkRIBExporter::Superclass

Definition at line 71 of file vtkRIBExporter.h.

Constructor & Destructor Documentation

vtkRIBExporter::vtkRIBExporter ( )

protected

vtkRIBExporter::~vtkRIBExporter ( )

protected

Member Function Documentation

static vtkRIBExporter* vtkRIBExporter::New ( )

static

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

static

virtual int vtkRIBExporter::IsA ( const char * name )

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.

static vtkRIBExporter* vtkRIBExporter::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkRIBExporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkExporter.

vtkRIBExporter* vtkRIBExporter::NewInstance ( ) const

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] )

Specify the size of the image for RenderMan.

If none is specified, the size of the render window will be used.

virtual int* vtkRIBExporter::GetSize ( )

virtual

Specify the size of the image for RenderMan.

If none is specified, the size of the render window will be used.

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

virtual

Specify the size of the image for RenderMan.

If none is specified, the size of the render window will be used.

virtual void vtkRIBExporter::SetPixelSamples	(	int	,
		int
	)

virtual

Specify the sampling rate for the rendering.

Default is 2 2.

void vtkRIBExporter::SetPixelSamples ( int [2] )

Specify the sampling rate for the rendering.

Default is 2 2.

virtual int* vtkRIBExporter::GetPixelSamples ( )

virtual

Specify the sampling rate for the rendering.

Default is 2 2.

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

virtual

Specify the sampling rate for the rendering.

Default is 2 2.

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

Specify the prefix of the files to write out.

The resulting file names will have .rib appended to them.

virtual void vtkRIBExporter::SetTexturePrefix ( const char * )

virtual

Specify the prefix of any generated texture files.

virtual char* vtkRIBExporter::GetTexturePrefix ( )

virtual

Specify the prefix of any generated texture files.

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

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 void vtkRIBExporter::BackgroundOn ( )

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 void vtkRIBExporter::BackgroundOff ( )

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 void vtkRIBExporter::SetExportArrays ( int )

virtual

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. Default is Off (0).

virtual void vtkRIBExporter::ExportArraysOn ( )

virtual

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. Default is Off (0).

virtual void vtkRIBExporter::ExportArraysOff ( )

virtual

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. Default is Off (0).

virtual int vtkRIBExporter::GetExportArrays ( )

virtual

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. Default is Off (0).

void vtkRIBExporter::WriteHeader ( vtkRenderer * aRen )

protected

Write the RIB header.

void vtkRIBExporter::WriteTrailer ( )

protected

Write the RIB header.

void vtkRIBExporter::WriteTexture ( vtkTexture * aTexture )

protected

Write the RIB header.

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

protected

Write the RIB header.

void vtkRIBExporter::WriteCamera ( vtkCamera * aCamera )

protected

Write the RIB header.

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

protected

Write the RIB header.

void vtkRIBExporter::WriteAmbientLight ( int count )

protected

Write the RIB header.

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

protected

Write the RIB header.

void vtkRIBExporter::WritePolygons	(	vtkPolyData *	pd,
		vtkUnsignedCharArray *	colors,
		vtkProperty *	aProperty
	)

protected

Write the RIB header.

void vtkRIBExporter::WriteStrips	(	vtkPolyData *	pd,
		vtkUnsignedCharArray *	colors,
		vtkProperty *	aProperty
	)

protected

Write the RIB header.

void vtkRIBExporter::WriteData ( )

protectedvirtual

Implements vtkExporter.

void vtkRIBExporter::WriteActor ( vtkActor * anActor )

protected

void vtkRIBExporter::ModifyArrayName	(	char *	newname,
		const char *	name
	)

protected

Since additional variables are sent to the shader as variables, and their names are used in the shader, these names have to follow C naming convention.

This method modifies array name so that you can use it in shader.

char* vtkRIBExporter::GetTextureName ( vtkTexture * aTexture )

protected

char* vtkRIBExporter::GetTIFFName ( vtkTexture * aTexture )

protected

Member Data Documentation

int vtkRIBExporter::Background

protected

Definition at line 146 of file vtkRIBExporter.h.

int vtkRIBExporter::Size[2]

protected

Definition at line 147 of file vtkRIBExporter.h.

int vtkRIBExporter::PixelSamples[2]

protected

Definition at line 148 of file vtkRIBExporter.h.

int vtkRIBExporter::ExportArrays

protected

This variable defines whether the arrays are exported or not.

Definition at line 153 of file vtkRIBExporter.h.

char* vtkRIBExporter::FilePrefix

protected

Definition at line 186 of file vtkRIBExporter.h.

FILE* vtkRIBExporter::FilePtr

protected

Definition at line 187 of file vtkRIBExporter.h.

char* vtkRIBExporter::TexturePrefix

protected

Definition at line 188 of file vtkRIBExporter.h.

The documentation for this class was generated from the following file:

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/IO/Export/vtkRIBExporter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation