Bcf_2_1Bitmap.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_BITMAP_H
#define _BCF_2_1_BITMAP_H
 
#include "BcfCommon.h"
#include "OdGUID.h"
 
#include "BcfElement.h"

namespace OdBcf_2_1 {
 
  class OdBcfPoint;
  typedef OdSmartPtr<OdBcfPoint> OdBcfPointPtr;
 
  class OdBcfDirection;
  typedef OdSmartPtr<OdBcfDirection> OdBcfDirectionPtr;
 
  class OdBcfSession;

  class OdBcfBitmapData
  {
  public:
    OdString          m_bitmap;
    OdString          m_reference;
    OdBcfPointPtr     m_pLocation;
    OdBcfDirectionPtr m_pNormal;
    OdBcfDirectionPtr m_pUp;
    double            m_height;
    OdGUID            m_guid; //TODO: resolve documentation inconsistency
  };

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

    OdBcfBitmap();

    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    const OdString& getBitmap() const;

    bool isBitmapUnset() const;

    const OdString& getReference() const;

    bool isReferenceUnset() const;

    const OdBcfPointPtr& getLocation() const;

    bool isLocationUnset() const;

    const OdBcfDirectionPtr& getNormal() const;

    bool isNormalUnset() const;

    const OdBcfDirectionPtr& getUp() const;

    bool isUpUnset() const;

    const double& getHeight() const;

    bool isHeightUnset() const;

    const OdGUID& getGuid() const;

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

    OdBcfBitmap& operator = (const OdBcfBitmapData& val);

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

  typedef OdSmartPtr<OdBcfBitmap> OdBcfBitmapPtr;
 
} //namespace OdBcf_2_1
 
#endif // _BCF_2_1_BITMAP_H