VTK  9.0.20210424
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGLTFDocumentLoader Class Reference

Deserialize a GLTF model file. More...

#include <vtkGLTFDocumentLoader.h>

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

Classes

struct  Accessor
 This struct describes an accessor glTF object. More...
 
struct  Animation
 This struct describes a glTF animation object. More...
 
struct  BufferView
 This struct describes a glTF bufferView object. More...
 
struct  Camera
 This struct describes a glTF camera object. More...
 
struct  Extensions
 This struct contains extension metadata. More...
 
struct  Image
 This struct describes a glTF image object. More...
 
struct  Material
 This struct describes a glTF material object. More...
 
struct  Mesh
 This struct describes a glTF mesh object. More...
 
struct  Model
 This struct contains all data from a gltf asset. More...
 
struct  MorphTarget
 This struct describes a glTF Morph Target object. More...
 
struct  Node
 This struct describes a glTF node object. More...
 
struct  Primitive
 This struct describes a glTF primitive object. More...
 
struct  Sampler
 This struct describes a glTF sampler object. More...
 
struct  Scene
 This struct describes a glTF scene object. More...
 
struct  Skin
 This struct describes a glTF asset. More...
 
struct  Texture
 This struct describes a glTF texture object. More...
 
struct  TextureInfo
 This struct describes a glTF textureInfo object, mostly used in material descriptions They contain two indexes, one to a texture object, and the second being used to construct a string with the format TEXCOORD_<index>, which references a key in mesh.primitives.attributes. More...
 

Public Types

enum  Target : unsigned short { Target::ARRAY_BUFFER = 34962, Target::ELEMENT_ARRAY_BUFFER = 34963 }
 Define an openGL draw target. More...
 
enum  AccessorType : unsigned char {
  AccessorType::SCALAR, AccessorType::VEC2, AccessorType::VEC3, AccessorType::VEC4,
  AccessorType::MAT2, AccessorType::MAT3, AccessorType::MAT4, AccessorType::INVALID
}
 Defines an accessor's type. More...
 
enum  ComponentType : unsigned short {
  ComponentType::BYTE = 5120, ComponentType::UNSIGNED_BYTE = 5121, ComponentType::SHORT = 5122, ComponentType::UNSIGNED_SHORT = 5123,
  ComponentType::UNSIGNED_INT = 5125, ComponentType::FLOAT = 5126
}
 Define a type for different data components. More...
 
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...
 
vtkGLTFDocumentLoaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool ApplyAnimation (float t, int animationId, bool forceStep=false)
 Apply the specified animation, at the specified time, to the internal Model. More...
 
void ResetAnimation (int animationId)
 Restore the transforms that were modified by an animation to their initial state. More...
 
bool LoadFileBuffer (const std::string &fileName, std::vector< char > &glbBuffer)
 Load the binary part of a binary glTF (.glb) file. More...
 
bool LoadModelMetaDataFromFile (std::string FileName)
 Reset internal Model struct, and serialize glTF metadata (all json information) into it. More...
 
bool LoadModelData (const std::vector< char > &glbBuffer)
 Load buffer data into the internal Model. More...
 
bool BuildModelVTKGeometry ()
 Converts the internal Model's loaded data into more convenient vtk objects. More...
 
std::shared_ptr< ModelGetInternalModel ()
 Get the internal Model. More...
 
const std::vector< std::string > & GetSupportedExtensions ()
 Get the list of extensions that are supported by this loader. More...
 
const std::vector< std::string > & GetUsedExtensions ()
 Get the list of extensions that are used by the current model. More...
 
void BuildGlobalTransforms (unsigned int nodeIndex, vtkSmartPointer< vtkMatrix4x4 > parentTransform)
 Concatenate the current node's local transform to its parent's global transform, storing the resulting transform in the node's globalTransform field. More...
 
void BuildGlobalTransforms ()
 Build all global transforms. 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 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 vtkGLTFDocumentLoaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGLTFDocumentLoaderSafeDownCast (vtkObjectBase *o)
 
static unsigned int GetNumberOfComponentsForType (vtkGLTFDocumentLoader::AccessorType type)
 Returns the number of components for a given accessor type. More...
 
static void ComputeJointMatrices (const Model &model, const Skin &skin, Node &node, std::vector< vtkSmartPointer< vtkMatrix4x4 >> &jointMats)
 Compute all joint matrices of the skin of a specific node. More...
 
- 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
 
 vtkGLTFDocumentLoader ()=default
 
 ~vtkGLTFDocumentLoader () override=default
 
- 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 &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- 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

Deserialize a GLTF model file.

vtkGLTFDocument loader is an internal utility class which defines data structures and functions with the purpose of deserializing a glTF model from a glTF file, loading its data from binary buffers and creating vtk objects with the extracted geometry. It contains an internal Model structure into which all loading is performed.

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

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

