Share

Miscellaneous Classes

Classes

Class Description
Ac3dDwfNavTreeNode This class describes the interface that must be implemented by the (optional) NavTree Publisher. The NavTree publisher controls what will appear in the navigation tree in the Viewer. If no NavTree publisher is passed in to the Ac3dDwfPublisher, then it will display a "flat" tree listing all the objects with their class names and handles. You must create an object that implements the Ac3dDwfNavTreePublisher interface, i.e. an object that derives from Ac3dDwfNavTreePublisher and implements its functions. You will get called after each entity is done publishing its graphics and properties. Use those calls to build a tree of Ac3dDwfNavTreeNode's, based... more
AcadAppInfo Objects of the AcadAppInfo class are used by the ObjectARX application demand load mechanism. AcadAppInfo objects are used by the AutoCAD system when processing unknown commands, and during drawing load or dxfin when custom classes are detected for which there is no controlling ObjectARX application currently loaded. When used for custom classes, an AcadAppInfo object is created for each custom class encountered for which there is no controlling ObjectARX application present. For unknown commands, an AcadAppInfo object is used to represent a single ObjectARX application. In all cases, each AcadAppInfo object works with the registry data of only one ObjectARX... more
AcArrayUtil Utility class for use with AcArrays.
AcCFile AcCFile is derived from CFile, but unlike its base class, AcCFile also supports reading and writing of string data type. Whenever reading/writing of string data type is involved, conversion will take place to match input wide strings to the output format, and vice-versa. Please refer to setCharFormat() for more information on text file formats.
AcCStdioFileAcCStdioFile is derived from CStdioFile.
AcFILE AcFILE is a wrapper encapsulating a standard FILE pointer.
AcHeapOperators This class provides local new and delete operators to any class that derives from it. Starting in ObjectARX for AutoCAD 2004, this class is a second base class for AcDbObject and replaces the local new and delete operators for AcDbObject.Objects that inherit from AcHeapOperators are guaranteed to be allocated on the AcDb heap. AcHeapOperators resolves memory allocation conflicts for objects in applications that are built with a version of the C runtime library that differs from the one used by AutoCAD's memory manager.Classes that override the AcDbObject::new and delete operators should not require changes to accommodate the... more
AcIfstream Input stream AcIfstream is derived from std::ifstream in MBCS build, and std::wifstream in UNICODE build. Under UNICODE build AcIfstream overrides the open() method of it's base class and handles file paths in wide string.
AcLispAppInfo Objects of this class are used to represent AutoLISP program files.
AcLocale Class with language name and country name.
AcNameValuePair A container class for a name-value pair to be stored in a client's private data area of the DSD file.
AcOutputBufMgr Used by AcCFile and AcCStdioFile.
AcPane The AcPane class represents an individual pane in the status bar. A pane can contain text or an icon.This class supplies methods that support adding, removing, modifying and displaying panes in the status bar. For additional methods that apply to panes, see the AcStatusBarItem class.
AcPcPointAttributes Point attributes definition
AcPcPointDouble Point definition for double precision points.
AcPcPointFloat Point definition for single precision points.
AcPointCloudColorSchemeCollectionReactor The AcPointCloudColorSchemeCollectionReactor object is an abstract class that gets notified when a AcDbPointCloudColorMap is changed.
AcPointCloudExtractedCylinder This class wraps the data structure of a cylinder, which is extracted from point cloud segment and is used for preview.
AcPointCloudExtractor This class does the point cloud line extraction and line output.
AcPointCloudExtractResult Point cloud line extraction result.
AcPointCloudItem Class point cloud item, which presents different type of point cloud elements e.g. project, scan, region, etc.
AcReCallout The AcReCallout class is intended to be used as the base class for callout classes which override the methods that are called during the acreEntityToFaces process in order to retrieve the faceted approximation information to entities. When an object of one of these derived classes is instantiated and registered with the function acreRegisterCallout(), then when the function acreEntityToFaces() is called, the appropriate methods within the Callout object will be called.The class AcReCallout has one public data member, intflags. It is the responsibility of the application to initialize this variable to some meaningful value before passing objects of... more
AcStackAllocator Used to allocate objects on a stack.
AcStatusBarItem The AcStatusBarItem class represents an item in the status bar. The item can be a pane or a tray item.This class provides methods that support both both pane and tray item objects.For more information about pane objects, see AcPane. For more information about tray item objects, see AcTrayItem.
AcStatusBarMenuItem AcStatusBarMenuItem
AcStringAcString is a compiler-neutral string class. It provides functions for converting between multibyte (ANSI) strings and Unicode, and it is MIF (M+nxxyy) and CIF (U+xxxx) aware.
AcUnderlayLayer An abstract class that represents underlay layers in the drawing.Underlays are similar to raster images but their content is snappable. An AcDbUnderlayReference must reference a compatible AcDbUnderlayDefinition. The AcDbUnderlayReference is responsible for the placement of the content within the drawing while AcDbUnderlayDefinition handles the linkage to the underlay content.Instances of AcDbUnderlayReference derived concrete classes are inserted in a block table record. Instances of AcDbUnderlayDefinition derived concrete classes are inserted into a dictionary of the named object .
AcUniqueString This class maintains a list of interned strings for quick comparisons. Two interned strings can be compared for equality by doing a straight pointer comparison instead of the more expensive character-by-character comparison.Returns a unique identifier (pointer) for the input string, to allow fast compares using pointer values instead of strings.Input strings are converted to lowercase, then are looked up in and stored in an internal map. So "ABC" and "abc" return the same AcUniqueString pointer.AcUniqueString pointers are valid for the process's lifetime. Input pointer must not be null, and return pointer will not be null.... more
AcValue For internal use only.
AcViewFrustum View frustum for defining an area of interest for point extraction.
AcXRefLayerPropertyOverride This is class AcXRefLayerPropertyOverride.
AdCharFormatter This utility class assists in conversions among various character formats, including the following:
  • ANSI
  • CIF
  • UTF8
  • UTF16
  • UTF32
