VTK
9.4.20241112
|
export a scene into RenderMan RIB format. More...
#include <vtkRIBExporter.h>
Public Types | |
typedef vtkExporter | Superclass |
Public Types inherited from vtkExporter | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkRIBExporter * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | SetSize (int, int) |
Specify the size of the image for RenderMan. | |
void | SetSize (int[2]) |
Specify the size of the image for RenderMan. | |
virtual int * | GetSize () |
Specify the size of the image for RenderMan. | |
virtual void | GetSize (int data[2]) |
Specify the size of the image for RenderMan. | |
virtual void | SetPixelSamples (int, int) |
Specify the sampling rate for the rendering. | |
void | SetPixelSamples (int[2]) |
Specify the sampling rate for the rendering. | |
virtual int * | GetPixelSamples () |
Specify the sampling rate for the rendering. | |
virtual void | GetPixelSamples (int data[2]) |
Specify the sampling rate for the rendering. | |
vtkSetFilePathMacro (FilePrefix) | |
Specify the prefix of the files to write out. | |
vtkGetFilePathMacro (FilePrefix) | |
Specify the prefix of the files to write out. | |
virtual void | SetTexturePrefix (const char *) |
Specify the prefix of any generated texture files. | |
virtual char * | GetTexturePrefix () |
Specify the prefix of any generated texture files. | |
virtual void | SetBackground (vtkTypeBool) |
Set/Get the background flag. | |
virtual vtkTypeBool | GetBackground () |
Set/Get the background flag. | |
virtual void | BackgroundOn () |
Set/Get the background flag. | |
virtual void | BackgroundOff () |
Set/Get the background flag. | |
virtual void | SetExportArrays (vtkTypeBool) |
Set or get the ExportArrays. | |
virtual void | ExportArraysOn () |
Set or get the ExportArrays. | |
virtual void | ExportArraysOff () |
Set or get the ExportArrays. | |
virtual vtkTypeBool | GetExportArrays () |
Set or get the ExportArrays. | |
Public Member Functions inherited from vtkExporter | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkExporter * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual VTK_UNBLOCKTHREADS void | Write () |
Write data to output. | |
VTK_UNBLOCKTHREADS void | Update () |
Convenient alias for Write() method. | |
void | SetStartWrite (void(*f)(void *), void *arg) |
Specify a function to be called before data is written. | |
void | SetEndWrite (void(*f)(void *), void *arg) |
Specify a function to be called after data is written. | |
void | SetStartWriteArgDelete (void(*f)(void *)) |
Set the arg delete method. | |
void | SetEndWriteArgDelete (void(*f)(void *)) |
Set the arg delete method. | |
vtkMTimeType | GetMTime () override |
Returns the MTime also considering the RenderWindow. | |
virtual void | SetRenderWindow (vtkRenderWindow *) |
Set/Get the rendering window that contains the scene to be written. | |
virtual vtkRenderWindow * | GetRenderWindow () |
Set/Get the rendering window that contains the scene to be written. | |
virtual void | SetActiveRenderer (vtkRenderer *) |
Set/Get the renderer that contains actors to be written. | |
virtual vtkRenderer * | GetActiveRenderer () |
Set/Get the renderer that contains actors to be written. | |
void | SetInput (vtkRenderWindow *renWin) |
These methods are provided for backward compatibility. | |
vtkRenderWindow * | GetInput () |
These methods are provided for backward compatibility. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
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. | |
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. | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual std::string | GetObjectDescription () const |
The object description printed in messages and PrintSelf output. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. | |
Static Public Member Functions | |
static vtkRIBExporter * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkRIBExporter * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkExporter | |
static vtkTypeBool | 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. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static vtkTypeBool | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkRIBExporter () | |
~vtkRIBExporter () override | |
void | WriteData () override |
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. | |
char * | GetTextureName (vtkTexture *aTexture) |
char * | GetTIFFName (vtkTexture *aTexture) |
void | WriteHeader (vtkRenderer *aRen) |
Write the RIB header. | |
void | WriteTrailer () |
Write the RIB header. | |
void | WriteTexture (vtkTexture *aTexture) |
Write the RIB header. | |
void | WriteViewport (vtkRenderer *aRenderer, int size[2]) |
Write the RIB header. | |
void | WriteCamera (vtkCamera *aCamera) |
Write the RIB header. | |
void | WriteLight (vtkLight *aLight, int count) |
Write the RIB header. | |
void | WriteAmbientLight (int count) |
Write the RIB header. | |
void | WriteProperty (vtkProperty *aProperty, vtkTexture *aTexture) |
Write the RIB header. | |
void | WritePolygons (vtkPolyData *pd, vtkUnsignedCharArray *colors, vtkProperty *aProperty) |
Write the RIB header. | |
void | WriteStrips (vtkPolyData *pd, vtkUnsignedCharArray *colors, vtkProperty *aProperty) |
Write the RIB header. | |
Protected Member Functions inherited from vtkExporter | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkExporter () | |
~vtkExporter () override | |
virtual void | WriteData ()=0 |
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=nullptr) |
These methods allow a command to exclusively grab all events. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkTypeBool | Background |
int | Size [2] |
int | PixelSamples [2] |
vtkTypeBool | ExportArrays |
This variable defines whether the arrays are exported or not. | |
char * | FilePrefix |
FILE * | FilePtr |
char * | TexturePrefix |
Protected Attributes inherited from vtkExporter | |
vtkRenderWindow * | RenderWindow |
vtkRenderer * | ActiveRenderer |
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 |
std::string | ObjectName |
Protected Attributes inherited from vtkObjectBase | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 68 of file vtkRIBExporter.h.
Definition at line 72 of file vtkRIBExporter.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 |
|
protectedvirtual |
Reimplemented from vtkExporter.
vtkRIBExporter * vtkRIBExporter::NewInstance | ( | ) | const |
|
overridevirtual |
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 |
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 |
Specify the size of the image for RenderMan.
If none is specified, the size of the render window will be used.
|
virtual |
Specify the size of the image for RenderMan.
If none is specified, the size of the render window will be used.
|
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 |
Specify the sampling rate for the rendering.
Default is 2 2.
|
virtual |
Specify the sampling rate for the rendering.
Default is 2 2.
vtkRIBExporter::vtkSetFilePathMacro | ( | FilePrefix | ) |
Specify the prefix of the files to write out.
The resulting file names will have .rib appended to them.
vtkRIBExporter::vtkGetFilePathMacro | ( | FilePrefix | ) |
Specify the prefix of the files to write out.
The resulting file names will have .rib appended to them.
|
virtual |
Specify the prefix of any generated texture files.
|
virtual |
Specify the prefix of any generated texture files.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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).
|
protected |
Write the RIB header.
|
protected |
Write the RIB header.
|
protected |
Write the RIB header.
|
protected |
Write the RIB header.
|
protected |
Write the RIB header.
|
protected |
Write the RIB header.
|
protected |
Write the RIB header.
|
protected |
Write the RIB header.
|
protected |
Write the RIB header.
|
protected |
Write the RIB header.
|
overrideprotectedvirtual |
Implements vtkExporter.
|
protected |
|
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.
|
protected |
|
protected |
|
protected |
Definition at line 147 of file vtkRIBExporter.h.
|
protected |
Definition at line 148 of file vtkRIBExporter.h.
|
protected |
Definition at line 149 of file vtkRIBExporter.h.
|
protected |
This variable defines whether the arrays are exported or not.
Definition at line 154 of file vtkRIBExporter.h.
|
protected |
Definition at line 185 of file vtkRIBExporter.h.
|
protected |
Definition at line 186 of file vtkRIBExporter.h.
|
protected |
Definition at line 187 of file vtkRIBExporter.h.