Interface AcGiRenderer<T>

interface AcGiRenderer<T extends AcGiEntity = AcGiEntity> {
    area(area: AcGeArea2d, style: AcGiHatchStyle): T;
    circularArc(arc: AcGeCircArc3d, style: AcGiLineStyle): T;
    ellipticalArc(ellipseArc: AcGeEllipseArc3d, style: AcGiLineStyle): T;
    group(entities: T[]): T;
    image(blob: Blob, style: AcGiImageStyle): T;
    lines(points: AcGeVector3dLike[], style: AcGiLineStyle): T;
    lineSegments(
        array: Float32Array,
        itemSize: number,
        indices: Uint16Array,
        style: AcGiLineStyle,
    ): T;
    mtext(mtext: AcGiMTextData, style: AcGiTextStyle, delay?: boolean): T;
    point(point: AcGePoint3d, style: AcGiPointStyle): T;
    setFontMapping(mapping: AcGiFontMapping): void;
}

Type Parameters

T extends AcGiEntity = AcGiEntity

Index

Methods

area circularArc ellipticalArc group image lines lineSegments mtext point setFontMapping

Methods

area

area(area: AcGeArea2d, style: AcGiHatchStyle): T
Draw one area
Parameters
- area: AcGeArea2d
  Input area to draw
- style: AcGiHatchStyle
  Input hatch style applied to the area
Returns T
Return an object which can be added to scene
- Defined in AcGiRenderer.ts:87

circularArc

circularArc(arc: AcGeCircArc3d, style: AcGiLineStyle): T
Draw a circular arc or full circle.
Parameters
- arc: AcGeCircArc3d
  Input circular arc to draw
- style: AcGiLineStyle
  Input line style applied to circular arc
Returns T
Return an object which can be added to scene
- Defined in AcGiRenderer.ts:45

ellipticalArc

ellipticalArc(ellipseArc: AcGeEllipseArc3d, style: AcGiLineStyle): T
Draw an elliptical arc or full ellipse.
Parameters
- ellipseArc: AcGeEllipseArc3d
  Input elliptical arc to draw
- style: AcGiLineStyle
  Input line style applied to elliptical arc
Returns T
Return an object which can be added to scene
- Defined in AcGiRenderer.ts:53

group

group(entities: T[]): T
Create one group
Parameters
- entities: T[]
  Input entities to group together
Returns T
Return created group
- Defined in AcGiRenderer.ts:29

image

image(blob: Blob, style: AcGiImageStyle): T
Draw image
Parameters
- blob: Blob
  Input Blob instance of one image file
- style: AcGiImageStyle
  Input image style
Returns T
Return an object which can be added to scene
- Defined in AcGiRenderer.ts:106

lines

lines(points: AcGeVector3dLike[], style: AcGiLineStyle): T
Draw lines using gl.LINE_STRIP.
Parameters
- points: AcGeVector3dLike[]
  Input a point array which contains all line vertices
- style: AcGiLineStyle
  Input line style applied to lines
Returns T
Return an object which can be added to scene
- Defined in AcGiRenderer.ts:61

lineSegments

lineSegments(
    array: Float32Array,
    itemSize: number,
    indices: Uint16Array,
    style: AcGiLineStyle,
): T
Draw lines using gl.LINES.
Parameters
- array: Float32Array
  Must be a TypedArray. Used to instantiate the buffer. This array should have itemSize * numVertices elements, where numVertices is the number of vertices.
- itemSize: number
  The number of values of the array that should be associated with a particular vertex. If the vertex is one 2d point, then itemSize should be 2. If the vertex is one 3d point, then itemSize should be 3.
- indices: Uint16Array
  Index buffer.
- style: AcGiLineStyle
  Input line style applied to line segments
Returns T
Return an object which can be added to scene
- Defined in AcGiRenderer.ts:74

mtext

mtext(mtext: AcGiMTextData, style: AcGiTextStyle, delay?: boolean): T
Draw multiple line texts
Parameters
- mtext: AcGiMTextData
  Input multiple line text data to draw
- style: AcGiTextStyle
  Input text style applied to the text string
- Optionaldelay: boolean
  The flag to delay creating one rendered entity and just create one dummy entity. Renderer can delay heavy calculation operation to avoid blocking UI when this flag is true.
Returns T
Return an object which can be added to scene
- Defined in AcGiRenderer.ts:98

point

point(point: AcGePoint3d, style: AcGiPointStyle): T
Draw a point.
Parameters
- point: AcGePoint3d
  Input point to draw
- style: AcGiPointStyle
  Input point style applied to point
Returns T
Return an object which can be added to scene
- Defined in AcGiRenderer.ts:37

setFontMapping

setFontMapping(mapping: AcGiFontMapping): void
Set font mapping
Parameters
- mapping: AcGiFontMapping
Returns void
- Defined in AcGiRenderer.ts:112