Class AcDbFace

Represents a three-dimensional surface patch — specifically, a flat polygon that can have three or four vertices (triangular or quadrilateral). It’s one of the simplest types of 3D geometry in AutoCAD — used mainly for visual representation of 3D models, not for solid modeling.

Hierarchy (View Summary)

AcDbEntity
- AcDbFace

Constructors

constructor

new AcDbFace(): AcDbFace
Creates a new face entity.

This constructor initializes a face with default values. All vertices are set to the origin.

Returns AcDbFace
Overrides AcDbEntity.constructor
- Defined in data-model/src/entity/AcDbFace.ts:31

Properties

`Static`typeName

typeName: string = 'Face'

The entity type name

Accessors

attrs

get attrs(): AcCmObject<ATTRS>
Gets the attributes object for this AcDbObject.

Returns AcCmObject<ATTRS>
The AcCmObject instance containing all attributes
Example
```
const attrs = obj.attrs;
const value = attrs.get('someAttribute');
```
Inherited from AcDbEntity.attrs
- Defined in data-model/src/base/AcDbObject.ts:80

color

get color(): AcCmColor
Gets the color information of this entity.

Returns AcCmColor
The color object for this entity
Example
```
const color = entity.color;
```
Inherited from AcDbEntity.color
- Defined in data-model/src/entity/AcDbEntity.ts:111
set color(value: AcCmColor): void
Sets the color information for this entity.
Parameters
- value: AcCmColor
  The new color object
Returns void
Example
```
entity.color = new AcCmColor(0xFF0000);
```
Inherited from AcDbEntity.color
- Defined in data-model/src/entity/AcDbEntity.ts:125

database

get database(): AcDbDatabase
Gets the database in which this object is resident.

When an object isn't added to a database, this property returns the current working database. After it is added to a database, it will be set automatically. You should never set this value manually.

Returns AcDbDatabase
The database this object belongs to
Example
```
const db = obj.database;
```
Inherited from AcDbEntity.database
- Defined in data-model/src/base/AcDbObject.ts:223
set database(db: AcDbDatabase): void
Sets the database for this object.

This is typically set automatically when the object is added to a database. Manual setting should be avoided unless you know what you're doing.
Parameters
- db: AcDbDatabase
  The database to associate with this object
Returns void
Example
```
obj.database = myDatabase;
```
Inherited from AcDbEntity.database
- Defined in data-model/src/base/AcDbObject.ts:242

geometricExtents

get geometricExtents(): AcGeBox3d
Gets the geometric extents (bounding box) of this face.

Returns AcGeBox3d
The bounding box that encompasses the entire face
Example
```
const extents = face.geometricExtents;
console.log(`Trace bounds: ${extents.minPoint} to ${extents.maxPoint}`);
```
Overrides AcDbEntity.geometricExtents
- Defined in data-model/src/entity/AcDbFace.ts:164

layer

get layer(): string
Gets the name of the layer referenced by this entity.

Returns string
The layer name
Example
```
const layerName = entity.layer;
```
Inherited from AcDbEntity.layer
- Defined in data-model/src/entity/AcDbEntity.ts:83
set layer(value: string): void
Sets the name of the layer for this entity.
Parameters
- value: string
  The new layer name
Returns void
Example
```
entity.layer = 'MyLayer';
```
Inherited from AcDbEntity.layer
- Defined in data-model/src/entity/AcDbEntity.ts:97

`Protected`lineStyle

get lineStyle(): AcGiLineStyle
Gets the line style for this entity.

This method returns the line style based on the entity's linetype and other properties.

Returns AcGiLineStyle
The line style object
Example
```
const lineStyle = entity.lineStyle;
```
Inherited from AcDbEntity.lineStyle
- Defined in data-model/src/entity/AcDbEntity.ts:443

lineType

get lineType(): string
Gets the name of the line type referenced by this entity.

