DbDynBlockReference.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 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 _DbDynBlock_h_Included_
#define _DbDynBlock_h_Included_
 
 
#include "DbEvalGraph.h"
#include "TD_PackPush.h"
 
// Forward class declarations
 
class OdDbBlockReference;
class OdDbDynBlockReference;
class OdDbDynBlockReferenceProperty;
class OdDbDynBlockReferencePropertyImpl;
class OdDbDynBlockReferenceImpl;
struct OdDbBlkParamPropertyDescriptor;
class OdDbBlockParameter;
class OdDbDynBlockTableRecordImpl;
class OdDbBlockRepresentationContext;
typedef OdSmartPtr<OdDbBlockParameter> OdDbBlockParameterPtr;
 
class DYNBLOCKS_EXPORT OdDbDynBlockReferenceProperty : public OdRxObject
{
public:
 
  enum UnitsType {
    kNoUnits  = 0,  // No units defined.
    kAngular  = 1,  // Angle.
    kDistance = 2,  // Distance.
    kArea     = 3   // 2D area.
  };
 
  OdDbDynBlockReferenceProperty ();
  virtual ~OdDbDynBlockReferenceProperty ();
 
  OdDbDynBlockReferenceProperty (const OdDbDynBlockReferenceProperty& other);
 
  OdDbDynBlockReferenceProperty& operator=(
    const OdDbDynBlockReferenceProperty& other);
 
  OdDbObjectId blockId() const;
 
  OdString propertyName()  const;
 
  OdResBuf::ValueType propertyType() const;
 
  bool readOnly() const;
 
  
  bool show() const;
 
  bool visibleInCurrentVisibilityState() const;
 
  OdString description () const;
 
  UnitsType             unitsType () const;
 
 
  void getAllowedValues(OdResBufArray& allowedValues);
 
  OdResBufPtr value () const;
 
  bool setValue (const OdResBufPtr& value);
 
  OdDbBlockParameterPtr getParameter();
  
  void getDescriptor(OdDbEvalNodeId& parameterId, OdDbBlkParamPropertyDescriptor& pDescriptor);
 
private:
  friend class OdDbDynBlockReferencePropertyImpl;
  OdDbDynBlockReferencePropertyImpl* m_pImpl;
};
 
typedef OdSmartPtr<OdDbDynBlockReferenceProperty> OdDbDynBlockReferencePropertyPtr;
typedef OdArray<OdDbDynBlockReferencePropertyPtr> OdDbDynBlockReferencePropertyArray;
 
class DYNBLOCKS_EXPORT OdDbDynBlockReference
{
// FELIX_CHANGE_BEGIN
  // need to make BomUtil a friend class since it uses a private function
  // which became public in a newer ODA version
  friend class BomUtil;
// FELIX_CHANGE_END
  ODRX_HEAP_OPERATORS();
public:
  
  OdDbDynBlockReference(const OdDbObjectId& blockRefId);
 
  OdDbDynBlockReference(OdDbBlockReference* pRef);
 
  virtual ~OdDbDynBlockReference ();
 
  static bool isDynamicBlock (const OdDbObjectId& blockTableRecordId);
  
  bool isDynamicBlock () const;
 
  OdDbObjectId blockId() const;
 
 
  void getBlockProperties(OdDbDynBlockReferencePropertyArray& properties) const;
 
  void resetBlock();
 
  bool convertToStaticBlock();
  bool convertToStaticBlock (const OdString& newBlockName);
 
  OdDbObjectId dynamicBlockTableRecord () const;
 
  OdDbObjectId anonymousBlockTableRecord () const; 
private:
  OdDbDynBlockReference();
  OdDbBlockRepresentationContext* getRepresentationContext() const;
  OdDbDynBlockReferenceImpl* m_pImpl;
  friend class OdDbDynBlockTableRecord;
};
 
class DYNBLOCKS_EXPORT OdDbDynBlockTableRecord
{
  ODRX_HEAP_OPERATORS();
public:
  OdDbDynBlockTableRecord(OdDbObjectId blockId);
  ~OdDbDynBlockTableRecord();
  bool isDynamicBlock() const;
  OdDbObjectId blockTableRecordId() const;
  
  void getAnonymousBlockIds(OdDbObjectIdArray& anonymousIds) const;
  void updateAnonymousBlocks() const;
private:
  OdDbDynBlockTableRecord();
  OdDbDynBlockTableRecordImpl* m_pImpl;
};
 
#include "TD_PackPop.h"
 
#endif