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

Read a GLTF file. More...

#include <vtkGLTFReader.h>

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

Classes

struct  GLTFTexture
 Materials are not directly applied to this reader's output. More...
 

Public Types

typedef vtkMultiBlockDataSetAlgorithm Superclass
 
- Public Types inherited from vtkMultiBlockDataSetAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. 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...
 
vtkGLTFReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkStringArrayGetAllSceneNames ()
 Get a list all scenes names as a vtkStringArray, with duplicate names numbered and empty names replaced by a generic name. More...
 
vtkDataArraySelectionGetAnimationSelection ()
 Get the vtkDataArraySelection object to enable/disable animations. More...
 
vtkIdType GetNumberOfTextures ()
 
GLTFTexture GetGLTFTexture (vtkIdType textureIndex)
 
virtual void SetFileName (const char *)
 Set/Get the name of the file from which to read points. More...
 
virtual char * GetFileName ()
 Set/Get the name of the file from which to read points. More...
 
void SetApplyDeformationsToGeometry (bool flag)
 The model's skinning transforms are computed and added to the different vtkPolyData objects' field data. More...
 
virtual bool GetApplyDeformationsToGeometry ()
 The model's skinning transforms are computed and added to the different vtkPolyData objects' field data. More...
 
virtual void ApplyDeformationsToGeometryOn ()
 The model's skinning transforms are computed and added to the different vtkPolyData objects' field data. More...
 
virtual void ApplyDeformationsToGeometryOff ()
 The model's skinning transforms are computed and added to the different vtkPolyData objects' field data. More...
 
virtual vtkIdType GetNumberOfAnimations ()
 glTF models can contain multiple animations, with various names and duration. More...
 
std::string GetAnimationName (vtkIdType animationIndex)
 glTF models can contain multiple animations, with various names and duration. More...
 
float GetAnimationDuration (vtkIdType animationIndex)
 glTF models can contain multiple animations, with various names and duration. More...
 
void EnableAnimation (vtkIdType animationIndex)
 Enable/Disable an animation. More...
 
void DisableAnimation (vtkIdType animationIndex)
 Enable/Disable an animation. More...
 
bool IsAnimationEnabled (vtkIdType animationIndex)
 Enable/Disable an animation. More...
 
std::string GetSceneName (vtkIdType sceneIndex)
 glTF models can contain multiple scene descriptions. More...
 
virtual vtkIdType GetNumberOfScenes ()
 glTF models can contain multiple scene descriptions. More...
 
virtual vtkIdType GetCurrentScene ()
 Get/Set the scene to be used by the reader. More...
 
virtual void SetCurrentScene (vtkIdType)
 Get/Set the scene to be used by the reader. More...
 
void SetScene (const std::string &scene)
 Get/Set the scene to be used by the reader. More...
 
virtual unsigned int GetFrameRate ()
 Get/Set the rate at which animations will be sampled: the glTF format does not have the concept of static timesteps. More...
 
virtual void SetFrameRate (unsigned int)
 Get/Set the rate at which animations will be sampled: the glTF format does not have the concept of static timesteps. More...
 
- Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
vtkMultiBlockDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkMultiBlockDataSetGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. 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...
 
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 vtkGLTFReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGLTFReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMultiBlockDataSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGLTFReader ()
 
 ~vtkGLTFReader () override
 
void StoreTextureData ()
 Create and store GLTFTexture struct for each image present in the model. More...
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
void CreateSceneNamesArray ()
 Create the SceneNames array, generate unique identifiers for each scene based on their glTF name, then fill the SceneNames array with the generated identifiers. More...
 
void CreateAnimationSelection ()
 Fill the AnimationSelection vtkDataArraySelection with animation names. More...
 
- Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
 vtkMultiBlockDataSetAlgorithm ()
 
 ~vtkMultiBlockDataSetAlgorithm () override
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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 &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkGLTFDocumentLoaderLoader
 
vtkSmartPointer< vtkMultiBlockDataSetOutputDataSet
 
std::vector< GLTFTextureTextures
 
char * FileName = nullptr
 
vtkIdType CurrentScene = 0
 
unsigned int FrameRate = 60
 
vtkIdType NumberOfAnimations = 0
 
vtkIdType NumberOfScenes = 0
 
bool IsModelLoaded = false
 
bool IsMetaDataLoaded = false
 
bool ApplyDeformationsToGeometry = true
 
vtkSmartPointer< vtkStringArraySceneNames
 
vtkSmartPointer< vtkDataArraySelectionPreviousAnimationSelection
 
vtkSmartPointer< vtkDataArraySelectionAnimationSelection
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Read a GLTF file.

