fs_pdf3d.h

#if (defined(_WIN32) || defined(_WIN64)) || defined(__EMSCRIPTEN__)

#ifndef FS_3DPDF_H_
#define FS_3DPDF_H_
#include "common/fs_common.h"
#include "pdf/fs_pdfdoc.h"
#include "pdf/annots/fs_annot.h"
namespace foxit {
namespace addon {
namespace pdf3d {
class PDF3DAnnotViewData FS_FINAL : public Object{
 public:
  PDF3DAnnotViewData(){}

  PDF3DAnnotViewData(const PDF3DAnnotViewData& other) {
    this->display_name = other.display_name;
    this->name = other.name;
  }

  PDF3DAnnotViewData& operator = (const PDF3DAnnotViewData& data) {
    this->display_name = data.display_name;
    this->name = data.name;
    return *this;
  }

  WString display_name;

  WString name;
};

FSDK_DEFINE_ARRAY(PDF3DAnnotViewDataArray, PDF3DAnnotViewData)


class ModelNode FS_FINAL : public Base{
 public:
  typedef enum _PDF3DModelNodeType {
    e_TypeModelRoot = 0,
    e_TypeGroup = 1,
    e_TypeMesh = 2,
    e_TypeSprite = 3,
    e_TypeMarkup = 4,
    e_TypePunctualLight = 5,
    e_TypeAmbientLight = 6,
    e_TypeViewCamera = 7,
    e_TypeClippingPlane = 8,
    e_TypeProcedural = 9,
    e_TypeBone = 10,
    e_TypeDummy = 11
  } PDF3DModelNodeType;
  
  ModelNode() {}

  ModelNode(const ModelNode& other);

  ~ModelNode();

  bool IsEmpty() const;

  ModelNode& operator=(const ModelNode& other);

  bool operator==(const ModelNode& other) const;

  bool operator!=(const ModelNode& other) const;
  
  PDF3DModelNodeType GetNodeType();

  ModelNode GetFirstChildNode();

  ModelNode GetNextSiblingNode();

  ModelNode GetParentNode();

  WString GetName();

  void SetVisible(bool is_visible);

  bool IsVisible();

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit ModelNode(FS_HANDLE handle);
};

class PDF3DAnnotInstance FS_FINAL : public Base{
 public:
  typedef enum _PDF3DController {
    e_ControllerRotate = 0,
    e_ControllerSpin = 1,
    e_ControllerPan = 2,
    e_ControllerZoom = 3,
    e_ControllerWalk = 4,
    e_ControllerFly     = 5
  } PDF3DController;
  
  typedef enum _PDF3DRenderMode {
    e_RenderModeSolid = 1,
    e_RenderModeSolidWireframe = 2,
    e_RenderModeSolidOutline = 3,
    e_RenderModeTransparent = 4,
    e_RenderModeTransparentWireframe = 5,
    e_RenderModeBoundingBox = 6,
    e_RenderModeTransparentBoundingBox = 7,
    e_RenderModeTransparentBoundingBoxOutline = 8,
    e_RenderModeWireframe = 9,
    e_RenderModeShadedWireframe = 10,
    e_RenderModeHiddenWireframe = 11,
    e_RenderModeIllustration = 12,
    e_RenderModeShadedIllustration = 13,
    e_RenderModeVertices = 14,
    e_RenderModeShadedVertices = 15
  } PDF3DRenderMode;
  

  PDF3DAnnotInstance(){}

  PDF3DAnnotInstance(const PDF3DAnnotInstance& other);

  ~PDF3DAnnotInstance();

  PDF3DAnnotInstance& operator=(const PDF3DAnnotInstance& other);

  bool operator==(const PDF3DAnnotInstance& other) const;

  bool operator!=(const PDF3DAnnotInstance& other) const;

  bool IsEmpty() const;

  void SetController(PDF3DController tool_tag);

  void SetRenderMode(PDF3DRenderMode render_mode);

  FX_HWND ActivateCanvas(FX_HWND screen_canvas_parent);

  void UpdateCanvas(RectI rect);

  void OnLButtonDown(int flag, PointF point);

  void OnLButtonUp(int flag, PointF point);

  void OnMouseMove(int flag, PointF point);

  void OnMouseWheel(int flag, int delta, PointF point);

  void OnRButtonDown(int flag, PointF point);

  void OnRButtonUp(int flag, PointF point);

  void ResetDefaultView();

  PDF3DAnnotViewDataArray GetPresetViewList();

  void ApplyPresetView(const PDF3DAnnotViewData& view_data);

  ModelNode GetRootNode();

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit PDF3DAnnotInstance(FS_HANDLE handle);
};
FSDK_DEFINE_ARRAY(PDF3DAnnotInstanceArray, PDF3DAnnotInstance)


class PDF3DAnnot FS_FINAL : public Base{
 public:
  typedef enum _PDF3DType {
    e_3DTypeArtwork = 0,
    e_3DTypeRichMedia = 1
  } PDF3DType;
  

