ElementTemplateUtils.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

DGNPLATFORM_TYPEDEFS(ElementTemplateNode);
DGNPLATFORM_REF_COUNTED_PTR(ElementTemplateNode);

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE


enum    ElementTemplateStatus
    {    
    ETSTATUS_Success                          = BSISUCCESS, //0x0000
    ETSTATUS_BadArg                           = 1,
    ETSTATUS_InvalidFile                      = 2,
    ETSTATUS_InvalidDataTreeOwner             = 3,
    ETSTATUS_InvalidPath                      = 4,
    ETSTATUS_PathAlreadyDefined               = 5,
    ETSTATUS_UnableToAccessDataTree           = 6,
    ETSTATUS_UnableToCreateNewGroupNode       = 7,
    ETSTATUS_UnableToCreateNewTemplateNode    = 8,
    ETSTATUS_InvalidArgument                  = 9,
    ETSTATUS_UnableToDeleteReadOnly           = 10,
    ETSTATUS_UnableToDeleteReferenceNode      = 11,
    ETSTATUS_UnableToDeleteNode               = 12,
    ETSTATUS_NoDefaultInstanceFound           = 13,
    ETSTATUS_InvalidTemplateParameter         = 14,
    ETSTATUS_InvalidPropertySpecification     = 15,
    ETSTATUS_BadPropertyValue                 = 16,
    ETSTATUS_NullPropertyValue                = 17,
    ETSTATUS_InvalidLevelId                   = 18,
    ETSTATUS_UnableToAddParameter             = 19,
    ETSTATUS_NoStructInstanceFound            = 20,
    ETSTATUS_TemplateNotInFile                = 21,
    ETSTATUS_InvalidMaterialId                = 22,
    ETSTATUS_NullModelRef                     = 23,
    ETSTATUS_NoTemplateId                     = 24,
    ETSTATUS_UnableToAddGradientKeys          = 25,
    ETSTATUS_InvalidMlineStyleId              = 26,
    ETSTATUS_InvalidDimensionStyleId          = 27,
    ETSTATUS_UnableToImportItemSchema         = 28,
    ETSTATUS_InvalidElementRefForNode         = 29,
    ETSTATUS_InvalidEnabler                   = 30,
    ETSTATUS_UnableToSetParameter             = 31,
    ETSTATUS_InvalidArrayIndex                = 32,
    ETSTATUS_UnableToRemoveParameter          = 33,
    ETSTATUS_LevelNameDoesNotExist            = 34,
    ETSTATUS_NoColorTypeSpecified             = 35,
    ETSTATUS_InvalidLineWeightValue           = 36,
    ETSTATUS_UnableToLoadMaterialById         = 37,
    ETSTATUS_InvalidParameterValue            = 38,
    ETSTATUS_NoTemplateReferenceFound         = 39,
    ETSTATUS_UnableToWriteToReadOnlyFile      = 40,
    ETSTATUS_Error                            = BSIERROR, // 0x8000
    };


/*=================================================================================**/
struct ElementTemplateUtils
{
public:
    DGNPLATFORM_EXPORT static ElementTemplateStatus      RemoveTemplateReferenceFromElement (ElementRefP elemRef);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      ScheduleTemplateReferenceRemoval (EditElementHandleR graphicElemHandle);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      AttachMaterialLinkages (EditElementHandleR graphicElemHandle, ElementTemplateNodeR templateNode);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      GetPathForReferencedTemplate (WString& templatePath, ElementRefP elemRef);

    DGNPLATFORM_EXPORT static ElementTemplateNodePtr     GetReferencedTemplate (ElementRefP elemRef);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      GetPathForTemplate (WString* templatePath, DgnPlatform::ElementId templateID, DgnModelRefP modelRef);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      GetTemplateIDFromPath (DgnPlatform::ElementId* pTemplateID, WCharCP wPath, DgnFileP dgnFileP);
    
    DGNPLATFORM_EXPORT static ElementTemplateStatus      GetReferencedTemplateData (WString* elementTemplatePath, DgnPlatform::ElementId* templateId, ElementRefP elementRef);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      GetReferencedTemplateID (DgnPlatform::ElementId& pTemplateID, ElementRefP elemRef);

    DGNPLATFORM_EXPORT static ElementId                  GetReferencedTemplateIDFromHandle (ElementHandleCR graphicElemHandle);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      SetReferencedTemplateID (EditElementHandleR graphicElemHandle, DgnPlatform::ElementId templateID, bool applyDefaultSymbology);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      SetReferencedTemplateID (ElementRefP elementRef, DgnPlatform::ElementId templateID);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      ScheduleTemplateReferenceAttachment (EditElementHandleR graphicElemHandle, ElementTemplateNode& templateNode);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      DeleteFromFile (ElementTemplateNode& templateNode);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      DeleteTemplateNode (ElementTemplateNodePtr& templateNode);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      CreateByPath (ElementTemplateNodePtr& templateNode, WCharCP fullPath, XDataTreeOwner& owner);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      CreateByPath (ElementTemplateNodePtr& templateNode, WCharCP fullPath, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT static ElementTemplateNodePtr     FindTemplateNodeByPath (WCharCP elementTemplatePath, XDataTreeOwner& owner);

    DGNPLATFORM_EXPORT static ElementTemplateNodePtr     FindTemplateNodeByPath (WCharCP elementTemplatePath, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT static ElementTemplateNodePtr     GetTemplateNodeUsingDependentElement (ElementRefP elementRef);

    DGNPLATFORM_EXPORT static bool                       IsTemplateInUse (ElementTemplateNodeCR templateNode, bool loadAllModels=false);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      AddItemToTemplate (ElementTemplateNodeCR templateNode, ECN::StandaloneECInstanceCR itemInstance);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      AttachItemToElement (ElementRefP elemRef, ECN::StandaloneECInstanceCR itemInstance);

    DGNPLATFORM_EXPORT static ElementTemplateStatus      WriteTemplateNode (ElementTemplateNodeR templateNode);

    DGNPLATFORM_EXPORT static Bentley::DgnPlatform::HandlerId GetElementTemplateHandlerId ();
};


END_BENTLEY_DGNPLATFORM_NAMESPACE