Import a GLTF file. More...

#include <vtkGLTFImporter.h>

Inheritance diagram for vtkGLTFImporter:

Collaboration diagram for vtkGLTFImporter:

Public Types
typedef vtkImporter	Superclass

Public Types inherited from vtkImporter
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...

vtkGLTFImporter *	NewInstance () const

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

vtkSmartPointer< vtkCamera >	GetCamera (unsigned int id)
	glTF defines multiple camera objects, but no default behavior for which camera should be used. More...

std::string	GetOutputsDescription () override
	Get a printable string describing all outputs. More...

void	UpdateTimeStep (double timestep) override
	update timestep More...

vtkIdType	GetNumberOfAnimations () override
	Get the number of available animations. More...

std::string	GetAnimationName (vtkIdType animationIndex) override
	Return the name of the animation. More...

vtkIdType	GetNumberOfCameras () override
	Get the number of available cameras. More...

std::string	GetCameraName (vtkIdType camIndex) override
	Get the name of a camera. More...

void	SetCamera (vtkIdType camIndex) override
	Enable a specific camera. More...

bool	GetTemporalInformation (vtkIdType animationIndex, double frameRate, int &nbTimeSteps, double timeRange[2], vtkDoubleArray *timeSteps) override
	Get temporal informations for the currently enabled animations. More...


	vtkSetFilePathMacro (FileName)
	Specify the name of the file to read. More...

	vtkGetFilePathMacro (FileName)
	Specify the name of the file to read. More...


void	EnableAnimation (vtkIdType animationIndex) override
	Enable/Disable/Get the status of specific animations. More...

void	DisableAnimation (vtkIdType animationIndex) override
	Enable/Disable/Get the status of specific animations. More...

bool	IsAnimationEnabled (vtkIdType animationIndex) override
	Enable/Disable/Get the status of specific animations. More...

Public Member Functions inherited from vtkImporter
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkImporter *	NewInstance () const

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

virtual std::string	GetOutputsDescription ()
	Recover a printable string that let importer implementation Describe their outputs. More...

virtual vtkIdType	GetNumberOfAnimations ()
	Get the number of available animations. More...

virtual std::string	GetAnimationName (vtkIdType vtkNotUsed(animationIndex))
	Get the name of an animation. More...

virtual vtkIdType	GetNumberOfCameras ()
	Get the number of available cameras. More...

virtual std::string	GetCameraName (vtkIdType vtkNotUsed(camIndex))
	Get the name of a camera. More...

virtual void	SetCamera (vtkIdType vtkNotUsed(camIndex))
	Enable a specific camera. More...

virtual bool	GetTemporalInformation (vtkIdType animationIndex, double frameRate, int &nbTimeSteps, double timeRange[2], vtkDoubleArray *timeSteps)
	Get temporal informations for the currently enabled animations. More...

virtual void	UpdateTimeStep (double timeStep)
	Import the actors, camera, lights and properties at a specific timestep. More...

virtual vtkRenderer *	GetRenderer ()
	Get the renderer that contains the imported actors, cameras and lights. More...

virtual void	SetRenderWindow (vtkRenderWindow *)
	Set the vtkRenderWindow to contain the imported actors, cameras and lights, If no vtkRenderWindow is set, one will be created and can be obtained with the GetRenderWindow method. More...

virtual vtkRenderWindow *	GetRenderWindow ()
	Set the vtkRenderWindow to contain the imported actors, cameras and lights, If no vtkRenderWindow is set, one will be created and can be obtained with the GetRenderWindow method. More...

void	Read ()
	Import the actors, cameras, lights and properties into a vtkRenderWindow. More...

void	Update ()
	Import the actors, cameras, lights and properties into a vtkRenderWindow. More...

virtual void	EnableAnimation (vtkIdType vtkNotUsed(animationIndex))
	Enable/Disable/Get the status of specific animations. More...

virtual void	DisableAnimation (vtkIdType vtkNotUsed(animationIndex))
	Enable/Disable/Get the status of specific animations. More...

virtual bool	IsAnimationEnabled (vtkIdType vtkNotUsed(animationIndex))
	Enable/Disable/Get the status of specific animations. 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...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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)

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