  ~PDF3DAnnot();

  PDF3DAnnot(const PDF3DAnnot& other);

  PDF3DAnnot& operator=(const PDF3DAnnot& other);

  bool operator==(const PDF3DAnnot& other) const;

  bool operator!=(const PDF3DAnnot& other) const;

  bool IsEmpty() const;

  int GetAnnotIndex();

  pdf::annots::Annot GetAnnot();

  PDF3DType Get3DAnnotType();
  
  PDF3DAnnotInstance Get3DArtworkInstance();

  PDF3DAnnotInstanceArray GetRichMediaInstances();

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit PDF3DAnnot(FS_HANDLE handle);
};
FSDK_DEFINE_ARRAY(PDF3DAnnotArray, PDF3DAnnot)


class PDF3DLaunchSetting FS_FINAL : public Object {
 public:
  typedef enum _PDF3DActivationEnableSetting {
    e_3DActivationEnableSettingContentClicked = 0,
    e_3DActivationEnableSettingPageOpened = 1,
    e_3DActivationEnableSettingPageVisible = 2
  } PDF3DActivationEnableSetting;
  
  typedef enum _PDF3DActivationDisableSetting {
    e_3DActivationDisableSettingContextMenuSelected = 0,
    e_3DActivationDisableSettingPageClosed = 1,
    e_3DActivationDisableSettingPageInvisible = 2
  } PDF3DActivationDisableSetting;
  
  typedef enum _PDF3DActivationPlaybackStyleSetting {
    e_3DActivationPlaybackStyleOnPage = 0,
    e_3DActivationPlaybackStyleInFloatingWindow = 1
  } PDF3DActivationPlaybackStyleSetting;
  
  typedef enum _PDF3DAppearanceSettingBorderWidth {
    e_3DAppearanceSettingBorderWidthNone = 0,
    e_3DAppearanceSettingBorderWidthThin = 1,
    e_3DAppearanceSettingBorderWidthMedium = 2,
    e_3DAppearanceSettingBorderWidthThick = 3
  } PDF3DAppearanceSettingBorderWidth;
  
  typedef enum _PDF3DPosterImageSetting {
    e_3DPosterImageKeepCurrent = 0,
    e_3DPosterImageRetrieveFromDefaultView = 1,
    e_3DPosterImageCreateFromFile = 2
  } PDF3DPosterImageSetting;
  

  PDF3DLaunchSetting()
   : activation_enable(e_3DActivationEnableSettingContentClicked)
   , activation_disable(e_3DActivationDisableSettingContextMenuSelected)
   , activation_playback(e_3DActivationPlaybackStyleOnPage)
   , window_width(320)
   , window_height(240)
   , border_width(e_3DAppearanceSettingBorderWidthNone)
   , is_transparent_background(false)
   , poster_image(e_3DPosterImageKeepCurrent)
   , poster_file_path(L"") {
  }

  PDF3DLaunchSetting(const PDF3DLaunchSetting& launch_setting)
    : activation_enable(launch_setting.activation_enable)
    , activation_disable(launch_setting.activation_disable)
    , activation_playback(launch_setting.activation_playback)
    , window_width(launch_setting.window_width)
    , window_height(launch_setting.window_height)
    , border_width(launch_setting.border_width)
    , is_transparent_background(launch_setting.is_transparent_background)
    , poster_image(launch_setting.poster_image) 
    , poster_file_path(launch_setting.poster_file_path) {
  }

  PDF3DLaunchSetting(PDF3DActivationEnableSetting activation_enable, PDF3DActivationDisableSetting activation_disable ,
           PDF3DActivationPlaybackStyleSetting activation_playback, int window_width, int window_height,
           PDF3DAppearanceSettingBorderWidth border_width, bool is_transparent_background,
           PDF3DPosterImageSetting poster_image, WString poster_file_path) {
    this->activation_enable = activation_enable;
    this->activation_disable = activation_disable;
    this->activation_playback = activation_playback;
    this->window_width = window_width;
    this->window_height = window_height;
    this->border_width = border_width;
    this->is_transparent_background = is_transparent_background;
    this->poster_image = poster_image;
    this->poster_file_path = poster_file_path;
  }

  void Set(PDF3DActivationEnableSetting activation_enable, PDF3DActivationDisableSetting activation_disable ,
           PDF3DActivationPlaybackStyleSetting activation_playback, int window_width, int window_height,
           PDF3DAppearanceSettingBorderWidth border_width, bool is_transparent_background, 
           PDF3DPosterImageSetting poster_image, WString poster_file_path) {
    this->activation_enable = activation_enable;
    this->activation_disable = activation_disable;
    this->activation_playback = activation_playback;
    this->window_width = window_width;
    this->window_height = window_height;
    this->border_width = border_width;
    this->is_transparent_background = is_transparent_background;
    this->poster_image = poster_image;
    this->poster_file_path = poster_file_path;
  }

