AECSmartReference.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 __AECSMARTREFERENCE_H__
#define __AECSMARTREFERENCE_H__
 
#include "AECBase.h"

struct AECBASE_API AECSmartReference
{
    public:
        enum Type
        {
            eSimple         = 0,
            eBlock          = 1,
            eBlockReference = 2,
            eXRef           = 3
        };
 
    public:
        AECSmartReference()
        {
            eType = eSimple;
            cUnk1 = 0;
            hObject = 0;
        }

        static const AECSmartReference createSimple ( const OdDbObjectId& idObj );

        static const AECSmartReference createWithPath ( const OdDbObjectId& idObj, const OdDbObjectId& idPath );

        static const AECSmartReference createPathNode ( OdDbDatabase* pPathDB, const OdDbObjectId& idBlockReference );
 
    public:
        bool isNull() const;

        bool isValid( bool bSkipNotLoadedXREFs = false,
            const OdRxClass* pTargetClass = 0 ) const;

        OdDbObjectId getTargetId() const;

        OdDbObjectId getPathId() const;

        OdResult getTransform( OdGeMatrix3d& mTransform ) const;
 
        bool operator == ( const AECSmartReference& rRef ) const;
        bool operator != ( const AECSmartReference& rRef ) const;
 
    public:
        // Type of smart reference.
        Type eType;
 
        // Major reference.
        OdDbObjectId idRef1;
 
        // Auxiliary reference.
        OdDbObjectId idRef2;
 
        // Value in front of handle string
        // for XRef reference.
        OdUInt8 cUnk1;
 
        // Handle for XRef reference.
        OdDbHandle hObject;
 
    public:
        AECBASE_API_STATIC static AECSmartReference kNull;
};
 
#endif // __AECSMARTREFERENCE_H__