vtkGLTFReader is a concrete subclass of vtkMultiBlockDataSetAlgorithm 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 reader currently outputs a vtkMultiBlockDataSet containing geometry information for the current selected scene, with animations, skins and morph targets applied, unless configured not to (see ApplyDeformationsToGeometry).

It is possible to get information about available scenes and animations by using the corresponding accessors. To use animations, first call SetFramerate with a non-zero value, then use EnableAnimation or DisableAnimation to configure which animations you would like to apply to the geometry. Finally, use UPDATE_TIME_STEPS to choose which frame to apply. If ApplyDeformationsToGeometry is set to true, the reader will apply the deformations, otherwise, animation transformation information will be saved to the dataset's FieldData.

Materials are currently not supported in this reader. If you would like to display materials, please try using vtkGLTFImporter. You could also use vtkGLTFReader::GetGLTFTexture, to access the image data that was loaded from the glTF 2.0 document.

This reader 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

See also
vtkMultiBlockDataSetAlgorithm vtkGLTFImporter

Definition at line 75 of file vtkGLTFReader.h.

Member Typedef Documentation

Definition at line 79 of file vtkGLTFReader.h.

Constructor & Destructor Documentation

vtkGLTFReader::vtkGLTFReader ( )
protected
vtkGLTFReader::~vtkGLTFReader ( )
overrideprotected

Member Function Documentation

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

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

vtkGLTFReader* vtkGLTFReader::NewInstance ( ) const
void vtkGLTFReader::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 vtkMultiBlockDataSetAlgorithm.

vtkIdType vtkGLTFReader::GetNumberOfTextures ( )
GLTFTexture vtkGLTFReader::GetGLTFTexture ( vtkIdType  textureIndex)
virtual void vtkGLTFReader::SetFileName ( const char *  )
virtual

Set/Get the name of the file from which to read points.

virtual char* vtkGLTFReader::GetFileName ( )
virtual

Set/Get the name of the file from which to read points.

void vtkGLTFReader::SetApplyDeformationsToGeometry ( bool  flag)

The model's skinning transforms are computed and added to the different vtkPolyData objects' field data.

If this flag is set to true, the reader will apply those skinning transforms to the model's geometry.

virtual bool vtkGLTFReader::GetApplyDeformationsToGeometry ( )
virtual

The model's skinning transforms are computed and added to the different vtkPolyData objects' field data.

If this flag is set to true, the reader will apply those skinning transforms to the model's geometry.

virtual void vtkGLTFReader::ApplyDeformationsToGeometryOn ( )
virtual

The model's skinning transforms are computed and added to the different vtkPolyData objects' field data.

If this flag is set to true, the reader will apply those skinning transforms to the model's geometry.

virtual void vtkGLTFReader::ApplyDeformationsToGeometryOff ( )
virtual

The model's skinning transforms are computed and added to the different vtkPolyData objects' field data.

If this flag is set to true, the reader will apply those skinning transforms to the model's geometry.

virtual vtkIdType vtkGLTFReader::GetNumberOfAnimations ( )
virtual

glTF models can contain multiple animations, with various names and duration.

glTF does not specify however any runtime behavior (order of playing, auto-start, loops, mapping of timelines, etc), which is why no animation is enabled by default. These accessors expose metadata information about a model's available animations.

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

glTF models can contain multiple animations, with various names and duration.

glTF does not specify however any runtime behavior (order of playing, auto-start, loops, mapping of timelines, etc), which is why no animation is enabled by default. These accessors expose metadata information about a model's available animations.

float vtkGLTFReader::GetAnimationDuration ( vtkIdType  animationIndex)

glTF models can contain multiple animations, with various names and duration.

glTF does not specify however any runtime behavior (order of playing, auto-start, loops, mapping of timelines, etc), which is why no animation is enabled by default. These accessors expose metadata information about a model's available animations.

void vtkGLTFReader::EnableAnimation ( vtkIdType  animationIndex)

Enable/Disable an animation.

The reader will apply all enabled animations to the model's transformations, at the specified time step. Use UPDATE_TIME_STEP to select which frame should be applied.

void vtkGLTFReader::DisableAnimation ( vtkIdType  animationIndex)

Enable/Disable an animation.

The reader will apply all enabled animations to the model's transformations, at the specified time step. Use UPDATE_TIME_STEP to select which frame should be applied.

bool vtkGLTFReader::IsAnimationEnabled ( vtkIdType  animationIndex)

Enable/Disable an animation.

The reader will apply all enabled animations to the model's transformations, at the specified time step. Use UPDATE_TIME_STEP to select which frame should be applied.

