AECDimPoint.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 __AECDIMENSIONCOMMONOVERRIDE_H__
#define __AECDIMENSIONCOMMONOVERRIDE_H__
 
#include "AECArchDACHBase.h"
#include "Common/AECSmartReference.h"
#include <DbFiler.h>
#include <Ge/GePoint3d.h>
 
class AECARCHDACHBASE_API AECDimPoint
{
    public:
        AECDimPoint();
 
    public:
        enum Type
        {
            etPoint          = -1,
            etIntersection   =  1,
            etEndPoint       =  2,
            etStartPoint     =  3,
            etCenter         =  4,
            etWidthCenter    =  6,
            etQuadrant       =  7
        };
 
        enum Category
        {
            ecPoint                 = 1,
            ecOverall               = 2,
            ecWallPoint             = 2,
            ecEdgePoint             = 3,
            ecWallComponentPoint    = 3,
            ecWallOpeningPoint      = 4,
            ecWallIntersectionPoint = 6,
            ecBoundingBox           = 7,
            ecComponentCenter       = 7
        };
 
        enum Group
        {
            egWall,
            egMassElement,
            egCurtainWallLayout,
            egWindowAssembly,
            egStructuralMember,
            egOpeningBase,
            eg2DLayoutGrid,
            egOther,
            egCurve,
            egPoint,
            egAecPoint
        };
 
    public:
        void setPoint( const OdGePoint2d& ptLocation, OdInt16 iIndex = 0 );
 
        void setSimple( const OdGePoint2d& ptLocation,
            const OdDbObjectId& idPrimary, const OdDbObjectId& idSecondary,
            Type eType, Category eCategory, OdInt16 iIndex = 0, OdInt16 iTag = 0 );
 
        void setComplex( const OdGePoint2d& ptLocation,
            const AECSmartReference& srefPrimary, const AECSmartReference& srefSecondary,
            Type eType, Category eCategory, OdInt16 iIndex = 0, OdInt16 iTag = 0 );
 
    public:
        const OdGePoint3d& location() const;
 
        void setLocation( const OdGePoint3d& ptLocation );
 
        Type type() const;
 
        void setType( Type eType );
 
        Category category() const;
 
        void setCategory( Category eCategory );
 
        OdInt16 index() const;
 
        void setIndex( OdInt16 iIndex );
 
        OdInt16 tag() const;
 
        void setTag( OdInt16 iTag );
 
        Group group() const;
 
        void setGroup( Group eGroup );
 
        AECSmartReference primaryObject() const;
 
        void setPrimaryObject( const AECSmartReference& rReference );
 
        AECSmartReference secondaryObject() const;
 
        void setSecondaryObject( const AECSmartReference& rReference );
 
    private:
        // Location.
        OdGePoint3d m_ptLocation;
 
        // Known values:
        // o -1 - Non-Associative Point.
        // o  1 - Intersection.
        // o  2 - Start Point.
        // o  3 - End Point.
        // o  4 - Center.
        // o  6 - Width Center.
        // o  7 - Quadrant.
        OdInt16 m_iPointType;
 
        // Known values:
        // Walls:
        // o 2 - Wall Points.
        // o 3 - Wall Component Points.
        // o 4 - Wall Opening.
        // o 6 - Intersections.
        //
        // Mass Elements:
        // Curtain Walls:
        // Window Assemblies:
        // Structural Member:
        // Openings:
        // o 2 - Overall, Edges Facing.
        // o 3 - Edges.
        // o 7 - Bounding Box, Center.
        //
        // Non-Associative Points:
        // o 1 - Point.
        OdInt16 m_iCategory;
 
        // Index for some point types:
        // Walls:
        // o Category 3 - Component Index.
        // o Category 4 - Opening Index.
        // o Category 6 - Intersection Point Index.
        //
        // Curtain Walls:
        // Window Assemblies:
        // o Category 3 - Component Index (in order: Frames, Mullions, Infills).
        OdInt16 m_iIndex;
 
        // Class name that specifies overall point category.
        // o "AecDbWall" - Walls, Wall Openings
        // o "AecDbMassElem" - Mass Elements
        // o "AecDbCurtainWallLayout" - Curtain Walls
        // o "AecDbWindowAssembly" - Window Assemblies
        // o "AecsDbMember" - Structural Members
        // o "AecDbOpeningBase" - Doors, Windows and Openings
        // o "AecDbLayoutGrid2d" - 2D Layout Grids
        // o "AECDbGeo" - Slabs, Spaces, Roofs and Railings
        // o "AecDbPoint" - Aec Point.
        // o "OdDbCurve" - Linework
        // o "" - Non-Associative Point.
        //OdString m_strClassGroup;
        Group m_eGroup;
 
        // Primary object.
        AECSmartReference m_srefPrimary;
 
        // Secondary object.
        AECSmartReference m_srefSecondary;
 
        // Additional Tag. By default - 0.
        // Walls:
        // o 1 - Width
        // o 2 - Opening in Wall Width
        //
        // Mass Elements:
        // Curtain Walls:
        // Window Assemblies:
        // Structural Member:
        // Openings:
        // o Edge Index (-1 for center).
        OdInt16 m_iTag;
};
 
#endif // __AECDIMENSIONCOMMONOVERRIDE_H__