scene_initialization_helpers.h

Go to the documentation of this file.

 
#ifndef SDK_VIS_SCENE_INITIALIZATION_HELPERS_H_
#define SDK_VIS_SCENE_INITIALIZATION_HELPERS_H_
#pragma once
 
#include <map>
#include <base/inc/platform.h>
#include <base/inc/sdk_results.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_any_handler.h>
#include <visualizationlayer/inc/graphics/os_specific_types.h>
#include "../graphic_context_interface.h"
#include "../backend_interface.h"
 
#if defined(SDK_OS_WIN)
// Windows/DirectX specific types
# include <Windows.h>
# if defined(SDK_GRAPHICS_USE_DIRECTX_10_1)
#  include <d3d10_1.h>
#  undef ERROR
# endif
#elif defined(SDK_OS_LINUX)
// No additional includes required for Linux
#elif defined(SDK_OS_ANDROID)
// No additional includes required for Android
#else
// TODO:
Other OS specific includes
#endif // SDK_OS_WIN
 
namespace sdk {
namespace vis {
namespace scene {
 
class GraphicContextInitParametersHelper : public IGraphicContextInitialParameters
{
public:
  virtual SDKResult SDK_CALLTYPE GetParameter(SDKParameterID parameter_id, SDKAny& value) const throw();
  virtual SDKResult SDK_CALLTYPE SetParameter(SDKParameterID parameter_id, const SDKAny& value) throw()
  { return kSDKResult_NotImplemented; } // Initial value can't be changed
  virtual SDKResult SDK_CALLTYPE Clone(ISDKParametersSP& clone) const throw()
  { return kSDKResult_NotImplemented; }
 
  virtual SDKAtomicRefCount SDK_CALLTYPE AddRef() const throw();
  virtual SDKAtomicRefCount SDK_CALLTYPE Release() const throw();
  virtual SDKResult SDK_CALLTYPE GetInterface(
    const InterfaceId& id, void** obj_ptr) throw();
 
  static SDKResult CreateGraphicContextInitialParametersForAutoType(
    sdk::vis::scene::IGraphicContextInitialParametersSP& init_params) throw();
  static SDKResult CreateGraphicContextInitialParametersForAutoType(
    const sdk::gfx::OSWindow& window, // Should be non-null
    sdk::vis::scene::IGraphicContextInitialParametersSP& init_params) throw();
 
#if defined(SDK_OS_WIN) && defined(SDK_GRAPHICS_USE_DIRECTX_10_1)
  // \brief DO NOT RELEASE the ID3D10Device1 instance, due of initial settings
  // component does not holds a strong reference to it
  static SDKResult CreateGraphicContextInitialParametersForDirectX10Type(
    ID3D10Device1* d3d10_device, // Can be NULL to create internal DirectX context
    sdk::vis::scene::IGraphicContextInitialParametersSP& init_params) throw(); 
#endif // SDK_OS_WIN && SDK_GRAPHICS_USE_DIRECTX_10_1
 
  static SDKResult CreateGraphicContextInitialParametersForOpenGLType(
    const sdk::gfx::OpenGLGraphicsDeviceContext& device_context,
    sdk::vis::scene::IGraphicContextInitialParametersSP& init_params) throw(); 
  
  static SDKResult CreateGraphicContextInitialParametersForSoftwareType(
    sdk::vis::scene::IGraphicContextInitialParametersSP& init_params) throw();
        
protected:
  GraphicContextInitParametersHelper();
  virtual ~GraphicContextInitParametersHelper();
 
  virtual SDKResult SetParameterImpl(const SDKParameterID& id, const SDKAny& value) throw();
 
private:
  GraphicContextInitParametersHelper(const GraphicContextInitParametersHelper&);
  void operator=(const GraphicContextInitParametersHelper&);
 
protected:
  // Number of references
  mutable SDKAtomicRefCount m_ref;
 
  // Parameters storage
  typedef std::map<SDKParameterID, SDKAnyHandler> ParametersMap;
  ParametersMap                                   m_parameters;
#if defined(SDK_OS_WIN)
  // Windows specific Window/DC handles for Window based context
  HWND m_hwnd;
  HDC  m_hdc;
#endif // SDK_OS_WIN
};
 
class BackendInitParametersHelper : public IBackendInitialParameters
{
public:
  virtual SDKResult SDK_CALLTYPE GetParameter(SDKParameterID parameter_id, SDKAny& value) const throw();
  virtual SDKResult SDK_CALLTYPE SetParameter(SDKParameterID parameter_id, const SDKAny& value) throw()
  { return kSDKResult_NotImplemented; } // Initial value can't be changed
  virtual SDKResult SDK_CALLTYPE Clone(ISDKParametersSP& clone) const throw()
  { return kSDKResult_NotImplemented; }
 
  virtual SDKAtomicRefCount SDK_CALLTYPE AddRef() const throw();
  virtual SDKAtomicRefCount SDK_CALLTYPE Release() const throw();
  virtual SDKResult SDK_CALLTYPE GetInterface(const InterfaceId& id,
    void** obj_ptr) throw();
 
  static SDKResult CreateBackendInitialParametersForWindowType(
    const sdk::gfx::OSWindow& window,
    sdk::vis::scene::IBackendInitialParametersSP& init_params) throw();
 
  static SDKResult CreateBackendInitialParametersForTextureType(
    const SDKSize& texture_size, 
    sdk::vis::scene::IBackendInitialParametersSP& init_params) throw();
 
protected:
  BackendInitParametersHelper();
  virtual ~BackendInitParametersHelper();
 
  virtual SDKResult SetParameterImpl(const SDKParameterID& id, const SDKAny& value) throw();
 
private:
  BackendInitParametersHelper(const BackendInitParametersHelper&);
  void operator=(const BackendInitParametersHelper&);
 
protected:
  // Number of references
  mutable SDKAtomicRefCount m_ref;
 
  // Parameters storage
  typedef std::map<SDKParameterID, SDKAnyHandler> ParametersMap;
  ParametersMap                                   m_parameters;
};
 
} // namespace scene 
} // namespace vis
} // namespace sdk 
 
#endif // SDK_VIS_SCENE_INITIALIZATION_HELPERS_H_