Classes | Typedefs | Enumerations

A detailing symbol is an annotation that plays a vital role in drawing composition. More...

Classes

struct  BoundedPlane
 Struct used to represent a bounded plane. More...
 
struct  BaseDetailingPropInfo
 Base class to encapsulate property enums for the various detailing symbol types. More...
 
struct  IDetailingSymbol
 Base class for the various detailing symbol types. More...
 
struct  IDetailingSymbolFactory
 IDetailingSymbolFactory is a factory interface that creates and identifies a subclass of IDetailingSymbol. More...
 
struct  VolumeDef
 VolumeDef holds data that represent a six-sided volume and crop masks on each of the six sides. More...
 
struct  VolumeDefCollection
 Collection of VolumeDef objects. More...
 
struct  IClipElementProvider
 Provides a clip element definition. More...
 
struct  IHasClipElementProvider
 Interface implemented by callouts that provide IClipElementProvider object to synchronize themselves with IViewClipObject. More...
 
struct  IVolumeDefContainer
 volume definition container, contains collection of volume defs More...
 
struct  IPreserveUp
 Interface implemented by callouts to control their behavior of preserving the 'up-direction' of the model. More...
 
struct  IFlipDirection
 Interface to support flipping the direction of callout. More...
 
struct  ICreateGapProvider
 Interface to support Creating Gap in the callout. More...
 
struct  SectionCalloutDef
 Section callout definition. More...
 
struct  DetailCalloutDef
 Detail callout definition. More...
 
struct  DetailCallout3DViewDef
 New Detail callout structure corresponding to new detail views that are stored in 3d model like any other view. More...
 
struct  ElevationCalloutDef
 Elevation callout definition. More...
 
struct  InteriorElevationCalloutDef
 Interior Elevation marker definition. More...
 
struct  PlanCalloutDef
 Plan callout definition. More...
 
struct  TitleTextDef
 Title Text definition. More...
 
struct  DrawingBoundaryDef
 Drawing Title annotation definition. More...
 
struct  IDrawingTraverseOptions
 Object containing options for traversing drawing titles of a model. More...
 
struct  IDrawingTraverseHandler
 Interface to traverse drawing titles of a model. More...
 
struct  DrawingManager
 Manager class for managing drawings. More...
 
struct  DetailingSymbolManager
 Manager class for managing creating, deleting and modifying of detailing symbols. More...
 
struct  CalloutBuilder
 Class for building callouts. More...
 
struct  DrawingBoundaryBoundaryElementGenerator
 Provides ability to generate to Drawing Title boundary element from drawing title persistent element. More...
 

Typedefs

typedef RefCountedPtr
< IDetailingSymbol > 
IDetailingSymbolPtr
 Ref-counted smart-pointer object to control memory and life time of IDetailingSymbol pointer. More...
 
typedef RefCountedPtr
< IDetailingSymbolFactory > 
IDetailingSymbolFactoryPtr
 < Ref-counted smart-pointer object to control memory and life time of IDetailingSymbolFactory pointer. More...
 
typedef RefCountedPtr
< IClipElementProvider > 
IClipElementProviderPtr
 Ref-counted smart-pointer object to control memory and life time of IClipElementProvider pointer. More...
 
typedef RefCountedPtr
< SectionCalloutDef > 
SectionCalloutDefPtr
 Ref-counted smart-pointer object to control memory and life time of SectionCalloutDef pointer. More...
 
typedef RefCountedPtr
< DetailCalloutDef > 
DetailCalloutDefPtr
 Ref-counted smart-pointer object to control memory and life time of DetailCalloutDef pointer. More...
 
typedef RefCountedPtr
< DetailCallout3DViewDef > 
DetailCallout3DViewDefPtr
 Ref-counted smart-pointer object to control memory and life time of DetailCallout3DViewDef pointer. More...
 
typedef RefCountedPtr
< ElevationCalloutDef > 
ElevationCalloutDefPtr
 Ref-counted smart-pointer object to control memory and life time of ElevationCalloutDef pointer. More...
 
typedef RefCountedPtr
< InteriorElevationCalloutDef > 
InteriorElevationCalloutDefPtr
 Ref-counted smart-pointer object to control memory and life time of InteriorElevationCalloutDef pointer. More...
 
typedef RefCountedPtr
< PlanCalloutDef > 
PlanCalloutDefPtr
 Ref-counted smart-pointer object to control memory and life time of PlanCalloutDef pointer. More...
 
typedef RefCountedPtr
< TitleTextDef > 
TitleTextDefPtr
 Ref-counted smart-pointer object to control memory and life time of TitleTextDef pointer. More...
 
typedef RefCountedPtr
< DrawingBoundaryDef > 
DrawingBoundaryDefPtr
 Ref-counted smart-pointer object to control memory and life time of DrawingBoundaryDef pointer. More...
 
typedef RefCountedPtr
< IDrawingTraverseOptions > 
IDrawingTraverseOptionsPtr
 Ref-counted smart-pointer object to control memory and life time of IDrawingTraverseOptions pointer. More...
 