std::string vtkGLTFReader::GetSceneName ( vtkIdType  sceneIndex)

glTF models can contain multiple scene descriptions.

These accessors expose metadata information about a model's available scenes.

virtual vtkIdType vtkGLTFReader::GetNumberOfScenes ( )
virtual

glTF models can contain multiple scene descriptions.

These accessors expose metadata information about a model's available scenes.

virtual vtkIdType vtkGLTFReader::GetCurrentScene ( )
virtual

Get/Set the scene to be used by the reader.

virtual void vtkGLTFReader::SetCurrentScene ( vtkIdType  )
virtual

Get/Set the scene to be used by the reader.

void vtkGLTFReader::SetScene ( const std::string &  scene)

Get/Set the scene to be used by the reader.

virtual unsigned int vtkGLTFReader::GetFrameRate ( )
virtual

Get/Set the rate at which animations will be sampled: the glTF format does not have the concept of static timesteps.

TimeSteps are generated, during the REQUEST_INFORMATION pass, as linearly interpolated time values between 0s and the animations' maximum durations, sampled at the specified frame rate. Use the TIME_STEPS information key to obtain integer indices to each of these steps.

virtual void vtkGLTFReader::SetFrameRate ( unsigned  int)
virtual

Get/Set the rate at which animations will be sampled: the glTF format does not have the concept of static timesteps.

TimeSteps are generated, during the REQUEST_INFORMATION pass, as linearly interpolated time values between 0s and the animations' maximum durations, sampled at the specified frame rate. Use the TIME_STEPS information key to obtain integer indices to each of these steps.

vtkStringArray* vtkGLTFReader::GetAllSceneNames ( )

Get a list all scenes names as a vtkStringArray, with duplicate names numbered and empty names replaced by a generic name.

All names are guaranteed to be unique, and their index in the array matches the glTF document's scene indices.

vtkDataArraySelection* vtkGLTFReader::GetAnimationSelection ( )

Get the vtkDataArraySelection object to enable/disable animations.

void vtkGLTFReader::StoreTextureData ( )
protected

Create and store GLTFTexture struct for each image present in the model.

int vtkGLTFReader::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

int vtkGLTFReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

void vtkGLTFReader::CreateSceneNamesArray ( )
protected

Create the SceneNames array, generate unique identifiers for each scene based on their glTF name, then fill the SceneNames array with the generated identifiers.

void vtkGLTFReader::CreateAnimationSelection ( )
protected

Fill the AnimationSelection vtkDataArraySelection with animation names.

Names are adapted from the glTF document to ensure that they are unique and non-empty.

Member Data Documentation

vtkSmartPointer<vtkGLTFDocumentLoader> vtkGLTFReader::Loader
protected

Definition at line 191 of file vtkGLTFReader.h.

vtkSmartPointer<vtkMultiBlockDataSet> vtkGLTFReader::OutputDataSet
protected

Definition at line 193 of file vtkGLTFReader.h.

std::vector<GLTFTexture> vtkGLTFReader::Textures
protected

Definition at line 195 of file vtkGLTFReader.h.

char* vtkGLTFReader::FileName = nullptr
protected

Definition at line 202 of file vtkGLTFReader.h.

vtkIdType vtkGLTFReader::CurrentScene = 0
protected

Definition at line 204 of file vtkGLTFReader.h.

unsigned int vtkGLTFReader::FrameRate = 60
protected

Definition at line 205 of file vtkGLTFReader.h.

vtkIdType vtkGLTFReader::NumberOfAnimations = 0
protected

Definition at line 206 of file vtkGLTFReader.h.

vtkIdType vtkGLTFReader::NumberOfScenes = 0
protected

Definition at line 207 of file vtkGLTFReader.h.

bool vtkGLTFReader::IsModelLoaded = false
protected

Definition at line 209 of file vtkGLTFReader.h.

bool vtkGLTFReader::IsMetaDataLoaded = false
protected

Definition at line 210 of file vtkGLTFReader.h.

bool vtkGLTFReader::ApplyDeformationsToGeometry = true
protected

Definition at line 212 of file vtkGLTFReader.h.

vtkSmartPointer<vtkStringArray> vtkGLTFReader::SceneNames
protected

Definition at line 214 of file vtkGLTFReader.h.

vtkSmartPointer<vtkDataArraySelection> vtkGLTFReader::PreviousAnimationSelection
protected

Definition at line 216 of file vtkGLTFReader.h.

vtkSmartPointer<vtkDataArraySelection> vtkGLTFReader::AnimationSelection
protected

Definition at line 217 of file vtkGLTFReader.h.


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