AECMacros.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 __AECMACROS_H__
#define __AECMACROS_H__
 
#include <DbEntity.h>
#include <RxModule.h>
 
class AECDbDwgFiler;
 
// Methods from OdDbCurve interface currently supported by Teigha® Architecture entities.
// TODO: Add all other methods from OdDbCurve interface.
#define CURVE_DECLARE_MEMBERS()                                                           \
     public:                                                                              \
        virtual bool isClosed() const;                                                    \
        virtual bool isPeriodic() const;                                                  \
        virtual OdResult getStartParam( double& param ) const;                            \
        virtual OdResult getEndParam ( double& param ) const;                             \
        virtual OdResult getStartPoint( OdGePoint3d& pt ) const;                          \
        virtual OdResult getEndPoint( OdGePoint3d& pt ) const;                            \
        virtual OdResult getPointAtParam( double, OdGePoint3d& ) const;                   \
        virtual OdResult getParamAtPoint( const OdGePoint3d&, double& ) const;            \
        virtual OdResult getDistAtParam ( double param, double& dist ) const;             \
        virtual OdResult getParamAtDist ( double dist, double& param ) const;             \
        virtual OdResult getDistAtPoint ( const OdGePoint3d&, double& )const;             \
        virtual OdResult getPointAtDist ( double, OdGePoint3d&) const;                    \
        virtual OdResult getFirstDeriv ( double param, OdGeVector3d& firstDeriv ) const;  \
        virtual OdResult getPlane(OdGePlane& plane, OdDb::Planarity& planarity) const;    \
        virtual OdResult getClosestPointTo( const OdGePoint3d& givenPoint, OdGePoint3d& pointOnCurve, bool extend = false ) const
 
// Declares standard methods for each
// Teigha® Architecture database resident or imp-object.
#define AEC_DECLARE_MEMBERS( ClassName )                            \
                                                                    \
    ODRX_DECLARE_MEMBERS( ClassName );                              \
                                                                    \
    private:                                                        \
        OdRxModulePtr m_pModule;                                    \
    public:                                                         \
        static const OdUInt16 m_AECType;                            \
        static const OdUInt16 m_ver;                                \
    public:                                                         \
        ClassName();                                                \
        virtual ~ClassName();                                       \
    public:                                                         \
        virtual OdUInt16 GetAECType() const;                        \
        void referenceModule();                                     \
                                                                    \
        virtual OdResult dwgInFieldsEx( AECDbDwgFiler* pFiler );    \
        virtual void dwgOutFieldsEx( AECDbDwgFiler* pFiler ) const; \
                                                                    \
        virtual OdResult dxfInFields( OdDbDxfFiler* pFiler );       \
        virtual void dxfOutFields( OdDbDxfFiler* pFiler ) const
 
// Declares empty Teigha® Architecture subobject or database resident.
#define DECLARE_EMPTY( API, AECClass, AECParentClass )              \
class API AECClass : public AECParentClass                          \
{                                                                   \
    AEC_DECLARE_MEMBERS( AECClass );                                \
};                                                                  \
typedef OdSmartPtr<AECClass> AECClass##Ptr
 
// Following macros is used to define
// standard static methods for AEC dictionaries.
#define AEC_DICTIONARY_BASE( ClassName )                                                                    \
    public:                                                                                                 \
        static OdDbObjectId GetAECDictionary( OdDbDatabase* pDatabase, bool bCreateIfNotFound = false );    \
        static OdDbObjectId GetAECDictionaryExt( OdDbObject* pObject, bool bCreateIfNotFound = false )
 
#define AEC_DICTIONARY_DECLARE_MEMBERS( ClassName )                                                                   \
    AEC_DICTIONARY_BASE( ClassName );                                                                                 \
        static OdDbObjectId GetStandardAECObject( OdDbDatabase* pDatabase );                                          \
        static OdDbObjectId GetAECObject( OdDbDatabase* pDatabase, const OdString& strName = OdString::kEmpty );      \
        static OdDbObjectId GetAECObjectExt( OdDbObject* pObject, const OdString& strName );                          \
        static OdDbObjectId CreateAECObject( OdDbDatabase* pDatabase, const OdString& strName = OdString::kEmpty );   \
        static OdDbObjectId CreateAECObjectExt( OdDbObject* pObject, const OdString& strName = OdString::kEmpty )
 
// Declares simple sub-object.
#define AEC_SUBOBJ_DECLARE_MEMBERS_NO_DESTR( ClassName )            \
    ODRX_DECLARE_MEMBERS( ClassName );                              \
    public:                                                         \
        ClassName();                                                \
        virtual OdResult dwgInFieldsEx( AECDbDwgFiler* pFiler );    \
        virtual void dwgOutFieldsEx( AECDbDwgFiler* pFiler ) const;
 
#define AEC_SUBOBJ_DECLARE_MEMBERS( ClassName )                     \
    AEC_SUBOBJ_DECLARE_MEMBERS_NO_DESTR( ClassName )                \
        virtual ~ClassName() { }
 
#endif  //__AECMACROS_H__