Returns string
The linetype name
Example
```
const lineType = entity.lineType;
```
Inherited from AcDbEntity.lineType
- Defined in data-model/src/entity/AcDbEntity.ts:170
set lineType(value: string): void
Sets the name of the line type for this entity.
Parameters
- value: string
  The new linetype name
Returns void
Example
```
entity.lineType = 'DASHED';
```
Inherited from AcDbEntity.lineType
- Defined in data-model/src/entity/AcDbEntity.ts:184

linetypeScale

get linetypeScale(): number
Gets the line type scale factor of this entity.

When an entity is first instantiated, its line type scale is initialized to an invalid value. When the entity is added to the database, if a linetype scale has not been specified for the entity, it is set to the database's current line type scale value.

Returns number
The linetype scale factor
Example
```
const scale = entity.linetypeScale;
```
Inherited from AcDbEntity.linetypeScale
- Defined in data-model/src/entity/AcDbEntity.ts:231
set linetypeScale(value: number): void
Sets the line type scale factor for this entity.
Parameters
- value: number
  The new linetype scale factor
Returns void
Example
```
entity.linetypeScale = 2.0;
```
Inherited from AcDbEntity.linetypeScale
- Defined in data-model/src/entity/AcDbEntity.ts:245

lineWeight

get lineWeight(): number
Gets the line weight used by this entity.

Returns number
The line weight value
Example
```
const weight = entity.lineWeight;
```
Inherited from AcDbEntity.lineWeight
- Defined in data-model/src/entity/AcDbEntity.ts:198
set lineWeight(value: number): void
Sets the line weight for this entity.
Parameters
- value: number
  The new line weight value
Returns void
Example
```
entity.lineWeight = 2;
```
Inherited from AcDbEntity.lineWeight
- Defined in data-model/src/entity/AcDbEntity.ts:212

objectId

get objectId(): string
Gets the object ID.

AutoCAD uses 64-bit integers to represent handles, which exceed the maximum integer value of JavaScript. Therefore, strings are used to represent object handles.

Returns string
The object ID as a string
Example
```
const id = obj.objectId;
console.log(`Object ID: ${id}`);
```
Inherited from AcDbEntity.objectId
- Defined in data-model/src/base/AcDbObject.ts:163
set objectId(value: string): void
Sets the object ID.
Parameters
- value: string
  The new object ID
Returns void
Example
```
obj.objectId = 'new-object-id';
```
Inherited from AcDbEntity.objectId
- Defined in data-model/src/base/AcDbObject.ts:177

ownerId

get ownerId(): string
Gets the object ID of the owner of this object.

Returns string
The owner object ID
Example
```
const ownerId = obj.ownerId;
```
Inherited from AcDbEntity.ownerId
- Defined in data-model/src/base/AcDbObject.ts:191
set ownerId(value: string): void
Sets the object ID of the owner of this object.
Parameters
- value: string
  The new owner object ID
Returns void
Example
```
obj.ownerId = 'parent-object-id';
```
Inherited from AcDbEntity.ownerId
- Defined in data-model/src/base/AcDbObject.ts:205

rgbColor

get rgbColor(): number
Gets the RGB color of this entity after converting color index.

This method handles the conversion of color indices (including ByLayer and ByBlock) to actual RGB colors. It resolves layer colors and block colors as needed.

Returns number
The RGB color value as a number
Example
```
const rgbColor = entity.rgbColor;
console.log(`RGB: ${rgbColor.toString(16)}`);
```
Inherited from AcDbEntity.rgbColor
- Defined in data-model/src/entity/AcDbEntity.ts:143

transparency

get transparency(): number
Gets the transparency level of this entity.

Returns number
The transparency value (0-1, where 0 is opaque and 1 is fully transparent)
Example
```
const transparency = entity.transparency;
```
Inherited from AcDbEntity.transparency
- Defined in data-model/src/entity/AcDbEntity.ts:287
set transparency(value: number): void
Sets the transparency level of this entity.
Parameters
- value: number
  The transparency value (0-1, where 0 is opaque and 1 is fully transparent)
