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

Import a GLTF file. More...

#include <vtkGLTFImporter.h>

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

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...
 
vtkGLTFImporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkSmartPointer< vtkCameraGetCamera (unsigned int id)
 glTF defines multiple camera objects, but no default behavior for which camera should be used. More...
 
size_t GetNumberOfCameras ()
 Get the total number of cameras. More...
 
virtual void SetFileName (const char *)
 Specify the name of the file to read. More...
 
virtual char * GetFileName ()
 Specify the name of the file to read. More...
 
- Public Member Functions inherited from vtkImporter
vtkImporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkRendererGetRenderer ()
 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 vtkRenderWindowGetRenderWindow ()
 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...
 
- 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 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...
 
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...
 
- 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 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...
 
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 vtkGLTFImporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGLTFImporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImporter
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImporterSafeDownCast (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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGLTFImporter ()=default
 
 ~vtkGLTFImporter () override
 
int ImportBegin () override
 
void ImportActors (vtkRenderer *renderer) override
 
void ImportCameras (vtkRenderer *renderer) override
 
void ImportLights (vtkRenderer *renderer) override
 
- Protected Member Functions inherited from vtkImporter
 vtkImporter ()
 
 ~vtkImporter () override
 
virtual void ImportEnd ()
 
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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * FileName = nullptr
 
std::vector< vtkSmartPointer< vtkCamera > > Cameras
 
std::map< int, vtkSmartPointer< vtkTexture > > Textures
 
vtkSmartPointer< vtkGLTFDocumentLoaderLoader
 
- Protected Attributes inherited from vtkImporter
vtkRendererRenderer
 
vtkRenderWindowRenderWindow
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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:

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:

See also
vtkImporter vtkGLTFReader

Definition at line 72 of file vtkGLTFImporter.h.

Member Typedef Documentation

Definition at line 77 of file vtkGLTFImporter.h.

Constructor & Destructor Documentation

vtkGLTFImporter::vtkGLTFImporter ( )
protecteddefault
vtkGLTFImporter::~vtkGLTFImporter ( )
overrideprotected

Member Function Documentation

static vtkGLTFImporter* vtkGLTFImporter::New ( )
static
static vtkTypeBool vtkGLTFImporter::IsTypeOf ( const char *  type)
static
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.

static vtkGLTFImporter* vtkGLTFImporter::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkGLTFImporter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImporter.

vtkGLTFImporter* vtkGLTFImporter::NewInstance ( ) const
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.

virtual void vtkGLTFImporter::SetFileName ( const char *  )
virtual

Specify the name of the file to read.

virtual char* vtkGLTFImporter::GetFileName ( )
virtual

Specify the name of the file to read.

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.

size_t vtkGLTFImporter::GetNumberOfCameras ( )

Get the total number of cameras.

int vtkGLTFImporter::ImportBegin ( )
overrideprotectedvirtual

Reimplemented from vtkImporter.

void vtkGLTFImporter::ImportActors ( vtkRenderer renderer)
overrideprotectedvirtual

Reimplemented from vtkImporter.

void vtkGLTFImporter::ImportCameras ( vtkRenderer renderer)
overrideprotectedvirtual

Reimplemented from vtkImporter.

void vtkGLTFImporter::ImportLights ( vtkRenderer renderer)
overrideprotectedvirtual

Reimplemented from vtkImporter.

Member Data Documentation

char* vtkGLTFImporter::FileName = nullptr
protected

Definition at line 109 of file vtkGLTFImporter.h.

std::vector<vtkSmartPointer<vtkCamera> > vtkGLTFImporter::Cameras
protected

Definition at line 111 of file vtkGLTFImporter.h.

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

Definition at line 112 of file vtkGLTFImporter.h.

vtkSmartPointer<vtkGLTFDocumentLoader> vtkGLTFImporter::Loader
protected

Definition at line 113 of file vtkGLTFImporter.h.


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