typedef bvector
< IDetailingSymbolFactory * > 
VectorOfIDetailingSymbolFactories
 Collection of 'IDetailingSymbolFactory' objects. 'DetailingSymbolManager' holds an object of this type in order to manage the creation of detailing symbols. More...
 

Enumerations

enum  BaseDetailingProp { Invalid = 0, Level_LEVEL = 1 }
 Enum of properties that are common to all detailing symbols. More...
 
enum  DrawingBoundaryUnderlineType { ByText = 0, ByDrawing, FixedLength, NoLine }
 Options to control the extent of underline of drawing title. More...
 
enum  DrawingBoundaryBubbleSideType { Left = 0, Right }
 Options to control whether drawing title's bubble (terminator cell) is displayed on the left hand side or right hand side. More...
 
enum  DrawingBoundaryDisplayStatus { Hidden = 0, Visible }
 Options to control whether drawing title's settings like boundary and annotation should be visible or hidden. More...
 
enum  CalloutVerticalExtent { FromView = 0, FromModel = 1, UserDefined = 2 }
 Options to compute the vertical height (top height + bottom height) of callout. More...
 

Detailed Description

A detailing symbol is an annotation that plays a vital role in drawing composition.

Detailing symbols are broadly classified into callouts and drawing titles. Callouts are annotations that represent a dynamic view of a model. Callouts help in navigating from one drawing to another. For example, SectionCallout, PlanCallout, etc. DrawingBoundary is an annotation whose purpose is to label drawings placed in sheets.

Typedef Documentation

typedef RefCountedPtr<DetailCallout3DViewDef> DetailCallout3DViewDefPtr

Ref-counted smart-pointer object to control memory and life time of DetailCallout3DViewDef pointer.

typedef RefCountedPtr<DetailCalloutDef> DetailCalloutDefPtr

Ref-counted smart-pointer object to control memory and life time of DetailCalloutDef pointer.

typedef RefCountedPtr<DrawingBoundaryDef> DrawingBoundaryDefPtr

Ref-counted smart-pointer object to control memory and life time of DrawingBoundaryDef pointer.

typedef RefCountedPtr<ElevationCalloutDef> ElevationCalloutDefPtr

Ref-counted smart-pointer object to control memory and life time of ElevationCalloutDef pointer.

typedef RefCountedPtr<IClipElementProvider> IClipElementProviderPtr

Ref-counted smart-pointer object to control memory and life time of IClipElementProvider pointer.

typedef RefCountedPtr<IDetailingSymbolFactory> IDetailingSymbolFactoryPtr

< Ref-counted smart-pointer object to control memory and life time of IDetailingSymbolFactory pointer.

typedef RefCountedPtr<IDetailingSymbol> IDetailingSymbolPtr

Ref-counted smart-pointer object to control memory and life time of IDetailingSymbol pointer.

typedef RefCountedPtr<IDrawingTraverseOptions> IDrawingTraverseOptionsPtr

Ref-counted smart-pointer object to control memory and life time of IDrawingTraverseOptions pointer.

typedef RefCountedPtr<InteriorElevationCalloutDef> InteriorElevationCalloutDefPtr

Ref-counted smart-pointer object to control memory and life time of InteriorElevationCalloutDef pointer.

typedef RefCountedPtr<PlanCalloutDef> PlanCalloutDefPtr

Ref-counted smart-pointer object to control memory and life time of PlanCalloutDef pointer.

typedef RefCountedPtr<SectionCalloutDef> SectionCalloutDefPtr

Ref-counted smart-pointer object to control memory and life time of SectionCalloutDef pointer.

typedef RefCountedPtr<TitleTextDef> TitleTextDefPtr

Ref-counted smart-pointer object to control memory and life time of TitleTextDef pointer.

typedef bvector<IDetailingSymbolFactory*> VectorOfIDetailingSymbolFactories

Collection of 'IDetailingSymbolFactory' objects. 'DetailingSymbolManager' holds an object of this type in order to manage the creation of detailing symbols.

Enumeration Type Documentation

enum BaseDetailingProp
strong

Enum of properties that are common to all detailing symbols.

Enumerator
Invalid 
Level_LEVEL 
enum CalloutVerticalExtent
strong

Options to compute the vertical height (top height + bottom height) of callout.

Enumerator
FromView 

Compute callout's vertical height from the active view or reference attachment on which the callout was placed.

FromModel 

Compute callout's vertical height from the entire height of model displayed in the active view or the reference on which the callout was placed.

UserDefined 

Follow user-defined height (provided separately)

enum DrawingBoundaryBubbleSideType
strong

Options to control whether drawing title's bubble (terminator cell) is displayed on the left hand side or right hand side.

Enumerator
Left 
Right 

Drawing Title bubble is on left hand side.

enum DrawingBoundaryDisplayStatus
strong

Options to control whether drawing title's settings like boundary and annotation should be visible or hidden.

Enumerator
Hidden 
Visible 

Drawing Title settings is hidden.

enum DrawingBoundaryUnderlineType
strong

Options to control the extent of underline of drawing title.

Enumerator
ByText 

Drawing title underline length as per the length of text.

ByDrawing 

Drawing title underline length as per the drawing length.

FixedLength 

Drawing title underline length should be fixed as specified by user.

NoLine 

Drawing title underline length to be zero.


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