vtkCommand *	GetCommand (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...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. 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...

Static Public Member Functions
static vtkGLTFImporter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkGLTFImporter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkImporter
static vtkTypeBool	IsTypeOf (const char *type)

static vtkImporter *	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. 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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkGLTFImporter ()=default

	~vtkGLTFImporter () override

int	ImportBegin () override

void	ImportActors (vtkRenderer *renderer) override

void	ImportCameras (vtkRenderer *renderer) override

void	ImportLights (vtkRenderer *renderer) override

void	ApplySkinningMorphing ()

Protected Member Functions inherited from vtkImporter
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImporter ()

	~vtkImporter () override

virtual int	ImportBegin ()

virtual void	ImportEnd ()

virtual void	ImportActors (vtkRenderer *)

virtual void	ImportCameras (vtkRenderer *)

virtual void	ImportLights (vtkRenderer *)

virtual void	ImportProperties (vtkRenderer *)

virtual void	ReadData ()

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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	FileName = nullptr

std::map< int, vtkSmartPointer< vtkCamera > >	Cameras

std::map< int, vtkSmartPointer< vtkTexture > >	Textures

std::map< int, std::vector< vtkSmartPointer< vtkActor > > >	Actors

vtkSmartPointer< vtkGLTFDocumentLoader >	Loader

std::string	OutputsDescription

std::vector< bool >	EnabledAnimations

vtkIdType	EnabledCamera = -1

Protected Attributes inherited from vtkImporter
vtkRenderer *	Renderer

vtkRenderWindow *	RenderWindow

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkImporter
static std::string	GetDataSetDescription (vtkDataSet *ds, vtkIndent indent)

static std::string	GetArrayDescription (vtkAbstractArray *array, vtkIndent indent)

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Import a GLTF file.

vtkGLTFImporter is a concrete subclass of vtkImporter that reads glTF 2.0 files.

The GL Transmission Format (glTF) is an API-neutral runtime asset delivery format. A glTF asset is represented by:

A JSON-formatted file (.gltf) containing a full scene description: node hierarchy, materials, cameras, as well as descriptor information for meshes, animations, and other constructs
Binary files (.bin) containing geometry and animation data, and other buffer-based data
Image files (.jpg, .png) for textures

This importer supports all physically-based rendering material features, with the exception of alpha masking and mirrored texture wrapping, which are not supported.

This importer does not support materials that use multiple sets of texture coordinates. Only the first set will be used in this case.

This importer does not support animations, morphing and skinning. If you would like to use animations, morphing or skinning, please consider using vtkGLTFReader.

This importer only supports assets that use the 2.x version of the glTF specification.

For the full glTF specification, see: https://github.com/KhronosGroup/glTF/tree/master/specification/2.0

Note: array sizes should not exceed INT_MAX

Supported extensions:

KHR_lights_punctual : The importer supports the KHR_lights_punctual extension except for this feature:
- VTK does not support changing the falloff of the cone with innerConeAngle and outerConeAngle. The importer uses outerConeAngle and ignores innerConeAngle as specified for this situation.

See also: vtkImporter vtkGLTFReader

Online Examples:

GLTFImporter

ImportToExport

CombineImportedActors

Definition at line 112 of file vtkGLTFImporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImporter vtkGLTFImporter::Superclass

Definition at line 117 of file vtkGLTFImporter.h.

Constructor & Destructor Documentation

◆ vtkGLTFImporter()

vtkGLTFImporter::vtkGLTFImporter ( )

protecteddefault

◆ ~vtkGLTFImporter()

vtkGLTFImporter::~vtkGLTFImporter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkGLTFImporter * vtkGLTFImporter::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGLTFImporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImporter.

◆ NewInstance()

vtkGLTFImporter * vtkGLTFImporter::NewInstance ( ) const

◆ PrintSelf()

void vtkGLTFImporter::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 vtkObject.

◆ vtkSetFilePathMacro()

vtkGLTFImporter::vtkSetFilePathMacro ( FileName )

Specify the name of the file to read.

◆ vtkGetFilePathMacro()

vtkGLTFImporter::vtkGetFilePathMacro ( FileName )

Specify the name of the file to read.

◆ GetCamera()

vtkSmartPointer< vtkCamera > vtkGLTFImporter::GetCamera ( unsigned int id )

glTF defines multiple camera objects, but no default behavior for which camera should be used.

The importer will by default apply the asset's first camera. This accessor lets you use the asset's other cameras.

◆ GetOutputsDescription()

std::string vtkGLTFImporter::GetOutputsDescription ( )

inlineoverridevirtual

Get a printable string describing all outputs.

Reimplemented from vtkImporter.

Definition at line 138 of file vtkGLTFImporter.h.

◆ UpdateTimeStep()

void vtkGLTFImporter::UpdateTimeStep ( double timestep )

overridevirtual

update timestep

Reimplemented from vtkImporter.

◆ GetNumberOfAnimations()

vtkIdType vtkGLTFImporter::GetNumberOfAnimations ( )

overridevirtual

Get the number of available animations.

Reimplemented from vtkImporter.

◆ GetAnimationName()

std::string vtkGLTFImporter::GetAnimationName ( vtkIdType animationIndex )

override

Return the name of the animation.

◆ EnableAnimation()

void vtkGLTFImporter::EnableAnimation ( vtkIdType animationIndex )

override

Enable/Disable/Get the status of specific animations.

◆ DisableAnimation()

void vtkGLTFImporter::DisableAnimation ( vtkIdType animationIndex )

override

Enable/Disable/Get the status of specific animations.

◆ IsAnimationEnabled()

bool vtkGLTFImporter::IsAnimationEnabled ( vtkIdType animationIndex )

override

Enable/Disable/Get the status of specific animations.

◆ GetNumberOfCameras()

vtkIdType vtkGLTFImporter::GetNumberOfCameras ( )

overridevirtual

Get the number of available cameras.

Reimplemented from vtkImporter.

◆ GetCameraName()

std::string vtkGLTFImporter::GetCameraName ( vtkIdType camIndex )

override

Get the name of a camera.

◆ SetCamera()

void vtkGLTFImporter::SetCamera ( vtkIdType camIndex )

override

Enable a specific camera.

If a negative index is provided, no camera from the importer is used.

◆ GetTemporalInformation()

bool vtkGLTFImporter::GetTemporalInformation	(	vtkIdType	animationIndex,
		double	frameRate,
		int &	nbTimeSteps,
		double	timeRange[2],
		vtkDoubleArray *	timeSteps
	)

overridevirtual

Get temporal informations for the currently enabled animations.

frameRate is used to define the number of frames for one second of simulation. the three return arguments are defined in this implementation.

Reimplemented from vtkImporter.

◆ ImportBegin()

int vtkGLTFImporter::ImportBegin ( )

overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportActors()

void vtkGLTFImporter::ImportActors ( vtkRenderer * renderer )

overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportCameras()

void vtkGLTFImporter::ImportCameras ( vtkRenderer * renderer )

overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportLights()

void vtkGLTFImporter::ImportLights ( vtkRenderer * renderer )

overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ApplySkinningMorphing()

void vtkGLTFImporter::ApplySkinningMorphing ( )

protected

Member Data Documentation

◆ FileName

char* vtkGLTFImporter::FileName = nullptr

protected

Definition at line 199 of file vtkGLTFImporter.h.

◆ Cameras

std::map<int, vtkSmartPointer<vtkCamera> > vtkGLTFImporter::Cameras

protected

Definition at line 201 of file vtkGLTFImporter.h.

◆ Textures

std::map<int, vtkSmartPointer<vtkTexture> > vtkGLTFImporter::Textures

protected

Definition at line 202 of file vtkGLTFImporter.h.

◆ Actors

std::map<int, std::vector<vtkSmartPointer<vtkActor> > > vtkGLTFImporter::Actors

protected

Definition at line 203 of file vtkGLTFImporter.h.

◆ Loader

vtkSmartPointer<vtkGLTFDocumentLoader> vtkGLTFImporter::Loader

protected

Definition at line 204 of file vtkGLTFImporter.h.

◆ OutputsDescription

std::string vtkGLTFImporter::OutputsDescription

protected

Definition at line 205 of file vtkGLTFImporter.h.

◆ EnabledAnimations

std::vector<bool> vtkGLTFImporter::EnabledAnimations

protected

Definition at line 206 of file vtkGLTFImporter.h.

◆ EnabledCamera

vtkIdType vtkGLTFImporter::EnabledCamera = -1

protected

Definition at line 207 of file vtkGLTFImporter.h.

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

IO/Import/vtkGLTFImporter.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

◆ vtkGLTFImporter()

◆ ~vtkGLTFImporter()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ vtkSetFilePathMacro()

◆ vtkGetFilePathMacro()

◆ GetCamera()

◆ GetOutputsDescription()

◆ UpdateTimeStep()

◆ GetNumberOfAnimations()

◆ GetAnimationName()

◆ EnableAnimation()

◆ DisableAnimation()

◆ IsAnimationEnabled()

◆ GetNumberOfCameras()

◆ GetCameraName()

◆ SetCamera()

◆ GetTemporalInformation()

◆ ImportBegin()

◆ ImportActors()

◆ ImportCameras()

◆ ImportLights()

◆ ApplySkinningMorphing()

Member Data Documentation

◆ FileName

◆ Cameras

◆ Textures

◆ Actors

◆ Loader

◆ OutputsDescription

◆ EnabledAnimations

◆ EnabledCamera