VTK  9.5.2
vtkGLTFImporter.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
3
51
52#ifndef vtkGLTFImporter_h
53#define vtkGLTFImporter_h
54
55#include "vtkIOImportModule.h" // For export macro
56#include "vtkImporter.h"
57#include "vtkResourceStream.h" // For Stream
58#include "vtkSmartPointer.h" // For SmartPointer
59#include "vtkURILoader.h" // For URILoader
60
61#include <map> // For map
62#include <vector> // For vector
63
64VTK_ABI_NAMESPACE_BEGIN
65
66// Forward declarations
67class vtkActor;
68class vtkCamera;
70class vtkTexture;
71class vtkURILoader;
72
73class VTKIOIMPORT_EXPORT vtkGLTFImporter : public vtkImporter
74{
75public:
77
79 void PrintSelf(ostream& os, vtkIndent indent) override;
80
82
88
90
99 vtkSetSmartPointerMacro(Stream, vtkResourceStream);
100 vtkGetSmartPointerMacro(Stream, vtkResourceStream);
102
104
108 vtkSetSmartPointerMacro(StreamURILoader, vtkURILoader);
109 vtkGetSmartPointerMacro(StreamURILoader, vtkURILoader);
111
113
118 vtkSetMacro(StreamIsBinary, bool);
119 vtkGetMacro(StreamIsBinary, bool);
120 vtkBooleanMacro(StreamIsBinary, bool);
122
129
133 std::string GetOutputsDescription() override { return this->OutputsDescription; }
134
138 bool UpdateAtTimeValue(double timeValue) override;
139
145
150
154 std::string GetAnimationName(vtkIdType animationIndex) override;
155
157
160 void EnableAnimation(vtkIdType animationIndex) override;
161 void DisableAnimation(vtkIdType animationIndex) override;
162 bool IsAnimationEnabled(vtkIdType animationIndex) override;
164
169
173 std::string GetCameraName(vtkIdType camIndex) override;
174
179 void SetCamera(vtkIdType camIndex) override;
180
189 bool GetTemporalInformation(vtkIdType animationIndex, double frameRate, int& nbTimeSteps,
190 double timeRange[2], vtkDoubleArray* timeSteps) override;
191
192protected:
193 vtkGLTFImporter() = default;
195
200 virtual void InitializeLoader();
201
202 int ImportBegin() override;
203 void ImportActors(vtkRenderer* renderer) override;
204 void ImportCameras(vtkRenderer* renderer) override;
205 void ImportLights(vtkRenderer* renderer) override;
206
208
215 virtual void ApplyArmatureProperties(vtkActor* actor);
216
217 char* FileName = nullptr;
220 bool StreamIsBinary = false;
221
222 std::map<int, vtkSmartPointer<vtkCamera>> Cameras;
223 std::map<int, vtkSmartPointer<vtkTexture>> Textures;
224 std::map<int, std::vector<vtkSmartPointer<vtkActor>>> Actors;
227 std::vector<bool> EnabledAnimations;
229
230private:
231 vtkGLTFImporter(const vtkGLTFImporter&) = delete;
232 void operator=(const vtkGLTFImporter&) = delete;
233
234 std::map<int, vtkSmartPointer<vtkActor>> ArmatureActors;
235};
236
237VTK_ABI_NAMESPACE_END
238#endif
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:42
a virtual camera for 3D rendering
Definition vtkCamera.h:42
dynamic, self-adjusting array of double
Deserialize a GLTF model file.
void DisableAnimation(vtkIdType animationIndex) override
Enable/Disable/Get the status of specific animations.
vtkIdType GetNumberOfCameras() override
Get the number of available cameras.
std::map< int, vtkSmartPointer< vtkCamera > > Cameras
~vtkGLTFImporter() override
std::string OutputsDescription
std::map< int, vtkSmartPointer< vtkTexture > > Textures
bool UpdateAtTimeValue(double timeValue) override
update timestep
vtkIdType EnabledCamera
void ApplySkinningMorphing()
vtkSmartPointer< vtkResourceStream > Stream
std::string GetOutputsDescription() override
Get a printable string describing all outputs.
vtkSetFilePathMacro(FileName)
Specify the name of the file to read.
vtkGLTFImporter()=default
void ImportActors(vtkRenderer *renderer) override
bool IsAnimationEnabled(vtkIdType animationIndex) override
Enable/Disable/Get the status of specific animations.
vtkGetFilePathMacro(FileName)
Specify the name of the file to read.
vtkSmartPointer< vtkURILoader > StreamURILoader
AnimationSupportLevel GetAnimationSupportLevel() override
Get the level of animation support in this importer, which is always AnimationSupportLevel::MULTI.
vtkSmartPointer< vtkGLTFDocumentLoader > Loader
void EnableAnimation(vtkIdType animationIndex) override
Enable/Disable/Get the status of specific animations.
void SetCamera(vtkIdType camIndex) override
Enable a specific camera.
int ImportBegin() override
std::string GetAnimationName(vtkIdType animationIndex) override
Return the name of the animation.
virtual void ApplyArmatureProperties(vtkActor *actor)
Apply properties on the armature actors.
std::map< int, std::vector< vtkSmartPointer< vtkActor > > > Actors
virtual void InitializeLoader()
Initialize the document loader.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSmartPointer< vtkCamera > GetCamera(unsigned int id)
glTF defines multiple camera objects, but no default behavior for which camera should be used.
std::string GetCameraName(vtkIdType camIndex) override
Get the name of a camera.
void ImportLights(vtkRenderer *renderer) override
bool GetTemporalInformation(vtkIdType animationIndex, double frameRate, int &nbTimeSteps, double timeRange[2], vtkDoubleArray *timeSteps) override
Get temporal information for the provided animationIndex and frameRate.
std::vector< bool > EnabledAnimations
static vtkGLTFImporter * New()
vtkIdType GetNumberOfAnimations() override
Get the number of available animations.
void ImportCameras(vtkRenderer *renderer) override
a simple class to control print indentation
Definition vtkIndent.h:29
abstract specification for renderers
Definition vtkRenderer.h:60
Abstract class used for custom streams.
Hold a reference to a vtkObjectBase instance.
handles properties associated with a texture map
Definition vtkTexture.h:59
Helper class for readers and importer that need to load more than one resource.
int vtkIdType
Definition vtkType.h:332