Returns void
Example
```
entity.transparency = 0.5; // 50% transparent
```
Inherited from AcDbEntity.transparency
- Defined in data-model/src/entity/AcDbEntity.ts:301

type

get type(): string
Gets the type name of this entity.

This method returns the entity type by removing the "AcDb" prefix from the constructor name.

Returns string
The entity type name
Example
```
const entity = new AcDbLine();
console.log(entity.type); // "Line"
```
Inherited from AcDbEntity.type
- Defined in data-model/src/entity/AcDbEntity.ts:69

visibility

get visibility(): boolean
Gets whether this entity is visible.

Returns boolean
True if the entity is visible, false otherwise
Example
```
const isVisible = entity.visibility;
```
Inherited from AcDbEntity.visibility
- Defined in data-model/src/entity/AcDbEntity.ts:259
set visibility(value: boolean): void
Sets whether this entity is visible.
Parameters
- value: boolean
  True to make the entity visible, false to hide it
Returns void
Example
```
entity.visibility = false; // Hide the entity
```
Inherited from AcDbEntity.visibility
- Defined in data-model/src/entity/AcDbEntity.ts:273

Methods

`Protected`attachEntityInfo

attachEntityInfo(target: undefined | null | AcGiEntity): void
Attaches entity information to a graphic interface entity.

This method transfers essential entity properties (object ID, owner ID, layer name, and visibility) from this entity to the target graphic interface entity. This is typically used during the rendering process to ensure the graphic entity has the correct metadata.
Parameters
- target: undefined | null | AcGiEntity
  The graphic interface entity to attach information to
Returns void
Inherited from AcDbEntity.attachEntityInfo
- Defined in data-model/src/entity/AcDbEntity.ts:522

close

close(): void
Closes the object.

All changes made to the object since it was opened are committed to the database, and a "closed" notification is sent. This method can be overridden by subclasses to provide specific cleanup behavior.

Returns void
Example
```
obj.close();
```
Inherited from AcDbEntity.close
- Defined in data-model/src/base/AcDbObject.ts:258

draw

draw(renderer: AcGiRenderer<AcGiEntity>): AcGiEntity
Draws this face using the specified renderer.

This method renders the face as a filled area using the face's current style properties.
Parameters
- renderer: AcGiRenderer<AcGiEntity>
  The renderer to use for drawing
Returns AcGiEntity
The rendered face entity, or undefined if drawing failed
Example
```
const renderedFace = face.draw(renderer);
```
Overrides AcDbEntity.draw
- Defined in data-model/src/entity/AcDbFace.ts:204

getAttr

getAttr(attrName: string): any
Gets the value of the specified attribute.

This method will throw an exception if the specified attribute doesn't exist. Use getAttrWithoutException() if you want to handle missing attributes gracefully.
Parameters
- attrName: string
  The name of the attribute to retrieve
Returns any
The value of the specified attribute
Throws
When the specified attribute doesn't exist
Example
```
try {
  const value = obj.getAttr('objectId');
} catch (error) {
  console.error('Attribute not found');
}
```
Inherited from AcDbEntity.getAttr
- Defined in data-model/src/base/AcDbObject.ts:103

getAttrWithoutException

getAttrWithoutException(attrName: string): any
Gets the value of the specified attribute without throwing an exception.

This method returns undefined if the specified attribute doesn't exist, making it safer for optional attributes.
Parameters
- attrName: string
  The name of the attribute to retrieve
Returns any
The value of the specified attribute, or undefined if it doesn't exist
Example
```
const value = obj.getAttrWithoutException('optionalAttribute');
if (value !== undefined) {
  // Use the value
}
```
Inherited from AcDbEntity.getAttrWithoutException
- Defined in data-model/src/base/AcDbObject.ts:130

