DocumentImporter.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "COLLADAFWController.h"
#include "COLLADAFWEffect.h"
#include "COLLADAFWEffectCommon.h"
#include "COLLADAFWIWriter.h"
#include "COLLADAFWImage.h"
#include "COLLADAFWMaterial.h"
 
#include "AnimationImporter.h"
#include "ArmatureImporter.h"
#include "ImportSettings.h"
#include "MeshImporter.h"
 
struct bContext;

class DocumentImporter : COLLADAFW::IWriter {
 public:
  enum ImportStage {
    Fetching_Scene_data,      /* First pass to collect all data except controller */
    Fetching_Controller_data, /* Second pass to collect controller data */
  };

  DocumentImporter(bContext *C, const ImportSettings *import_settings);

  ~DocumentImporter() override;

  bool import();

  Object *create_camera_object(COLLADAFW::InstanceCamera *, Scene *);
  Object *create_light_object(COLLADAFW::InstanceLight *, Scene *);
  Object *create_instance_node(Object *, COLLADAFW::Node *, COLLADAFW::Node *, Scene *, bool);
  void create_constraints(ExtraTags *et, Object *ob);
  std::vector<Object *> *write_node(COLLADAFW::Node *, COLLADAFW::Node *, Scene *, Object *, bool);
  void write_profile_COMMON(COLLADAFW::EffectCommon *, Material *);
 
  void translate_anim_recursive(COLLADAFW::Node *, COLLADAFW::Node *, Object *);

  void cancel(const COLLADAFW::String &errorMessage) override;

  void start() override;

  void finish() override;

  bool writeGlobalAsset(const COLLADAFW::FileInfo * /*asset*/) override;
  std::string get_import_version(const COLLADAFW::FileInfo *asset);

  bool writeScene(const COLLADAFW::Scene * /*scene*/) override;

  bool writeVisualScene(const COLLADAFW::VisualScene * /*visualScene*/) override;

  bool writeLibraryNodes(const COLLADAFW::LibraryNodes * /*libraryNodes*/) override;

  bool writeAnimation(const COLLADAFW::Animation * /*animation*/) override;

  bool writeAnimationList(const COLLADAFW::AnimationList * /*animationList*/) override;
 
#if WITH_OPENCOLLADA_ANIMATION_CLIP
  /* Please enable this when building with Collada 1.6.65 or newer (also in DocumentImporter.cpp)
   */
  bool writeAnimationClip(const COLLADAFW::AnimationClip *animationClip) override;
#endif

  bool writeGeometry(const COLLADAFW::Geometry * /*geometry*/) override;

  bool writeMaterial(const COLLADAFW::Material * /*material*/) override;

  bool writeEffect(const COLLADAFW::Effect * /*effect*/) override;

  bool writeCamera(const COLLADAFW::Camera * /*camera*/) override;

  bool writeImage(const COLLADAFW::Image * /*image*/) override;

  bool writeLight(const COLLADAFW::Light * /*light*/) override;

  bool writeSkinControllerData(
      const COLLADAFW::SkinControllerData * /*skinControllerData*/) override;

  bool writeController(const COLLADAFW::Controller * /*controller*/) override;
 
  bool writeFormulas(const COLLADAFW::Formulas * /*formulas*/) override;
 
  bool writeKinematicsScene(const COLLADAFW::KinematicsScene * /*kinematicsScene*/) override;

  bool addExtraTags(const COLLADAFW::UniqueId &uid, ExtraTags *extra_tags);
  ExtraTags *getExtraTags(const COLLADAFW::UniqueId &uid);
 
  bool is_armature(COLLADAFW::Node *node);
 
 private:
  const ImportSettings *import_settings;

  ImportStage mImportStage;
 
  bContext *mContext;
  ViewLayer *view_layer;
 
  UnitConverter unit_converter;
  ArmatureImporter armature_importer;
  MeshImporter mesh_importer;
  AnimationImporter anim_importer;

  using TagsMap = std::map<std::string, ExtraTags *>;
  TagsMap uid_tags_map;
 
  UidImageMap uid_image_map;
  std::map<COLLADAFW::UniqueId, Material *> uid_material_map;
  std::map<COLLADAFW::UniqueId, Material *> uid_effect_map;
  std::map<COLLADAFW::UniqueId, Camera *> uid_camera_map;
  std::map<COLLADAFW::UniqueId, Light *> uid_light_map;
  std::map<Material *, TexIndexTextureArrayMap> material_texture_mapping_map;
  std::multimap<COLLADAFW::UniqueId, Object *> object_map;
  std::map<COLLADAFW::UniqueId, COLLADAFW::Node *> node_map;
  std::vector<const COLLADAFW::VisualScene *> vscenes;
  std::vector<Object *> libnode_ob;
 
  std::map<COLLADAFW::UniqueId, COLLADAFW::Node *>
      root_map; /* find root joint by child joint uid, for bone tree evaluation during resampling
                 */
  std::map<COLLADAFW::UniqueId, const COLLADAFW::Object *> FW_object_map;
 
  std::string import_from_version;
 
  void report_unknown_reference(const COLLADAFW::Node &node, const std::string object_type);
};