  PDF3DLaunchSetting& operator=(const PDF3DLaunchSetting& launch_setting) {
    this->activation_enable = launch_setting.activation_enable;
    this->activation_disable = launch_setting.activation_disable;
    this->activation_playback = launch_setting.activation_playback;
    this->window_width = launch_setting.window_width;
    this->window_height = launch_setting.window_height;
    this->border_width = launch_setting.border_width;
    this->is_transparent_background = launch_setting.is_transparent_background;
    this->poster_image = launch_setting.poster_image;
    this->poster_file_path = launch_setting.poster_file_path;
    return *this;
  }

  PDF3DActivationEnableSetting activation_enable;

  PDF3DActivationDisableSetting activation_disable;

  PDF3DActivationPlaybackStyleSetting activation_playback;

  int window_width;

  int window_height;

  PDF3DAppearanceSettingBorderWidth border_width;

  bool is_transparent_background;

  PDF3DPosterImageSetting poster_image;

  WString poster_file_path;
};

class PDF3DAdvancedSetting FS_FINAL : public Object{
 public:
  typedef enum _PDF3DLightingScheme {
    e_3DLightingSchemeNone = 0,
    e_3DLightingSchemeFromFile = 1,
    e_3DLightingSchemeNoLights = 2,
    e_3DLightingSchemeWhiteLights = 3,
    e_3DLightingSchemeDayLights = 4,
    e_3DLightingSchemeHardLights = 5,
    e_3DLightingSchemePrimaryLights = 6,
    e_3DLightingSchemeNightLights = 7,
    e_3DLightingSchemeBlueLights = 8,
    e_3DLightingSchemeRedLights = 9,
    e_3DLightingSchemeCubeLights = 10,
    e_3DLightingSchemeCADLights= 11,
    e_3DLightingSchemeHeadlamp= 12
  } PDF3DLightingScheme;
  
  typedef enum _PDF3DRenderingStyle {
    e_3DRenderingStyleNone = 0,
    e_3DRenderingStyleBoundingBox = 1,
    e_3DRenderingStyleTransparentBoundingBox = 2,
    e_3DRenderingStyleTransparentBoundingBoxOutline = 3,
    e_3DRenderingStyleVertices = 4,
    e_3DRenderingStyleShadedVertices = 5,
    e_3DRenderingStyleWireframe = 6,
    e_3DRenderingStyleShadedWireframe = 7,
    e_3DRenderingStyleSolid = 8,
    e_3DRenderingStyleTransparent = 9,
    e_3DRenderingStyleSolidWireframe = 10,
    e_3DRenderingStyleTransparentWireframe = 11,
    e_3DRenderingStyleIllustration = 12,
    e_3DRenderingStyleSolidOutline = 13,
    e_3DRenderingStyleShadedIllustration = 14,
    e_3DRenderingStyleHiddenWireframe = 15
  } PDF3DRenderingStyle;
  
  typedef enum _PDF3DAnimationStyle {
    e_3DAnimationStyleNone = 0,
    e_3DAnimationStyleLoop = 1,
    e_3DAnimationStyleBounce = 2
  } PDF3DAnimationStyle;
  
  typedef enum _PDF3DDefaultViews {
    e_3DDefaultViewsNoViews = 0,
    e_3DDefaultViewsLeftTopFrontIsoAllOrtho = 1,
    e_3DDefaultViewsLeftTopFrontIsoAllPerspective = 2,
    e_3DDefaultViewsLeftTopFrontOrthoIsoPerspective = 3,
    e_3DDefaultViewsLeftTopFrontPerspectiveIsoOrtho = 4,
    e_3DDefaultViewsLeftTopFrontRightBottomBackAllOrtho = 5,
    e_3DDefaultViewsFromFile = 6
  } PDF3DDefaultViews;
  

  PDF3DAdvancedSetting()
   : background_color(0x5E5E5E)
   , lighting_scheme(e_3DLightingSchemeNone)
   , rendering_style(e_3DRenderingStyleBoundingBox)
   , animation_style(e_3DAnimationStyleNone) 
   , default_views(e_3DDefaultViewsNoViews) 
   , is_add_default_views(false)
   , is_retain_views_and_comments(false)
   , is_show_tool_bar(true)
   , is_open_model_tree(false) 
   , script_file_path(L"") {
  }

