Class AcEdBaseViewAbstract

Abstract base class for all CAD view implementations.

This class provides the foundation for rendering and interacting with CAD drawings. It manages:

  • Canvas and viewport dimensions
  • Mouse event handling and coordinate conversion
  • Entity selection and highlighting
  • View modes (selection, pan, etc.)
  • Spatial queries for entity picking
  • Hover/unhover detection with timing

Concrete implementations must provide specific rendering logic and coordinate transformations appropriate for their rendering technology (e.g., Three.js, SVG).

Key Responsibilities

  • Input Management: Handles mouse events and user interactions
  • Selection: Manages selected entities and visual feedback
  • Coordinate Systems: Converts between screen and world coordinates
  • Spatial Queries: Finds entities at specific locations
  • View State: Tracks current position, zoom, and view mode

Example

class MyView extends AcEdBaseView {
  // Implement required abstract methods
  get missedData() { return { fonts: {}, images: new Map() }; }
  get mode() { return this._mode; }
  set mode(value) { this._mode = value; }
  // ... other abstract methods
}

const view = new MyView(canvasElement);
view.events.mouseMove.addEventListener(args => {
  console.log('Mouse at world coords:', args.x, args.y);
});

Hierarchy (View Summary)

Constructors

constructor

Properties

_canvas events

Accessors

aspect backgroundColor bbox canvas center curPos curScreenPos editor height missedData mode selectionBoxSize selectionSet width

Methods

addEntity addLayer addLayout clear cwcs2Wcs highlight onHover onUnhover onWindowResize pick search select selectByBox setCalculateSizeCallback setCursor unhighlight updateEntity updateLayer wcs2Cwcs zoomTo zoomToFit

Constructors

constructor

  • new AcEdBaseView(canvas: HTMLCanvasElement): AcEdBaseView

    Creates a new base view instance.

    Sets up the canvas, initializes internal state, and registers event listeners for mouse interactions and window resize events.

    Parameters

    • canvas: HTMLCanvasElement

      The HTML canvas element to render into

    Returns AcEdBaseView

Properties

Protected_canvas

_canvas: HTMLCanvasElement

The HTML canvas element for rendering

Readonlyevents

events: {
    hover: AcCmEventManager<AcEdViewHoverEventArgs>;
    mouseMove: AcCmEventManager<AcEdMouseEventArgs>;
    unhover: AcCmEventManager<AcEdViewHoverEventArgs>;
    viewResize: AcCmEventManager<AcEdViewResizedEventArgs>;
} = ...

Events fired by the view for various interactions

Type declaration

Accessors

aspect

AbstractbackgroundColor

  • get backgroundColor(): number

    Gets the background color of the view.

    The color is represented as a 24-bit hexadecimal RGB number, for example 0x000000 for black or 0xffffff for white.

    Returns number

  • set backgroundColor(value: number): void

    Sets the background color of the view.

    Parameters

    • value: number

      The background color as a 24-bit hexadecimal RGB number

    Returns void

bbox

canvas

Abstractcenter

  • get center(): AcGePoint2d

    Gets the center point of the current view in world coordinates.

    Returns AcGePoint2d

    The view center point

  • set center(value: AcGePoint2d): void

    Sets the center point of the current view in world coordinates.

    Parameters

    • value: AcGePoint2d

      The new center point

    Returns void

curPos

curScreenPos

editor

  • get editor(): AcEditor

    Gets the input manager for handling user interactions.

    The editor provides high-level methods for getting user input like point selection, entity selection, and cursor management.

    Returns AcEditor

    The editor instance

height

AbstractmissedData

  • get missedData(): AcEdMissedData

    Gets information about missing data during rendering.

    This includes fonts that couldn't be loaded and images that are missing or inaccessible. Implementations should track and report this information to help users understand rendering issues.

    Returns AcEdMissedData

    Object containing missing fonts and images

Abstractmode

selectionBoxSize

  • get selectionBoxSize(): number

    Gets the size of the selection box used for entity picking.

    This determines how close the mouse needs to be to an entity to select it, measured in screen pixels.

    Returns number

    Selection box size in pixels

  • set selectionBoxSize(value: number): void

    Sets the size of the selection box used for entity picking.

    Parameters

    • value: number

      Selection box size in pixels

    Returns void

selectionSet

width

Methods

AbstractaddEntity

  • addEntity(entity: AcDbEntity | AcDbEntity[]): void

    Add the specified entity or entities in drawing database into the current scene and draw it or them

    Parameters

    • entity: AcDbEntity | AcDbEntity[]

      Input the entity to add into the current scene

    Returns void

