ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkRIBExporter Class Reference

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

Inheritance diagram for Kitware.VTK.vtkRIBExporter:
[legend]
Collaboration diagram for Kitware.VTK.vtkRIBExporter:
[legend]

List of all members.

Public Member Functions

 vtkRIBExporter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkRIBExporter ()
 Undocumented Block.
virtual 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.
virtual 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.
virtual 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.
virtual 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.
virtual 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.
virtual 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.
virtual 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.
virtual 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.
virtual string GetFilePrefix ()
 Specify the prefix of the files to write out. The resulting file names will have .RIB appended to them.
virtual int[] GetPixelSamples ()
 Description Specify the sampling rate for the rendering. Default is 2 2.
virtual void GetPixelSamples (IntPtr data)
 Description Specify the sampling rate for the rendering. Default is 2 2.
virtual int[] GetSize ()
 Description Specify the size of the image for RenderMan. If none is specified, the size of the render window will be used.
virtual void GetSize (IntPtr data)
 Description Specify the size of the image for RenderMan. If none is specified, the size of the render window will be used.
virtual string GetTexturePrefix ()
 Specify the prefix of any generated texture files.
override int IsA (string type)
 Undocumented Block.
new vtkRIBExporter NewInstance ()
 Undocumented Block.
virtual void SetBackground (int _arg)
 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 SetExportArrays (int _arg)
 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.
virtual void SetFilePrefix (string _arg)
 Specify the prefix of the files to write out. The resulting file names will have .RIB appended to them.
virtual void SetPixelSamples (int _arg1, int _arg2)
 Description Specify the sampling rate for the rendering. Default is 2 2.
void SetPixelSamples (IntPtr _arg)
 Description Specify the sampling rate for the rendering. Default is 2 2.
virtual void SetSize (int _arg1, int _arg2)
 Description Specify the size of the image for RenderMan. If none is specified, the size of the render window will be used.
void SetSize (IntPtr _arg)
 Description Specify the size of the image for RenderMan. If none is specified, the size of the render window will be used.
virtual void SetTexturePrefix (string _arg)
 Specify the prefix of any generated texture files.

Static Public Member Functions

static new vtkRIBExporter New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkRIBExporter SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkRIBExporter"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkRIBExporter"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkRIBExporter_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkRIBExporter_BackgroundOff_01 (HandleRef pThis)
static internal void vtkRIBExporter_BackgroundOn_02 (HandleRef pThis)
static internal void vtkRIBExporter_ExportArraysOff_03 (HandleRef pThis)
static internal void vtkRIBExporter_ExportArraysOn_04 (HandleRef pThis)
static internal int vtkRIBExporter_GetBackground_05 (HandleRef pThis)
static internal int vtkRIBExporter_GetExportArrays_06 (HandleRef pThis)
static internal int vtkRIBExporter_GetExportArraysMaxValue_07 (HandleRef pThis)
static internal int vtkRIBExporter_GetExportArraysMinValue_08 (HandleRef pThis)
static internal IntPtr vtkRIBExporter_GetFilePrefix_09 (HandleRef pThis)
static internal IntPtr vtkRIBExporter_GetPixelSamples_10 (HandleRef pThis)
static internal void vtkRIBExporter_GetPixelSamples_11 (HandleRef pThis, IntPtr data)
static internal IntPtr vtkRIBExporter_GetSize_12 (HandleRef pThis)
static internal void vtkRIBExporter_GetSize_13 (HandleRef pThis, IntPtr data)
static internal IntPtr vtkRIBExporter_GetTexturePrefix_14 (HandleRef pThis)
static internal int vtkRIBExporter_IsA_15 (HandleRef pThis, string type)
static internal int vtkRIBExporter_IsTypeOf_16 (string type)
static internal IntPtr vtkRIBExporter_NewInstance_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkRIBExporter_SafeDownCast_19 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkRIBExporter_SetBackground_20 (HandleRef pThis, int _arg)
static internal void vtkRIBExporter_SetExportArrays_21 (HandleRef pThis, int _arg)
static internal void vtkRIBExporter_SetFilePrefix_22 (HandleRef pThis, string _arg)
static internal void vtkRIBExporter_SetPixelSamples_23 (HandleRef pThis, int _arg1, int _arg2)
static internal void vtkRIBExporter_SetPixelSamples_24 (HandleRef pThis, IntPtr _arg)
static internal void vtkRIBExporter_SetSize_25 (HandleRef pThis, int _arg1, int _arg2)
static internal void vtkRIBExporter_SetSize_26 (HandleRef pThis, IntPtr _arg)
static internal void vtkRIBExporter_SetTexturePrefix_27 (HandleRef pThis, string _arg)

