IDocumentObject.h

浏览该文件的文档.

/************************************************************************
* @file IDocumentObject.h
*
* @brief 文档对象类
*
* @details 文档对象类
*
* @author dixu
*
* @version 1.0
*
* @date 2014-9-8
*
* @license 北京华科软科技有限公司
*
*************************************************************************/
 
#ifndef BIMHOMEAPP_APP_IDOCUMENTOBJECT_H
#define BIMHOMEAPP_APP_IDOCUMENTOBJECT_H
 
#include "BHGlobal.h"
#include <Base/Vector3D.h>
#include <Base/BoundBox.h>
#include <set>
#include <map>
#include "boost/any.hpp"
 
namespace App
{
    class IDocument;
    class DocumentObjectObserverDelegate;
    class IPropertyAccessor;
 
    class AppExport IDocumentObject
    {
    public:
        static IDocumentObject* create(
            IDocument* pParent,
            const char* pObjectName = nullptr,
            bool isNew = true,
            const char* viewType = nullptr,
            bool isPartial = false);
 
        static IDocumentObject* create(
            IDocument* pParent,
            const char* pObjectName = nullptr,
            const char* pDocObjDelegateName = nullptr);
 
        virtual ~IDocumentObject();
 
        virtual const char* getViewProviderName(void) const = 0;
 
        virtual const char* getNameInBimPart(void) const = 0;
 
        virtual const char* getStatusString(void) const = 0;
 
        virtual App::IDocument* getDocument(void) const = 0;
 
        virtual void setDocument(App::IDocument* pDoc) = 0;
        virtual std::string getExportName(bool forced = false) const = 0;
 
        virtual std::string getNameWithDocId() = 0;
 
        virtual void getInListEx(std::set<App::IDocumentObject*>& inSet,
            bool recursive, std::vector<App::IDocumentObject*>* inList = nullptr) const = 0;
 
        virtual void getInList(std::vector<App::IDocumentObject*>& objList) const = 0;
 
        virtual void getOutList(std::vector<App::IDocumentObject*>& objList) const = 0;
 
        virtual void getInListRecursive(std::vector<App::IDocumentObject*>& objList) const = 0;
 
        virtual void getOutListRecursive(std::vector<App::IDocumentObject*>& objList) const = 0;
 
        virtual void getSubObjectList(const char* subname, std::vector<IDocumentObject*>& objList) const = 0;
 
        virtual void getParents(int depth, std::vector<std::pair<App::IDocumentObject*, std::string>>& iobjList) const = 0;
 
        virtual int setElementVisible(const char* element, bool visible) = 0;
        virtual long getId() const = 0;
 
        virtual std::string getLabel() const = 0;
 
        virtual void setLabel(const std::string& label) = 0;
 
        virtual bool recomputeFeature(bool recursive = false) = 0;
 
        virtual bool isTouched(void) const = 0;
 
        virtual bool adjustRelativeLinks(const std::set<App::IDocumentObject*>& inList, std::set<App::IDocumentObject*>* visited = nullptr) = 0;
 
        virtual bool hasChildElement() const = 0;
 
        virtual bool redirectSubName(std::ostringstream& ss, IDocumentObject* topParent, IDocumentObject* child) const = 0;
 
        virtual std::vector<std::string> getSubObjects(int reason = 0) const = 0;
 
        virtual int isElementVisible(const char* element) const = 0;
 
        virtual short mustExecute(void) const = 0;
 
        virtual void touch(bool noRecompute = false) = 0;
 
        virtual bool isImporting() const = 0;
 
        virtual void enforceRecompute() = 0;
 
        virtual Base::BoundBox3d getBoundingBox(bool isLocal) = 0;
 
        virtual Base::Vector3d getLocationInfo(bool isLocal) = 0;
 
        /* *
        * @brief                            获取父类节点对象
        * @details                          获取父类节点对象
        * @return                           父节点指针
        */
        virtual App::IDocument* getIDocument(void) = 0;
 
        virtual std::map<std::string, std::string> getPropertiesList() = 0;
 
        virtual IPropertyAccessor* getPropertyAccessor() = 0;
 
        virtual DocumentObjectObserverDelegate* getObserverDelegate() = 0;
 
        virtual void* getViewProviderDelegate()const = 0;
 
        virtual bool copyShapeFrom(App::IDocumentObject* pObj) = 0;
 
        virtual void addChild(App::IDocumentObject* pObj) = 0;
 
        virtual void removeChild(App::IDocumentObject* pObj) = 0;
    };
}
 
#endif // BIMHOMEAPP_APP_ANNOTATION_H