AdCharFormatter is particularly useful in file wrapper classes such as AcCFile, AcCStdioFile, and AcFILE . This class by itself does not perform physical file I/O tasks; its role is to ensure that details such as byte order mark (BOM) and new line expansion are handled in a consistent manner.
AdHostImageAppServices This class defines an interface to publish the initialization/un-initialization of format codecs with the imaging library that an application (like AutoCAD) might be internally using.Applications (like AutoCAD) which are clients of some imaging library themselves can provide implementation for this interface. It is preferred to have a singleton object implementing this interface for the entire application session. Using this interface, applications can mask the internals of how it initializes the imaging library it uses.
CAcGradientThumbnailEngine This class provides the ability to generate and display thumbnails of gradient configurations, as seen on the Gradient tab of the AutoCAD Hatch dialog.This is a pure virtual interface. The developer acquires a pointer to the underlying implementation object by calling the global function createGradientThumbnailEngine(). When finished with the thumbnail engine, the developer should delete the pointer.The process of creating the thumbnails involves the following steps:
  1. Create the gradient thumbnail engine.
  2. Set the desired gradient hatch parameters such as colors and angle.
  3. Render the thumbnails.
  4. Draw each of the nine thumbnails into a Windows device context.
  5. Make... more
CRectangle3d This class provides a way to get and set the location and size of OLE-contained objects in AutoCAD drawings in the drawing's World Coordinate System coordinates.
ExtractOption Allows you to do point cloud extraction.
IAcadAcCmColorAccess This interface provides access to the CAcadAcCmColor coclass. It allows you to get a copy of the encapsulated AcCmColor object directly, rather than by querying individual attributes such as name and bookname.This interface is not exposed through automation.
IAcadBaseDatabase This interface is implemented by the AcadDatabase object. It provides a link between the AcDbDatabase and its COM wrapper AcadDatabase.
IAcadBaseObject This interface defines the methods for base objects. It contains accessors to the object id and class id.
IAcadBaseObject2 This interface supplies methods that enable ObjectARX and ObjectDBX modules to provide COM wrappers for non-database-resident objects from their C++ implementations. This is a not an Automation-compatible interface. It is intended for use by C++ applications only.
IAcadBaseSubEntity This interface is used to manage the link from a COM object to an AcDbFullSubentPath object.
IAcDbPointCloudAttributeFilter This interface filters points based on point's attribute The attributes include color, intensity, normal and classification. Note that not all attributes may be available. The default value for these attributes are zero Efficiency of the implementation of this interface can critically affect performance of the point cloud access queries.
IAcDbPointCloudDataBuffer A data buffer that collects point data for a point cloud.
IAcDbPointCloudPointProcessor This interface processes all point data inside of a point cloud.
IAcDbPointCloudSpatialFilter Implement this interface to filter points based on point's coordinate. Efficiency of the implementation of this interface can affect performance of the point cloud rendering.
IAcPcDataBuffer Data buffer for points returned from the point cloud engine.Points returned in the data buffer will be in local point cloud space. To convert the points to world space you need to first add the XYZ offset to the point and then transform the point using the entityTransform.
IAcPcPointFilter Callback class for filtering the point display.
IAcPcPointProcessor Point processor.This class lets you extract points from the drawing for export or interrogation purposes. These operations do not affect the current point display.
IAcReadStream Interface for a readable stream.When using objects of this class there are two guidelines to follow:
  1. Don't call any instance methods on a pointer to the object after calling close() because close() can deallocate the object thus making the pointer invalid.
  2. If the framework which provided the pointer to the stream object has a factory method for deleting the object, then follow the requirements of that framework and call the delete method when expected.
