Share

AcEd Classes (WIN)

Classes

Class Description
AcEdCommand This class represents an AutoCAD command registered in the AutoCAD command dictionary. It contains the flags associated with the command, the address of the function to invoke when the command is processed, the global or untranslated name, and local or translated name associated with the command.
AcEdCommandIterator This class allows you to traverse the chain of command groups that are registered with AutoCAD and obtain information about the groups and the AcEdCommand objects within them.
AcEdCommandReactor This class is used to receive notifications on command start/end for specific commands. Attach to desired AcEdCommand instances.
AcEdCommandRejector The class allows you to disable a specified command before it can be ran in the command context on the client side. Users should inherit AcEdCommandRejector and override the reject() function.
AcEdCommandStack The system contains one instance of an object of this class. The single instance is referenced through the acedRegCmds macro (which provides a pointer to the object), and provides applications with the ability to create, define, and register command objects with AutoCAD. These command objects are used to invoke the proper ObjectARX application function when an externally defined command is processed. The command names used to execute the command can be either global and non-translated or local and translated. Commands can be added to existing groups of commands, or added to a newly created group (the new groups are automatically... more
AcEdCommandStackReactor This class is used to receive notifications on when commands are added/removed and also started/ended.Note: If you need to monitor start/end of a specific command, recommend using AcEdCommandReactor instead. This allows you to attach directly to the desired command.
AcEdDragStyle This class allows clients to define the visual styles for both the original and the dragged entity during a drag operation. The client can define the visual style by either explicitly specifying the AcGiVisualStyle or by specifying a pre-set type that is used to set the AcGiVisualStyle.
AcEdInplaceTextEditor This classs represents the in-place text editor in ACAD. It inherits from AcDbTextEditor.From such an object you can also access methods in the db editor like columns, paragraphs and so on.The user accesses the ACAD in-place text editor via MTEXT or TEXT objects. Also, you can create a non-database resident MTEXT object for a complex object and invoke the in-place text editor.For an ACAD session there is only one in-place text editor at any given time.To quit the in-place text editor, use close() and specify if changes need to be saved back to the input entity.... more
AcEdInplaceTextEditorSettings The AcEdInplaceTextEditorSettings class enables the setting of input options for the in-place editor. The setting affect the UI and properties.
AcEdInputPoint This class is used to handle what happened on point during the current input.Input might be from a digitizer event or mouse click, from raw cursor location (or tablet mode digitizer UCS point) through snap grid, ortho/alignment mode, OSNAP and Autosnap (aka "Alignment").
AcEdInputContextReactor This class provides reactors for notification of user prompts that are starting and completing. The parameters ALL have the same meaning as the parameters in the corresponding acedGetxxxx() functions.Note that the inputs can only be discerned from the beginGetxxxx callbacks and the outputs are returned to the endGetxxxx callbacks. This eliminates redundancy, and obviously, the timing is right. Within a given document, these callbacks can be nested, but an endGetxxxx callback will always balance with a beginGetxxxx callback within a document, unless AutoCAD terminates in mid-command.Note also that the acedInitGet() parameters are folded into the beginGetxxxx callbacks, and... more
AcEdInputPointFilter This class provides a callback protocol that defines a combination "Input Point Notification and Input Point filter" mechanism. It is intended to monitor and change points after built-in AutoCAD point filters have computed their effect. The net effect is that applications are able to override AutoCAD point evaluation, after considering any combination of AutoCAD's computation along the way. This also satisfies a more general desire for "cursor event notification", however if you intend to just monitor points, see AcEdInputPointMonitor instead.Note: If you use this class to add or change a tooltip displayed in the AutoCAD drawing area, you can... more
AcEdInputPointFilterResult This is class AcEdInputPointFilterResult.
AcEdInputPointManager The Input Point manager will be instantiated once for each active document in AutoCAD, and is exported via a member function on AcApDocument.Each instance manages the following things for the document's edit session:
  • Registration and de-registration of input point filters and input point monitors.
  • Registration and de-registration of input context reactors.
  • Disabling and re-enabling of system-generated cursor graphics, which is a key element of drawing custom cursor graphics.
  • Requesting forced entity picking during input events where entity picking would not otherwise be done. This is done to track what entities are under the cursor during cursor tracking across... more
AcEdInputPointMonitor This class provides a callback protocol that defines an "Input Point Notification" mechanism. It is intended to only monitor points after built-in AutoCAD point filters have computed their effect. This also satisfies a more general desire for "cursor event notification." If you intend to make changes to points, see AcEdInputPointFilter instead.Unlike AcEdInputPointFilter, this class cannot affect the point or influence the prompting, and therefore has none of the Output Value parameters of AcEdInputPointFilter. However, see graphics output, which is the same for monitors as for filters.
AcEdInputPointMonitorResult This is class AcEdInputPointMonitorResult.
AcEditor The single system object of a class derived from this abstract base class allows applications to manage AutoCAD drawing editor notification reactors. Applications can add and remove reactors from the AutoCAD drawing editor reactor chain.
AcEditorReactor This class serves as a base class for custom classes that receive notification of AcEditor events.The classes derived from this class override the methods that represent events about which users wish to be notified. When an object of a derived class is added to the reactor list of the AutoCAD editor and an event associated with one of the overloaded methods occurs, that method is called in the object.The default implementation for all methods in this class is an immediate return.
AcEdJig The AcEdJig provides a base class from which custom classes can be derived that make use of the Jig functionality. This functionality provides graphical representation and user interaction in the process of setting the entity's parameters to the user's specifications.Essentially the jig creates an entity object and then goes into a loop that:
  • Gets a user drag movement
  • Interprets this as a distance, angle, or point
  • Uses this value to update the entity's data
  • Calls the entity's worldDraw method to redraw it on screen
  • When all necessary data is obtained, the loop is exited and, if desired, the entity... more
AcEdSelectedTransient The AcEdSelectedTransent class defines the selected transient and its corresponding information, including its parent, GsMarker, DrawingMode, subDrawingMode, etc.
AcEdSelectionSetService This class provides services to the AcEdSSGetFilter class to support modification of a selection set. Objects of the AcEdSelectionSetService class are passed by the following functions:
  • AcEdSSGetFilter::ssgetAddFilter()
  • AcEdSSGetFilter::ssgetRemoveFilter()
  • AcEdSSGetFilter::endSSGet()
AcEdServices A single instance of this class is used by the ObjectARX system to create new AcEdCommand objects for ObjectARX command registration. This service object is not meant to be used by ObjectARX applications.
AcEdSolidSubentitySelector The AcEdSolidSubentitySelector class provides an interface for the selection of face subentities of a 3D solid object in the current space of the current document.
AcEdSSGetFilter This class is used for notification of selection set operations. Classes derived from this class can receive enhanced notification about ongoing selection set operations in AutoCAD and can modify the current selection set by adding entries to it and removing entries from it. Modification of the current selection set is supported by the AcEdSelectionSetService class. Creation or modification of the PICKFIRST set normally triggers an AcEdSSGetFilter::ssgetAddFilter() or AcEdSSGetFilter::ssgetRemoveFilter() notification. It does not typically trigger an AcEdSSGetFilter::endSSGet()notification, except in the following circumstances: * If the user cancels the creation of a PICKFIRST set by pressing ESC, an AcEdSSGetFilter::endSSGet() notification is... more
AcEdSSGetSubSelectFilter This class provides filtering services for subentity selections on a per-class basis. Objects of this class are registered with the AcEdInputPointManager for specific AcRxClass types. When a sub-selection is performed on an entity, the associated filter is notified of the selection and has the opportunity to add or remove additional subentity selections on the object through the callback functions implemented on the filter.
AcEdSteeringWheel This class defines functionality for the steering wheel navigation tool, a free form navigation for exterior (object inspection) and interior (walk-through) viewing.
AcEdSteeringWheelReactorThis class provides callbacks for all the actions associated with the steering wheel.
AcEdSubSelectFilter This class contains all the implementation for pick-in-space hit testing and subentity selection based on callbacks from the AcEdInputPointManager. This is a filter class. It needs to be registered with the AcEdInputPointManager by calling addSubSelectFilter(), and removed by calling removeSubSelectFilter() when the application is unloaded.For each type of entity that supports this type of subselection, applications are expected to derive a concrete subselection filter from AcEdSubSelectFilter and implement the necessary methods.
AcEdSubSelectFilterService This class is passed to notification callback functions implemented by AcEdSSGetSubSelectFilter objects. It provides methods for adding and removing subentities from the selection set arrays passed to the filter.
AcEdSysVarIterator This class provides a way to iterate over all of the public system variables and get their names, data type, range (if applicable), read-only status, and how they are stored.System variables that have their secret flag set or that have a "*" as the first character in their name are skipped by this iterator.
AcEdUIContext This class is used by ObjectARX applications to add items to AutoCAD shortcut (context) menus.
AcEdUpdateDisplayPauseScope For internal use only.Wrapper class to correctly save/set/restore the state of acedUpdateDisplayPause within a scope can also use default constructor to allow manual set/restore for callback type of patterns. AutoCAD code only uses this class, it does not directly use acedUpdateDisplayPause. This is not a stack, so only a single save state is maintained.
AcEdViewCube This class defines functionality for the view cube navigation tool, which allows for controlled navigation for the view orientation.
AcEdViewCubeReactorThis class provides callbacks for all the actions associated with the view cube.
AcEdXrefFileLock This base class handles the management of Xref file locking. Its main purpose is to prepare the Xref block in a drawing for in-place editing, though it can be used for other purposes. It is assumed that the Xref file methods in this class operate on the current database drawing.

Macros

Macro Description
AcEditorReactor2 This class serves as a base class for custom classes that receive notification of AcEditor events.The classes derived from this class override the methods that represent events about which users wish to be notified. When an object of a derived class is added to the reactor list of the AutoCAD editor and an event associated with one of the overloaded methods occurs, that method is called in the object.This class supplements the notifications provided by the AcEditorReactor class.The default implementation for all methods in this class is an immediate return.
AcEditorReactor3 This class provides further notifications for the AcEditorReactor class; specifically, the status of currently open documents.

Namespaces

Namespace Description
AcEdSSGet This namespace contains enumerations for the AcEdSSGetFilter class.
AcEdSymbolUtilities Namespace AcEdSymbolUtilities contains various utilities specific to AutoCAD for working with symbol names, symbol records, and symbol tables. The main access to the utility functions is through acedSymUtil(), which is then dereferenced to call the member functions of class AcEdSymbolUtilities::Services.The namespace alias AcEdSymUtil is available for use as a shorter abbreviation for the full namespace AcEdSymbolUtilities.This namespace should only be used in ObjectARX modules, and not in ObjectDBX modules.

Types

Type Description
AcEdSSGetFilter2 This class extends AcEdSSGetFilter with additional notifications of selection set operations.
AcEdSSGetFilter3 This class extends AcEdSSGetFilter with additional notifications of selection set operations.
AcEdSSGetFilter4 This class extends AcEdSSGetFilter with additional notifications of selection set operations.

Types

Was this information helpful?