VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkOBJExporter Class Reference

export a scene into Wavefront format. More...

#include <vtkOBJExporter.h>

Inheritance diagram for vtkOBJExporter:
[legend]
Collaboration diagram for vtkOBJExporter:
[legend]

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. More...
 
vtkOBJExporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetFilePrefix (const char *)
 Specify the prefix of the files to write out. More...
 
virtual char * GetFilePrefix ()
 
virtual void SetOBJFileComment (const char *)
 Specify comment string that will be written to the obj file header. More...
 
virtual char * GetOBJFileComment ()
 
virtual void SetMTLFileComment (const char *)
 Specify comment string that will be written to the mtl file header. More...
 
virtual char * GetMTLFileComment ()
 
- Public Member Functions inherited from vtkExporter
vtkExporterNewInstance () const
 
virtual void Write ()
 Write data to output. More...
 
void Update ()
 Convenient alias for Write() method. More...
 
virtual void SetRenderWindow (vtkRenderWindow *)
 Set/Get the rendering window that contains the scene to be written. More...
 
virtual vtkRenderWindowGetRenderWindow ()
 
virtual void SetActiveRenderer (vtkRenderer *)
 Set/Get the renderer that contains actors to be written. More...
 
virtual vtkRendererGetActiveRenderer ()
 
void SetInput (vtkRenderWindow *renWin)
 These methods are provided for backward compatibility. More...
 
vtkRenderWindowGetInput ()
 
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 () override
 Returns the MTime also considering the RenderWindow. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkOBJExporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOBJExporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkExporter
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOBJExporter ()
 
 ~vtkOBJExporter () override
 
void WriteData () override
 
void WriteAnActor (vtkActor *anActor, std::ofstream &fpObj, std::ofstream &fpMat, std::string &modelName, int &id)
 
- Protected Member Functions inherited from vtkExporter
 vtkExporter ()
 
 ~vtkExporter () override
 
- 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. More...
 
void InternalReleaseFocus ()
 
- 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

char * FilePrefix
 
char * OBJFileComment
 
char * MTLFileComment
 
bool FlipTexture
 
std::map< std::string, vtkTexture * > TextureFileMap
 
- Protected Attributes inherited from vtkExporter
vtkRenderWindowRenderWindow
 
vtkRendererActiveRenderer
 
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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

export a scene into Wavefront format.

vtkOBJExporter is a concrete subclass of vtkExporter that writes wavefront .OBJ files in ASCII form. It also writes out a mtl file that contains the material properties. The filenames are derived by appending the .obj and .mtl suffix onto the user specified FilePrefix.

See also
vtkExporter
Tests:
vtkOBJExporter (Tests)

Definition at line 43 of file vtkOBJExporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkOBJExporter.h.

Constructor & Destructor Documentation

◆ vtkOBJExporter()

vtkOBJExporter::vtkOBJExporter ( )
protected

◆ ~vtkOBJExporter()

vtkOBJExporter::~vtkOBJExporter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOBJExporter* vtkOBJExporter::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkOBJExporter::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkOBJExporter::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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOBJExporter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkExporter.

◆ NewInstance()

vtkOBJExporter* vtkOBJExporter::NewInstance ( ) const

◆ PrintSelf()

void vtkOBJExporter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

◆ SetFilePrefix()

virtual void vtkOBJExporter::SetFilePrefix ( const char *  )
virtual

Specify the prefix of the files to write out.

The resulting filenames will have .obj and .mtl appended to them.

◆ GetFilePrefix()

virtual char* vtkOBJExporter::GetFilePrefix ( )
virtual

◆ SetOBJFileComment()

virtual void vtkOBJExporter::SetOBJFileComment ( const char *  )
virtual

Specify comment string that will be written to the obj file header.

◆ GetOBJFileComment()

virtual char* vtkOBJExporter::GetOBJFileComment ( )
virtual

◆ SetMTLFileComment()

virtual void vtkOBJExporter::SetMTLFileComment ( const char *  )
virtual

Specify comment string that will be written to the mtl file header.

◆ GetMTLFileComment()

virtual char* vtkOBJExporter::GetMTLFileComment ( )
virtual

◆ WriteData()

void vtkOBJExporter::WriteData ( )
overrideprotectedvirtual

Implements vtkExporter.

◆ WriteAnActor()

void vtkOBJExporter::WriteAnActor ( vtkActor anActor,
std::ofstream &  fpObj,
std::ofstream &  fpMat,
std::string &  modelName,
int id 
)
protected

Member Data Documentation

◆ FilePrefix

char* vtkOBJExporter::FilePrefix
protected

Definition at line 85 of file vtkOBJExporter.h.

◆ OBJFileComment

char* vtkOBJExporter::OBJFileComment
protected

Definition at line 86 of file vtkOBJExporter.h.

◆ MTLFileComment

char* vtkOBJExporter::MTLFileComment
protected

Definition at line 87 of file vtkOBJExporter.h.

◆ FlipTexture

bool vtkOBJExporter::FlipTexture
protected

Definition at line 88 of file vtkOBJExporter.h.

◆ TextureFileMap

std::map<std::string, vtkTexture *> vtkOBJExporter::TextureFileMap
protected

Definition at line 89 of file vtkOBJExporter.h.


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