IAcRxEnumeration All the enumerated types will need to pass an object that implements this interface in the constructor of AcRxValueType. This interface will be used to query the enumerators contained in the enumeration.
IAcRxNonBlittableType The object of the types that cannot be copied using memory copy operation are non blittable types. An object that implements this interface will need to be passed in the AcRxValueType constructor for these types. This object will be used for copying the object.
IAcRxReferenceType This is useful for objects that implement open/close protocol like the AcDbObject. Object that implement the open/close protocol can pass an object that implements this interface in the constructor of AcRxValueType. This interface is useful to get the object from the AcRxValue. For example we can use this interface to get the AcDbObject from the AcRxValue that contains an AcDbObjectId. @IAcRxReferenceType::beginDereferencing@AcRxValue&@OpenMode@const Returns the object that is dereferenced.
IAcWriteStream Interface for a read/write stream.When using objects of this class there are two guidelines to follow:
  1. Don't call any instance methods on a pointer to the object after calling close() because close() can deallocate the object thus making the pointer invalid.
  2. If the framework which provided the pointer to the stream object has a factory method for deleting the object, then follow the requirements of that framework and call the delete method when expected.
IAdHostWindow Provides the interface definition for a generic window in the application.
IMetaColorSuppressor This interface manages a flag that prevents the Properties palette window from showing bylayer or byblock color in the color combo control or the color dialog box. This interface is obtained by querying an AcadAcCmColor automation object.
IPointCloudExtracProgressCallback Specifies callback for point cloud extraction progress.
IPointCloudFilter Implement this interface to define the volume of interest within the point cloud when this volume of interest is more complex than a view frustum. Efficiency of the implementation of this interface can critically affect performance of the point cloud access queries.
IPointCloudFilter2 Extend the interface IPointCloudFilter it supports transform by specifying a matrix.
OwnerDraw3d Internal use only.
PointCloudBinaryOperatorFilter The PointCloudBinaryOperatorFilter is the base class for all filters that use binary operation on two filters
PointCloudIntersectionFilter The PointCloudIntersectionFilter allows filter based on intersection of two filters
PointCloudUnionFilter The PointCloudUnionFilter allows filter based on union of two filters
PointCloudXORFilter The PointCloudXORFilter allows filter based on symmetric difference of two filters
ProfileCurve2d Profile curve, it may be a line or an arc.
RxADSAppTableEntryType For internal use only.

