DbModelDocViewStyle.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 OD_MODELDOCVIEWSTYLE_H
#define OD_MODELDOCVIEWSTYLE_H
 
#include "TD_PackPush.h"
#include "DbObject.h"

class ODRX_ABSTRACT DBENT_EXPORT OdDbModelDocViewStyle : public OdDbObject
{
protected:
  // Default constructor is protected since OdDbModelDocViewStyle is an abstract class.
  OdDbModelDocViewStyle();
 
public:
  ODDB_DECLARE_MEMBERS(OdDbModelDocViewStyle);

  enum AttachmentPoint {
    kAboveView    = 0,  // Label text is attached above the view.   
    kBelowView    = 1,  // Label text is attached below the view.
  };

  enum TextAlignment {
    kTextAlignmentLeft   = 0, // Left alignment is used for the view label text.
    kTextAlignmentCenter = 1, // Center alignment is used for the view label text.
    kTextAlignmentRight  = 2, // Right alignment is used for the view label text.
  };
 
  // Default destructor.
  virtual ~OdDbModelDocViewStyle() = 0;

  virtual OdString getName() const;

  virtual void setName(const OdString& name);

  virtual OdString description() const;

  virtual void setDescription(const OdString& description);

  virtual void setDatabaseDefaults(OdDbDatabase* pDb);

  virtual OdDbObjectId postViewStyleToDb(OdDbDatabase* pDb, 
                                         const OdString& styleName) = 0;

  bool isModifiedForRecompute() const;

  OdString defaultViewName(int index) const;

  bool isViewNameValid(const OdString& name) const;

  //  Calculates a view label's position.
  //
  //  \param offsetVector [out] Offset (vector) of the view label.
  //  \param textAlignment [out] Text alignment of the view label.
  //  \param attachment [in] Use with the offset argument to specify label position.
  //  \param offset [in] Use with the attachment argument to specify label position. 
  //  \param minPt [in] Point located in the lower left corner of the view's bounding box. 
  //  \param maxPt [in] Point located in the upper right corner of the view's bounding box. 
  //
  //  \returns
  //  Position of the view label.
  //*/
  //static OdGePoint3d calculateViewLabelPosition(OdGeVector2d& offsetVector,
  //                                              OdDbMText::AttachmentPoint& textAlignment,
  //                                              OdDbModelDocViewStyle::AttachmentPoint attachment,
  //                                              double offset,
  //                                              const OdGePoint3d& minPt,
  //                                              const OdGePoint3d& maxPt);

  //  Sets the position of a view label.
  //  
  //  \param pMText [in] Pointer to MText object to be positioned as a label.
  //  \param attachment [in] Use with the offset argument to specify label position. 
  //  \param offset [in] Use with the attachment argument to specify label position.
  //  \param minPt [in] Point located in the lower left corner of the view's bounding box.
  //  \param maxPt [in] Point located in the upper right corner of the view's bounding box. 
  //  
  //  \returns
  //  Position of the view label.
  //*/
  //static OdGeVector2d setViewLabelPosition(OdDbMText* pMText,
  //                                         OdDbModelDocViewStyle::AttachmentPoint attachment,
  //                                         double offset,
  //                                         const OdGePoint3d& minPt,
  //                                         const OdGePoint3d& maxPt);

  //  Updates the position of a view label.
  //
  //  \param pMText [in] Pointer to MText object to be positioned as a label.
  //  \param attachment [in] Specifies whether the label is attached. 
  //  \param minPt [in] Point located in the lower left corner of the view's bounding box.
  //  \param maxPt [in] Point located in the upper right corner of the view's bounding box. 
  //
  //  \returns
  //  Position of the view label.
  //*/
  //static OdGeVector2d updateViewLabelPosition(OdDbMText* pMText,
  //                                            OdDbModelDocViewStyle::AttachmentPoint attachment,
  //                                            const OdGePoint3d& minPt,
  //                                            const OdGePoint3d& maxPt);
 
  OdString getDisplayName() const;
  OdResult setDispayName( const OdString& name );
  bool canRename() const;
  OdResult setCanRename(bool canRename);

  virtual OdDbObjectId viewLabelTextStyleId() const = 0;
  virtual OdCmColor viewLabelTextColor() const = 0;
  virtual double viewLabelTextHeight() const = 0;
  virtual double viewLabelOffset() const = 0;
  virtual AttachmentPoint viewLabelAttachment() const = 0;
  virtual TextAlignment viewLabelAlignment() const = 0;
  virtual OdString viewLabelPattern() const = 0;
protected:
  // OdDbObject overridden functions
  virtual OdResult dwgInFields(OdDbDwgFiler* pFiler);
  virtual void dwgOutFields(OdDbDwgFiler* pFiler) const;
  virtual OdResult dxfInFields(OdDbDxfFiler* pFiler);
  virtual void dxfOutFields(OdDbDxfFiler* pFiler) const;
 
  enum
  {
    kCanRename = 1
  };
 
  virtual OdResult subOpen(OdDb::OpenMode mode) ODRX_OVERRIDE;
//protected:
//  // For internal use only
//  virtual OdDbObjectPtr subDeepClone(OdDbObject* pOwner,
//                                     OdDbIdMapping& idMap, bool isPrimary = true) const;
//  virtual OdDbObjectPtr subWblockClone(OdDbObject* pOwner,
//                                       OdDbIdMapping& idMap, bool isPrimary = true) const;
//private:
//    friend class OdDbModelDocViewStyleImp;
};

typedef OdSmartPtr<OdDbModelDocViewStyle> OdDbModelDocViewStylePtr;
 
#include "TD_PackPop.h"
 
#endif // OD_MODELDOCVIEWSTYLE_H