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

#include <vtkGLTFExporter.h>

Inheritance diagram for vtkGLTFExporter:

Collaboration diagram for vtkGLTFExporter:

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.

vtkGLTFExporter *	NewInstance () const

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

std::string	WriteToString ()
	Write the result to a string instead of a file.

void	WriteToStream (ostream &out)
	Write the result to a provided ostream.


	vtkSetFilePathMacro (FileName)
	Specify the name of the GLTF file to write.

	vtkGetFilePathMacro (FileName)
	Specify the name of the GLTF file to write.


virtual bool	GetInlineData ()
	Should the binary data be included in the json file as a base64 string.

virtual void	SetInlineData (bool)
	Should the binary data be included in the json file as a base64 string.

virtual void	InlineDataOn ()
	Should the binary data be included in the json file as a base64 string.

virtual void	InlineDataOff ()
	Should the binary data be included in the json file as a base64 string.


virtual bool	GetSaveNormal ()
	It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found.

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.

virtual void	SaveNormalOn ()
	It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found.

virtual void	SaveNormalOff ()
	It looks for a point array called NORMAL in the data and it saves it in the GLTF file if found.


virtual bool	GetSaveBatchId ()
	It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found.

virtual void	SetSaveBatchId (bool)
	It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found.

virtual void	SaveBatchIdOn ()
	It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found.

virtual void	SaveBatchIdOff ()
	It looks for point arrays called _BATCHID in the data and it saves it in the GLTF file if found.


virtual bool	GetSaveNaNValues ()
	Set/Get weither NaN color is saved in the texture associated to the mesh.

virtual void	SetSaveNaNValues (bool)
	Set/Get weither NaN color is saved in the texture associated to the mesh.

virtual void	SaveNaNValuesOn ()
	Set/Get weither NaN color is saved in the texture associated to the mesh.

virtual void	SaveNaNValuesOff ()
	Set/Get weither NaN color is saved in the texture associated to the mesh.

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 vtkGLTFExporter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkGLTFExporter *	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

	vtkGLTFExporter ()

	~vtkGLTFExporter () override

void	WriteData () override

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
char *	FileName

bool	InlineData

bool	SaveNormal

bool	SaveBatchId

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

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:

GLTFExporter

ImportToExport

Tests:: vtkGLTFExporter (Tests)

Definition at line 64 of file vtkGLTFExporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkExporter vtkGLTFExporter::Superclass

Definition at line 68 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

◆ GetSaveNaNValues()

virtual bool vtkGLTFExporter::GetSaveNaNValues ( )

virtual

Set/Get weither NaN color is saved in the texture associated to the mesh.

Certain viewers do not support well the texture generated with NaN colors, so consider disabling this unless NaN data is present. Default value is true.

◆ SetSaveNaNValues()

virtual void vtkGLTFExporter::SetSaveNaNValues ( bool )

virtual

Set/Get weither NaN color is saved in the texture associated to the mesh.

Certain viewers do not support well the texture generated with NaN colors, so consider disabling this unless NaN data is present. Default value is true.

◆ SaveNaNValuesOn()

virtual void vtkGLTFExporter::SaveNaNValuesOn ( )

virtual

Set/Get weither NaN color is saved in the texture associated to the mesh.

Certain viewers do not support well the texture generated with NaN colors, so consider disabling this unless NaN data is present. Default value is true.

◆ SaveNaNValuesOff()

virtual void vtkGLTFExporter::SaveNaNValuesOff ( )

virtual

Set/Get weither NaN color is saved in the texture associated to the mesh.

Certain viewers do not support well the texture generated with NaN colors, so consider disabling this unless NaN data is present. Default value is true.

◆ 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:

IO/Export/vtkGLTFExporter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkGLTFExporter()

◆ ~vtkGLTFExporter()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ vtkSetFilePathMacro()

◆ vtkGetFilePathMacro()

◆ GetInlineData()

◆ SetInlineData()

◆ InlineDataOn()

◆ InlineDataOff()

◆ GetSaveNormal()

◆ SetSaveNormal()

◆ SaveNormalOn()

◆ SaveNormalOff()

◆ GetSaveBatchId()

◆ SetSaveBatchId()

◆ SaveBatchIdOn()

◆ SaveBatchIdOff()

◆ GetSaveNaNValues()

◆ SetSaveNaNValues()

◆ SaveNaNValuesOn()

◆ SaveNaNValuesOff()

◆ WriteToString()

◆ WriteToStream()

◆ WriteData()

Member Data Documentation

◆ FileName

◆ InlineData

◆ SaveNormal

◆ SaveBatchId