AECCustomOpeningBlock.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 __AECCUSTOMOPENINGBLOCK_H__
#define __AECCUSTOMOPENINGBLOCK_H__
 
#include "Subobjects/DispComps/AECDispCompEnt.h"
#include <Ge/GeVector3d.h>
 
class AECARCHBASE_API AECCustomOpeningBlock : public AECDispCompEnt
{
    AEC_DECLARE_MEMBERS( AECCustomOpeningBlock );
 
    public:
        OdDbObjectId GetBlock() const;
 
        void SetBlock( const OdDbObjectId& idBlock );
 
        XPosition GetXPosition() const;
 
        void SetXPosition( XPosition ePosition );
 
        YPosition GetYPosition() const;
 
        void SetYPosition( YPosition ePosition );
 
        ZPosition GetZPosition() const;
 
        void SetZPosition( ZPosition ePosition );
 
        bool IsMirrorX() const;
 
        void SetIsMirrorX( bool bMirror );
 
        bool IsMirrorY() const;
 
        void SetIsMirrorY( bool bMirror );
 
        bool IsMirrorZ() const;
 
        void SetIsMirrorZ( bool bMirror );
 
        bool IsScaleToFitWidth() const;
 
        void SetIsScaleToFitWidth( bool bScale );
 
        bool IsScaleToFitHeight() const;
 
        void SetIsScaleToFitHeight( bool bScale );
 
        bool IsScaleToFitDepth() const;
 
        void SetIsScaleToFitDepth( bool bScale );
 
        bool IsScaleToFitLockXYRatio() const;
 
        void SetIsScaleToFitLockXYRatio( bool bScale );
 
        const OdGeVector3d& GetInsertionOffset() const;
 
        void SetInsertionOffset( const OdGeVector3d& vOffset );
 
        enum Display {
          eAlways                   = 0,
          eWhenIntersectingCutPlane = 1,
          eWhenAboveCutPlane        = 2,
          eWhenBelowCutPlane        = 3
        };
 
        Display GetDisplayOption() const;
 
        void SetDisplayOption( Display displayOption );
 
    public:
        void GetOffsetFromOrigin( const OdGeVector3d& vEntityDimension,
                                        OdGeVector3d& vOffset ) const;
 
    protected:
        // Interpretation of this value is still unknown.
        OdDbHardPointerId m_blockId;
 
        // Custom opening block flags.
        BlockFlags m_uFlags;
 
        // This member stores insertion offset.
        OdGeVector3d m_vInsertionOffset;
 
        // Display Option.
        OdUInt8 m_displayOption;
 
        // Class uses flags structure.
        friend class AECGaCustomBlock;
};
 
typedef OdSmartPtr<AECCustomOpeningBlock> AECCustomOpeningBlockPtr;
typedef AECSubPtr<AECCustomOpeningBlock> AECCustomOpeningBlockSubPtr;
 
#endif  //__AECCUSTOMOPENINGBLOCK_H__