elementref.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------------------+
2 |
3 | Supplied under applicable software license agreement.
4 |
5 | Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
6 |
7 +---------------------------------------------------------------------------------------*/
8 #pragma once
10 
17 MSCORE_EXPORT DgnModelP elementRef_getCache (ElementRefP pElem);
18 
25 MSCORE_EXPORT DgnFileP elementRef_getDgnFileObj (ElementRefP pElem);
26 
33 MSCORE_EXPORT UInt32 elementRef_getFilePos (ElementRefP pElem);
34 
42 MSCORE_EXPORT void elementRef_getElementHeader (ElementRefP pElem, Elm_hdrP hdr);
43 
52 MSCORE_EXPORT size_t elementRef_getElement (ElementRefP pElem, MSElementP pEl, size_t inSize);
53 
61 MSCORE_EXPORT bool elementRef_isEOF (ElementRefP pElem);
62 
69 MSCORE_EXPORT bool elementRef_isComplexComponent (ElementRefP pElem);
70 
79 MSCORE_EXPORT bool elementRef_isDirty (ElementRefP pElem);
80 
88 MSCORE_EXPORT bool elementRef_isDeleted (ElementRefP pElem);
89 
97 MSCORE_EXPORT bool elementRef_isCacheDeleted (ElementRefP pElem);
98 
105 MSCORE_EXPORT bool elementRef_isNew (ElementRefP pElem);
106 
114 MSCORE_EXPORT bool elementRef_isHilited (ElementRefP pElem, DgnModelRefP modelRef);
115 
124 
132 MSCORE_EXPORT bool elementRef_isInSelectionSet (ElementRefP pElem, DgnModelRefP modelRef);
133 
141 MSCORE_EXPORT bool elementRef_isInDisplaySet (ElementRefP pElem, DgnModelRefP modelRef);
142 
150 MSCORE_EXPORT bool elementRef_isIncludedForModelRef (ElementRefP pElem, DgnModelRefP modelRef);
151 
158 MSCORE_EXPORT bool elementRef_hasDependents (ElementRefP elemRef);
159 
168 MSCORE_EXPORT int elementRef_getDependents (ElementRefP baseElem, ElementRefP* pDependents, int nDependents);
169 
180 MSCORE_EXPORT bool elementRef_isDependent (ElementRefP pRoot, ElementRefP pDependent);
181 
195 
206 
218 
226 
233 MSCORE_EXPORT int elementRef_getElemType (ElementRefP elemRef);
234 
242 
249 MSCORE_EXPORT UInt32 elementRef_getElemLevel (ElementRefP elemRef);
250 
257 MSCORE_EXPORT size_t elementRef_getElemSize (ElementRefP elemRef);
258 
269 MSCORE_EXPORT bool elementRef_isImmediateDependent (ElementRefP pRoot, ElementRefP pDependent);
270 
277 MSCORE_EXPORT int elementRef_getElemArchive (ElementRefP elemRef);
278 
285 MSCORE_EXPORT int elementRef_getXAttributeArchive (ElementRefP elemRef);
286 
293 MSCORE_EXPORT int elementRef_getElemAttrOffset (ElementRefP elemRef);
294 
301 MSCORE_EXPORT bool elementRef_isComplexHeader (ElementRefP elemRef);
302 
310 MSCORE_EXPORT int elementRef_getComponentCount (ElementRefP elemRef);
311 
319 MSCORE_EXPORT ElementRefP elementRef_getParent (ElementRefP pElem);
320 
321 
ElementRefP elementRef_getParent(ElementRefP pElem)
Given an ElementRefP, return its parent's ElementRefP (returns NULL for non-complex elements)...
bool elementRef_isEOF(ElementRefP pElem)
Test whether the given ElementRefP is the "end of file" marker.
bool elementRef_isComplexHeader(ElementRefP elemRef)
Given an ElementRefP, determine whether it is a complex header.
ElementRefP elementDependent_getElemRef(DependentElemRef thisDep)
Given a DependentElemRef, get the ElementRefP for the dependent element.
int elementRef_getElemArchive(ElementRefP elemRef)
Given an ElementRefP, get the state of the archive flags.
bool elementRef_isInDisplaySet(ElementRefP pElem, DgnModelRefP modelRef)
Check to determine whether an elementRef/ModelRef pair is currently in the display set...
DgnModelP elementRef_getCache(ElementRefP pElem)
Given an ElementRefP, return the DgnModelP that holds it.
DependentElemRef elementRef_getFirstDependent(ElementRefP pElem)
Given an ElementRefP, get the first element that is a dependent of this element, in the form of a Dep...
UInt32 elementRef_getFilePos(ElementRefP pElem)
Given an ElementRefP, return it's filepos.
union DgnPlatform::MSElement * MSElementP
Definition: DgnPlatform.h:531
int elementRef_getComponentCount(ElementRefP elemRef)
Given an ElementRefP, get the number of children of its element.
bool elementRef_isNew(ElementRefP pElem)
Check the "new" flag on an element.
DgnFileP elementRef_getDgnFileObj(ElementRefP pElem)
Given an ElementRefP, return the DgnFile that holds it.
bool elementRef_isDirty(ElementRefP pElem)
Test whether the "dirty" flag on an element has been set.
uint32_t UInt32
Definition: Bentley.r.h:128
DgnPlatform::ElementId elementRef_getElemID(ElementRefP elemRef)
Given an ElementRefP, get the ID of its element.
bool elementRef_isImmediateDependent(ElementRefP pRoot, ElementRefP pDependent)
Query if the 'dependent' element is an immediate dependent of the 'root' element. ...
int elementRef_getElemType(ElementRefP elemRef)
Given an ElementRefP, get the type of its element.
size_t elementRef_getElemSize(ElementRefP elemRef)
Given an ElementRefP, get the size of its element, in bytes.
void elementRef_getElementHeader(ElementRefP pElem, Elm_hdrP hdr)
Given an ElementRefP, return just its header.
bool elementRef_hasDependents(ElementRefP elemRef)
Test whether the specified element has dependents.
struct DgnPlatform::DgnModel * DgnModelP
Definition: DgnPlatform.h:220
size_t elementRef_getElement(ElementRefP pElem, MSElementP pEl, size_t inSize)
Given an ElementRefP, return the element data.
struct DgnPlatform::DgnFile * DgnFileP
Definition: DgnPlatform.h:206
bool elementRef_isDeleted(ElementRefP pElem)
Test whether the element has been deleted.
int elementRef_getXAttributeArchive(ElementRefP elemRef)
Check if the ElementRefP's XAttribute archive flag is ste.
bool elementRef_isDependent(ElementRefP pRoot, ElementRefP pDependent)
Query if the 'dependent' element is a dependent of the 'root' element or of any of the elements on wh...
DgnPlatform::ElementRefType elementRef_getRefType(ElementRefP elemRef)
Given an ElementRefP, get its type (e.g.
UInt64 ElementId
Definition: DgnPlatformBaseType.r.h:83
bool elementRef_isCacheDeleted(ElementRefP pElem)
Test whether the element is part of a DgnModel that has been deleted.
struct DgnPlatform::ElementRefBase * ElementRefP
Definition: DgnPlatform.h:166
bool elementRef_isInSelectionSet(ElementRefP pElem, DgnModelRefP modelRef)
Check to determine whether an elementRef/ModelRef pair is currently in the selection set...
struct DgnPlatform::DependentElm * DependentElemRef
Definition: DgnPlatform.h:165
int elementRef_getElemAttrOffset(ElementRefP elemRef)
Given an ElementRefP, get the Attribute Offset for this element.
DgnPlatform::ElementHiliteState elementRef_getHiliteState(ElementRefP pElem, DgnModelRefP modelRef)
Check the "hilite" flag on an elementRef/ModelRef combination and return the current state...
int elementRef_getDependents(ElementRefP baseElem, ElementRefP *pDependents, int nDependents)
Get a list of IDs of elements dependent on the specified element.
UInt32 elementRef_getElemLevel(ElementRefP elemRef)
Given an ElementRefP, get the level of its element.
bool elementRef_isComplexComponent(ElementRefP pElem)
Test whether the given ElementRefP is a complex component.
bool elementRef_isIncludedForModelRef(ElementRefP pElem, DgnModelRefP modelRef)
Check to determine whether an elementRef is included for the given modelRef.
struct DgnPlatform::DgnModelRef * DgnModelRefP
Definition: DgnPlatform.h:223
bool elementRef_isHilited(ElementRefP pElem, DgnModelRefP modelRef)
Check the "hilite" flag on an elementRef/ModelRef combination.
ElementHiliteState
The current Hilite state of the element.
Definition: ElementRefBase.h:33
ElementRefType
Types of ElementRefs.
Definition: ElementRefBase.h:22
DependentElemRef elementDependent_getNext(DependentElemRef thisDep)
Given a DependentElemRef, get a DependentElemRef for the next element dependent on the same base elem...

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.