DbDetailSymbol.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_DETAILSYMBOL_H
#define OD_DETAILSYMBOL_H
 
#include "DbViewSymbol.h"
#include "DbDetailViewStyle.h"
#include "TD_PackPush.h"

class MODELDOCOBJ_EXPORT OdDbDetailSymbol : public OdDbViewSymbol
{
public:
  ODDB_DECLARE_MEMBERS(OdDbDetailSymbol);

  OdDbDetailSymbol();
  ~OdDbDetailSymbol();

  enum BoundaryType
  {
    kCircularBoundary,         // Circular boundary
    kRectangularBoundary,   // Rectangular boundary
    kCustomBoundary       // Custom boundary type
  };
 

  enum OverriddenProperty
  {
    kNone = 0,                             // No properties are overridden
    kModelEdge = 0x1,                 // Indicates the model edge type of the corresponding OdDbDetailViewStyle object has been overridden.
    kIdentifierPosition = 0x1 << 1   // Indicates the identifier placement of the corresponding OdDbDetailViewStyle object has been overridden.
  };

  BoundaryType boundaryType() const;

  OdDbDetailViewStyle::ModelEdge modelEdgeType() const;

  bool isOverriddenProperty(OdDbDetailSymbol::OverriddenProperty property) const;

  bool displayIdentifier() const;
 

  OdGePoint3d origin() const;

  const OdGeVector3d direction() const;

  const OdGeVector2d& boundarySize() const;

  const OdGePoint3d& modelEdgeOrigin() const;

  double owningViewScale() const;

  double detailViewScale() const;

  const OdGeVector3d& modelEdgeDirection() const;

  OdResult modelEdgeBorderExtents(OdGeExtents3d& extents) const;

  OdGePoint3d identifierPosition() const;
 
  // Methods to use internal only :
 
  OdResult initializeIdentifierPositionAt( const OdGePoint3d& pt );
  OdResult resetIdentifierPosition();
  OdResult setIdentifierPosition( const OdGePoint3d& pt );
 
  OdResult setDetailViewScale( double viewScale );
  OdResult setOwningViewScale( double viewScale );
 
  OdResult setBoundaryType( OdDbDetailSymbol::BoundaryType bndType );
 
  OdResult setModelEdgeType( OdDbDetailViewStyle::ModelEdge modelEdgeType );
  OdResult setModelEdgeOrigin( const OdGePoint3d& pt );
  OdResult setModelEdgeDirection( const OdGeVector3d& dir );
 
  OdResult setDisplayIdentifier( const bool displayIdentifier );
 
  OdResult setOrigin( const OdGePoint3d& pt );
  OdResult setBoundarySize( const OdGeVector2d& size );
 
  OdResult setPickPoints(const OdGePoint3dArray& pickPoints);
 
protected:
  virtual void modified(const OdDbObject* pObject) ODRX_OVERRIDE;
 
  // OdDbObject methods :
  virtual OdResult dwgInFields(OdDbDwgFiler* pFiler) ODRX_OVERRIDE;
  virtual void dwgOutFields(OdDbDwgFiler* pFiler) const ODRX_OVERRIDE;
  virtual OdResult dxfInFields(OdDbDxfFiler* pFiler) ODRX_OVERRIDE;
  virtual void dxfOutFields(OdDbDxfFiler* pFiler) const ODRX_OVERRIDE;
 
  // OdGiDrawable methods :
  virtual bool subWorldDraw(OdGiWorldDraw* pWorldDraw) const ODRX_OVERRIDE;
 
  virtual OdResult subTransformBy( const OdGeMatrix3d& xfm ) ODRX_OVERRIDE;
 
  virtual void subSetDatabaseDefaults(OdDbDatabase* db, bool doSubents) ODRX_OVERRIDE;
 
};

typedef OdSmartPtr<OdDbDetailSymbol> OdDbDetailSymbolPtr;
 
#include "TD_PackPop.h"
 
#endif // OD_DETAILSYMBOL_H