Static Private Member Functions

static vtkRIBExporter ()
 Automatically generated type registration mechanics.

Detailed Description

vtkRIBExporter - export a scene into RenderMan RIB format.

Description 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.

vtkExporter vtkRIBProperty


Constructor & Destructor Documentation

static Kitware.VTK.vtkRIBExporter.vtkRIBExporter ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkRIBExporter.vtkRIBExporter ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

virtual void Kitware.VTK.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 Kitware.VTK.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.

override void Kitware.VTK.vtkRIBExporter.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkExporter.

virtual void Kitware.VTK.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.

virtual void Kitware.VTK.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.

virtual int Kitware.VTK.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 int Kitware.VTK.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.

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.

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.

virtual string Kitware.VTK.vtkRIBExporter.GetFilePrefix ( ) [virtual]

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

virtual int [] Kitware.VTK.vtkRIBExporter.GetPixelSamples ( ) [virtual]

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

virtual void Kitware.VTK.vtkRIBExporter.GetPixelSamples ( IntPtr  data) [virtual]

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

virtual int [] Kitware.VTK.vtkRIBExporter.GetSize ( ) [virtual]

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

virtual void Kitware.VTK.vtkRIBExporter.GetSize ( IntPtr  data) [virtual]

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

virtual string Kitware.VTK.vtkRIBExporter.GetTexturePrefix ( ) [virtual]

Specify the prefix of any generated texture files.

override int Kitware.VTK.vtkRIBExporter.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkExporter.

static new int Kitware.VTK.vtkRIBExporter.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkExporter.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkExporter.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkExporter.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkRIBExporter.SetBackground ( int  _arg) [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 Kitware.VTK.vtkRIBExporter.SetExportArrays ( int  _arg) [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.

virtual void Kitware.VTK.vtkRIBExporter.SetFilePrefix ( string  _arg) [virtual]

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

virtual void Kitware.VTK.vtkRIBExporter.SetPixelSamples ( int  _arg1,
int  _arg2 
) [virtual]

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

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

virtual void Kitware.VTK.vtkRIBExporter.SetSize ( int  _arg1,
int  _arg2 
) [virtual]

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

void Kitware.VTK.vtkRIBExporter.SetSize ( IntPtr  _arg)

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

virtual void Kitware.VTK.vtkRIBExporter.SetTexturePrefix ( string  _arg) [virtual]

Specify the prefix of any generated texture files.

static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_BackgroundOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_BackgroundOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_ExportArraysOff_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_ExportArraysOn_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetBackground_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetExportArrays_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetExportArraysMaxValue_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetExportArraysMinValue_08 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetFilePrefix_09 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetPixelSamples_10 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetPixelSamples_11 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal IntPtr Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetSize_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetSize_13 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal IntPtr Kitware.VTK.vtkRIBExporter.vtkRIBExporter_GetTexturePrefix_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkRIBExporter.vtkRIBExporter_IsA_15 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkRIBExporter.vtkRIBExporter_IsTypeOf_16 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkRIBExporter.vtkRIBExporter_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkRIBExporter.vtkRIBExporter_NewInstance_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkRIBExporter.vtkRIBExporter_SafeDownCast_19 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_SetBackground_20 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_SetExportArrays_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_SetFilePrefix_22 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_SetPixelSamples_23 ( HandleRef  pThis,
int  _arg1,
int  _arg2 
) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_SetPixelSamples_24 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_SetSize_25 ( HandleRef  pThis,
int  _arg1,
int  _arg2 
) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_SetSize_26 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkRIBExporter.vtkRIBExporter_SetTexturePrefix_27 ( HandleRef  pThis,
string  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkRIBExporter.MRClassNameKey = "14vtkRIBExporter" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkExporter.

new const string Kitware.VTK.vtkRIBExporter.MRFullTypeName = "Kitware.VTK.vtkRIBExporter"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkExporter.


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