Manages the actively displayed fence. More...
#include <FenceManager.h>
Public Types | |
| enum | FenceDisplayMode { FENCE_NormalDraw = 0, FENCE_InhibitDraw = 1, FENCE_InhibitFill = 2 } |
Public Member Functions | |
| bool | UseActiveFence () |
| Check the active setting for whether a tool should use the fence if one is currently active. More... | |
| bool | IsFenceActive () |
| Return whether a fence is currently defined, either by points or element. More... | |
| bool | IsVoidMode () |
| Return whether current fence mode is void. Accept elements outside fence. More... | |
| bool | IsOverlapMode () |
| Return whether current fence mode is overlap. Accept elements that overlap the fence boundary and aren't completely inside (or outside if void mode). More... | |
| bool | IsClipMode () |
| Return whether current fence mode is clip. Accept and clip elements that overlap the fence boundary. More... | |
| bool | IsDefinedByElem () |
| Return whether a fence defined by element is currently active. More... | |
| bool | IsDefinedByPoints () |
| Return whether a fence defined by points is currently active. More... | |
| void | ClearFence () |
| Clear any active points/element fence so that are is no longer a fence active. More... | |
| void | DisplayFence (ViewportP, TransformCP optTrans=0, int const *optTransparency=0) |
| For use in tools that manipulate fence contents. Draw transforms fence as a decorator. More... | |
| void | SetInhibitFenceDisplay (FenceDisplayMode inhibit) |
| For use in tools that need to automate fence creation/processing and don't want the fence displayed in the view. More... | |
| ViewportP | GetFenceViewport () |
| Get the fence viewport for a fence defined by points. More... | |
| ElementHandleCP | GetFenceElem () |
| Get the element for a fence defined by element. More... | |
| StatusInt | GetFencePoints (bvector< DPoint3d > &) |
| Get the points for a fence defined by points. More... | |
| StatusInt | DefineByElement (ElementHandleP, ViewportP) |
| Set active fence from an element. More... | |
| StatusInt | DefineByPoints (DPoint3dCP, int numPoints, ViewportP) |
| Set active fence by points. More... | |
| StatusInt | TransformFence (TransformCP) |
| Apply a transform to the active fence. More... | |
| StatusInt | InitFromActiveFence (FenceParamsR, bool overlap, bool doClip, FenceClipMode allowClipFlag) |
| Populate the supplied FenceParams with information for the active fence. More... | |
| StatusInt | BuildAgenda (FenceParamsR, ElementAgendaR, DgnModelRefListP, bool modifyOrig, bool allowLocked, bool callAsynch) |
| Collect elements that satisfy the supplied FenceParams/criteria. More... | |
| FenceStretchFlags | GetActiveFenceStretchFlags () |
| Get active fence stretch behavior setting. More... | |
| FenceClipFlags | GetActiveFenceClipFlags () |
| Get active fence clip behavior settings. More... | |
| StatusInt | StretchElement (FenceParamsR, EditElementHandleR, TransformCR, FenceStretchFlags) |
| Apply fence stretch operation to input element. More... | |
| StatusInt | ClipElement (FenceParamsR, ElementAgendaP inside, ElementAgendaP outside, ElementHandleCR, FenceClipFlags) |
| Apply fence clip operation to input element. More... | |
Static Public Member Functions | |
| static FenceManagerR | GetManager () |
| Get the current FenceManager instance. More... | |
Manages the actively displayed fence.
| enum FenceDisplayMode |
| StatusInt BuildAgenda | ( | FenceParamsR | , |
| ElementAgendaR | , | ||
| DgnModelRefListP | , | ||
| bool | modifyOrig, | ||
| bool | allowLocked, | ||
| bool | callAsynch | ||
| ) |
Collect elements that satisfy the supplied FenceParams/criteria.
| void ClearFence | ( | ) |
Clear any active points/element fence so that are is no longer a fence active.
| StatusInt ClipElement | ( | FenceParamsR | , |
| ElementAgendaP | inside, | ||
| ElementAgendaP | outside, | ||
| ElementHandleCR | , | ||
| FenceClipFlags | |||
| ) |
Apply fence clip operation to input element.
| StatusInt DefineByElement | ( | ElementHandleP | , |
| ViewportP | |||
| ) |
Set active fence from an element.
| StatusInt DefineByPoints | ( | DPoint3dCP | , |
| int | numPoints, | ||
| ViewportP | |||
| ) |
Set active fence by points.
| void DisplayFence | ( | ViewportP | , |
| TransformCP | optTrans = 0, |
||
| int const * | optTransparency = 0 |
||
| ) |
For use in tools that manipulate fence contents. Draw transforms fence as a decorator.
| FenceClipFlags GetActiveFenceClipFlags | ( | ) |
Get active fence clip behavior settings.
| FenceStretchFlags GetActiveFenceStretchFlags | ( | ) |
Get active fence stretch behavior setting.
| ElementHandleCP GetFenceElem | ( | ) |
Get the element for a fence defined by element.
| ViewportP GetFenceViewport | ( | ) |
Get the fence viewport for a fence defined by points.
|
static |
Get the current FenceManager instance.
| StatusInt InitFromActiveFence | ( | FenceParamsR | , |
| bool | overlap, | ||
| bool | doClip, | ||
| FenceClipMode | allowClipFlag | ||
| ) |
Populate the supplied FenceParams with information for the active fence.
| bool IsClipMode | ( | ) |
Return whether current fence mode is clip. Accept and clip elements that overlap the fence boundary.
| bool IsDefinedByElem | ( | ) |
Return whether a fence defined by element is currently active.
| bool IsDefinedByPoints | ( | ) |
Return whether a fence defined by points is currently active.
| bool IsFenceActive | ( | ) |
Return whether a fence is currently defined, either by points or element.
| bool IsOverlapMode | ( | ) |
Return whether current fence mode is overlap. Accept elements that overlap the fence boundary and aren't completely inside (or outside if void mode).
| bool IsVoidMode | ( | ) |
Return whether current fence mode is void. Accept elements outside fence.
| void SetInhibitFenceDisplay | ( | FenceDisplayMode | inhibit | ) |
For use in tools that need to automate fence creation/processing and don't want the fence displayed in the view.
| StatusInt StretchElement | ( | FenceParamsR | , |
| EditElementHandleR | , | ||
| TransformCR | , | ||
| FenceStretchFlags | |||
| ) |
Apply fence stretch operation to input element.
| StatusInt TransformFence | ( | TransformCP | ) |
Apply a transform to the active fence.
| bool UseActiveFence | ( | ) |
Check the active setting for whether a tool should use the fence if one is currently active.