`Protected`getLayerColor

getLayerColor(): null | AcCmColor
Gets the color of the layer this entity belongs to.

This method retrieves the color from the layer table for the layer this entity belongs to.

Returns null | AcCmColor
The layer color, or undefined if the layer doesn't exist
Example
```
const layerColor = entity.getLayerColor();
```
Inherited from AcDbEntity.getLayerColor
- Defined in data-model/src/entity/AcDbEntity.ts:499

getVertexAt

getVertexAt(index: number): AcGePoint3d
Gets the point at the specified index in this face.

The index can be 0, 1, 2, or 3, representing the four vertices of the face. If the index is out of range, it returns the first or last vertex accordingly.
Parameters
- index: number
  The index (0-3) of the vertex to get
Returns AcGePoint3d
The point at the specified index in WCS coordinates
Example
```
const point0 = face.getVertexAt(0);
const point1 = face.getVertexAt(1);
console.log(`Vertex 0: ${point0.x}, ${point0.y}, ${point0.z}`);
```
- Defined in data-model/src/entity/AcDbFace.ts:53

isEdgeVisibleAt

isEdgeVisibleAt(index: number): boolean
Checks if the edge at the specified index is visible.

The index must be 0, 1, 2, or 3, representing the four edges of the face. If the index is out of range, it throws an error.
Parameters
- index: number
  The index (0-3) of the edge to check
Returns boolean
True if the edge is visible, false otherwise
Example
```
const isVisible = face.isEdgeVisibleAt(0);
console.log(`Edge 0 is visible: ${isVisible}`);
```
- Defined in data-model/src/entity/AcDbFace.ts:123

makeEdgeInvisibleAt

makeEdgeInvisibleAt(index: number): void
Makes the edge at the specified index invisible.

The index must be 0, 1, 2, or 3, representing the four edges of the face. If the index is out of range, it throws an error.
Parameters
- index: number
  The index (0-3) of the edge to make invisible
Returns void
Example
```
face.makeEdgeInvisibleAt(0);
face.makeEdgeInvisibleAt(1);
face.makeEdgeInvisibleAt(2);
face.makeEdgeInvisibleAt(3);
```
- Defined in data-model/src/entity/AcDbFace.ts:146

setAttr

setAttr<A extends string>(attrName: A, val?: AcDbObjectAttrs[A]): void
Sets the value of an attribute.
Type Parameters
- A extends string
Parameters
- attrName: A
  The name of the attribute to set
- Optionalval: AcDbObjectAttrs[A]
  The value to assign to the attribute
Returns void
Example
```
obj.setAttr('objectId', 'new-id-123');
```
Inherited from AcDbEntity.setAttr
- Defined in data-model/src/base/AcDbObject.ts:145

setEdgeInvisibilities

setEdgeInvisibilities(invisibilities: number): void
Sets the invisibilities of the edges of the face.

The invisibilities are represented as a bitmask, where each bit corresponds to an edge. If the bit is set, the edge is invisible, otherwise it is visible.
Parameters
- invisibilities: number
  The bitmask representing the invisibilities of the edges
Returns void
Example
```
face.setEdgeInvisibilities(0b1111); // All edges are visible
face.setEdgeInvisibilities(0b0000); // All edges are invisible
face.setEdgeInvisibilities(0b1010); // Edge 0 and 2 are visible, edge 1 and 3 are invisible
```
- Defined in data-model/src/entity/AcDbFace.ts:104

setVertexAt

setVertexAt(index: number, point: AcGeVectorLike): undefined | AcGePoint3d
Sets the point at the specified index in this face.

The index must be 0, 1, 2, or 3, representing the four vertices of the face. If the index is out of range, it sets the first or last vertex accordingly.
Parameters
- index: number
  The index (0-3) of the vertex to set
- point: AcGeVectorLike
  The new point in WCS coordinates
