AECDispCompEnt.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 __AECDISPCOMPENT_H__
#define __AECDISPCOMPENT_H__
 
#include "Subobjects/DispComps/AECDispComp.h"
#include <CmColor.h>
 
class AECBASE_API AECDispCompEnt : public AECDispComp
{
    AEC_DECLARE_MEMBERS( AECDispCompEnt );
 
    public:
        // Display Component specific method.
        // Assigns default layer linetype and similar properties.
        virtual void SetDbProperties( const OdDbDatabase* pDb );
 
    public:
        enum XPosition
        {
            exLeft      = 0,
            exCenter    = 1,
            exRight     = 2
        };
 
        enum YPosition
        {
            eyFront     = 0,
            eyCenter    = 1,
            eyBack      = 2
        };
 
        enum ZPosition
        {
            ezBottom    = 0,
            ezCenter    = 1,
            ezTop       = 2
        };
 
    public:
        bool IsVisible() const;
 
        void SetIsVisible( bool bVisible );
 
        const OdCmColor& GetColor() const;
 
        void SetColor( const OdCmColor& cColor );
        
        OdDbObjectId GetLayer() const;
 
        void SetLayer( const OdDbObjectId& idLayer );
        
        OdDbObjectId GetLinetype() const;
        
        void SetLinetype( const OdDbObjectId& idLinetype );
 
        OdDb::LineWeight GetLineWeight() const;
 
        void SetLineWeight( OdDb::LineWeight eLineWeight );
        
        double GetLtScale() const;
 
        void SetLtScale( double dScale );
 
        OdDb::PlotStyleNameType GetPlotStyleNameType() const;
 
        void SetPlotStyleNameType( OdDb::PlotStyleNameType eType );
 
        OdDbObjectId GetPlotStyle() const;
 
        void SetPlotStyle( const OdDbObjectId& idPlotStyle );
 
        bool MayBeByMaterial() const;
 
        void SetMayBeByMaterial( bool bMayBeByMaterial );
 
        bool IsByMaterial() const;
 
        void SetIsByMaterial( bool bByMaterial );
 
    public:
        // Common flags structure.
        // Used by opening blocks and structural member blocks.
        union BlockFlags
        {
            OdUInt16        m_iFlags;
            struct
            {
 
#ifdef ODA_BIGENDIAN
                OdUInt16 eFitType                  : 2;
                OdUInt16 bRepeatBlockDisplay       : 1;
                OdUInt16 bScaleToFitLockXYRatio    : 1;
                OdUInt16 eZPosition                : 2;
                OdUInt16 eYPosition                : 2;
                OdUInt16 eXPosition                : 2;
                OdUInt16 bMirrorZ                  : 1;
                OdUInt16 bMirrorY                  : 1;
                OdUInt16 bMirrorX                  : 1;
                OdUInt16 bScaleToFitHeight         : 1;
                OdUInt16 bScaleToFitDepth          : 1;
                OdUInt16 bScaleToFitWidth          : 1;
#else
                OdUInt16 bScaleToFitWidth          : 1;
                OdUInt16 bScaleToFitDepth          : 1;
                OdUInt16 bScaleToFitHeight         : 1;
                OdUInt16 bMirrorX                  : 1;
                OdUInt16 bMirrorY                  : 1;
                OdUInt16 bMirrorZ                  : 1;
                OdUInt16 eXPosition                : 2;
                OdUInt16 eYPosition                : 2;
                OdUInt16 eZPosition                : 2;
                OdUInt16 bScaleToFitLockXYRatio    : 1;
                OdUInt16 bRepeatBlockDisplay       : 1;
                OdUInt16 eFitType                  : 2;
#endif
            } m_bBits;
        };
 
    protected:
        union MaterialFlags
        {
            OdUInt16        m_iFlags;
            struct
            {
 
#ifdef ODA_BIGENDIAN
                OdUInt16 uReserved                 : 14;
                OdUInt16 bByMaterial               :  1;
                OdUInt16 bMayBeByMaterial          :  1;
#else
                OdUInt16 bMayBeByMaterial          :  1;
                OdUInt16 bByMaterial               :  1;
                OdUInt16 uReserved                 : 14;
#endif
            } m_bBits;
        };
 
    protected:
        // Visibility flag
        bool m_bVisible;
 
        // Display component's layer.
        OdDbHardPointerId m_hpidDbLayerTableRecord;
 
        // Display component's color.
        OdCmColor m_cColor;
        bool m_bNoneColor;
 
        // Display component's linetype.
        OdDbHardPointerId m_hpidDbLineTypeTableRecord;
 
        // This member stores line weight in .01 mm. There are special cases:
        // o    Value -3 means "Default"
        // o    Value -2 means "ByBlock"
        // o    Value -1 means "ByLayer"
        OdDb::LineWeight m_eLineWeight;
 
        // This member stores line-type scaling factor.
        double m_dLtScale;
 
        // Plot style name type.
        OdDb::PlotStyleNameType m_ePlotStyleName;
 
        // Plot style.// (OdDbPlaceHolder)
        OdDbHardPointerId m_hpidPlotStyle;
 
        // Material flags.
        MaterialFlags m_iMaterialFlags;
 
        OdUInt32 m_unknSmartStrID;
 
        OdString m_unknSmartStrValue;
 
        OdInt32 m_iUnknown1;
};
 
typedef OdSmartPtr<AECDispCompEnt> AECDispCompEntPtr;
typedef AECSubPtr<AECDispCompEnt> AECDispCompEntSubPtr;
 
#endif  //__AECDISPCOMPENT_H__