  PDF3DAdvancedSetting(const PDF3DAdvancedSetting& advanced_setting)
    : background_color(advanced_setting.background_color)
    , lighting_scheme(advanced_setting.lighting_scheme)
    , rendering_style(advanced_setting.rendering_style)
    , animation_style(advanced_setting.animation_style)
    , default_views(advanced_setting.default_views) 
    , is_add_default_views(advanced_setting.is_add_default_views)
    , is_retain_views_and_comments(advanced_setting.is_retain_views_and_comments)
    , is_show_tool_bar(advanced_setting.is_show_tool_bar)
    , is_open_model_tree(advanced_setting.is_open_model_tree)
    , script_file_path(advanced_setting.script_file_path) {
  }

  PDF3DAdvancedSetting& operator=(const PDF3DAdvancedSetting& advanced_setting) {
    this->background_color = advanced_setting.background_color;
    this->lighting_scheme = advanced_setting.lighting_scheme;
    this->rendering_style = advanced_setting.rendering_style;
    this->animation_style = advanced_setting.animation_style;
    this->default_views = advanced_setting.default_views;
    this->is_add_default_views = advanced_setting.is_add_default_views;
    this->is_retain_views_and_comments = advanced_setting.is_retain_views_and_comments;
    this->is_show_tool_bar = advanced_setting.is_show_tool_bar;
    this->is_open_model_tree = advanced_setting.is_open_model_tree;
    this->script_file_path = advanced_setting.script_file_path;
    return *this;
  }

  PDF3DAdvancedSetting(foxit::RGB background_color, PDF3DLightingScheme lighting_scheme ,
          PDF3DRenderingStyle rendering_style, PDF3DAnimationStyle animation_style, 
          PDF3DDefaultViews default_views, bool is_add_default_views, bool is_retain_views_and_comments,
          bool is_show_tool_bar, bool is_open_model_tree, WString script_file_path) {
   this->background_color = background_color;
   this->lighting_scheme = lighting_scheme;
   this->rendering_style = rendering_style;
   this->animation_style = animation_style;
   this->default_views = default_views;
   this->is_add_default_views = is_add_default_views;
   this->is_retain_views_and_comments = is_retain_views_and_comments;
   this->is_show_tool_bar = is_show_tool_bar;
   this->is_open_model_tree = is_open_model_tree;  
   this->script_file_path = script_file_path;
 }
  void Set(foxit::RGB background_color, PDF3DLightingScheme lighting_scheme , 
          PDF3DRenderingStyle rendering_style, PDF3DAnimationStyle animation_style, 
          PDF3DDefaultViews default_views, bool is_add_default_views, bool is_retain_views_and_comments,
          bool is_show_tool_bar, bool is_open_model_tree, WString script_file_path) {
   this->background_color = background_color;
   this->lighting_scheme = lighting_scheme;
   this->rendering_style = rendering_style;
   this->animation_style = animation_style;
   this->default_views = default_views;
   this->is_add_default_views = is_add_default_views;
   this->is_retain_views_and_comments = is_retain_views_and_comments;
   this->is_show_tool_bar = is_show_tool_bar;
   this->is_open_model_tree = is_open_model_tree;  
   this->script_file_path = script_file_path;
 }
  foxit::RGB background_color;

  PDF3DLightingScheme lighting_scheme;

  PDF3DRenderingStyle rendering_style;

  PDF3DAnimationStyle animation_style;

  PDF3DDefaultViews default_views;

  bool is_add_default_views;

  bool is_retain_views_and_comments;

  bool is_show_tool_bar;

  bool is_open_model_tree;

  WString script_file_path;
};

class PDF3DContext FS_FINAL : public Base{
 public:
  explicit PDF3DContext(const pdf::PDFDoc& doc);

  PDF3DContext(const PDF3DContext& other);

  ~PDF3DContext();

  PDF3DContext& operator=(const PDF3DContext& other);

  bool operator==(const PDF3DContext& other) const;

  bool operator!=(const PDF3DContext& other) const;

  bool IsEmpty() const;

  PDF3DAnnotArray GetPage3DAnnotArray(int page_index);

  void Invalidate();

  PDF3DAnnot Add3DAnnot(const wchar_t* threeD_file_path, int page_index, foxit::RectF rectf, void* screen_canvas_parent,
      PDF3DLaunchSetting launch_setting, PDF3DAdvancedSetting advanced_setting);

  PDF3DAnnot Add3DAnnot(foxit::common::file::ReaderCallback* threeD_file_read, int page_index, foxit::RectF rectf, void* screen_canvas_parent, PDF3DLaunchSetting launch_setting, PDF3DAdvancedSetting advanced_setting);

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit PDF3DContext(FS_HANDLE handle = NULL);
};
} //pdf3d
} //addon
} //foxit
#endif //FS_3DPDF_H_
#endif //defined(_WIN32) || defined(_WIN64)