Returns undefined | AcGePoint3d
Example
```
face.setVertexAt(0, new AcGePoint3d(0, 0, 0));
face.setVertexAt(1, new AcGePoint3d(10, 0, 0));
face.setVertexAt(2, new AcGePoint3d(10, 5, 0));
face.setVertexAt(3, new AcGePoint3d(0, 5, 0));
```
- Defined in data-model/src/entity/AcDbFace.ts:78

subGetGripPoints

subGetGripPoints(): AcGePoint3d[]
Gets the grip points for this face.

Grip points are control points that can be used to modify the face. For a face, the grip points are all four vertices.

Returns AcGePoint3d[]
Array of grip points (all four vertices)
Example
```
const gripPoints = face.subGetGripPoints();
// gripPoints contains all four vertices of the face
```
Overrides AcDbEntity.subGetGripPoints
- Defined in data-model/src/entity/AcDbFace.ts:182

subGetOsnapPoints

subGetOsnapPoints(
    osnapMode: AcDbOsnapMode,
    gsSelectionMark: number,
    pickPoint: AcGePoint3d,
    lastPoint: AcGePoint3d,
    snapPoints: AcGePoint3d[],
): void
Gets the object snap points for this entity.

Object snap points are the points that can be used for precise positioning when drawing or editing. This method should be overridden by subclasses to provide entity-specific snap points.
Parameters
- osnapMode: AcDbOsnapMode
  The object snap mode
- gsSelectionMark: number
  The selection mark
- pickPoint: AcGePoint3d
  The pick point
- lastPoint: AcGePoint3d
  The last point
- snapPoints: AcGePoint3d[]
  Array to populate with snap points
Returns void
Example
```
const snapPoints: AcGePoint3d[] = [];
entity.subGetOsnapPoints(AcDbOsnapMode.Endpoint, 0, pickPoint, lastPoint, snapPoints);
```
Inherited from AcDbEntity.subGetOsnapPoints
- Defined in data-model/src/entity/AcDbEntity.ts:343

transformBy

transformBy(matrix: AcGeMatrix3d): this
Transforms this entity by the specified matrix.

This method applies a geometric transformation to the entity. Subclasses should override this method to provide entity-specific transformation behavior.
Parameters
- matrix: AcGeMatrix3d
  The transformation matrix to apply
Returns this
This entity after transformation
Example
```
const matrix = AcGeMatrix3d.translation(10, 0, 0);
entity.transformBy(matrix);
```
Inherited from AcDbEntity.transformBy
- Defined in data-model/src/entity/AcDbEntity.ts:373

triggerModifiedEvent

triggerModifiedEvent(): void
Triggers a modified event for this entity.

This method notifies listeners that the entity has been modified.

Returns void
Example
```
entity.triggerModifiedEvent();
```
Inherited from AcDbEntity.triggerModifiedEvent
- Defined in data-model/src/entity/AcDbEntity.ts:423

Class AcDbFace

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AcDbFace

Properties

StatictypeName

Accessors

attrs

Returns AcCmObject<ATTRS>

Example

color

Returns AcCmColor

Example

Parameters

Returns void

Example

database

Returns AcDbDatabase

Example

Parameters

Returns void

Example

geometricExtents

Returns AcGeBox3d

Example

layer

Returns string

Example

Parameters

Returns void

Example

ProtectedlineStyle

Returns AcGiLineStyle

Example

lineType

Returns string

Example

Parameters

Returns void

Example

linetypeScale

Returns number

Example

Parameters

Returns void

Example

lineWeight

Returns number

Example

Parameters

Returns void

Example

objectId

Returns string

Example

Parameters

Returns void

Example

ownerId

Returns string

Example

Parameters

Returns void

Example

rgbColor

Returns number

Example

transparency

Returns number

Example

Parameters

Returns void

Example

type

`Static`typeName

`Protected`lineStyle

`Protected`attachEntityInfo

`Protected`getLayerColor