Bcf_2_1VisualizationInfo.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _BCF_2_1_VISUALIZATION_INFO_H
#define _BCF_2_1_VISUALIZATION_INFO_H
 
#include "BcfCommon.h"
#include "OdArray.h"
#include "OdGUID.h"
 
#include "BcfElement.h"

namespace OdBcf_2_1 {
 
  class OdBcfComponents;
  typedef OdSmartPtr<OdBcfComponents> OdBcfComponentsPtr;
 
  class OdBcfOrthogonalCamera;
  typedef OdSmartPtr<OdBcfOrthogonalCamera> OdBcfOrthogonalCameraPtr;
 
  class OdBcfPerspectiveCamera;
  typedef OdSmartPtr<OdBcfPerspectiveCamera> OdBcfPerspectiveCameraPtr;
 
  class OdBcfLines;
  typedef OdSmartPtr<OdBcfLines> OdBcfLinesPtr;
 
  class OdBcfClippingPlanes;
  typedef OdSmartPtr<OdBcfClippingPlanes> OdBcfClippingPlanesPtr;
 
  class OdBcfBitmap;
  typedef OdSmartPtr<OdBcfBitmap> OdBcfBitmapPtr;
  
  typedef OdArray<OdBcfBitmapPtr> OdBcfBitmapArray;
 
  class OdBcfSession;

  class OdBcfVisualizationInfoData
  {
  public:
    OdBcfComponentsPtr        m_pComponents;
    
    OdBcfOrthogonalCameraPtr  m_pOrthogonalCamera;
    
    OdBcfPerspectiveCameraPtr m_pPerspectiveCamera;
    
    OdBcfLinesPtr             m_pLines;
    
    OdBcfClippingPlanesPtr    m_pClippingPlanes;
    
    OdBcfBitmapArray          m_bitmap;
  protected:
  
    OdGUID                    m_guid;
  };

  class BCF_2_1_EXPORT OdBcfVisualizationInfo : public OdBcf::OdBcfElement, protected OdBcfVisualizationInfoData
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfVisualizationInfo);
    //DOM-IGNORE-END

    OdBcfVisualizationInfo();

    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    const OdBcfComponentsPtr& getComponents() const;

    bool isComponentsUnset() const;

    const OdBcfOrthogonalCameraPtr& getOrthogonalCamera() const;

    bool isOrthogonalCameraUnset() const;

    const OdBcfPerspectiveCameraPtr& getPerspectiveCamera() const;

    bool isPerspectiveCameraUnset() const;

    const OdBcfLinesPtr& getLines() const;

    bool isLinesUnset() const;

    const OdBcfClippingPlanesPtr& getClippingPlanes() const;

    bool isClippingPlanesUnset() const;

    const OdBcfBitmapArray& getBitmap() const;

    bool isBitmapUnset() const;

    const OdGUID& getGuid() const;

    bool isGuidUnset() const;
 
    //DOM-IGNORE-BEGIN
  protected:
    void setGuid(const OdGUID &guidValue);

    OdBcfVisualizationInfo& operator = (const OdBcfVisualizationInfoData& val);

    virtual bool validateData() const ODRX_OVERRIDE;
 
    friend class OdBcfSession;
    //DOM-IGNORE-END
  };

  typedef OdSmartPtr<OdBcfVisualizationInfo> OdBcfVisualizationInfoPtr;
 
} //namespace OdBcf_2_1
 
#endif // _BCF_2_1_VISUALIZATION_INFO_H