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

export a scene into GLTF 2.0 format. More...

#include <vtkGLTFExporter.h>

Inheritance diagram for vtkGLTFExporter:
[legend]
Collaboration diagram for vtkGLTFExporter:
[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...
 
vtkGLTFExporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
std::string WriteToString ()
 Write the result to a string instead of a file. More...
 
void WriteToStream (ostream &out)
 Write the result to a provided ostream. More...
 
 vtkSetFilePathMacro (FileName)
 Specify the name of the GLTF file to write. More...
 
 vtkGetFilePathMacro (FileName)
 Specify the name of the GLTF file to write. More...
 
virtual bool GetInlineData ()
 Should the binary data be included in the json file as a base64 string. More...
 
virtual void SetInlineData (bool)
 Should the binary data be included in the json file as a base64 string. More...
 
virtual void InlineDataOn ()
 Should the binary data be included in the json file as a base64 string. More...
 
virtual void InlineDataOff ()
 Should the binary data be included in the json file as a base64 string. More...
 
virtual bool GetSaveNormal ()
 It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found. More...
 
virtual void SetSaveNormal (bool)
 It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found. More...
 
virtual void SaveNormalOn ()
 It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found. More...
 
virtual void SaveNormalOff ()
 It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found. More...
 
virtual bool GetSaveBatchId ()
 It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found. More...
 
virtual void SetSaveBatchId (bool)
 It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found. More...
 
virtual void SaveBatchIdOn ()
 It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found. More...
 
virtual void SaveBatchIdOff ()
 It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found. More...
 
- Public Member Functions inherited from vtkExporter
vtkExporterNewInstance () 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 () override
 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 vtkRenderWindowGetRenderWindow ()
 Set/Get the rendering window that contains the scene to be written. More...
 
virtual void SetActiveRenderer (vtkRenderer *)
 Set/Get the renderer that contains actors to be written. More...
 
virtual vtkRendererGetActiveRenderer ()
 Set/Get the renderer that contains actors to be written. More...
 
void SetInput (vtkRenderWindow *renWin)
 These methods are provided for backward compatibility. More...
 
vtkRenderWindowGetInput ()
 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 ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkGLTFExporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGLTFExporterSafeDownCast (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 ()
 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGLTFExporter ()
 
 ~vtkGLTFExporter () override
 
void WriteData () override
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * FileName
 
bool InlineData
 
bool SaveNormal
 
bool SaveBatchId
 
- 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
 
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 ()
 

Detailed Description

export a scene into GLTF 2.0 format.

vtkGLTFExporter is a concrete subclass of vtkExporter that writes GLTF 2.0 files. It currently only supports a very small subset of what VTK can do including polygonal meshes with optional vertex colors. Over time the class can be expanded to support more and more of what VTK renders.

It should be noted that gltf is a format for rendering data. As such it stores what the VTK scene renders as, not the underlying data. For example it currently does not support quads or higher sided polygons although VTK does. As such taking an exported gltf file and then selecting wireframe in a viewer will give all triangles where VTK's rendering would correctly draw the original polygons. etc.

See also
vtkExporter
Online Examples:

Tests:
vtkGLTFExporter (Tests)

Definition at line 76 of file vtkGLTFExporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 80 of file vtkGLTFExporter.h.

Constructor & Destructor Documentation

◆ vtkGLTFExporter()

vtkGLTFExporter::vtkGLTFExporter ( )
protected

◆ ~vtkGLTFExporter()

vtkGLTFExporter::~vtkGLTFExporter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGLTFExporter* vtkGLTFExporter::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkGLTFExporter::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 vtkGLTFExporter* vtkGLTFExporter::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGLTFExporter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkExporter.

◆ NewInstance()

vtkGLTFExporter* vtkGLTFExporter::NewInstance ( ) const

◆ PrintSelf()

void vtkGLTFExporter::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.

◆ vtkSetFilePathMacro()

vtkGLTFExporter::vtkSetFilePathMacro ( FileName  )

Specify the name of the GLTF file to write.

◆ vtkGetFilePathMacro()

vtkGLTFExporter::vtkGetFilePathMacro ( FileName  )

Specify the name of the GLTF file to write.

◆ GetInlineData()

virtual bool vtkGLTFExporter::GetInlineData ( )
virtual

Should the binary data be included in the json file as a base64 string.

◆ SetInlineData()

virtual void vtkGLTFExporter::SetInlineData ( bool  )
virtual

Should the binary data be included in the json file as a base64 string.

◆ InlineDataOn()

virtual void vtkGLTFExporter::InlineDataOn ( )
virtual

Should the binary data be included in the json file as a base64 string.

◆ InlineDataOff()

virtual void vtkGLTFExporter::InlineDataOff ( )
virtual

Should the binary data be included in the json file as a base64 string.

◆ GetSaveNormal()

virtual bool vtkGLTFExporter::GetSaveNormal ( )
virtual

It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found.

NORMAL is the vertex normal. Cesium needs this to render buildings correctly if there is no texture.

◆ SetSaveNormal()

virtual void vtkGLTFExporter::SetSaveNormal ( bool  )
virtual

It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found.

NORMAL is the vertex normal. Cesium needs this to render buildings correctly if there is no texture.

◆ SaveNormalOn()

virtual void vtkGLTFExporter::SaveNormalOn ( )
virtual

It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found.

NORMAL is the vertex normal. Cesium needs this to render buildings correctly if there is no texture.

◆ SaveNormalOff()

virtual void vtkGLTFExporter::SaveNormalOff ( )
virtual

It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found.

NORMAL is the vertex normal. Cesium needs this to render buildings correctly if there is no texture.

◆ GetSaveBatchId()

virtual bool vtkGLTFExporter::GetSaveBatchId ( )
virtual

It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found.

_BATCHID is an index used in 3D Tiles b3dm format. This format stores a binary gltf with a mesh that has several objects (buildings). Objects are indexed from 0 to number of objects - 1, all points of an objects have the same index. These index values are stored in _BATCHID

◆ SetSaveBatchId()

virtual void vtkGLTFExporter::SetSaveBatchId ( bool  )
virtual

It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found.

_BATCHID is an index used in 3D Tiles b3dm format. This format stores a binary gltf with a mesh that has several objects (buildings). Objects are indexed from 0 to number of objects - 1, all points of an objects have the same index. These index values are stored in _BATCHID

◆ SaveBatchIdOn()

virtual void vtkGLTFExporter::SaveBatchIdOn ( )
virtual

It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found.

_BATCHID is an index used in 3D Tiles b3dm format. This format stores a binary gltf with a mesh that has several objects (buildings). Objects are indexed from 0 to number of objects - 1, all points of an objects have the same index. These index values are stored in _BATCHID

◆ SaveBatchIdOff()

virtual void vtkGLTFExporter::SaveBatchIdOff ( )
virtual

It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found.

_BATCHID is an index used in 3D Tiles b3dm format. This format stores a binary gltf with a mesh that has several objects (buildings). Objects are indexed from 0 to number of objects - 1, all points of an objects have the same index. These index values are stored in _BATCHID

◆ WriteToString()

std::string vtkGLTFExporter::WriteToString ( )

Write the result to a string instead of a file.

◆ WriteToStream()

void vtkGLTFExporter::WriteToStream ( ostream &  out)

Write the result to a provided ostream.

◆ WriteData()

void vtkGLTFExporter::WriteData ( )
overrideprotectedvirtual

Implements vtkExporter.

Member Data Documentation

◆ FileName

char* vtkGLTFExporter::FileName
protected

Definition at line 146 of file vtkGLTFExporter.h.

◆ InlineData

bool vtkGLTFExporter::InlineData
protected

Definition at line 147 of file vtkGLTFExporter.h.

◆ SaveNormal

bool vtkGLTFExporter::SaveNormal
protected

Definition at line 148 of file vtkGLTFExporter.h.

◆ SaveBatchId

bool vtkGLTFExporter::SaveBatchId
protected

Definition at line 149 of file vtkGLTFExporter.h.


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