AbstractaddLayer

  • addLayer(layer: AcDbLayerTableRecord): void

    Add the specified layer in drawing database into the current scene

    Parameters

    • layer: AcDbLayerTableRecord

      Input the layer to add into the current scene

    Returns void

AbstractaddLayout

  • addLayout(layout: AcDbLayout): void

    Add the specified layout in drawing database into the current scene

    Parameters

    • layout: AcDbLayout

      Input the layout to add into the current scene

    Returns void

Abstractclear

Abstractcwcs2Wcs

  • cwcs2Wcs(point: AcGeVector2dLike): AcGePoint2d

    Converts a point from client window coordinates to world coordinates.

    The client window coordinate system has its origin at the top-left corner of the canvas, with Y increasing downward. World coordinates use the CAD coordinate system with Y typically increasing upward.

    Parameters

    • point: AcGeVector2dLike

      Point in client window coordinates

    Returns AcGePoint2d

    Point in world coordinates

    Example

    const screenPoint = { x: 100, y: 200 }; // 100px right, 200px down
    const worldPoint = view.cwcs2Wcs(screenPoint);
    console.log('World coordinates:', worldPoint.x, worldPoint.y);

Abstracthighlight

Protected AbstractonHover

Protected AbstractonUnhover

ProtectedonWindowResize

Abstractpick

  • pick(point?: AcGeVector2dLike): string[]

    Pick entities intersected with the specified point in the world coordinate system.

    Parameters

    • Optionalpoint: AcGeVector2dLike

      Input the point to pick objects. If not provided, the position of current cursor is used.

    Returns string[]

    Return ids of entities intersected with the specified point

Abstractsearch

Abstractselect

  • select(point?: AcGeVector2dLike): void

    Select entities intersected with the specified point in the world coordinate system, add them to the current selection set, and highlight them.

    Parameters

    • Optionalpoint: AcGeVector2dLike

    Returns void

AbstractselectByBox

  • selectByBox(box: AcGeBox2d): void

    Select entities intersected with the specified bounding box in the world coordinate system, add them to the current selection set, and highlight them.

    Parameters

    • box: AcGeBox2d

      Input one bounding box in the world coordinate system.

    Returns void

setCalculateSizeCallback

setCursor

Abstractunhighlight

AbstractupdateEntity

  • updateEntity(entity: AcDbEntity | AcDbEntity[]): void

    Update the specified entity or entities

    Parameters

    • entity: AcDbEntity | AcDbEntity[]

      Input the entity or entities to update

    Returns void

AbstractupdateLayer

  • updateLayer(layer: AcDbLayerTableRecord): void

    Update the specified layer in the current scene

    Parameters

    • layer: AcDbLayerTableRecord

      Input the layer to update

    Returns void

Abstractwcs2Cwcs

  • wcs2Cwcs(point: AcGeVector2dLike): AcGePoint2d

    Converts a point from world coordinates to client window coordinates.

    This is the inverse of cwcs2Wcs(), converting from the CAD world coordinate system to screen pixel coordinates.

    Parameters

    • point: AcGeVector2dLike

      Point in world coordinates

    Returns AcGePoint2d

    Point in client window coordinates

    Example

    const worldPoint = new AcGePoint2d(10, 20); // CAD coordinates
    const screenPoint = view.wcs2Cwcs(worldPoint);
    console.log('Screen position:', screenPoint.x, screenPoint.y);

AbstractzoomTo

  • zoomTo(box: AcGeBox2d, margin: number): void

    Zooms the view to fit the specified bounding box with optional margin.

    This method adjusts the view's center and zoom level so that the entire specified bounding box is visible within the viewport. The margin parameter adds extra space around the bounding box to provide visual padding.

    Parameters

    • box: AcGeBox2d

      The bounding box to zoom to, in world coordinates

    • margin: number

      Additional margin around the bounding box (in world units)

    Returns void

AbstractzoomToFit

  • zoomToFit(timeout?: number): void

    Zooms the view to fit all visible entities in the current scene.

    This method automatically calculates the bounding box of all entities currently displayed in the view and adjusts the view's center and zoom level to show the entire scene. This is useful for getting an overview of the entire drawing or after loading new content.

    This function takes effect only if the current view has finished rendering all entities. When opening a file, progressive Rendering is used to render entities incrementally. So this function will wait until all of entities rendered or a timeout occurs.

    Parameters

    • Optionaltimeout: number

      Maximum time (ms) to wait before executing zoom to fit action. Default: 0 (no timeout).

    Returns void

Settings

Member Visibility

On This Page

Key Responsibilities
Constructors
Properties
Accessors
Methods