Interfaces

Interface Description
IRelocateDrawing Private.

Namespaces

Namespace Description
AcDmUtil The AcDmUtil namespace is a collection of dimensioning utility functions for managing dimension arrowheads and for dimension style migration from Release 14 to AutoCAD 2000.Four new dimension variables have been added and two old variables have been removed. The Release 14 variable DIMFIT was separated into the variables DIMATFIT and DIMTMOVE, and the Release 14 variable DIMUNIT was separated into the variables DIMLUNIT and DIMFRAC. Migration functions are provided in this namespace to map from the old variables to the new and from the new to the old.There are nineteen built-in arrowheads. Each has a globally invariant name... more
AcDwgExtractor API that allows for the addition of arbitrary properties to drawing extraction results.Note: For APS Design Automation Use only.
GS Container for enumerations used by the Graphics System API.

Templates

Template Description
AcadToolImpl The AcadToolImpl class handles general AutoCAD Tool functionality by parsing the tool's type information at runtime to discover details about the custom interface. This information is used to persist the tool via XML (ATC files), support the default property inspector for the tool properties, handle drag/drop notifications, and support for Color and Layer property controls . At the same time, the developer is free to override any functionality handled by this class by implementing the necessary virtual functions.
AcArrayAcArray is a template class, which means other arrays of specific objects use this class to obtain their definition. Since this is a template class, the descriptions for all the other array classes are actually defined here. The signatures are described with the template syntax. Depending on the array class you are working with, replace the type (for example, AcDbObjectIdArray), with the type name T indicator when reading the AcArray descriptions.The following description applies to all of the dynamic arrays used in ObjectARX. The term "dynamic array" means that the array can grow without bounds unlike declaring an... more
AcArrayMemCopyReallocator Template class for dynamic arrays.If the contained class can be safely copied by the memcpy operator, use the AcArrayMemCopyReallocator template with the array. If the class you intend to contain requires the use of operator=() for the copying during reallocation, use AcArrayObjectCopyReallocator instead.The default behavior is to use AcArrayMemCopyReallocator.
AcArrayObjectCopyReallocator Template class for dynamic arrays.If the class you intend to contain requires the use of operator=() for the copying during reallocation, use AcArrayObjectCopyReallocator with the array. If the contained class can be copied safely by the memcpy operator, use the AcArrayMemCopyReallocator template instead. The default behavior is to use AcArrayMemCopyReallocator.
CProxy_PropertyNotifySink This template class facilitates notification to connected objects when a COM wrapper class is modified. The class is extended to expose a new method that allows the COM wrapper class to identify the object property that was modified and triggered the notification.
IAcadBaseDatabaseImpl Abstract base class used to manage the AcDbDatabase pointer.
IAcadBaseObject2Impl This class provides a default implementation of the IAcadBaseObject2 interface. Object wrappers should derive from either this template class or the IAcadBaseObjectImpl template class, but not both.The IAcadObjectDispatchImpl template class derives from this template class, so any custom object wrappers deriving from IAcadObjectDispatchImpl or IAcadEntityDispatchImpl inherit the default implementation of IAcadBaseObject2 as well.
IAcadBaseObjectImplIDispatch-based template class that is used to implement and instantiate objects derived from the IAcadBaseObject interface.
IAcadObjectDispatchImpl This IDispatch-based template class implements the common object properties and methods, in addition to inheriting IAcadObject protocol.

Was this information helpful?