Events:
vtkCommand::ProgressEvent

Definition at line 61 of file vtkGLTFDocumentLoader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 65 of file vtkGLTFDocumentLoader.h.

Member Enumeration Documentation

◆ Target

enum vtkGLTFDocumentLoader::Target : unsigned short
strong

Define an openGL draw target.

Enumerator
ARRAY_BUFFER 
ELEMENT_ARRAY_BUFFER 

Definition at line 71 of file vtkGLTFDocumentLoader.h.

◆ AccessorType

enum vtkGLTFDocumentLoader::AccessorType : unsigned char
strong

Defines an accessor's type.

These are defined as strings in the glTF specification. Each type implies a specific number of components.

Enumerator
SCALAR 
VEC2 
VEC3 
VEC4 
MAT2 
MAT3 
MAT4 
INVALID 

Definition at line 81 of file vtkGLTFDocumentLoader.h.

◆ ComponentType

enum vtkGLTFDocumentLoader::ComponentType : unsigned short
strong

Define a type for different data components.

Values match with the corresponding GLenum, as they are used in the glTF specification.

Enumerator
BYTE 
UNSIGNED_BYTE 
SHORT 
UNSIGNED_SHORT 
UNSIGNED_INT 
FLOAT 

Definition at line 97 of file vtkGLTFDocumentLoader.h.

Constructor & Destructor Documentation

◆ vtkGLTFDocumentLoader()

vtkGLTFDocumentLoader::vtkGLTFDocumentLoader ( )
protecteddefault

◆ ~vtkGLTFDocumentLoader()

vtkGLTFDocumentLoader::~vtkGLTFDocumentLoader ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkGLTFDocumentLoader* vtkGLTFDocumentLoader::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGLTFDocumentLoader::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkGLTFDocumentLoader* vtkGLTFDocumentLoader::NewInstance ( ) const

◆ PrintSelf()

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

◆ ApplyAnimation()

bool vtkGLTFDocumentLoader::ApplyAnimation ( float  t,
int  animationId,
bool  forceStep = false 
)

Apply the specified animation, at the specified time, to the internal Model.

Changes node transforms and morphing weights.

◆ ResetAnimation()

void vtkGLTFDocumentLoader::ResetAnimation ( int  animationId)

Restore the transforms that were modified by an animation to their initial state.

◆ LoadFileBuffer()

bool vtkGLTFDocumentLoader::LoadFileBuffer ( const std::string &  fileName,
std::vector< char > &  glbBuffer 
)

Load the binary part of a binary glTF (.glb) file.

Returns false if no valid binary part was found.

◆ LoadModelMetaDataFromFile()

bool vtkGLTFDocumentLoader::LoadModelMetaDataFromFile ( std::string  FileName)

Reset internal Model struct, and serialize glTF metadata (all json information) into it.

To load buffers, use LoadModelData

◆ LoadModelData()

bool vtkGLTFDocumentLoader::LoadModelData ( const std::vector< char > &  glbBuffer)

Load buffer data into the internal Model.

◆ BuildModelVTKGeometry()

bool vtkGLTFDocumentLoader::BuildModelVTKGeometry ( )

Converts the internal Model's loaded data into more convenient vtk objects.

◆ GetInternalModel()

std::shared_ptr<Model> vtkGLTFDocumentLoader::GetInternalModel ( )

Get the internal Model.

◆ GetNumberOfComponentsForType()

static unsigned int vtkGLTFDocumentLoader::GetNumberOfComponentsForType ( vtkGLTFDocumentLoader::AccessorType  type)
static

Returns the number of components for a given accessor type.

◆ GetSupportedExtensions()

const std::vector<std::string>& vtkGLTFDocumentLoader::GetSupportedExtensions ( )

Get the list of extensions that are supported by this loader.

◆ GetUsedExtensions()

const std::vector<std::string>& vtkGLTFDocumentLoader::GetUsedExtensions ( )

Get the list of extensions that are used by the current model.

◆ BuildGlobalTransforms() [1/2]

void vtkGLTFDocumentLoader::BuildGlobalTransforms ( unsigned int  nodeIndex,
vtkSmartPointer< vtkMatrix4x4 parentTransform 
)

Concatenate the current node's local transform to its parent's global transform, storing the resulting transform in the node's globalTransform field.

Then does the same for the current node's children. Recursive.

◆ BuildGlobalTransforms() [2/2]

void vtkGLTFDocumentLoader::BuildGlobalTransforms ( )

Build all global transforms.

◆ ComputeJointMatrices()

static void vtkGLTFDocumentLoader::ComputeJointMatrices ( const Model model,
const Skin skin,
Node node,
std::vector< vtkSmartPointer< vtkMatrix4x4 >> &  jointMats 
)
static

Compute all joint matrices of the skin of a specific node.


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